feat(config): Add OCO_OMIT_SCOPE option to control scope inclusion in commit messages #453
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.
What
This PR adds a new environment variable
OCO_OMIT_SCOPE
that allows users to control whether to include the scope part in generated commit messages.Why
Some users or projects prefer commit messages without scopes, following a simpler format of
<type>: <subject>
rather than<type>(<scope>): <subject>
. This configuration option provides flexibility to accommodate different commit style preferences.How to use
Set the environment variable
OCO_OMIT_SCOPE
totrue
to omit scopes in commit messages:Examples:
With default configuration or
OCO_OMIT_SCOPE=false
:With
OCO_OMIT_SCOPE=true
:Changes made
OCO_OMIT_SCOPE
to theCONFIG_KEYS
enumConfigType
interfacefalse
to theDEFAULT_CONFIG
objectConsistencyPrompt
type to support scope-less formatsTesting
The functionality has been verified through manual testing and all existing tests continue to pass.