diff --git a/docs/cli/config.md b/docs/cli/config.md index 38772a182..974c8e763 100644 --- a/docs/cli/config.md +++ b/docs/cli/config.md @@ -33,7 +33,7 @@ e.g `czg --config="./config/cz.js"` ```js // config/cz.js -/** @type {import('czg').CommitizenGitOptions} */ +/** @type {import('czg').UserConfig['prompt']} */ module.exports = { maxSubjectLength: 100 // configure ... diff --git a/docs/config/index.md b/docs/config/index.md index 3efc7a80d..15acba1bb 100644 --- a/docs/config/index.md +++ b/docs/config/index.md @@ -97,7 +97,7 @@ module.exports = { ```js // cz.config.js -/** @type {import('cz-git').CommitizenGitOptions} */ +/** @type {import('cz-git').UserConfig['prompt']} */ module.exports = { alias: { fd: 'docs: fix typos' }, messages: { diff --git a/docs/zh/cli/config.md b/docs/zh/cli/config.md index c7fc0268d..9d2717e15 100644 --- a/docs/zh/cli/config.md +++ b/docs/zh/cli/config.md @@ -33,7 +33,7 @@ const v = site.value.themeConfig.nav?.[4]?.text.slice(1) ```js // config/cz.js -/** @type {import('czg').CommitizenGitOptions} */ +/** @type {import('czg').UserConfig['prompt']} */ module.exports = { maxSubjectLength: 100 // 配置 ... diff --git a/docs/zh/config/index.md b/docs/zh/config/index.md index 8d19f974a..5e229f5ef 100644 --- a/docs/zh/config/index.md +++ b/docs/zh/config/index.md @@ -97,7 +97,7 @@ module.exports = { ```js // cz.config.js -/** @type {import('cz-git').CommitizenGitOptions} */ +/** @type {import('cz-git').UserConfig['prompt']} */ module.exports = { alias: { fd: 'docs: fix typos' }, messages: { diff --git a/packages/cli/package.json b/packages/cli/package.json index eed042b6a..5d3941ae1 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -29,7 +29,7 @@ "./package.json": "./package.json" }, "main": "lib/index.js", - "types": "lib/config.d.ts", + "types": "lib/index.d.ts", "bin": { "czg": "bin/index.js", "git-czg": "bin/index.js" diff --git a/packages/cli/tsup.config.ts b/packages/cli/tsup.config.ts index f80d297be..447097df8 100644 --- a/packages/cli/tsup.config.ts +++ b/packages/cli/tsup.config.ts @@ -2,8 +2,16 @@ import { defineConfig } from 'tsup' import baseConfig from '../../tsup.config' export default defineConfig((opts) => { - return Object.assign({}, baseConfig, { - dts: './src/shared/types/config.ts', - minify: !opts.watch, - }) + return [ + { + ...baseConfig, + dts: false, + minify: !opts.watch, + }, + { + entry: { index: './src/shared/types/config.ts' }, + outDir: './lib', + dts: { only: true }, + }, + ] }) diff --git a/packages/cz-git/src/shared/types/options.ts b/packages/cz-git/src/shared/types/options.ts index bec958476..73a2863fc 100644 --- a/packages/cz-git/src/shared/types/options.ts +++ b/packages/cz-git/src/shared/types/options.ts @@ -7,7 +7,9 @@ import type { QuestionsType } from '../../generator' import type { CommitlintUserConfig } from './commitlint' +/** cz-git + commitlint configure */ export interface UserConfig extends CommitlintUserConfig { + /** cz-git configure */ prompt?: CommitizenGitOptions } @@ -167,6 +169,7 @@ export interface GenerateAIPromptType { diff?: string } +/** cz-git configure */ export interface CommitizenGitOptions { /** * @description: define commonly used commit message alias