conventional-changelog/commitlint

fix: dependencies tree for typing needs fine-tunning

Fermée

#4 107 ouverte le 28 juil. 2024

Voir sur GitHubGuide contributeur
 (2 commentaires) (0 réaction) (0 personne assignée)TypeScript (896 forks)batch import
bughelp wanted

Métriques du dépôt

Stars
 (15 497 étoiles)
Métriques de merge PR
 (Merge moyen 12h 56m) (52 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
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.
Stack technique
typescript
Domaine
tooling
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
TypeScriptnpm package management
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40