mirror of
https://github.com/pezkuwichain/pezkuwi-dev.git
synced 2026-10-22 19:56:18 +00:00
pezkuwi-dev-migrate-eslint10: rename rule keys in eslint.config.* too
A repository's own eslint config turns rules on and off by name, and a
renamed rule there is the same trap as in a disable comment: measured on
pezkuwi-extension, 'import/extensions': 'off' and, for specs,
'deprecation/deprecation': 'off' silently stopped applying, which surfaced
17 import-x/extensions and 57 deprecation findings the repository had
deliberately turned off.
The tool now renames rule keys (quoted or not) in eslint.config.{js,mjs,cjs,
ts,mts,cts}; other keys are left alone. A rule that became several
(@typescript-eslint/ban-types) needs its value repeated for each, so it is
reported for a hand edit and the tool exits 1.
This commit is contained in:
1 parent
5f2729fe34
commit
998a11291d
2 files changed
+95
-10
No files matched your search
@@ -38,14 +38,40 @@ const header = '/* eslint-disable @stylistic/quotes */';
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
`;
|
||||
|
||||
function inRepo (content: string, args: string[] = []): { out: string; code: number; file: string } {
|
||||
const CONFIG_BEFORE = `export default [
|
||||
{
|
||||
files: ['**/*.ts'],
|
||||
rules: {
|
||||
'deprecation/deprecation': 'off',
|
||||
"import/extensions": 'off',
|
||||
indent: 'off',
|
||||
'no-console': 'error'
|
||||
}
|
||||
}
|
||||
];
|
||||
`;
|
||||
|
||||
const CONFIG_AFTER = `export default [
|
||||
{
|
||||
files: ['**/*.ts'],
|
||||
rules: {
|
||||
'@typescript-eslint/no-deprecated': 'off',
|
||||
'import-x/extensions': 'off',
|
||||
'@stylistic/indent': 'off',
|
||||
'no-console': 'error'
|
||||
}
|
||||
}
|
||||
];
|
||||
`;
|
||||
|
||||
function inRepo (content: string, args: string[] = [], name = 'sample.ts'): { out: string; code: number; file: string } {
|
||||
const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'migrate-eslint10-'));
|
||||
const file = path.join(dir, 'sample.ts');
|
||||
const file = path.join(dir, name);
|
||||
|
||||
try {
|
||||
fs.writeFileSync(file, content);
|
||||
execFileSync('git', ['init', '-q'], { cwd: dir });
|
||||
execFileSync('git', ['add', 'sample.ts'], { cwd: dir });
|
||||
execFileSync('git', ['add', name], { cwd: dir });
|
||||
|
||||
let code = 0;
|
||||
let out = '';
|
||||
@@ -68,14 +94,31 @@ describe('pezkuwi-dev-migrate-eslint10', (): void => {
|
||||
const { file, out } = inRepo(BEFORE);
|
||||
|
||||
expect(file).toEqual(AFTER);
|
||||
expect(out.includes('rewrote 8 directive(s) in 1 file(s)')).toEqual(true);
|
||||
expect(out.includes('rewrote 8 directive(s) and 0 config key(s) in 1 file(s)')).toEqual(true);
|
||||
});
|
||||
|
||||
it('leaves current rule names and bare disables alone', (): void => {
|
||||
const { file, out } = inRepo(AFTER);
|
||||
|
||||
expect(file).toEqual(AFTER);
|
||||
expect(out.includes('rewrote 0 directive(s) in 0 file(s)')).toEqual(true);
|
||||
expect(out.includes('rewrote 0 directive(s) and 0 config key(s) in 0 file(s)')).toEqual(true);
|
||||
});
|
||||
|
||||
it('renames rule keys in eslint.config.*, and only rule keys', (): void => {
|
||||
const { code, file, out } = inRepo(CONFIG_BEFORE, [], 'eslint.config.js');
|
||||
|
||||
expect(file).toEqual(CONFIG_AFTER);
|
||||
expect(code).toEqual(0);
|
||||
expect(out.includes('rewrote 0 directive(s) and 3 config key(s) in 1 file(s)')).toEqual(true);
|
||||
});
|
||||
|
||||
it('leaves a rule that became several to a hand edit, and exits 1', (): void => {
|
||||
const config = "export default [{ rules: { '@typescript-eslint/ban-types': 'off' } }];\n";
|
||||
const { code, file, out } = inRepo(config, [], 'eslint.config.mjs');
|
||||
|
||||
expect(file).toEqual(config);
|
||||
expect(code).toEqual(1);
|
||||
expect(out.includes("by hand: eslint.config.mjs: '@typescript-eslint/ban-types' is now")).toEqual(true);
|
||||
});
|
||||
|
||||
it('--check reports and changes nothing, exiting 1 when there is work', (): void => {
|
||||
|
||||
Reference in new issue
Block a user