Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(cz-git): provide config file type helper fn defineConfig and definePrompt #196

Merged
merged 6 commits into from
Oct 30, 2024
Merged

feat(cz-git): provide config file type helper fn defineConfig and definePrompt #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6ecf9d5
feat(cz-git): provide config file type helper fn `defineConfig` and `…
Zhengqbbb Oct 30, 2024
39663fd
Merge branch 'main' into feat/export-defind-config-fn_193
Zhengqbbb Oct 30, 2024
ab9e7a5
feat(cli): move CLI enter file for import types helper fn
Zhengqbbb Oct 30, 2024
54d941b
docs: template config replace types helper fn
Zhengqbbb Oct 30, 2024
a056c28
build(cz-git,cli): add esm import enter for types helper fn
Zhengqbbb Oct 30, 2024
61a3af6
build(cz-git,cli): add esm import enter for types helper fn
Zhengqbbb Oct 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/.vitepress/theme/style/main.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,12 +286,13 @@ img.error::after {

.code-group .code-group__nav {
margin-top: 0.85rem;
margin-bottom: calc(-1.7rem - 6px);
margin-bottom: calc(-1.6rem - 6px);
padding-bottom: calc(1.7rem - 10px);
padding-left: 10px;
padding-top: 10px;
border-top-left-radius: 6px;
border-top-right-radius: 6px;
border-bottom: 1px solid var(--vp-code-block-border);
background-color: var(--vp-code-block-bg);
}

Expand Down
2 changes: 2 additions & 0 deletions docs/.vitepress/theme/style/vars.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
--vp-custom-block-danger-text: rgb(196, 46, 46);
--vp-custom-block-danger-text-deep: rgba(220, 38, 38, 1);
--vp-code-block-bg: rgba(232, 232, 232, 0.3);
--vp-code-block-border: rgba(232, 232, 232, 1);
--vp-term-block-bg: hsl(0, 1%, 92%);
--vp-c-text-dark-1: rgb(240, 238, 238);
--vp-c-text-dark-3: rgb(111, 111, 111);
Expand Down Expand Up @@ -80,6 +81,7 @@
--vp-custom-block-danger-text: rgba(248, 113, 113, 1);
--vp-custom-block-danger-text-deep: rgba(248, 113, 113, 1);
--vp-code-block-bg: rgba(0, 0, 0, 0.3);
--vp-code-block-border: rgba(0, 0, 0);
--vp-term-block-bg: hsl(0, 1%, 5%);
--vp-c-gutter: rgba(84, 84, 84, .48);
--vp-code-line-highlight-color: rgba(0, 0, 0, 0.5);
Expand Down
7 changes: 4 additions & 3 deletions docs/cli/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,12 @@ e.g `czg --config="./config/cz.js"`

```js
// config/cz.js
/** @type {import('czg').UserConfig['prompt']} */
module.exports = {
const { definePrompt } = require('czg')

module.exports = definePrompt({
maxSubjectLength: 100
// configure ...
}
})
```

:::tip
Expand Down
54 changes: 44 additions & 10 deletions docs/cli/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,24 +54,58 @@ const v = site.value.themeConfig.nav?.[4]?.text.slice(1)
}
```

:::tip
If you want to write JavaScript configuration, can add `@type` to file
:::::tip
If you want to write JavaScript configuration, can import helper functions from `czg` or add `@type` to file

:::: code-group
::: code-group-item cz.config.js
```js
// .commitlintrc.cjs
/** @type {import('czg').UserConfig} */
const { definePrompt } = require('czg')

module.exports = definePrompt({
scopes: ['hello', 'world'],
})
```
:::
::: code-group-item cz.config.js
```js
/** @type {import('czg').UserConfig['prompt']} */
module.exports = {
rules: {
// @see: https://commitlint.js.org/#/reference-rules
},
prompt: {
scopes: ['hello', 'world'],
},
}
```
:::
::: code-group-item commitlint.config.js
```js
const { defineConfig } = require('czg')

module.exports = defineConfig({
rules: {
// @see: https://commitlint.js.org/#/reference-rules
},
prompt: {
scopes: ['hello', 'world'],
},
})
```
:::
::: code-group-item commitlint.config.js
```js
/** @type {import('czg').UserConfig} */
module.exports = {
rules: {
// @see: https://commitlint.js.org/#/reference-rules
},
prompt: {
scopes: ['hello', 'world'],
},
}
```
:::
::::

More information about configure file and options. See → [Config](/config/)
:::
:::::


## Features and Help
Expand Down
Loading
Loading