miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 6 Packages Projects Releases Wiki Activity

feat(linter): add cacheStrategy, rulesdir and resolvePluginsRelativeTo flags to eslint executor (#9709)

Browse Source
This commit is contained in:
Leosvel Pérez Espinosa 2022-04-07 15:49:44 +01:00 committed by GitHub
parent 9562ad2bab
commit a64bba9980
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 108 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/generated/packages/linter.json
View File

@ -282,6 +282,22 @@
"hasTypeAwareRules": {
"type": "boolean",
"description": "When set to `true`, the linter will invalidate its cache when any of its dependencies changes."
},
"cacheStrategy": {
"type": "string",
"description": "Strategy to use for detecting changed files in the cache.",
"default": "metadata",
"enum": ["metadata", "content"]
},
"rulesdir": {
"type": "array",
"description": "The equivalent of the `--rulesdir` flag on the ESLint CLI.",
"default": [],
"items": { "type": "string" }
},
"resolvePluginsRelativeTo": {
"type": "string",
"description": "The equivalent of the `--resolve-plugins-relative-to` flag on the ESLint CLI."
}
},
"additionalProperties": false,

6
packages/linter/src/executors/eslint/lint.impl.spec.ts
View File

@ -45,6 +45,7 @@ function createValidRunBuilderOptions(
fix: true,
cache: true,
cacheLocation: 'cacheLocation1',
cacheStrategy: 'content',
format: 'stylish',
force: false,
silent: false,
@ -54,6 +55,8 @@ function createValidRunBuilderOptions(
noEslintrc: false,
quiet: false,
hasTypeAwareRules: false,
rulesdir: [],
resolvePluginsRelativeTo: null,
...additionalOptions,
};
}
@ -137,6 +140,7 @@ describe('Linter Builder', () => {
fix: true,
cache: true,
cacheLocation: 'cacheLocation1',
cacheStrategy: 'content',
format: 'stylish',
force: false,
silent: false,
@ -145,6 +149,8 @@ describe('Linter Builder', () => {
outputFile: null,
quiet: false,
noEslintrc: false,
rulesdir: [],
resolvePluginsRelativeTo: null,
});
});

3
packages/linter/src/executors/eslint/schema.d.ts vendored
View File

@ -15,6 +15,9 @@ export interface Schema extends JsonObject {
quiet: boolean;
ignorePath: string | null;
hasTypeAwareRules: boolean;
cacheStrategy: 'content' | 'metadata' | null;
rulesdir: string[];
resolvePluginsRelativeTo: string | null;
}
type Formatter =

18
packages/linter/src/executors/eslint/schema.json
View File

@ -94,6 +94,24 @@
"hasTypeAwareRules": {
"type": "boolean",
"description": "When set to `true`, the linter will invalidate its cache when any of its dependencies changes."
},
"cacheStrategy": {
"type": "string",
"description": "Strategy to use for detecting changed files in the cache.",
"default": "metadata",
"enum": ["metadata", "content"]
},
"rulesdir": {
"type": "array",
"description": "The equivalent of the `--rulesdir` flag on the ESLint CLI.",
"default": [],
"items": {
"type": "string"
}
},
"resolvePluginsRelativeTo": {
"type": "string",
"description": "The equivalent of the `--resolve-plugins-relative-to` flag on the ESLint CLI."
}
},
"additionalProperties": false,

62
packages/linter/src/executors/eslint/utility/eslint-utils.spec.ts
View File

@ -22,6 +22,7 @@ describe('eslint-utils', () => {
fix: true,
cache: true,
cacheLocation: '/root/cache',
cacheStrategy: 'content',
}).catch(() => {});
expect(ESLint).toHaveBeenCalledWith({
@ -29,8 +30,11 @@ describe('eslint-utils', () => {
fix: true,
cache: true,
cacheLocation: '/root/cache',
cacheStrategy: 'content',
ignorePath: undefined,
useEslintrc: true,
resolvePluginsRelativeTo: undefined,
rulePaths: [],
errorOnUnmatchedPattern: false,
});
});
@ -40,6 +44,7 @@ describe('eslint-utils', () => {
fix: true,
cache: true,
cacheLocation: '/root/cache',
cacheStrategy: 'content',
}).catch(() => {});
expect(ESLint).toHaveBeenCalledWith({
@ -47,8 +52,11 @@ describe('eslint-utils', () => {
fix: true,
cache: true,
cacheLocation: '/root/cache',
cacheStrategy: 'content',
ignorePath: undefined,
useEslintrc: true,
resolvePluginsRelativeTo: undefined,
rulePaths: [],
errorOnUnmatchedPattern: false,
});
});
@ -67,8 +75,62 @@ describe('eslint-utils', () => {
fix: true,
cache: true,
cacheLocation: '/root/cache',
cacheStrategy: undefined,
ignorePath: undefined,
useEslintrc: false,
resolvePluginsRelativeTo: undefined,
rulePaths: [],
errorOnUnmatchedPattern: false,
});
});
});
describe('rulesdir', () => {
it('should create the ESLint instance with "rulePaths" set to the given value for rulesdir', async () => {
const extraRuleDirectories = ['./some-rules', '../some-more-rules'];
await lint(undefined, {
fix: true,
cache: true,
cacheLocation: '/root/cache',
cacheStrategy: 'content',
rulesdir: extraRuleDirectories,
}).catch(() => {});
expect(ESLint).toHaveBeenCalledWith({
overrideConfigFile: undefined,
fix: true,
cache: true,
cacheLocation: '/root/cache',
cacheStrategy: 'content',
ignorePath: undefined,
useEslintrc: true,
resolvePluginsRelativeTo: undefined,
rulePaths: extraRuleDirectories,
errorOnUnmatchedPattern: false,
});
});
});
describe('resolvePluginsRelativeTo', () => {
it('should create the ESLint instance with "resolvePluginsRelativeTo" set to the given value for resolvePluginsRelativeTo', async () => {
await lint(undefined, {
fix: true,
cache: true,
cacheLocation: '/root/cache',
cacheStrategy: 'content',
resolvePluginsRelativeTo: './some-path',
}).catch(() => {});
expect(ESLint).toHaveBeenCalledWith({
overrideConfigFile: undefined,
fix: true,
cache: true,
cacheLocation: '/root/cache',
cacheStrategy: 'content',
ignorePath: undefined,
useEslintrc: true,
resolvePluginsRelativeTo: './some-path',
rulePaths: [],
errorOnUnmatchedPattern: false,
});
});

3
packages/linter/src/executors/eslint/utility/eslint-utils.ts
View File

@ -28,6 +28,9 @@ export async function lint(
fix: !!options.fix,
cache: !!options.cache,
cacheLocation: options.cacheLocation || undefined,
cacheStrategy: options.cacheStrategy || undefined,
resolvePluginsRelativeTo: options.resolvePluginsRelativeTo || undefined,
rulePaths: options.rulesdir || [],
/**
* Default is `true` and if not overridden the eslint.lintFiles() method will throw an error
* when no target files are found.