commitizen / commitizen/cz-cli
Bootstrap and custom plugin configuration
- 主要言語
- JavaScript
- スター
- 17.5k
- フォーク
- 566
- 平均マージ
- 8時間 16分
- マージ済み PR(30日)
- 1
説明
Hi everyone.
Our company is using commitizen for one of our main OSS project but we slowly started using it in smaller projects and tools.
We now require a standard commitizen configuration in order to keep all projects the same way.
Our current solution has a lot of configs and is not working very well for us.
For context we are using:
- Commitizen
- cz-customizable
- validate-commit-msg
Each of this packages has it's own config. for sake of conventions I've started creating our own tool to manage commits (an adapter of comitizen) the goal is to keep all the configuration hidden for the end user as much as possible.
I've seen the `bootstrap` and as far as I can see in the code this are the options you can give:
```js
debug: false,
cliPath: path.join(__dirname, '../node_modules/commitizen'),
config: {
"path": "cz-customizable"
}
```
Now my current problem. `cz-customizable` right now reads from a config file specified in the package json.
I think bootstrap should be able to send all this configuration options to the adapter, but right now the project only uses the path and instances the prompter.
I was thinking on something like:
```js
function getPrompter(adapterConfig) {
var resolvedAdapterPath = resolveAdapterPath(adapterConfig.path);
var adapter = require(resolvedAdapterPath)(adapterConfig);
}
```
or
```js
function getPrompter(adapterPath, adapterConfig) {
var resolvedAdapterPath = resolveAdapterPath(adapterPath);
var adapter = require(resolvedAdapterPath);
if (adapterConfig && adapter && adapter.setConfig && (0, _util.isFunction)(adapter.setConfig)) {
adapter.setConfig(adapterConfig)
}
}
```
First one breaks all the current adapters, so I understand no one is eager to do that.
The second one works without breaking anything since I think most of the adapters do not require a config?
What do you think about it? is something you will like to see for adapters?
Or maybe I should create my own adapter for the company? I was thinking on this because `cz-customizable` has all we need, but it lack the ability to get config from bootstrap
コントリビューションガイド
調査の方向性
この issue は bootstrap と getPrompter の adapter-loading パスを中心としています。まず、bootstrap が現在どのように設定を渡しているか、またアダプターがどのようにインスタンス化されているかを追跡します。完了条件は、bootstrap の設定をアダプターに到達させる後方互換性のある方法を定義し、既存のアダプターと cz-customizable について期待される動作の合意を得ることです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- javascript, node.js
- 領域
- cli, tooling
- issue の種類
- 機能追加
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 30/100