Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use npm's config object, deprecate czConfig #30

Closed
5 tasks done
jimthedev opened this issue Oct 19, 2015 · 5 comments
Closed
5 tasks done

Use npm's config object, deprecate czConfig #30

jimthedev opened this issue Oct 19, 2015 · 5 comments

Comments

@jimthedev
Copy link
Member

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!

@kentcdodds
Copy link
Member

👍

1 similar comment
@joshmanders
Copy link

👍

@jimthedev jimthedev modified the milestones: Unscheduled, 3.0.0 Oct 22, 2015
@jimthedev
Copy link
Member Author

This is included in 2.3.0. Also created a #38 as a reminder to remove czConfig as a breaking change in 3.0.0.

@kentcdodds
Copy link
Member

Cheers! Well done @jimthedev!

@joshmanders
Copy link

Awesome work @jimthedev!

orestes pushed a commit to videogular/videogular2 that referenced this issue Jan 31, 2016
Commitizen is deprecating czConfig in favor of npm's config object
commitizen/cz-cli#30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants