Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(linter): disabled eslint rules dont count as type checked rules #6897

Merged
merged 1 commit into from Aug 31, 2021
Merged

fix(linter): disabled eslint rules dont count as type checked rules #6897

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions packages/linter/migrations.json
View file
Open in desktop
Expand Up @@ -52,6 +52,12 @@
"version": "12.9.0-beta.0",
"description": "Add outputs for caching",
"factory": "./src/migrations/update-12-9-0/add-outputs"
},
"remove-eslint-project-config-if-no-type-checking-rules-again": {
"cli": "nx",
"version": "12.9.0-beta.0",
"description": "Remove ESLint parserOptions.project config if no rules requiring type-checking are in use",
"factory": "./src/migrations/update-12-4-0/remove-eslint-project-config-if-no-type-checking-rules"
}
},
"packageJsonUpdates": {
Expand Down
51 changes: 48 additions & 3 deletions ...c/migrations/update-12-4-0/remove-eslint-project-config-if-no-type-checking-rules.spec.ts
View file
Open in desktop
Expand Up @@ -6,7 +6,7 @@ import {
} from '@nrwl/devkit';
import { createTreeWithEmptyWorkspace } from '@nrwl/devkit/testing';
import removeESLintProjectConfigIfNoTypeCheckingRules from './remove-eslint-project-config-if-no-type-checking-rules';

import type { Linter } from 'eslint';
const KNOWN_RULE_REQUIRING_TYPE_CHECKING = '@typescript-eslint/await-thenable';

describe('Remove ESLint parserOptions.project config if no rules requiring type-checking are in use', () => {
Expand All @@ -31,6 +31,12 @@ describe('Remove ESLint parserOptions.project config if no rules requiring type-
projectType: 'library',
targets: {},
});
addProjectConfiguration(tree, 'another-lib', {
root: 'libs/another-lib',
sourceRoot: 'libs/another-lib/src',
projectType: 'library',
targets: {},
});
});

it('should not update any configs if the root .eslintrc.json contains at least one rule requiring type-checking', async () => {
Expand Down Expand Up @@ -123,7 +129,7 @@ describe('Remove ESLint parserOptions.project config if no rules requiring type-
};
writeJson(tree, '.eslintrc.json', rootEslintConfig);

const projectEslintConfig1 = {
const projectEslintConfig1: Linter.Config = {
extends: '../../../.eslintrc.json',
ignorePatterns: ['!**/*'],
overrides: [
Expand All @@ -140,7 +146,7 @@ describe('Remove ESLint parserOptions.project config if no rules requiring type-
};
writeJson(tree, 'apps/react-app/.eslintrc.json', projectEslintConfig1);

const projectEslintConfig2 = {
const projectEslintConfig2: Linter.Config = {
extends: '../../../.eslintrc.json',
ignorePatterns: ['!**/*'],
overrides: [
Expand All @@ -157,6 +163,23 @@ describe('Remove ESLint parserOptions.project config if no rules requiring type-
};
writeJson(tree, 'libs/workspace-lib/.eslintrc.json', projectEslintConfig2);

const projectEslintConfig3: Linter.Config = {
extends: '../../../.eslintrc.json',
ignorePatterns: ['!**/*'],
overrides: [
{
files: ['*.ts', '*.tsx'],
parserOptions: {
project: 'some-path-to-tsconfig.json',
},
rules: {
[KNOWN_RULE_REQUIRING_TYPE_CHECKING]: 'off',
},
},
],
};
writeJson(tree, 'libs/another-lib/.eslintrc.json', projectEslintConfig3);

await removeESLintProjectConfigIfNoTypeCheckingRules(tree);

// No change - uses rule requiring type-checking
Expand All @@ -183,6 +206,28 @@ describe('Remove ESLint parserOptions.project config if no rules requiring type-
],
}
`);

// Updated - no more parserOptions.project
expect(readJson(tree, 'libs/another-lib/.eslintrc.json'))
.toMatchInlineSnapshot(`
Object {
"extends": "../../../.eslintrc.json",
"ignorePatterns": Array [
"!**/*",
],
"overrides": Array [
Object {
"files": Array [
"*.ts",
"*.tsx",
],
"rules": Object {
"@typescript-eslint/await-thenable": "off",
},
},
],
}
`);
});

it('should not error if .eslintrc.json does not exist', async () => {
Expand Down
12 changes: 10 additions & 2 deletions packages/linter/src/utils/rules-requiring-type-checking.ts
View file
Open in desktop
Expand Up @@ -53,12 +53,20 @@ export function removeParserOptionsProjectIfNotRequired(
return json;
}

function determineEnabledRules(rules: Linter.RulesRecord): string[] {
return Object.entries(rules)
.filter(([key, value]) => {
return !(typeof value === 'string' && value === 'off');
})
.map(([ruleName]) => ruleName);
}

function getAllRulesInConfig(json: Linter.Config): string[] {
let allRules = json.rules ? Object.keys(json.rules) : [];
let allRules = json.rules ? determineEnabledRules(json.rules) : [];
if (json.overrides?.length > 0) {
for (const o of json.overrides) {
if (o.rules) {
allRules = [...allRules, ...Object.keys(o.rules)];
allRules = allRules = [...allRules, ...determineEnabledRules(o.rules)];
}
}
}
Expand Down