1455086 - codespell: add an exclude list

Status: RESOLVED FIXED

(Developer Infrastructure :: Lint and Formatting, enhancement)

Description

[Sylvestre Ledru [:Sylvestre]]

We have some Mozilla specific words. I propose that we add an exclude list.

Comment 1

[Sylvestre Ledru [:Sylvestre]]

Attachment: Bug 1455086 - codespell: add an exclude list

Review commit: https://reviewboard.mozilla.org/r/237714/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/237714/

Comment 2

[Andrew Halberstadt [:ahal]]

Comment on attachment 8969028 [details]
Bug 1455086 - codespell: add an exclude list

https://reviewboard.mozilla.org/r/237714/#review243674

Thanks, lgtm!

::: tools/lint/spell/__init__.py:101
(Diff revision 1)
> +    path_to_exclude_list = os.path.join(
> +        config['root'], "tools", "lint", "spell", "exclude-list.txt")

This is fine, so feel to ignore. But it might be better to find the path relative to this one (so we can move directories around easier).

At the top of the file:

    here = os.path.abspath(os.path.dirname(__file__))
    
Then:

    exclude_list = os.path.join(here, 'exclude-list-txt')

::: tools/lint/spell/__init__.py:112
(Diff revision 1)
>                  # 2: disable warnings about binary file
>                  # 4: shut down warnings about automatic fixes
>                  #    that were disabled in dictionary.
>                  '--quiet-level=4',
> +                '--ignore-words=' + path_to_exclude_list,
> +                '--skip=exclude-list.txt',

Shouldn't this also use the `path_to_exclude_list` variable?

Comment 3

[Sylvestre Ledru [:Sylvestre]]

Comment on attachment 8969028 [details]
Bug 1455086 - codespell: add an exclude list

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/237714/diff/1-2/

Comment 4

[Sylvestre Ledru [:Sylvestre]]

Comment on attachment 8969028 [details]
Bug 1455086 - codespell: add an exclude list

https://reviewboard.mozilla.org/r/237714/#review243674

> Shouldn't this also use the `path_to_exclude_list` variable?

codespell can handle just the filename:
Example:
./mach lint -l codespell -n tools/lint/spell/exclude-list.txt

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/e73fe9c25c94
codespell: add an exclude list r=ahal

Comment 6

[Raul Gurzau (:RaulG)]

https://hg.mozilla.org/mozilla-central/rev/e73fe9c25c94