💡: Better defaults for defaultExcludeGlobs

[lonix1]

Problem

Further to discussion in #8927.

For the vscode extension, default ignores have this default:

  "cSpell.ignorePaths": [
    "package-lock.json",
    "node_modules",
    "vscode-extension",
    ".git/{info,lfs,logs,refs,objects}/**",
    ".git/{index,*refs,*HEAD}",
    ".vscode",
    ".vscode-insiders"
  ],

However this is the default for the library/cli:

const defaultExcludeGlobs = ['node_modules/'];

I think most people would be surprised that .git/ (and others things) is not auto-ignored.

Solution

The default should probably be something like this:

const defaultExcludeGlobs = ['.git/', 'node_modules/'];

Maybe it should also include package-lock.json and pnpm-lock.yaml.

Is there a reason the library/cli default is so minimal?

Alternatives

In cspell.json:

"ignorePaths": [".git/", "node_modules/", "pnpm-lock.yaml"]

And, better docs here so people don't fall into this trap.

Additional Context

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[Jason3S]

@lonix1,

Thank you for contributing. What problem are you trying to solve? Do you have an example situation?

By default, .git is not scanned if you do not include the CLI option --dot.

CSpell is used by editors to check git commit messages and other related templates. This is why the VSCode extension has a more complicated ignorePaths for .git.

[lonix1]

In a precommit hook I use --dot, and in "cspell.json" I use "enableGlobDot":true. I want to scan .foo/ directories, except .git/.

As you explained, if it does not scan .git/ by default, then I suppose it's ok for most users. But consider that it's a "side effect" of the enableGlobDot rather than being ignored by ignorePaths. Which is sensible, but still surprising (there are many settings, so it's not obvious/easy).

So maybe a compromise for other users, is to simply document the default(s) for ignorePaths here?