feat: support more configure file | add scopeFilter and typesDefault

* feat: add .cz.js and cz.config.js config file
* feat: add scopeFilters options
* feat: add defaultType options
* feat: support custom define config file
* feat: support get promise Func options

Author: Zhengqbbb

.commitlintrc.js

@@ -1,22 +1,22 @@
-const fs = require('fs')
-const path = require('path')
-const { execSync } = require('child_process');
+const fs = require("fs");
+const path = require("path");
+const { execSync } = require("child_process");
 
 // @description: git branch name = feature/issue_33 => auto get defaultIssues = #33
-const issue = execSync('git rev-parse --abbrev-ref HEAD')
+const issue = execSync("git rev-parse --abbrev-ref HEAD")
   .toString()
   .trim()
-  .split("_")[1]
+  .split("_")[1];
 // @description: monorepo dynamic get name
-const packages = fs.readdirSync(path.resolve(__dirname, 'packages/@cz-git'));
+const packages = fs.readdirSync(path.resolve(__dirname, "packages/@cz-git"));
 
 /** @type {import('cz-git').UserConfig} */
 module.exports = {
   extends: ["@commitlint/config-conventional"],
   rules: {
-    "scope-enum": [2, "always", [ "cz-git", "guide", ...packages ]],
-    "subject-min-length": [2, 'always', 2],
-    "subject-empty": [2, "never"],
+    "scope-enum": [2, "always", ["cz-git", "guide", ...packages]],
+    "subject-min-length": [2, "always", 2],
+    "subject-empty": [2, "never"]
   },
   prompt: {
     // @see: https://github.com/Zhengqbbb/cz-git#options

.eslintrc

@@ -18,6 +18,7 @@
     "@typescript-eslint/no-unused-vars": "error",
     "@typescript-eslint/no-explicit-any": "off",
     "@typescript-eslint/no-var-requires": "off",
-    "@typescript-eslint/ban-ts-comment": "off"
+    "@typescript-eslint/ban-ts-comment": "off",
+    "@typescript-eslint/no-non-null-assertion": "off"
   }
 }

.vscode/settings.json

