[Feature Request] Optional prompt to use exclamation (!) to denote breaking change #38

sitiom · 2022-06-22T02:57:24Z

💭 Describe the feature

See Conventional Commits examples:

💡 Proposed Solution

An option to denote an exclamation mark

Zhengqbbb · 2022-06-22T03:01:19Z

Received, thanks for the let me know more, you can look at this option
https://cz-git.qbenben.com/config/show.html#typesappend
See if it can solve your needs first

Zhengqbbb · 2022-06-22T03:05:15Z

I have been following this option, you can check out this tweet.
Let me know if it solves your problem

https://twitter.com/antfu7/status/1536301374748913666

sitiom · 2022-06-22T03:18:44Z

Received, thanks for the let me know more, you can look at this option cz-git.qbenben.com/config/show.html#typesappend See if it can solve your needs first

This just adds additional types in addition to the default ones. I want to be able to append an exclamation mark to every type (feat!:, chore!:, ci!:, ...).

I have been following this option, you can check out this tweet. Let me know if it solves your problem

twitter.com/antfu7/status/1536301374748913666

This one is for changelogs, not for Commitizen.

Zhengqbbb · 2022-06-22T03:21:45Z

In the next version I will add an environment variable for better use.
e.g:break=1 czIn this way, "!" mark will be added after all types.

What better opinion do you have?

sitiom · 2022-06-22T03:31:57Z

I was thinking of an optional prompt "Would you like to prefix an exclamation (!) mark to denote a breaking change? (Yn)" right before the "List any BREAKING CHANGES" prompt.

Zhengqbbb · 2022-06-22T03:50:07Z

I also need to consider that users who use commitlint will return false so mark is not provided by default.

I think there should be a configuration item to give prompt to cooperate with BREAKCHANGE

Environment variables are also prepared for no-config for anyway,
I will release cz-git cli in the next version
break=1 cz or
czg break

sitiom · 2022-06-22T03:53:21Z

I also need to consider that users who use commitlint will return false so mark is not provided by default.

I'm using commitlint and using the exclamation mark works just fine.

Zhengqbbb · 2022-06-22T04:09:31Z

I also need to consider that users who use commitlint will return false so mark is not provided by default.

I'm using commitlint and using the exclamation mark works just fine.

great~ Maybe this feature needs more than cli.it will come soon

Zhengqbbb · 2022-06-22T05:27:08Z

@sitiom
I think I'm almost done.
you see if there is any problem

Use the environment variable Demo :

Can add options markBreakingChangeMode: true turn on the question of extra prompt:
demo:

it use exclamation (!) to denote breaking change see: https://www.conventionalcommits.org/en/v1.0.0/#examples link #38

sitiom · 2022-06-22T05:44:19Z

Looks good to me!

Zhengqbbb · 2022-06-22T05:46:50Z

Looks good to me!

I expect that I will a release on the weekend, of course I want the cli to go live together, I will give a notice at that time, thank you for your suggestion

link #38

…t mark `!` #39 (#38) feat(cz-git): add `markBreakingChangeMode` options to add extra prompt mark `!` it use exclamation (!) to denote breaking change see: https://www.conventionalcommits.org/en/v1.0.0/#examples

Zhengqbbb · 2022-06-25T12:11:07Z

@sitiom
The latest version 🌟(v1.3.6)🌟 should be resolve this issue request , please have a try. 💪
👀 Let me know if there are still any issues. Thanks for you work! 🎉

Guide see: https://cz-git.qbenben.com/recipes/breakingchange.html

sitiom · 2022-06-25T12:27:06Z

Thanks, it works as intended so far.

sitiom · 2022-06-25T12:48:10Z

@Zhengqbbb Wait, if I input "no" in the breaking change prompt it won't ask for a breaking change footer. Regardless, it should still ask for a breaking change description because it is possible to omit the ! if a breaking change footer exists (and vice versa).

Zhengqbbb · 2022-06-25T12:54:44Z

I didn't want to add another question, but that said, it should be added and matched with the allowBreakingChanges options.

But what I'm not sure about is if this would be too verbose

Zhengqbbb · 2022-06-25T12:57:35Z

This is how I see it, if this mode is turned on, if you choose no, then it means that there is no BREAKINGCHANGE

sitiom · 2022-06-25T13:01:43Z

