1433912 - Create lint tasks for the 'codespell' linter

Status: RESOLVED FIXED

(Developer Infrastructure :: Lint and Formatting, enhancement)

Description

[Andrew Halberstadt [:ahal]]

We recently added two new linters, but don't have tasks for them yet. This is bad because it means someone could inadvertently add lint bustage to the tree if they don't have the hook installed/don't use mozreview, then other people will see that bustage on their patches.

This is my fault, I should have made it a requirement when doing the reviews.

To prevent this from happening in the future, I think we should create a 'misc' lint task that runs all linters that don't otherwise have an explicit task defined for them (or I could just be better at the reviews).

Comment 1

[Simon Fraser [:sfraser] ⌚️GMT]

Bug 1432627 is now updated for a shellcheck CI job, thank you for the reminder.

Comment 2

[Andrew Halberstadt [:ahal]]

Also, I didn't notice that the codespell linter doesn't actually pass everywhere it runs (I should have tested locally). This makes it a high priority to get fixed ASAP, otherwise people who modify those files will see unrelated lint errors.

For now I propose we just run codespell on python/mozlint and tools/lint. We can take the time to enable it in more places once this is fixed.

Comment 3

[Andrew Halberstadt [:ahal]]

(In reply to Simon Fraser [:sfraser] ⌚️GMT from comment #1)
> Bug 1432627 is now updated for a shellcheck CI job, thank you for the
> reminder.

Ah, thanks for the patch! I'll just make this bug about fixing codespell then.

Comment 4

[Simon Fraser [:sfraser] ⌚️GMT]

I still like the idea of a 'misc' lint task that acts as a catch-all. I wonder if, without explicit directories to examine, the linter could warn rather than fail a check-in with that scenario? Or is that too risky?

Comment 5

[Andrew Halberstadt [:ahal]]

Attachment: Bug 1433912 - [lint] Only run codespell linter on python/mozlint and tools/lint for now,

This is a bustage fix that needs to get out quickly. Once landed we can take
the time to enable it on more directories, or preferably change it to a
blacklist.

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

Comment 6

[Andrew Halberstadt [:ahal]]

Attachment: Bug 1433912 - [lint] Create a task for the codespell linter,

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

Comment 7

[Sylvestre Ledru [:Sylvestre]]

Comment on attachment 8946263 [details]
Bug 1433912 - [lint] Only run codespell linter on python/mozlint and tools/lint for now,

https://reviewboard.mozilla.org/r/216216/#review222028

Less typos \o/

Comment 8

[Sylvestre Ledru [:Sylvestre]]

Comment on attachment 8946264 [details]
Bug 1433912 - [lint] Create a task for the codespell linter,

https://reviewboard.mozilla.org/r/216218/#review222030

::: taskcluster/ci/source-test/mozlint.yml:26
(Diff revision 1)
> +    treeherder:
> +        symbol: spell
> +    run:
> +        mach: lint -l codespell -f treeherder
> +    when:
> +        files-changed:

I guess we don't have any other choice than duplication here?

Comment 9

[Andrew Halberstadt [:ahal]]

Comment on attachment 8946264 [details]
Bug 1433912 - [lint] Create a task for the codespell linter,

https://reviewboard.mozilla.org/r/216218/#review222030

> I guess we don't have any other choice than duplication here?

I'll file a follow-up to get rid of this duplication. Though, I think we're going to be moving away from the 'when.files-changed' optimization in Taskcluster, so it might fix itself.

But yeah, there's no "easy fix" at the moment, and I want to get this landed before developers start complaining about lint failures :).

Comment 10

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/399becfe083a
[lint] Only run codespell linter on python/mozlint and tools/lint for now, r=sylvestre
https://hg.mozilla.org/integration/autoland/rev/df92ffbb0d01
[lint] Create a task for the codespell linter, r=sylvestre

Comment 11

[Andrew Halberstadt [:ahal]]

Here's a try run:
https://treeherder.mozilla.org/#/jobs?repo=try&revision=76e18174a4fcb412a6e7063449dc650b5ed1fedd

I'll also file a follow-up to re-enable this linter on more directories. As of this patch, it'll only be running on tools/lint and python/mozlint.

Comment 12

[Raul Gurzau (:RaulG)]

https://hg.mozilla.org/mozilla-central/rev/399becfe083a
https://hg.mozilla.org/mozilla-central/rev/df92ffbb0d01