commitizen / commitizen/cz-cli

Bootstrap and custom plugin configuration

Aperta
#438 6 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
JavaScript
Stelle
17.5k
Fork
566
Merge medio
8h 16m
PR unite (30g)
1

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

La issue riguarda bootstrap e il percorso di caricamento degli adattatori di getPrompter; inizia tracciando il modo in cui bootstrap passa attualmente la configurazione e il modo in cui vengono istanziati gli adattatori. Il lavoro sarà completato quando sarà definito un modo retrocompatibile per far arrivare la configurazione di bootstrap agli adattatori, con il comportamento atteso concordato per gli adattatori esistenti e cz-customizable.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript, node.js
Ambito
cli, tooling
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
30/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.