Skip to content

Commit

Permalink
feat(zhi-root): add commitlint support
Browse files Browse the repository at this point in the history
  • Loading branch information
terwer committed May 4, 2023
1 parent 33b0843 commit 2ab1aac
Show file tree
Hide file tree
Showing 4 changed files with 2,217 additions and 57 deletions.
36 changes: 36 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,39 @@ Run `npx nx connect-to-nx-cloud` to enable [remote caching](https://nx.app) and
## Further help

Visit the [Nx Documentation](https://nx.dev) to learn more.

## Components

### commitlint

1

https://www.npmjs.com/package/@commitlint/cz-commitlint

```bash
npm install --save-dev @commitlint/config-angular @commitlint/cz-commitlint commitizen inquirer@8
## commitlint.config.js
```

2 package.json

or

```
{
"scripts": {
"commit": "git-cz"
},
"config": {
"commitizen": {
"path": "@commitlint/cz-commitlint"
}
}
}
```

3
```bash
git add -A
npm run commit
```
110 changes: 110 additions & 0 deletions commitlint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
module.exports = {
extends: ["@commitlint/config-angular"],
rules: {
"type-enum": [2, "always", ["feat", "fix", "refactor", "perf", "revert", "chore", "docs"]],
},
prompt: {
settings: {},
messages: {
skip: ":skip",
max: "upper %d chars",
min: "%d chars at least",
emptyWarning: "can not be empty",
upperLimitWarning: "over limit",
lowerLimitWarning: "below limit",
},
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: "🐛",
},
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: "🚀",
},
revert: {
description: "Reverts a previous commit",
title: "Reverts",
emoji: "🗑",
},
chore: {
description: "Other changes that don't modify src or test files",
title: "Chores",
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: "💎",
},
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: "⚙️",
},
},
},
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".)',
},
},
},
}
Loading

0 comments on commit 2ab1aac

Please sign in to comment.