🐛 npx rome format prints lots of Unknown lint rule _______ in suppression comment

[lgarron]

Environment information

macOS 12.6
Rome CLI v0.10.1-next

What happened?

Repro steps:

shell
git clone https://github.com/cubing/cubing.js
cd cubing.js
git checkout 4b8891790c651de031d8a35dd7687f59db5e84e2
npm install
npx rome format --write ./script ./src

Output (truncated):

./src/sites/experiments.cubing.net/cubing.js/speechcubing/index.ts:39:5 suppressions/unknownRule ━━━

  ⚠ Unknown lint rule correctness/useTemplate in suppression comment

    37 │   const latestResult = event.results.item(event.results.length - 1);
    38 │   alternativeListElem.textContent =
  > 39 │     // rome-ignore lint(correctness/useTemplate): Using a template would make this more confusing.
       │     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    40 │     "Raw alternatives: " +
    41 │     Array.from(latestResult)


./src/cubing/search/instantiator.ts:17:3 suppressions/unknownRule ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Unknown lint rule correctness/noAsyncPromiseExecutor in suppression comment

    16 │ export async function instantiateModuleWorker(): Promise<WorkerInsideAPI> {
  > 17 │   // rome-ignore lint(correctness/noAsyncPromiseExecutor): TODO
       │   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    18 │   return new Promise<WorkerInsideAPI>(async (resolve, reject) => {
    19 │     const timeoutID = setTimeout(() => {


./src/cubing/alg/parseAlg.ts:140:9 suppressions/unknownRule ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Unknown lint rule correctness/noUnnecessaryContinue in suppression comment

    138 │           algStartIdx = this.#idx;
    139 │         }
  > 140 │         // rome-ignore lint(correctness/noUnnecessaryContinue): This line allows for more robust refactoring.
        │         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    141 │         continue mainLoop;
    142 │       } else if (MOVE_START_REGEX.test(this.#input[this.#idx])) {


./src/cubing/alg/parseAlg.ts:149:9 suppressions/unknownRule ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Unknown lint rule correctness/noUnnecessaryContinue in suppression comment

    147 │         algEndIdx = this.#idx;
    148 │
  > 149 │         // rome-ignore lint(correctness/noUnnecessaryContinue): This line allows for more robust refactoring.
        │         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    150 │         continue mainLoop;
    151 │       } else if (this.tryConsumeNext("(")) {


./src/cubing/alg/parseAlg.ts:179:11 suppressions/unknownRule ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Unknown lint rule correctness/noUnnecessaryContinue in suppression comment

    177 │           algEndIdx = this.#idx;
    178 │
  > 179 │           // rome-ignore lint(correctness/noUnnecessaryContinue): This line allows for more robust refactoring.
        │           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    180 │           continue mainLoop;
    181 │         } else {


./src/cubing/alg/parseAlg.ts:195:11 suppressions/unknownRule ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Unknown lint rule correctness/noUnnecessaryContinue in suppression comment

    193 │           algEndIdx = this.#idx;
    194 │
  > 195 │           // rome-ignore lint(correctness/noUnnecessaryContinue): This line allows for more robust refactoring.
        │           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    196 │           continue mainLoop;
    197 │         }


./src/cubing/alg/parseAlg.ts:231:13 suppressions/unknownRule ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Unknown lint rule correctness/noUnnecessaryContinue in suppression comment

    229 │             algEndIdx = this.#idx;
    230 │
  > 231 │             // rome-ignore lint(correctness/noUnnecessaryContinue): This line allows for more robust refactoring.
        │             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    232 │             continue mainLoop;
    233 │           }

Expected result

No warnings about suppressed errors.

The VSCode extension seems to recognize these // rome-ignore comments as valid syntax, I'm not sure why the CLI doesn't.

Code of Conduct

• I agree to follow Rome's Code of Conduct

[ematipico]

I can reproduce the issue, even in our repository. @leops any idea what's the issue?

[leops]

This is because the suppression comment parser is checking for the existence of the rule in the "dynamic registry" that's built for every call into the analyzer and only contains the rules enabled for this analysis pass. The formatter doesn't run the full analyzer, it only needs the syntax rules so the registry instance used for formatting doesn't contain any of the lint rules.
I think the fix would be to explicitly split off a "static registry" that would only contains the rule metadata for all the rules and would be used to check the suppressions or run lintdoc, and a "dynamic registry" that would be used to actually execute the rules but only contains the enabled rules. The downside I see to this is that we would lose the "unknown rule" diagnostic when the rule does exist but is disabled in the configuration, it would need to be reintroduced through some additional logic but that would be a good opportunity to improve the messaging for that diagnostic to better state that the rule is known, but the suppression comment is not doing anything because the rule is disabled for the whole project