commitizen icon indicating copy to clipboard operation
commitizen copied to clipboard

Check unknown config in configuration file

Open Lee-W opened this issue 5 years ago • 5 comments

Description

Check whether unknown configuration exists in the configuration file when strict_config=True is passed. It should work like --strict-markers in pytest. It can avoid typo in the configuration.

Possible Solution

  1. add strict_config as a configuration
  2. define the valid configurations
  3. check unknown key in base_config if strict_config=True

Additional context

Related Issue

Lee-W avatar Nov 12 '20 02:11 Lee-W

How would this work? What do you envision and what's the use case?

woile avatar Nov 14 '20 10:11 woile

If any configuration not supported by commitizen exists in the section [tool.commitizen], any commtizen command should fail with an error message saying which configuration is not supported.

Days ago, I tried to reproduce #297, but forget that I didn't have the latest commitizen installed which does not yet support update_changelog_on_bump.

Also, I think it might be great if an user can list all the configuration through cli like pytest --fixtures does.

Lee-W avatar Nov 15 '20 03:11 Lee-W