conventional-changelog/commitlint

fix: dependencies tree for typing needs fine-tunning

Chiusa

#4107 aperta il 28 lug 2024

Vedi su GitHubGuida contributor
 (2 commenti) (0 reazioni) (0 assegnatari)TypeScript (896 fork)batch import
bughelp wanted

Metriche repository

Star
 (15.497 stelle)
Metriche merge PR
 (Merge medio 12h 56m) (52 PR mergiate in 30 g)

Descrizione

Steps to Reproduce

  1. In a new typescript project install the following:

typescript@latest @commitlint/cli@19.3.0 conventional-commits-parser@6.0.0

  1. import conventional-commits-parser and notice how the types are missing

Current Behavior

When Installing @commitlint/cli@19.3.0 @commitlint/types@19.0.3 is also installed

https://github.com/conventional-changelog/commitlint/blob/master/%40commitlint/cli/package.json#L55C6-L55C23

Which breaks typing when conventional-commits-parser@6.0.0 is installed.

typescript will complain about commit parser having no exported member 'CommitParser' import { CommitParser } from "conventional-commits-parser";

https://github.com/conventional-changelog/conventional-changelog/blob/d3b8aaa16337993bbad4d91db1ffac5a7568756b/packages/conventional-commits-parser/src/CommitParser.ts#L42

Expected Behavior

Installing @commitlint/cli & conventional-commits-parser should result in the correct typings

Affected packages

  • cli
  • core
  • prompt
  • config-angular

Possible Solution

No response

Context

No response

commitlint --version

@commitlint/cli@19.3.0

git --version

2.41.0

node --version

22.4.0

Guida contributor

Direzione di ricerca
Investigate the type resolution issue between @commitlint/types and conventional commits parser. Look at the package.json of @commitlint/cli and how it depends on @commitlint/types. Check the types mentioned in the issue: CommitParser export from conventional commits parser. The fix likely involves adjusting the type exports or ensuring correct version alignment. The issue references specific lines in the commitlint and conventional changelog repositories. Review the linked files to understand the dependency tree.
Tech stack
typescript
Dominio
tooling
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
TypeScriptnpm package management
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40