1736559 - Codespell incorrectly changes package.json

Status: RESOLVED FIXED

(Developer Infrastructure :: Lint and Formatting, task, P2)

Description

[Mark Banner (:standard8)]

I just caught this on a patch that someone had posted.

Running ./mach lint -l codespell --fix causes a change to tools/lint/eslint/eslint-plugin-mozilla/package-lock.json as per below. These files should never be automatically changed by linters.

diff --git a/tools/lint/eslint/eslint-plugin-mozilla/package-lock.json b/tools/lint/eslint/eslint-plugin-mozilla/package-lock.json
index 36be00fdd1967..2d8bc6aeaf069 100644
--- a/tools/lint/eslint/eslint-plugin-mozilla/package-lock.json
+++ b/tools/lint/eslint/eslint-plugin-mozilla/package-lock.json
@@ -1499,7 +1499,7 @@
     "require-from-string": {
       "version": "2.0.2",
       "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz",
-      "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==",
+      "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/view==",
       "dev": true
     },
     "resolve-from": {

Comment 1

[Mark Banner (:standard8)]

I can't figure out how to stop this happening, I've added various variants of package-lock.json (with ** and with full paths) to the exclude list in tools/lint/codespell.yml and it doesn't prevent the change.

Any ideas Andrew?

Comment 2

[Andrew Halberstadt [:ahal] (PTO Until Apr 3rd)]

Adding "**/package-lock.json" seems to do it for me. Note it needs to be in quotes though since * is a special character in yaml.

Comment 3

[Andrew Halberstadt [:ahal] (PTO Until Apr 3rd)]

Attachment: Bug 1736559 - [lint] Fix codespell silently fixing files, r?#linter-reviewers

We have a check in the 'CodespellProcess' class to ignore errors that are
fixing single letter camelCase errors (since these tend to be used frequently.

Unfortunately, when using '--fix', these errors are fixed regardless as the
fixing happens with the codespell process. Since we increment the 'fix'
variable after the check happens, we don't even report that anything was
'fixed'.

Ideally we would find a way to prevent these types of errors from being fixed,
but for now this at will at least ensure that the user is notified that
something was modified.

Comment 4

[Andrew Halberstadt [:ahal] (PTO Until Apr 3rd)]

Attachment: Bug 1736559 - [lint] Ignore all 'package-lock.json' files in codespell linter, r?#linter-reviewers

Depends on D128885

Comment 5

[Andrew Halberstadt [:ahal] (PTO Until Apr 3rd)]

Note there's still a bug in the codespell linter though. Basically this check is useless with --fix:
https://searchfox.org/mozilla-central/rev/36aa22c7ea92bd3cf7910774004fff7e63341cf5/tools/lint/spell/__init__.py#58

This check prevents the aforementioned package-lock.json issue from being reported without --fix.

Comment 6

[Mark Banner (:standard8)]

(In reply to Andrew Halberstadt [:ahal] from comment #2)

Adding "**/package-lock.json" seems to do it for me. Note it needs to be in quotes though since * is a special character in yaml.

Hmm, I wonder if I maybe changed the file in the wrong repo... oops.

(In reply to Andrew Halberstadt [:ahal] from comment #5)

Note there's still a bug in the codespell linter though. Basically this check is useless with --fix:
https://searchfox.org/mozilla-central/rev/36aa22c7ea92bd3cf7910774004fff7e63341cf5/tools/lint/spell/__init__.py#58

This check prevents the aforementioned package-lock.json issue from being reported without --fix.

We could use bug 1736560 to fix that maybe.

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/f42752e51c9c
[lint] Fix codespell silently fixing files, r=linter-reviewers,sylvestre
https://hg.mozilla.org/integration/autoland/rev/bd985949aa5c
[lint] Ignore all 'package-lock.json' files in codespell linter, r=linter-reviewers,sylvestre

Comment 8

[Atila Butkovits]

https://hg.mozilla.org/mozilla-central/rev/f42752e51c9c
https://hg.mozilla.org/mozilla-central/rev/bd985949aa5c