How to exclude files in cspell

[ghost]

I'm using megalinter and github actions, if it matters.

[Jason3S]

@uranuspucksaxophone,

Command Line

You can use the command line option --exclude to specify a glob. To specify multiple globs, you can use --exclude multiple times.

cspell "**" --exclude "**/*-lock.json" --exclude "*.log"

Using a Config File

The best thing to use is a CSpell configuration file at the root of your repo.

cspell.config.yaml

ignorePaths:
  - "**/*.db"

or

.cspell.json

{ "ignorePaths": ["**/*.db"] }

[Nightblade]

ignorePaths:
  - "**/.pnpm-lock.json"

Something like that should work.

[Jason3S]

// .cspell.json

"ignorePaths": [
    "**/vite.config.ts",
]

eslint "@cspell/spellchecker" is not ignoring this file "vite.config.ts", what am I missing?

• Most likely cause:
  The ESLint @cspell/spellchecker will check all files that ESLint sends to it. Adjust the ESLint configuration to filter out that file.
• Syntax error in JSON file.
  JSON does not like , ] as in:

    "**/vite.config.ts",
  ]

The logic behind having ES Lint control which files are checked:

1. There needs to be a way to filter out files checked by ES Lint vs CSpell. The ES Lint spell checker plugin and CSpell give different answers due to how the files are parsed. If both linters are used on the same file, they might produce different answers. ignorePaths is a way to tell CSpell not to check the file when ES Lint is in control.

[Jason3S]

@marcoSven,

Please try adjusting your ESLint configuration to have it not spell check vite.config.ts.

[marcoSven]

// .eslintrc.js

  extends: [
    "plugin:@cspell/recommended",
  ],
  plugins: [
    "@cspell",
  ],
  rules: {
    "@cspell/spellchecker": ["warn"],

// .cspell.json

"ignorePaths": [
    "**/vite.config.ts"
  ],

Adjust the ESLint configuration to filter out that file.
Please try adjusting your ESLint configuration to have it not spell check vite.config.ts.

Are you suggesting disabling it like this below

// .eslintrc.js

overrides: [
    {
      files: ["vite.config.ts"],
      rules: {
        "@cspell/spellchecker": ["off"],
      },
    },
  ],

That would work, but I guess I still don't understand why the "ignorePaths" configuration in ".cspell.json" is ignored.

[marcoSven]

I guess I get it now https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-eslint-plugin#in-combination-with-cspell

[Jason3S]

Are you suggesting disabling it like this below

// .eslintrc.js

overrides: [
    {
      files: ["vite.config.ts"],
      rules: {
        "@cspell/spellchecker": ["off"],
      },
    },
  ],

Yes, exactly.

That would work, but I guess I still don't understand why the "ignorePaths" configuration in ".cspell.json" is ignored.

I guess I get it now in-combination-with-cspell

Without ignorePaths being independent, it wouldn't be possible to prevent the VS Code Spell Checker and the ESLint plug-in from giving duplicate errors.