commitizen / commitizen/cz-cli
[Config loader] check if config key is in package.json before accepting it as a config file
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- JavaScript
- Estrelas
- 17.5k
- Forks
- 566
- Merge médio
- 8h 16min
- PRs com merge (30d)
- 1
Descrição
Hello,
I'm working on a monorepo with backend and frontend and a `.czrc` at the directory's root to enforce commit rules with commitizen.
All frontend-related files are in a subdirectory, including the `package.json` file at different filesystem levels.
**My issue**: In a subdirectory with a package.json between `pwd` and git repository root, `commitizen` seems to acknowledge this file as a configuration file despite the lack of `config.commitizen` key.
**Fix proposal**: There seems to be a mechanism to check the package.json has a commitizen configuration, but it is commented: https://github.com/commitizen/cz-cli/blob/2e57fd02a5fd2b2dcf89d3235a6956edaeaf672c/src/configLoader/loader.js#L30-L36
I tried to uncomment it in a local version of commitizen, and it works as expected.
Would it be possible to uncomment it or does it have unwanted side effects?
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece em src/configLoader/loader.js, nas linhas 30-36, onde está localizada a verificação comentada da configuração de package.json. Rastreie como os arquivos de configuração são descobertos a partir de um subdiretório em direção à raiz do repositório e verifique o comportamento com e sem uma chave config.commitizen. Considera-se concluído quando package.json é aceito somente se declarar essa chave, sem quebrar outras fontes de configuração.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- javascript, node.js
- Domínio
- cli, tooling
- Tipo de issue
- Bug
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 35/100