commitizen / commitizen/cz-cli

Bootstrap and custom plugin configuration

Abierto
#438 6 comentarios 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
JavaScript
Estrellas
17.5k
Forks
566
Merge medio
8 h 16 min
PR fusionados (30 d)
1

Descripción

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

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

El issue se centra en bootstrap y en la ruta de carga de adaptadores de getPrompter; empieza trazando cómo bootstrap pasa actualmente la configuración y cómo se instancian los adaptadores. Se considerará terminado cuando se defina una forma retrocompatible de hacer llegar la configuración de bootstrap a los adaptadores, con el comportamiento esperado acordado para los adaptadores existentes y cz-customizable.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
javascript, node.js
Área
cli, tooling
Tipo de issue
Nueva funcionalidad
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
30/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.