Not necessarily, you can omit the ! when there is a BREAKING CHANGE: footer and vice versa. See the examples on the CC site:

Commit message with description and breaking change footer
feat: allow provided config object to extend other configs

BREAKING CHANGE: `extends` key in config file is now used for extending other config files
Commit message with ! to draw attention to breaking change
feat!: send an email to the customer when a product is shipped
Commit message with both ! and BREAKING CHANGE footer
chore!: drop support for Node 6

BREAKING CHANGE: use JavaScript features not available in Node 6.

sitiom · 2022-06-25T13:15:05Z

I just thought of it now; since both options can be omitted from each other, shouldn't the ! prompt be already there by default, and no config/environment var is needed?

Zhengqbbb · 2022-06-25T13:16:23Z

wait five mins

…CHANGE footer link #38

Zhengqbbb · 2022-06-25T13:26:27Z

I just thought of it now; since both options can be omitted from each other, shouldn't the ! prompt be already there by default, and no config/environment var is needed?

NO, this will lose the no-config convenience, and you ignore a point that only feat fix will have this question by default

sitiom · 2022-06-25T13:28:04Z

I just thought of it now; since both options can be omitted from each other, shouldn't the ! prompt be already there by default, and no config/environment var is needed?

Oh, Yeah, except those not defined in allowBreakingChanges of course.

Zhengqbbb · 2022-06-25T13:33:19Z

The latest version 🌟(v1.3.7)🌟 should be resolve this issue request , please have a try. 💪
👀 Let me know if there are still any issues. Thanks for you work! 🎉
Thanks again for your advice!!!

Zhengqbbb · 2022-06-25T13:38:09Z

BTW you can try npx czg in your project 😁😁😁
It will be awsome

sitiom · 2022-06-25T13:40:39Z

The latest version 🌟(v1.3.7)🌟 should be resolve this issue request , please have a try. 💪 👀 Let me know if there are still any issues. Thanks for you work! 🎉 Thanks again for your advice!!!

It works as intended now, thanks!

BTW you can try npx czg in your project 😁😁😁 It will be awsome

Thanks. I'm used to having a git cz alias, though. Can you add it for that one?

Zhengqbbb · 2022-06-25T13:48:44Z

Can you add it for that one?

I will say no. I'm also a shell developer, I know this behavior is very disruptive to the user's environment. it's up to the user to decide and create.
😇 Thx u support

sitiom · 2022-06-25T14:02:49Z

@Zhengqbbb the issue seems to still haven't been fixed in czg:

Zhengqbbb · 2022-06-25T14:07:04Z

Is there any operation steps, It fine on my env

https://cz-git.qbenben.com/cli/break.html

sitiom · 2022-06-25T14:09:47Z

There's still a break mode in czg? It doesn't match the behavior in the adapter?

Zhengqbbb · 2022-06-25T14:13:09Z

There's still a break mode in czg? It doesn't match the behavior in the adapter?

You mean, BREAKINGCHANGE footer is not appearing, Emmm allowBreakingChanges is a problem, I will fix it next week

break mode specifically refers to the quick addition of ! ,that all

sitiom · 2022-06-25T14:26:47Z

Oh ok, it seems that I have misunderstood it, sorry. Just ignore my previous comments, everything is working fine.

Zhengqbbb · 2022-06-25T14:32:08Z

Oh ok, it seems that I have misunderstood it, sorry. Just ignore my previous comments, everything is working fine.

Use the CLI a lot and you'll build muscle memory and experience the feeling of being fast and simple! ❤️

Zhengqbbb · 2022-07-22T15:02:17Z

Thanks. I'm used to having a git cz alias, though. Can you add it for that one?

Through the study of this article, I have changed my previous idea and added a command line entry git-czg, I will release a version v1.3.10 on the weekend, then you can use git czg to start CLI

Git automatically resolved subcommands from executables in the PATH that follow the naming convention git-. These subcommands can be executed with git .

🤗

sitiom · 2022-07-23T02:39:01Z

Interesting, that's why git recognizes git cz 🤔

sitiom added the enhancement New feature or request label Jun 22, 2022

sitiom assigned Zhengqbbb Jun 22, 2022

Zhengqbbb added the next version Plan for next version label Jun 22, 2022

sitiom changed the title ~~[Feature Request] Option to use exclamation (!) to denote breaking change~~ [Feature Request] Optional prompt to use exclamation (!) to denote breaking change Jun 22, 2022

Zhengqbbb added a commit that referenced this issue Jun 22, 2022

feat(cz-git): add markBreakingChangeMode options to add extra prompt

da4b624

it use exclamation (!) to denote breaking change see: https://www.conventionalcommits.org/en/v1.0.0/#examples link #38

Zhengqbbb added a commit that referenced this issue Jun 24, 2022

test(cz-git): add markBreakingChangeMode testcase

b7e96c7

link #38

Zhengqbbb added a commit that referenced this issue Jun 24, 2022

docs(site): add markBreakingChangeMode guide

01af17d

link #38

Zhengqbbb mentioned this issue Jun 24, 2022

feat(cz-git): add markBreakingChangeMode options to add extra prompt mark ! #39

Merged

7 tasks

Zhengqbbb closed this as completed Jun 25, 2022

Zhengqbbb reopened this Jun 25, 2022

Zhengqbbb added a commit that referenced this issue Jun 25, 2022

fix(cz-git): remove markBreakingChangeMode restrictions on BREAKING…

a745bf2

…CHANGE footer link #38

Zhengqbbb mentioned this issue Jun 25, 2022

fix(cz-git): remove markBreakingChangeMode restrictions #41

Merged

6 tasks

Zhengqbbb added a commit that referenced this issue Jun 25, 2022

fix(cz-git): remove markBreakingChangeMode restrictions #41 (#38)

0518839

Zhengqbbb closed this as completed Jun 25, 2022

[Feature Request] Optional prompt to use exclamation (!) to denote breaking change #38

[Feature Request] Optional prompt to use exclamation (!) to denote breaking change #38

Comments

sitiom commented Jun 22, 2022

💭 Describe the feature

💡 Proposed Solution

Zhengqbbb commented Jun 22, 2022 • edited

Zhengqbbb commented Jun 22, 2022

sitiom commented Jun 22, 2022

Zhengqbbb commented Jun 22, 2022 • edited

sitiom commented Jun 22, 2022

Zhengqbbb commented Jun 22, 2022

sitiom commented Jun 22, 2022

Zhengqbbb commented Jun 22, 2022

Zhengqbbb commented Jun 22, 2022

sitiom commented Jun 22, 2022

Zhengqbbb commented Jun 22, 2022

Zhengqbbb commented Jun 25, 2022 • edited

sitiom commented Jun 25, 2022

sitiom commented Jun 25, 2022

Zhengqbbb commented Jun 25, 2022 • edited

Zhengqbbb commented Jun 25, 2022

sitiom commented Jun 25, 2022 • edited

Commit message with description and breaking change footer

Commit message with ! to draw attention to breaking change

Commit message with both ! and BREAKING CHANGE footer

sitiom commented Jun 25, 2022 • edited

Zhengqbbb commented Jun 25, 2022

Zhengqbbb commented Jun 25, 2022

sitiom commented Jun 25, 2022 • edited

Zhengqbbb commented Jun 25, 2022

Zhengqbbb commented Jun 25, 2022 • edited

sitiom commented Jun 25, 2022

Zhengqbbb commented Jun 25, 2022

sitiom commented Jun 25, 2022

Zhengqbbb commented Jun 25, 2022 • edited

sitiom commented Jun 25, 2022

Zhengqbbb commented Jun 25, 2022 • edited

sitiom commented Jun 25, 2022

Zhengqbbb commented Jun 25, 2022

Zhengqbbb commented Jul 22, 2022

sitiom commented Jul 23, 2022

Zhengqbbb commented Jun 22, 2022 •

edited

Zhengqbbb commented Jun 22, 2022 •

edited

Zhengqbbb commented Jun 25, 2022 •

edited

Zhengqbbb commented Jun 25, 2022 •

edited

sitiom commented Jun 25, 2022 •

edited

Commit message with `!` to draw attention to breaking change

Commit message with both `!` and BREAKING CHANGE footer

sitiom commented Jun 25, 2022 •

edited

sitiom commented Jun 25, 2022 •

edited

Zhengqbbb commented Jun 25, 2022 •

edited

Zhengqbbb commented Jun 25, 2022 •

edited

Zhengqbbb commented Jun 25, 2022 •

edited