Update docs to show the list of supported config files.

[jayvdb]

https://github.com/streetsidesoftware/vscode-spell-checker/blob/main/design-docs/wip/configuration.md supports

These include cspell.json, cspell.config.yaml, and cspell.config.js. When spell checking files, the spell checker searches the directory hierarchy looking for configuration files. ...

The docs for this CLI says it only supports cspell.json as default.

[Jason3S]

@jayvdb,

The cli supports a wide range a configuration locations. See: configLocations.ts#L11-L52

The challenge is to keep the documentation up to date.

[ssbarnea]

I also found that the expression "cspell global config" is mentioned in both documentation and command line but without ever mentioning which filename to use if you want to create a global config.

Another issue with the term global is that is confusing, a better approach is to use the term system or user level config, just to make it clear.

I wanted to have some user level settings for cspell and created a ~/cspell.config.yaml file just to discover that cspell is not loading it unless I manually mention it via --config=~/cspell.config.yaml. In addition to this, there is no verbose mode for command line that I could use to figure out if cspell would load a config file from disc or not when run. -- Update: I already had another cspell user config that I did not see which was loaded by default, so partially my fault. Still, it might prove very useful to always log on stderr the name of the config file that is loaded when one is loaded, would save us from confusions without breaking tools that process stdout.

I know that the things I mentioned here might require additional tickets but I will let @Jason3S decide if yes or not. Hopefully we can address these.

[Jason3S]

@ssbarnea,

I should have closed this issue. It is a documentation issue, not a missing feature.

There is a verbose mode. What is the issue?

Please try:

cspell *.md --verbose     

[Jason3S]

@ssbarnea,

Please open a new issue.