1552317 - spelling typos in source, like comments

Status: RESOLVED FIXED

(Developer Infrastructure :: Lint and Formatting, defect, P5)

Description

[klemens]

Attachment: storage.txt

User Agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Firefox/60.0

Steps to reproduce:

i've run https://github.com/ka7/misspell_fixer against "current" https://github.com/mozilla/gecko-dev ( head @ 6d2cd4ea8b86e19ad16b1dd0b3d736d1e523e854 ).

... this is a fork of the meanwhile-better/faster https://github.com/vlajos/misspell-fixer, running with "common typos" dict, as lintian.debian.org is using.

Actual results:

it finds tons of typos, most of them in /* comments */. (some in variables, urls,.. to be ignored)
the "raw" output is a unified diff (containing about 115k diff-lines, 6.6k files affected)
also, some of the stuff is 3rd party... a big elephant hanging around :)

I did run it in per-dir, attached you find the (per chance quite clean) "storage/" sub-dir, just for demo purpose.

Expected results:

so..
ignore ?
1 big patch ?
multiple-patches ?
... ?

I know, fixing typos in comments will not safe the world, fixing bugs .. but less-distract the people in future, make stuff better search-able.

I´m open to any of that; and yes, this is a strange bug-report :)

Comment 1

[Lina Butler [:lina]]

Thanks, klemens! We'd definitely be happy to take that patch for storage/ specifically, but other folks might have thoughts about the rest of the tree. (I think our policy is not to apply these kinds of fixes to third-party code, for instance).

I'm not sure if there's a better Bugzilla component for this, since it's not a formatter that we run in automation now...but it's close enough. 😄

Comment 2

[Mark Banner (:standard8)]

Generally I think we're moving towards codespell, though I'm not sure we have any active efforts on that at the moment, maybe Andrew or Sylvestre know.

Comment 3

[Sylvestre Ledru [:Sylvestre]]

Yeah, we have codespell already integrated.
For now, it is only enabled on documentation and locales files.

If you want to run it on source code or other directories, this can be done:
./mach lint -l codespell storage/ --fix -n

If you are interested in helping, we could fix most of the issues in tree and activate it on more directories.
The configuration file is:
https://searchfox.org/mozilla-central/source/tools/lint/codespell.yml

Comment 5

[Andrew Halberstadt [:ahal]]

Let's leave this open. Doesn't hurt to focus on specific subdirs at a time and looks like :klemens had a patch nearly ready to go.

Comment 6

[Shivam Singhal [ :championshuttler ]]

Attachment: Bug 1552317 - Fix codespell errors for image/. r?tnikkel

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/2407a61b4a61
Fix codespell errors for image/. r=tnikkel

Comment 8

[Noemi Erli[:noemi_erli]]

https://hg.mozilla.org/mozilla-central/rev/2407a61b4a61

Comment 9

[BugBot [:suhaib / :marco/ :calixte]]

The leave-open keyword is there and there is no activity for 6 months.
:ahal, maybe it's time to close this bug?

Comment 10

[Shivam Singhal [ :championshuttler ]]

I guess the issue is till valid

Comment 11

[Sylvestre Ledru [:Sylvestre]]

yeah but to make it more actionable, we should report individual bugs per components
and mark them as good first bug.

Comment 12

[Andrew Halberstadt [:ahal]]

Agreed, I vote we close this out and file new bugs for any remaining work (if we can't be bothered to file new bugs, it likely wasn't that important anyway :))