k1nq/TREK
1
0
Fork 0
mirror of https://github.com/mauriceboe/TREK.git synced 2026-10-19 05:26:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci(client): lint:warnings fails an inline rule config comment

Browse Source 
A block comment such as /* eslint @typescript-eslint/no-explicit-any: off */
turns a rule off for its file without leaving a message behind, neither
among the warnings nor among the suppressed ones, so a new file could
switch any warning rule off and the ratchet stayed green. eslint-disable
comments were already counted under "suppressed"; this was the way
around them.

lintClient now reads the block comments of every file ESLint linted from
the TypeScript parser, so the same text in a string, a template or a
regex does not count, and the tally reports each config comment as an
error. Nothing in the client uses one today, so the check is zero
tolerance. The tests baseline drops by one no-unused-vars warning that
is gone.
This commit is contained in:
Maurice
2026-10-08 12:57:12 +02:00
parent 9d596d9916
commit 1b60de27f4
5 changed files with 111 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
client/tests/unit/scripts/eslint-ratchet.test.ts
+45 -1
View File
@@ -1,7 +1,7 @@
import { readFileSync } from 'node:fs';
import { join } from 'node:path';
import { afterEach, describe, expect, it } from 'vitest';
import { areaCounts, check, tally } from '../../../scripts/lib/eslint-warnings.mjs';
import { areaCounts, check, inlineConfigsOf, lintClient, tally } from '../../../scripts/lib/eslint-warnings.mjs';
import { RatchetError } from '../../../scripts/lib/ratchet.mjs';
import { ratchetTree, type RatchetTree } from '../../helpers/ratchetFixture';
@@ -128,4 +128,48 @@ describe('lint:warnings', () => {
expect(areaCounts({ ...empty, src: { a: -1 } })).toMatch(/in "src"/);
await expect(run({ src: {} }, () => [])).rejects.toThrow(RatchetError);
});
it('ESLINT-009: finds the block comments that configure a rule, and nothing in strings, templates or regexes', () => {
const source = [
'/* eslint @typescript-eslint/no-explicit-any: off */',
'const a = "/* eslint no-empty: off */";',
'const b = `${a} /* eslint no-empty: off */`;',
'/* eslint-disable no-empty */',
'/*eslint no-empty:0*/ const c = <div>{/* eslint no-empty: 1 */}</div>;',
'const r = /\\/\\* eslint no-empty/;',
'// eslint no-empty: off',
'/** eslint is the linter */',
].join('\n');
expect(inlineConfigsOf(source, 'src/a.tsx')).toEqual([
'1:1 /* eslint @typescript-eslint/no-explicit-any: off */',
'5:1 /*eslint no-empty:0*/',
'5:39 /* eslint no-empty: 1 */',
]);
expect(inlineConfigsOf('export const a = 1 /* eslint no-empty: off */\n', 'src/a.ts')).toHaveLength(1);
expect(inlineConfigsOf('export const a = 1\n', 'src/a.ts')).toEqual([]);
});
it('ESLINT-010: an inline rule config fails the check although it leaves no message behind', async () => {
const code = await run(empty, (root) => [
{ ...result(root, 'src/a.ts', []), inlineConfigs: ['1:1 /* eslint no-empty: off */'] },
]);
expect(code).toBe(1);
expect(tree.error.join('\n')).toMatch(
/src\/a\.ts:1:1 {2}\/\* eslint no-empty: off \*\/ {2}configures a rule inline/
);
});
it('ESLINT-011: lintClient reads the inline rule configs of every file it lints', async () => {
tree = ratchetTree({
'eslint.config.mjs': "export default [{ files: ['**/*.js'], rules: { 'no-empty': 'warn' } }];\n",
'src/a.js': '/* eslint no-empty: off */\nif (globalThis.x) {}\n',
'src/b.js': 'if (globalThis.x) {}\n',
});
const results = await lintClient(tree.root);
const byKey = Object.fromEntries(results.map((r) => [r.filePath.split('\\').join('/').split('/src/')[1], r]));
expect(byKey['a.js'].messages).toEqual([]);
expect(byKey['a.js'].inlineConfigs).toEqual(['1:1 /* eslint no-empty: off */']);
expect(byKey['b.js'].messages.map((m) => m.ruleId)).toEqual(['no-empty']);
expect(byKey['b.js'].inlineConfigs).toEqual([]);
});
});