10.0.5: parseCommits is not a function

[mattfelten]

"@release-it/conventional-changelog": "^10.0.5",
"release-it": "^19.2.4"

import type { Config } from "release-it";

export default {
  npm: {
    publish: false,
  },
  git: {
    commitMessage: "chore: release v${version}",
    push: false,
    requireBranch: "main",
    requireCleanWorkingDir: true,
  },
  plugins: {
    "@release-it/conventional-changelog": {
      infile: "CHANGELOG.md",
      preset: {
        name: "conventionalcommits",
      },
    },
  },
} satisfies Config;

I tried with and without the conventional-changelog-conventionalcommits override also.

Output looks like this:

❯ npx release-it --dry-run
$ git rev-parse --abbrev-ref HEAD
$ git rev-parse --abbrev-ref HEAD  [cached]
$ git config --get branch.main.remote
$ git remote get-url origin
! git fetch
$ git rev-parse --abbrev-ref HEAD  [cached]
$ git describe --tags --match=* --abbrev=0
$ git symbolic-ref HEAD
$ git for-each-ref --format="%(upstream:short)" refs/heads/main
ERROR parseCommits is not a function

[aarondpn]

Thanks for reporting this. I've been investigating but haven't been able to reproduce the issue with a clean install using your exact versions (release-it@19.2.4, @release-it/conventional-changelog@10.0.5) — tested with both npm and pnpm.

The error parseCommits is not a function originates in @conventional-changelog/git-client, which dynamically imports conventional-commits-parser. The parseCommits named export only exists in v6.x+ of that package. If v5.x gets resolved instead, parseCommits would be undefined, causing this error.

Could you provide the following so we can narrow this down?

1. Package manager and version — are you using npm, yarn, or pnpm? (npm --version / yarn --version / pnpm --version)
2. Node.js version — node --version
3. Dependency tree for the parser — npm ls conventional-commits-parser (or pnpm ls conventional-commits-parser / yarn why conventional-commits-parser)
4. Are you in a monorepo? If so, which tool (npm workspaces, turborepo, nx, etc.)?
5. Do you have any other dependencies in your project that depend on conventional-commits-parser or other conventional-changelog packages?
6. Were you on a previous version of this plugin that worked? If so, which version?

[emersonpgomes]

Thanks @aarondpn! I had the same problem as @mattfelten. But in my case, I found it was a conflict with the @commitlint/cli dependency. It worked after updating.

❯ npm ls conventional-commits-parser
[REDACTED]
├─┬ @commitlint/cli@19.8.1
│ └─┬ @commitlint/lint@19.8.1
│   └─┬ @commitlint/parse@19.8.1
│     └── conventional-commits-parser@5.0.0 deduped invalid: "^6.1.0" from node_modules/@conventional-changelog/git-client
└─┬ @release-it/conventional-changelog@10.0.5
  ├─┬ @conventional-changelog/git-client@2.5.1
  │ └── conventional-commits-parser@5.0.0 invalid: "^6.1.0" from node_modules/@conventional-changelog/git-client
  ├─┬ conventional-changelog@7.1.1
  │ └── conventional-commits-parser@6.2.1
  └─┬ conventional-recommended-bump@11.2.0
    └── conventional-commits-parser@6.2.1

It's worth noting that I have the legacy-peer-deps=true setting in the .npmrc file.