conventional-changelog / commitlint

📓 Lint commit messages
https://commitlint.js.org
MIT License
16.93k stars 912 forks source link

fix: dependencies tree for typing needs fine-tunning #4107

Open eladchen opened 4 months ago

eladchen commented 4 months ago

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

  2. 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

Possible Solution

No response

Context

No response

commitlint --version

@commitlint/cli@19.3.0

git --version

2.41.0

node --version

22.4.0

eladchen commented 4 months ago

The workaround I'm using is to add the below entry to the tsconfig file

"paths": {
      "conventional-commits-parser": [
        "node_modules/conventional-commits-parser/dist"
      ]
},
escapedcat commented 4 months ago

The PR to support v6 is still open: #4064
Happy for help