[tor-bugs] #25024 [Core Tor/Tor]: Add optional spell check to makefile to check for typos in tor source code.

[Tor Bug Tracker & Wiki]

#25024: Add optional spell check to makefile to check for typos in tor source code.
------------------------------------------+--------------------------------
 Reporter:  fristonio                     |          Owner:  alison
     Type:  enhancement                   |         Status:  needs_revision
 Priority:  Low                           |      Milestone:  Tor:
                                          |  0.3.4.x-final
Component:  Core Tor/Tor                  |        Version:
 Severity:  Minor                         |     Resolution:
 Keywords:  tor-comment, review-group-34  |  Actual Points:
Parent ID:                                |         Points:  0.5
 Reviewer:  asn                           |        Sponsor:
------------------------------------------+--------------------------------

Comment (by asn):

 Replying to [comment:21 fristonio]:
 > I completely agree with your point here asn, this will be an issue if we
 add misspell to Tor. Also, the `-i` flag solution does not seem to be
 scalable at all.
 > One possible solution I see here for this is to have some ''ignore
 rules'' feature in misspell something like what `eslint` have for JS
 wherein we can specify with the help of comments if we want to ignore a
 block of code from being checked.
 > See here: [https://eslint.org/docs/user-guide/configuring#disabling-
 rules-with-inline-comments]
 > What is your thought on this?
 >
 I feel like that might be a bit too ugly for our codebase just for a
 spellcheck. Perhaps that's fine for tests tho. IMO all possible solutions
 are a bit ugly here:
 a) Inline comments to disable spellcheck
 b) Custom dictionary
 c) Custom ignore rules with -i.

 I think we should decide how this feature should be used tho. If people
 are supposed to run this before every commit then it should have zero
 false positives. However, if that's just something that the maintainer
 runs before every stable release every few months, then perhaps some false
 positives are fine (or they can be removed with a custom dictionary).

 In general, I don't have strong opinions here, and as long as this feature
 is optional as it is, perhaps we can just merge it as is. What do you
 think?

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/25024#comment:22>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online