@@ -1,4 +1,5 @@
 {
+  "volar.autoCompleteRefs": true,
   "github-actions.workflows.pinned.workflows": [
     ".github/workflows/nodejs.yml",
     ".github/workflows/docs.yml"

README.md

@@ -58,8 +58,8 @@ A more engineered, lightweight, customizable, standard output format [commitizen
 
 ```bash
 $ npm i -D cz-git
-+ cz-git          (1.8 MB)
-added 1 package in 0.47s
++ cz-git          (1.7 MB)
+added 1 package in 0.461s
 ```
 
 ## Usage
@@ -89,6 +89,7 @@ added 1 package in 0.47s
 
 - [tdesign-vue-next](https://github.com/Tencent/tdesign-vue-next)
 - [vue3-antd-admin](https://github.com/buqiyuan/vue3-antd-admin)
+- [Geeker-Admin](https://github.com/HalseySpicy/Geeker-Admin)
 - [vuepress-theme-hope](https://github.com/vuepress-theme-hope/vuepress-theme-hope)
 - [vuepress-theme-gungnir](https://github.com/Renovamen/vuepress-theme-gungnir)
 

docs/.vuepress/components/FeatureCN.vue

@@ -29,9 +29,9 @@ import Emoji from "./Emoji.vue";
         $ npm install -D cz-git<br />
         + cz-git
         &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-        (<span class="token number"> 1.8 MB </span>) <br />added &nbsp;<span class="token number"
+        (<span class="token number"> 1.7 MB </span>) <br />added &nbsp;<span class="token number"
           >1</span
-        >&nbsp; package in &nbsp;<span class="token number">0.47s</span>
+        >&nbsp; package in &nbsp;<span class="token number">0.461s</span>
       </p>
     </div>
     <div class="feature">

docs/.vuepress/components/FeatureEN.vue

@@ -31,9 +31,9 @@ import Emoji from "./Emoji.vue";
         $ npm install -D cz-git<br />
         + cz-git
         &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-        (<span class="token number"> 1.8 MB </span>) <br />added &nbsp;<span class="token number"
+        (<span class="token number"> 1.7 MB </span>) <br />added &nbsp;<span class="token number"
           >1</span
-        >&nbsp; package in &nbsp;<span class="token number">0.47s</span>
+        >&nbsp; package in &nbsp;<span class="token number">0.461s</span>
       </p>
     </div>
     <div class="feature">

docs/guide/README.md

@@ -64,8 +64,8 @@ A more engineered, lightweight, customizable, standard output format [commitizen
 
 ```bash
 $ npm i -D cz-git
-+ cz-git          (1.8 MB)
-added 1 package in 0.47s
++ cz-git          (1.7 MB)
+added 1 package in 0.461s
 ```
 
 [⇒ Why cz-git](/guide/why.html)
@@ -74,6 +74,7 @@ added 1 package in 0.47s
 
 - [tdesign-vue-next](https://github.com/Tencent/tdesign-vue-next)
 - [vue3-antd-admin](https://github.com/buqiyuan/vue3-antd-admin)
+- [Geeker-Admin](https://github.com/HalseySpicy/Geeker-Admin)
 - [vuepress-theme-hope](https://github.com/vuepress-theme-hope/vuepress-theme-hope)
 - [vuepress-theme-gungnir](https://github.com/Renovamen/vuepress-theme-gungnir)
 

docs/guide/configuration.md

@@ -8,14 +8,15 @@ sitemap:
 
 # Configure Template
 
-## Default template
+## Javascript template
 
 - `.commitlintrc.js`
 - `.commitlintrc.cjs`
 - `commitlint.config.js`
 - `commitlint.config.cjs`
 
 ::: details Click to expand .commitlintrc.js complete default configuration template
+
 ```js
 // commitlint.config.js | .commitlintrc.js
 /** @type {import('cz-git').UserConfig} */
@@ -80,8 +81,96 @@ module.exports = {
   }
 };
 ```
+
+:::
+
+<Badge type="tip" text="Tip" vertical="middle" />
+
+> If your project does not use commitlint, you can use the following configuration items
+
+- `.cz.js`
+- `cz.config.js`
+
+:::details Click to expand cz.config.js complete default configuration template
+
+```js
+// cz.config.js
+/** @type {import('cz-git').CommitizenGitOptions} */
+module.exports = {
+  messages: {
+    type: "Select the type of change that you're committing:",
+    scope: "Denote the SCOPE of this change (optional):",
+    customScope: "Denote the SCOPE of this change:",
+    subject: "Write a SHORT, IMPERATIVE tense description of the change:\n",
+    body: 'Provide a LONGER description of the change (optional). Use "|" to break new line:\n',
+    breaking: 'List any BREAKING CHANGES (optional). Use "|" to break new line:\n',
+    footerPrefixsSelect: "Select the ISSUES type of changeList by this change (optional):",
+    customFooterPrefixs: "Input ISSUES prefix:",
+    footer: "List any ISSUES by this change. E.g.: #31, #34:\n",
+    confirmCommit: "Are you sure you want to proceed with the commit above?"
+  },
+  types: [
+    { value: "feat", name: "feat:     A new feature", emoji: ":sparkles:" },
+    { value: "fix", name: "fix:      A bug fix", emoji: ":bug:" },
+    { value: "docs", name: "docs:     Documentation only changes", emoji: ":memo:" },
+    { value: "style", name: "style:    Changes that do not affect the meaning of the code", emoji: ":lipstick:" },
+    { value: "refactor", name: "refactor: A code change that neither fixes a bug nor adds a feature", emoji: ":recycle:" },
+    { value: "perf", name: "perf:     A code change that improves performance", emoji: ":zap:" },
+    { value: "test", name: "test:     Adding missing tests or correcting existing tests", emoji: ":white_check_mark:" },
+    { value: "build", name: "build:    Changes that affect the build system or external dependencies", emoji: ":package:" },
+    { value: "ci", name: "ci:       Changes to our CI configuration files and scripts", emoji: ":ferris_wheel:" },
+    { value: "chore", name: "chore:    Other changes that don't modify src or test files", emoji: ":hammer:" },
+    { value: "revert", name: "revert:   Reverts a previous commit", emoji: ":rewind:" }
+  ],
+  useEmoji: false,
+  themeColorCode: "",
+  scopes: [],
+  allowCustomScopes: true,
+  allowEmptyScopes: true,
+  customScopesAlign: "bottom",
+  customScopesAlias: "custom",
+  emptyScopesAlias: "empty",
+  upperCaseSubject: false,
+  allowBreakingChanges: ['feat', 'fix'],
+  breaklineNumber: 100,
+  breaklineChar: "|",
+  skipQuestions: [],
+  issuePrefixs: [{ value: "closed", name: "closed:   ISSUES has been processed" }],
+  customIssuePrefixsAlign: "top",
+  emptyIssuePrefixsAlias: "skip",
+  customIssuePrefixsAlias: "custom",
+  allowCustomIssuePrefixs: true,
+  allowEmptyIssuePrefixs: true,
+  confirmColorize: true,
+  maxHeaderLength: Infinity,
+  maxSubjectLength: Infinity,
+  minSubjectLength: 0,
+  scopeOverrides: undefined,
+  defaultBody: "",
+  defaultIssues: "",
+  defaultScope: "",
+  defaultSubject: ""
+};
+```
+
 :::
 
+<Badge type="tip" text="Tip" vertical="middle" /> You can also optionally custom configuration file path in package.json
+
+```json{8}
+{
+  "scripts": {
+    "commit": "git cz"
+  },
+  "config": {
+    "commitizen": {
+      "path": "node_modules/cz-git",
+      "czConfig": "./config/cz.config.js"
+    }
+  }
+}
+```
+
 ## Emoji template
 
 ::: details Click to expand .commitlintrc.js complete emoji template template

docs/guide/option-engineer.md

@@ -23,13 +23,19 @@ If you define a `scope-enum` using the [commitlint](https://github.com/conventio
 - **description** : After customizing a specific **type**, **override module scope** command line display information
 - **type** : <br>`{ [type: string]: string[] | Array<{ name: string, value?: string }> } | undefined`
 - **default** : `undefined`
-- **example** : `scopeOverrides: { "test": ['e2eTest, 'unitTest'] }`
+- **example** : `scopeOverrides: { "test": ["e2eTest", "unitTest"] }`
 - **use** : Displays custom module scope selection when selecting module scope after selecting ==specific== commit **type** : `type`
 
 :::tip
 If you define `scopeOverrides` then define generic `scopes`
 :::
 
+## scopeFilters
+
+- **description** : Filter select of prompt to select module scopes by the scope.value
+- **type** : string[]
+- **default** : `[".DS_Store"]`
+
 ## enableMultipleScopes
 
 - **description** : Whether to enable the use of **multiple scopes mode**
@@ -72,7 +78,7 @@ It will automatically detect whether the definition of the [commitlint](https://
 
 - **description** : a specific **type** that allows BREAKING CHANGES
 - **type** : `string[]`
-- **default** : `['feat', 'fix']`
+- **default** : `["feat", "fix"]`
 
 ## upperCaseSubject
 

docs/guide/options-show.md

@@ -104,21 +104,27 @@ Try running `emoji=1 cz` to **enable output emoji mode in the current session**
 
 ---
 
+<br/>
+<br/>
+<br/>
+
 :::tip
 Using ==default value== can produce many ways to make the tool more suitable for you or your team's habits, [⇒ see the recipes](/guide/recipes.html#default)
 :::
 
+## defaultType
+
+- **description** : pin type item the top of the types list (match item value)
+- **type** : `string`
+- **default** : `""`
+
 ## defaultScope
 
 - **description** : Whether to use display default value in **custom scope**
 - **type** : `string`
 - **default** : `""`
 - **use** : when you want the default value to appear on the command line just press the "Enter" key
-
-:::tip
-If `defaultScope` matches the scope list item `value`.
-It will be pinned to the top of scope list.
-:::
+<Badge type="tip" text="Tip" vertical="middle" /> pin scope item the top of the scope list (match item value)
 
 ## defaultSubject
 

docs/guide/recipes.md

@@ -152,7 +152,7 @@ module.exports = {
 };
 ```
 
-![demo-gif](https://user-images.githubusercontent.com/40693636/169853818-a13ab13a-3b2d-4386-a833-2f3558b2c138.gif)
+![demo-gif](https://user-images.githubusercontent.com/40693636/170404847-bc1a76d5-f7bb-4ec6-9c1f-5476ba7fceee.gif)
 
 <br>
 <br>
@@ -166,7 +166,9 @@ module.exports = {
   - Then we use `defaultIssues`
   - When using, we only need to press the ==\<Enter\>== key to output the `Issue Number`, so that we can easily intercept the `Issue Number` to reduce repetitive work.
 
-- <Badge type="tip" text="Tip" vertical="middle" /> Of course, we can also combine the `customIssuePrefixsAlign` configuration item to dynamically change the position of the issue prefix option.
+<Badge type="tip" text="Tip" vertical="middle" /> 
+
+We can also combine the `customIssuePrefixsAlign` configuration item to dynamically change the position of the issue prefix option.
 
 ```js{5-8,13-14}
 // .commitlintrc.js 

docs/guide/why.md

@@ -25,7 +25,7 @@ $ npm i -D cz-conventional-changelog
 added 147 packages in 21s
 
 $ npm install -D cz-git
-added 1 package in 0.47s
+added 1 package in 0.461s
 ```
 
 ---
@@ -37,5 +37,5 @@ added 1 package in 0.47s
 ```sh{3}
 $ du -sh node_modules/*
 148 MB	node_modules/git-cz
-1.8 MB	node_modules/cz-git
+1.7 MB	node_modules/cz-git
 ```

docs/zh/guide/README.md

@@ -64,8 +64,8 @@ sitemap:
 
 ```bash
 $ npm install -D cz-git
-+ cz-git          (1.8 MB)
-added 1 package in 0.47s
++ cz-git          (1.7 MB)
+added 1 package in 0.461s
 ```
 
 [⇒ 为什么是 cz-git](/zh/guide/why.html)