cz-conventional-changelog
cz-conventional-changelog copied to clipboard
Add scope selector
any idea when this will be available? i'd like to configure custom scopes
me too !! it would be great !
Hi, when this will be available? We're waiting for this too.
Hi @jimthedev, can we have a review for this ?
@bertho-zero oh, neat, you've been working on this as well; I didn't know about scope-enum
rule though. Here's my progress so far, it's trying to change as little code as possible and be fairly backwards compatible (i.e., you have to opt into this feature): https://github.com/ThisIsMissEm/cz-conventional-changelog/pull/1
@bertho-zero just pushed my own version of this in #126, which tries to achieve the same goal in a cleaner manner (I didn't realise you already had this PR when I started writing my version), also means there's no double-prompt run.
it's fairly similar but allows users to also specify their own scope, so is less strict than your implementation. I think we could add a "don't allow free scope" option too if you wanna be really strict about scopes choices. Perhaps CZ_SCOPES_STRICT
or something?
Yes, this option can be useful if the commitlint config uses the scope-enum
rule.
https://github.com/conventional-changelog/commitlint/blob/master/%40commitlint/rules/src/scope-enum.ts
@bertho-zero Okay, so, I think if scope-enum is set, given that behaviour, then CZ_SCOPES_STRICT is implied — I could probably update my branch to implement that behaviour. I'm not sure if you've had a chance to take a look at my implementation, but I've effectively separated configuration from the running of the engine, such that we can test the parsing of configuration in isolation
Still need to write tests for the flow of inputs through that though!
Any news?
who's in charge of this repo? how can we get this merged?
@btd1337 @nweajoseph I haven't had a chance to ever look at this branch again, due to a lack of time. Maybe you could contribute unit tests to the code over at https://github.com/commitizen/cz-conventional-changelog/pull/126 and rebase it? More than happy to let someone else see it to completion.
I am really looking forward to this feature
Is it possible to get this simple feature merged ? If you are a project maintainer you should be able to allow only a limited scope to ensure consistency accros commit messages.
I tried to test the feature but did not get prompted with the scopes. what am I missing? @bertho-zero my package.json references this branch (and I ran npm install, I can see in node_modules the allowedScopes property)
"cz-conventional-changelog": "bertho-zero/cz-conventional-changelog#scope-enum",
I configured in package.json
"config": {
"commitizen": {
"path": "cz-conventional-changelog",
"allowedScopes": [
"my-project1",
"my-project2",
"my-project3"
]
}
},
I found a nice alternative to cz-conventional-changelog that can even autodetect the scopes if you work in a monorepo: https://github.com/Zhengqbbb/cz-git