Closed
Description
Per @killswitch and @kentcdodds in this original issue. We should be using npm's config object and not our own key. We want to be good package.json citizens after all. 👍
The main reason that this bad practice exists is that config loader originally came from jscs and thus followed their perhaps naive convention. The good news is we can easily add it and migrate to it being the default because their loader is pretty robust.
Things needed for this to happen:
- Need to add some more robust tests to areas of the codebase that would be impacted by this change.
- Add config.cz as the highest level priority option in the configLoader (note, we still need to support czConfig for now, but can add a deprecation warning in the cli to get people to switch)
- Change
commitizen init
to use the config.cz location by default to encourage new adoption. - Change the docs to reflect this change
- Add deprecation warning to cli, potentially even put in PRs on gh.
EDIT: Created a new ticket for removing czConfig in 3.0.0 per @kentcdodds
Hooray!