Add ESLint cache support via new settings#2120
Open
mako-taco wants to merge 2 commits into
Open
Conversation
Introduce three new settings — `eslint.cache`, `eslint.cacheLocation`, and `eslint.cacheStrategy` — that enable ESLint's built-in result caching when linting on save. When cache is active the server uses `lintFiles` (disk read) instead of `lintText` (in-memory) so the `.eslintcache` file is consulted and updated, which also benefits command-line ESLint and pre-commit hooks. Changes across the four touchpoints required by AGENTS.md: - package.json: setting schemas under contributes.configuration - $shared/settings.ts: ConfigurationSettings type - client/src/client.ts: readConfiguration() mapping - server/src/eslint.ts: option wiring and validate() integration Also includes targeted refactors for the new code: - Extract `applyCacheOptions()` helper from `withClass()` - Extract `shouldUseLintFiles()` type-guard from `validate()` - Narrow `ESLintClassOptions.cacheStrategy` to `'metadata' | 'content'` - Add JSDoc to all new public/shared cache properties Co-authored-by: Cursor <cursoragent@cursor.com>
Author
|
@microsoft-github-policy-service agree |
Author
|
Need anything else from me, here? |
|
As a workaround, right now you can use options. Sometimes it drastically improves the performance: ...
"eslint.options": {
"cache": true
},
...Not sure about |
dbaeumer
requested changes
May 18, 2026
Member
dbaeumer
left a comment
dbaeumer
left a comment
There was a problem hiding this comment.
The renames of the settings makes it consistent how VS Code and the extension deals with settings.
| "default": {}, | ||
| "markdownDescription": "The eslint options object to provide args normally passed to eslint when executed from a command line (see https://eslint.org/docs/developer-guide/nodejs-api#eslint-class)." | ||
| }, | ||
| "eslint.cache": { |
Member
There was a problem hiding this comment.
I would name this eslint.cache.enable
| "default": false, | ||
| "markdownDescription": "Enables ESLint's cache when linting on save (`eslint.run` must be `onSave`). The cache file (`.eslintcache`) can be reused by command-line ESLint and pre-commit hooks, improving their performance." | ||
| }, | ||
| "eslint.cacheLocation": { |
| "type": "string", | ||
| "markdownDescription": "Path to the ESLint cache file. If not specified, defaults to `.eslintcache` in the working directory. Only used when `eslint.cache` is enabled." | ||
| }, | ||
| "eslint.cacheStrategy": { |
Member
There was a problem hiding this comment.
and this on eslint.cache.strategy
| "metadata", | ||
| "content" | ||
| ], | ||
| "markdownDescription": "Strategy for the ESLint cache to detect changed files. `metadata` uses file metadata (faster) while `content` uses file content (for environments where metadata is unreliable). Only used when `eslint.cache` is enabled." |
Member
There was a problem hiding this comment.
Can we add a sentence about the default value
Member
|
@mako-taco thanks a lot for the PR. Nice work |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #1844
Introduce three new settings —
eslint.cache,eslint.cacheLocation, andeslint.cacheStrategy— that enable ESLint's built-in result caching when linting on save. When cache is active the server useslintFiles(disk read) instead oflintText(in-memory) so the.eslintcachefile is consulted and updated, which also benefits command-line ESLint and pre-commit hooks.