feat: add CJS export for cz-commitlint

[frantic1048]

resolves #3949

Description

Motivation and Context

Currently comittizen does not support ESM adapter, this PR add additional CJS export for @commitlint/cz-commitlint, which allows comittizen to work with it.

#3850 (comment)

Usage examples

This PR does not change usage.

How Has This Been Tested?

package.json

{
  "config": {
    "commitizen": {
      "path": "@commitlint/cz-commitlint"
    }
  },
}

Install new @commitlint/cz-commitlint and run commitizen:

pnpm add -D https://pkg.csb.dev/conventional-changelog/commitlint/commit/a6401ba0/@commitlint/cz-commitlint
pnpm exec cz # works

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my changes.
• All new and existing tests passed.

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

[JounQin]

commitlint/.eslintrc.cjs

Line 40 in 67baff9

files: ['*.ts'],

This line should change to files: ['*.cts', '*.ts'],

[JounQin]

I was thinking to use typeof import('./index.js') but I found there was a TypeScript error (I believe it's a bug), but considering this, I'm thinking to use <packageDir>/index.cjs which is plain js instead.

Basically it should be await import('./lib/index.js')

@frantic1048 How do you think?

[frantic1048]

Yes, that's weird and I'm trying to use cjs to workaround this.

I was thinking to use typeof import('./index.js') but I found there was a TypeScript error

[knocte]

CI is broken

[frantic1048]

The error from the tests appears to be related to vitest-dev/vitest#3987 🤔

[JounQin]

@frantic1048

We can bypass that issue easily.

#3963 (comment)

[escapedcat]

🚀

[frantic1048]

Checking the outupt: https://ci.codesandbox.io/status/conventional-changelog/commitlint/pr/3963/builds/482116, it appears the build is not containing index.cjs in output, the build related config may required to be updated to properly pack the package.

npm notice package: @commitlint/[email protected]
npm notice === Tarball Contents === 
npm notice 1.6kB README.md                                  
npm notice 464B  lib/index.d.ts                             
npm notice 372B  lib/index.d.ts.map                         
npm notice 451B  lib/index.js                               
npm notice 407B  lib/index.js.map                           
npm notice 335B  lib/Process.d.ts                           
npm notice 390B  lib/Process.d.ts.map                       
npm notice 948B  lib/Process.js                             
npm notice 965B  lib/Process.js.map                         

[frantic1048]

@escapedcat, oh, the merge may have been too hasty. I'm testing the built package and have found an issue with the build configuration. 😮

[escapedcat]

Ah sorry :D
Won't release anything for now

[JounQin]

I meant to have .cjs at <packageDir>/index.cjs, and add it into files field in package.json.