Feat: predefined scope options #1
Open
+497
−255
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ThisIsMissEm
force-pushed
the
feat/predefined-scope-options
branch
from
21480b0 to
16a5224
Compare
…rompter This allows us to use methods from inquirer, such as the Separator class, before actually calling prompter()
ThisIsMissEm
force-pushed
the
feat/predefined-scope-options
branch
from
16a5224 to
fd0c825
Compare
Previously configuration was tested by mocking our own code, as well as code that we don't own (other modules), this was because configuration took place at require-time of the cz-conventional-commit module, rather than at execution-time. By moving configuration evaluation to execution-time we can better test the logic involved in loading and evaluating configuration. The removal of the dependency on cosmiconfig comes because we no longer need to mock this module which is a 2nd degree dependency: it's used by commitlint, which we can just mock directly. The previous mocking was needed to override the max-header-length option in a really round-about manner where all tests effectively depended on commitlint, even though that wasn't what the functionality actually was. This changeset all means that we can test loading and evaluating configuration in isolation, without involving the engine.
Allow users to configure a predefined list of scopes that can be selected from, with the option to type their own scope if it's not on the list. When passing CZ_SCOPE, we attempt to pre-select the scope from the list of scopes, or auto-select "something else" which allows the user to confirm the CZ_SCOPE value.
Previously specifying a custom max header width wasn't actually tested for, only the configuration loading was tested. This ensures that we have coverage on this functionality.
ThisIsMissEm
force-pushed
the
feat/predefined-scope-options
branch
from
fd0c825 to
1964940
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This allows you to configure a predefined number of scopes, and then gives the user a nice graphical way to select one or enter their own. It should be backwards compatible with cz-conventional-changelog, and accept defaults via the same environment variable or config option as the existing
scopesfunctionality.The package.json configuration:
