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

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

Merged
merged 1 commit into from Apr 7, 2022
Merged

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

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
16 changes: 16 additions & 0 deletions docs/generated/packages/linter.json
View file
Open in desktop
Expand Up @@ -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,
Expand Down
6 changes: 6 additions & 0 deletions packages/linter/src/executors/eslint/lint.impl.spec.ts
View file
Open in desktop
Expand Up @@ -45,6 +45,7 @@ function createValidRunBuilderOptions(
fix: true,
cache: true,
cacheLocation: 'cacheLocation1',
cacheStrategy: 'content',
format: 'stylish',
force: false,
silent: false,
Expand All @@ -54,6 +55,8 @@ function createValidRunBuilderOptions(
noEslintrc: false,
quiet: false,
hasTypeAwareRules: false,
rulesdir: [],
resolvePluginsRelativeTo: null,
...additionalOptions,
};
}
Expand Down Expand Up @@ -137,6 +140,7 @@ describe('Linter Builder', () => {
fix: true,
cache: true,
cacheLocation: 'cacheLocation1',
cacheStrategy: 'content',
format: 'stylish',
force: false,
silent: false,
Expand All @@ -145,6 +149,8 @@ describe('Linter Builder', () => {
outputFile: null,
quiet: false,
noEslintrc: false,
rulesdir: [],
resolvePluginsRelativeTo: null,
});
});

Expand Down
3 changes: 3 additions & 0 deletions packages/linter/src/executors/eslint/schema.d.ts
View file
Open in desktop
Expand Up @@ -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 =
Expand Down
18 changes: 18 additions & 0 deletions packages/linter/src/executors/eslint/schema.json
View file
Open in desktop
Expand Up @@ -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,
Expand Down
62 changes: 62 additions & 0 deletions packages/linter/src/executors/eslint/utility/eslint-utils.spec.ts
View file
Open in desktop
Expand Up @@ -22,15 +22,19 @@ describe('eslint-utils', () => {
fix: true,
cache: true,
cacheLocation: '/root/cache',
cacheStrategy: 'content',
}).catch(() => {});

expect(ESLint).toHaveBeenCalledWith({
overrideConfigFile: './.eslintrc.json',
fix: true,
cache: true,
cacheLocation: '/root/cache',
cacheStrategy: 'content',
ignorePath: undefined,
useEslintrc: true,
resolvePluginsRelativeTo: undefined,
rulePaths: [],
errorOnUnmatchedPattern: false,
});
});
Expand All @@ -40,15 +44,19 @@ describe('eslint-utils', () => {
fix: true,
cache: true,
cacheLocation: '/root/cache',
cacheStrategy: 'content',
}).catch(() => {});

expect(ESLint).toHaveBeenCalledWith({
overrideConfigFile: undefined,
fix: true,
cache: true,
cacheLocation: '/root/cache',
cacheStrategy: 'content',
ignorePath: undefined,
useEslintrc: true,
resolvePluginsRelativeTo: undefined,
rulePaths: [],
errorOnUnmatchedPattern: false,
});
});
Expand All @@ -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,
});
});
Expand Down
3 changes: 3 additions & 0 deletions packages/linter/src/executors/eslint/utility/eslint-utils.ts
View file
Open in desktop
Expand Up @@ -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.
Expand Down