feat: add custom scope when commit #670
Open
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.
💡 Motivation Behind This PR: Supporting Custom Commit Scopes
Currently, the scope selection is limited to a predefined list, which works well for highly structured projects. However, it can be restrictive in more flexible or open source environments, where contributors might need to define context-specific scopes.
This pull request introduces a new
customScopeInputconfiguration option that allows:customScopeInput: true.🎯 Why this is valuable:
✅ Summary of Changes
🛠 Feature Implementation
[
README.md]: Updated to document the newcustomScopeInputoption.[
lib/defaults.js]: Introduced thecustomScopeInputflag (default isfalse).[
lib/questions/scope.js]: UpdatedcreateQuestionto:customScopeInputisfalse(default).limitedInputifcustomScopeInputistrue.🧪 Tests
test/formatCommitMessage.test.js]: Added tests withcustomScopeInput: falseto validate current behavior and ensure proper coverage.📌 Proposal
This enhancement introduces no breaking changes and brings more flexibility for users with varied workflows. It’s especially useful for open-source projects and collaborative environments.
The feature is:
I'd love to hear your feedback and am happy to make any adjustments necessary to meet your standards. Thank you for your time and consideration!