conventional-changelog/commitlint

fix: dependencies tree for typing needs fine-tunning

已关闭

#4,107 创建于 2024年7月28日

在 GitHub 查看贡献者指南
 (2 条评论) (0 个反应) (0 位负责人)TypeScript (896 个派生)batch import
bughelp wanted

仓库指标

星标
 (15,497 个星标)
PR 合并指标
 (平均合并 12小时 56分钟) (30 天内合并 52 个 PR)

描述

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

贡献者指南

研究方向
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.
技术栈
typescript
领域
tooling
议题类型
缺陷
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
新近可参与
清晰度议题是否清楚说明期望改动、验收标准和下一步。
基本清晰
前置要求
TypeScriptnpm package management
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
40