commitizen / commitizen/cz-cli

[Feature] combination of "cz-conventional-changelog" with "@commitlint/prompt"

オープン
#593 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
JavaScript
スター
17.5k
フォーク
566
平均マージ
8時間 16分
マージ済み PR(30日)
1

説明

## Question

> How to use "cz-conventional-changelog" and "@commitlint/prompt" together?

See details from https://github.com/marionebl/commitlint/issues/512

## Current configuration confliction

Default to
```js
...
"config": {
"commitizen": {
"path": "cz-conventional-changelog"
}
}
```

`commitizen` provides us with a way to automatically generate the changelog. However, it prompt is not convenient when used in daily work. I prefer to use a commitment adaptor like the following

```js
"config": {
"commitizen": {
"path": "@commitlint/prompt"
}
}
```

## Expected Behavior

```js

"config": {
"commitizen": {
"path": ["cz-conventional-changelog","@commitlint/prompt"]
}
}
```

## Current behavior

```bash
➜ topology git:(master) ✗ npm run git:commit

> nio_hdmap_topology@1.0.0 git:commit /Users/lei.wang1/Github/nio-common/topology
> git-cz && ./node_modules/validate-commit-msg/lib/cli.js

The "path" argument must be of type string. Received type object
```

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

まず commitizen の設定におけるパス処理を読み、レポートに示されている git-cz コマンドを再現します。次に、互換性の背景を確認するため、リンクされている commitlint issue を確認します。cz-conventional-changelog と @commitlint/prompt を組み合わせてもパス型エラーが発生せず、意図した毎日の prompt ワークフローが維持される設定にできれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
javascript, nodejs
領域
cli
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。