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

feat(engine): add support for custom scopes option #216

Closed
wants to merge 1 commit into from
Closed

feat(engine): add support for custom scopes option #216

wants to merge 1 commit into from

Conversation

haypho
Copy link

@haypho haypho commented Jan 7, 2024

This change is to support the custom scopes definition in the package.json's config.commitizen.scopes key. The format of the key matches the format of the config.commitizen.types key. Each scope has a description and title key used by inquirer to display the scope to the user. In order to maintain backward-compatibility, the default value for the new package.json key (i.e., scopes) is an empty JSON object. When no keys are present in this object, we will default to custom user input for the scope. This also includes the option to press Enter to skip.

refs: #213

cz-conventional-changelog-support-custom-scopes.mp4

This change is to support the custom scopes definition in the package.json's
`config.commitizen.scopes` key. The format of the key matches the format of the
`config.commitizen.types` key. Each scope has a `description` and `title` key used by inquirer to
display the scope to the user. In order to maintain backwards-compatibility, the default value for
the new package.json key (i.e., `scopes`) is an empty JSON object. When no keys are present in this
object, we will default to custom user input for the scope. This also includes the option to press
Enter to skip.

refs: #213
@haypho haypho closed this by deleting the head repository Feb 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant