Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

.cspellrc configuration file

See original GitHub issue

Is there a possibility to add .cspellrc as a valid configuration file?

I don’t want to call --config .cspellrc> always.

Rather, consider .cspellrc to be an official configuration file.

Issue Analytics

State:
Created a year ago
Comments:7 (3 by maintainers)

Top GitHub Comments

1reaction

Jason3Scommented, Apr 6, 2022

@carlocorradini,

Thank you for the suggestion. There is nothing “standard” about rc files. Even the format is not clear. Should it be JSON, or Yaml, or some other format?

Historically, rc (run command or run config) files tend to be different than the configuration files. They allow you to set defaults for the command line options, instead of the general configuration. Even Babel makes a distinction.

A perfect example of an option that would be in the rc and not in the configuration is the cache. This is because it is specific to the cspell cli and does not apply to the @cspell/eslint-plugin or to the VS Code spell checker extension. I debated on creating an rc to take care of that case, but because of the possible confusion, it was decided not to use one.

Kind regards, Jason

0reactions

github-actions[bot]commented, May 7, 2022

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

Top Results From Across the Web

Configuration | CSpell

CSpell's behavior can be controlled through a config file. By default it looks for any of the following files: ... Or you can...

cspell/README.md at main - GitHub

cspell's behavior can be controlled through a config file. By default it looks for any of the following files: ... Or you can...

Configuration Settings | Spell Checker - Street Side Software

Configuration Settings. Code Spell Checker; Languages and Dictionaries; Reporting and Display; Files, Folders, and Workspaces; Performance; CSpell; Advanced ...

cspell - npm

A Spelling Checker for Code!. Latest version: 6.18.0, last published: 6 days ago. Start using cspell in your project by running `npm i ......

CSpell

The default configuration file is ${CSPELL_DIR}/data/Config/cSpell.properties. The variables used in the configuration file are the empirical best value and ...