docs: Instructions for filtering nx projects are out of date

Question

docs: Instructions for filtering nx projects are out of date

jaytavares opened this issue 2 months ago · comments

Steps to Reproduce

1. Use @commitlint/config-nx-scopes
2. Follow [filtering projects instructions in docs](https://github.com/conventional-changelog/commitlint/blob/0288c6129200f5e1f469e71babbfd4fd5885f6be/%40commitlint/config-nx-scopes/readme.md#filtering-projects)

Current Behavior

Error at commit time:

require() of ES Module /Users/[...]/node_modules/@commitlint/config-nx-scopes/index.js from /Users/[...]/.commitlintrc.js not supported.
Instead change the require of index.js in /Users/[...]/.commitlintrc.js to a dynamic import() which is available in all CommonJS modules.

Expected Behavior

Commitlint should execute successfully.

Affected packages

cli
core
prompt
config-angular

Possible Solution

Update documentation to indicate proper usage. PR forthcoming...

Context

No response

commitlint --version

@commitlint/cli@19.2.2

git --version

v2.39.3

node --version

v18.19.1