Skip to content

💡: [Docs]: Documentation on all default configuration values #7840

@Drew-Daniels

Description

@Drew-Daniels

Problem

Thanks a lot for cspell! I've been using it for projects over the past couple of years and have really enjoyed using it.

I recently started working on a new project, and am taking more of a deep dive through all of the available configuration options for cspell as listed in the Configuration section of the documentation, but for many of the options, it is not immediately clear what the default values for these options are, such as useGitignore.

I can see that this option takes a boolean value, but it is unclear if this defaults to true or false when unspecified, so the only way to determine this is to lint, or look within the source code, which isn't ideal.

Solution

Maybe this documentation already exists somewhere, and I've missed it, but I think that it would be nice if the default values for configuration options were specified next to each configuration option in the Configuration documentation section linked above, or in the README.

Alternatives

No response

Additional Context

No response

Code of Conduct

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions