Feature/cz commitlint #2547

curly210102 · 2021-04-12T19:49:10Z

Description

Develop a new commitizen adapter: cz-commitlint, it based on inquirer and share commitlint.config.js with commitizen.
Add "prompt" field in commitlint.config.js, the interactive process can be customized in different shared configuration.
e.g.@commitlint/config-conventional

Motivation and Context

Why I have to develop it

It is necessary to submit and lint with same rules. It is inconvenient and unreliable to configure two file for commitlint and commitizen. I investigated the possible solutions:

commitlint/prompt/commitlint/prompt-cli: The interactive experience is not good.
cz-customizable: Not support async load.

There is no perfect solution, so I tried to develop a new one, which is inspired by cz-conventional-changelog and compatible with the submission process of commitlint/prompt.

It based on inquirer instead of vorpal, can be used with commitizen, also a beginning of "Rewrite @commitlint/prompt for better usability"(Refer from Roadmap).

How it works

Screen.Recording.2021-04-13.at.3.13.38.AM.mov

Usage examples

Prompt Config

Configure Prompt Config of commitlint.config.js，customize the interactive steps.

// commitlint.config.js
// Example: set prompt config  @commitlint/config-conventional
module.exports = {
	parserPreset: 'conventional-changelog-conventionalcommits',
	rules: {},
	prompt: {
		questions: {
			type: {
				description: "Select the type of change that you're committing:",
				enum: {
					feat: {
						description: 'A new feature',
						title: 'Features',
						emoji: '✨',
					},
					fix: {
						description: 'A bug fix',
						title: 'Bug Fixes',
						emoji: '🐛',
					},
					docs: {
						description: 'Documentation only changes',
						title: 'Documentation',
						emoji: '📚',
					},
					style: {
						description:
							'Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)',
						title: 'Styles',
						emoji: '💎',
					},
					refactor: {
						description:
							'A code change that neither fixes a bug nor adds a feature',
						title: 'Code Refactoring',
						emoji: '📦',
					},
					perf: {
						description: 'A code change that improves performance',
						title: 'Performance Improvements',
						emoji: '🚀',
					},
					test: {
						description: 'Adding missing tests or correcting existing tests',
						title: 'Tests',
						emoji: '🚨',
					},
					build: {
						description:
							'Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)',
						title: 'Builds',
						emoji: '🛠',
					},
					ci: {
						description:
							'Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)',
						title: 'Continuous Integrations',
						emoji: '⚙️',
					},
					chore: {
						description: "Other changes that don't modify src or test files",
						title: 'Chores',
						emoji: '♻️',
					},
					revert: {
						description: 'Reverts a previous commit',
						title: 'Reverts',
						emoji: '🗑',
					},
				},
			},
			scope: {
				description:
					'What is the scope of this change (e.g. component or file name)',
			},
			subject: {
				description: 'Write a short, imperative tense description of the change',
			},
			body: {
				description: 'Provide a longer description of the change',
			},
			isBreaking: {
				description: 'Are there any breaking changes?',
			},
			breakingBody: {
				description:
					'A BREAKING CHANGE commit requires a body. Please enter a longer description of the commit itself',
			},
			breaking: {
				description: 'Describe the breaking changes',
			},
			isIssueAffected: {
				description: 'Does this change affect any open issues?',
			},
			issuesBody: {
				description:
					'If issues are closed, the commit requires a body. Please enter a longer description of the commit itself',
			},
			issues: {
				description: 'Add issue references (e.g. "fix #123", "re #123".)',
			},
		},
	}
};

For more detail: Introduction of Prompt Config

Command-line Interaction

You can try it out in @commitlint/cz-commitlint folder.

yarn commit

How Has This Been Tested?

I have covered unit tests from underlying utilities to top entry.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

My change requires a change to the documentation.
I have updated the documentation accordingly.
I have added tests to cover my changes.
All new and existing tests passed.

Merge with origin master

…mmitlint

…l-changelog

…mmitlint

…tests for cz-commitlint prompt field is working for prompt config, settled in commitlint config file, can be defined by shared configurations.

…r config apply

escapedcat · 2021-04-13T01:28:11Z

Awesome @curly210102 ! Thank you for your efforts!

The prettier task fails:

Could you try running it locally? It might fix this.

@armano2 @byCedric @marionebl would you mind taking a look at this PR?

modify format

yarn.lock

…o longer used dependencies

@alias/commitlint-config-angular/package.json

AdeAttwood · 2021-04-26T07:17:08Z

@curly210102 only comments from me is the __test__ directory in src. Can we remove the __test__ directory and move the test files in the src folder to keep it consistent with the other package?

The other thing is more of a question that is where do the scopes come from? I tried adding an enum to the scope config and could not get it to work. I would be cool if we could do something like we can with the "type".

scope: {
    description: 'What is the scope of this change (e.g. component or file name)',
    enum: {
	  thing: {
		  description: 'References the thing component of the app',
		  title: 'Thing',
	  },
    },
},

@curly210102 really like this by the way.

curly210102 · 2021-04-28T08:23:27Z

@curly210102 only comments from me is the __test__ directory in src. Can we remove the __test__ directory and move the test files in the src folder to keep it consistent with the other package?

The other thing is more of a question that is where do the scopes come from? I tried adding an enum to the scope config and could not get it to work. I would be cool if we could do something like we can with the "type".
scope: {
    description: 'What is the scope of this change (e.g. component or file name)',
    enum: {
	  thing: {
		  description: 'References the thing component of the app',
		  title: 'Thing',
	  },
    },
},
@curly210102 really like this by the way.

@AdeAttwood thanks for review. I agree with the suggestion that move the test files flat with source code files to keep consistency.

The scopes is configured by "rules" field. As commitlint.config.js designed, the parts of commit message is decided by "rules", so it can be worked on both "lint" and "prompt"."prompt" field is only worked with prompt process, add auxiliary messages.Thus, if you'd like to add scope enums, need set 'rules -> scope-enum' at first.

rules: {
    'scope-enum': [2, 'always', ['thing']]
},
prompt: {
    questions: {
        scope: {
            description: 'What is the scope of this change (e.g. component or file name)',
            enum: {
                thing: {
                    description: 'References the thing component of the app',
                    title: 'Thing',
	            },
            },
        }
    }
}

…to keep consistency

escapedcat · 2021-04-29T05:44:47Z

Thanks for this @curly210102 !
@AdeAttwood thanks for your feedback.
Will merge this in and create next release for testing.

escapedcat · 2021-04-29T06:16:18Z

Published under next. Please give it a try.

curly210102 · 2021-05-01T09:34:53Z

Have try the next version, features passed test. Just optimize introductions, Make cz-commitlint searchable and easy to get start by curly210102 · Pull Request #2572 · conventional-changelog/commitlint (github.com)<#2572> [https://opengraph.githubassets.com/c2592b9e5d718c800e140a10e7f8971e1e70127e21692f6099fc3d018d4ca9c0/conventional-changelog/commitlint/pull/2572]<https://github.com/conventional-changelog/commitlint/pull/2572> Make cz-commitlint searchable and easy to get start by curly210102 · Pull Request #2572 · conventional-changelog/commitlint<#2572> Description Update package.json and README.md of cz-commitlint package add keywords of package.json simplify README, only introduce important points official document: provide a better screenshot... github.com Sent from Outlook<http://aka.ms/weboutlook>

…

________________________________ From: hannes ***@***.***> Sent: Thursday, April 29, 2021 2:16 PM To: conventional-changelog/commitlint ***@***.***> Cc: Curly Brackets ***@***.***>; Mention ***@***.***> Subject: Re: [conventional-changelog/commitlint] Feature/cz commitlint (#2547) Published under next. Please give it a try. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<#2547 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ASKNVMHSNRNU2V7CUBNV7ULTLD2ULANCNFSM42Z55NTQ>.

…elog (#7264) This commit updates to @commitlint/cz-commitlint, which adds the `scope` enum from commitlint without changing the interactive commit experience. Further motivation is explained in conventional-changelog/commitlint#2547 Co-authored-by: John Corser <xss@amazon.com>

…elog (aws-amplify#7264) This commit updates to @commitlint/cz-commitlint, which adds the `scope` enum from commitlint without changing the interactive commit experience. Further motivation is explained in conventional-changelog/commitlint#2547 Co-authored-by: John Corser <xss@amazon.com>

curly210102 and others added 11 commits March 14, 2021 18:20

Merge pull request #1 from conventional-changelog/master

5bf9830

Merge with origin master

Merge branch 'master' of https://github.com/conventional-changelog/co…

b188de3

…mmitlint

Merge branch 'master' of https://github.com/conventional-changelog/co…

c4b0bac

…mmitlint

feat(cz-commitlint): finish basic features inspired by cz-conventiona…

5b60836

…l-changelog

test(cz-commitlint): Add Util Function Tests

1d27083

Merge branch 'master' of https://github.com/conventional-changelog/co…

56f3074

…mmitlint

Merge branch 'master' into feature/cz-commitlint

12a596f

feat(cz-commitlint): add prompt field to commitlint config file, add …

56a4d8b

…tests for cz-commitlint prompt field is working for prompt config, settled in commitlint config file, can be defined by shared configurations.

test(cli): update 'should print config' test for add 'prompt' field

6a989ff

fix(cz-commitlint): fix question input start with new line, fix foote…

20c3598

…r config apply

docs(cz-commitlint): update commitlint doc "Guide: Use prompt"

efa47f9

escapedcat requested a review from byCedric April 13, 2021 01:19

curly210102 added 2 commits April 13, 2021 10:39

docs(cz-commitlint): add Prompt Configuration introdution

69cab32

fix(config-conventional): update to pass ci

0396ab1

modify format

escapedcat reviewed Apr 14, 2021

View reviewed changes

yarn.lock Outdated Show resolved Hide resolved

escapedcat requested a review from marionebl April 14, 2021 03:49

curly210102 added 2 commits April 14, 2021 14:41

chore: update registry to default npm

e08e3ef

fix(cz-commitlint): compatible old version @commitlint/load, remove n…

a53f814

…o longer used dependencies

escapedcat reviewed Apr 15, 2021

View reviewed changes

@alias/commitlint-config-angular/package.json Outdated Show resolved Hide resolved

fix(cz-commitlint): fix load prompt config from commitlint config file

e44b9e1

escapedcat mentioned this pull request Apr 27, 2021

Security vulnerability in dependency tree #585

Closed

4 tasks

test(cz-commitlint): move the test files flat with source code files …

db6a7b1

…to keep consistency

escapedcat merged commit c77381d into conventional-changelog:master Apr 29, 2021

escapedcat added a commit that referenced this pull request Apr 29, 2021

chore(cz-commitlint): update package name #2547

e0ec0bb

escapedcat mentioned this pull request May 2, 2021

prompt: reimplement with ink #86

Closed

johnpc mentioned this pull request May 5, 2021

build: use @commitlint/cz-commitlint instead of cz-conventional-changelog aws-amplify/amplify-cli#7264

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/cz commitlint #2547

Feature/cz commitlint #2547

curly210102 commented Apr 12, 2021 •

edited

Loading

escapedcat commented Apr 13, 2021 •

edited

Loading

AdeAttwood commented Apr 26, 2021

curly210102 commented Apr 28, 2021

escapedcat commented Apr 29, 2021

escapedcat commented Apr 29, 2021

curly210102 commented May 1, 2021 via email

Feature/cz commitlint #2547

Feature/cz commitlint #2547

Conversation

curly210102 commented Apr 12, 2021 • edited Loading

Description

Motivation and Context

Why I have to develop it

How it works

Usage examples

Prompt Config

Command-line Interaction

How Has This Been Tested?

Types of changes

Checklist:

escapedcat commented Apr 13, 2021 • edited Loading

AdeAttwood commented Apr 26, 2021

curly210102 commented Apr 28, 2021

escapedcat commented Apr 29, 2021

escapedcat commented Apr 29, 2021

curly210102 commented May 1, 2021 via email

curly210102 commented Apr 12, 2021 •

edited

Loading

escapedcat commented Apr 13, 2021 •

edited

Loading