VSCode Support

To make the VSCode ESLint Extension work better with Sheriff it's recommended to checkout a few settings. It's advisable to enable them at the workspace level, meaning in the root of the project in .vscode/settings.json.

Enable linting on specific file extensions

{
  "eslint.validate": [
    "javascript",
    "javascriptreact",
    "typescript",
    "typescriptreact",
  ],
}

Astro support

For Astro projects, add the astro extension too:

{
  "eslint.validate": [
    "javascript",
    "javascriptreact",
    "typescript",
    "typescriptreact",
    "astro", 
  ],
}

eslint.config.ts support

Follow these instructions if you are using the eslint.config.ts configuration file.

With ESLint >= 9.18.0

No further action is required. You are good to go!

With ESLint < 9.18.0

Add this to your .vscode/settings.json:

"eslint.options": {
  "flags": ["unstable_ts_config"]
}

Avoid "source.organizeImports"

Sheriff already handles imports sorting, so if you happen to have enabled the VSCode automatic import sorting feature, you should disable it to avoid conflicts:

"editor.codeActionsOnSave": {
    "source.organizeImports": "never"
}

If you wish, you can automatically fix some ESLint violations on save, including sorting imports:

"editor.codeActionsOnSave": {
    "source.fixAll.eslint": "explicit"
}