Can't run commitlint on project with tsconfig.json #3256

baby-gnu · 2022-06-27T10:02:02Z

When running commitlint on a typeScript project, I have an error because commitlint use the project tsconfig.json.

Expected Behavior

commitlint should not use the project typeScript configuration.

Current Behavior

commitlint produce the following traceback:

/usr/local/lib/node_modules/commitlint/node_modules/ts-node/src/index.ts:843
    return new TSError(diagnosticText, diagnosticCodes, diagnostics);
           ^
TSError: ⨯ Unable to compile TypeScript:
error TS6053: File '@loopback/build/config/tsconfig.common.json' not found.

    at createTSError (/usr/local/lib/node_modules/commitlint/node_modules/ts-node/src/index.ts:843:12)
    at reportTSError (/usr/local/lib/node_modules/commitlint/node_modules/ts-node/src/index.ts:847:19)
    at createFromPreloadedConfig (/usr/local/lib/node_modules/commitlint/node_modules/ts-node/src/index.ts:858:36)
    at create (/usr/local/lib/node_modules/commitlint/node_modules/ts-node/src/index.ts:613:10)
    at register (/usr/local/lib/node_modules/commitlint/node_modules/ts-node/src/index.ts:580:15)
    at TypeScriptLoader (/usr/local/lib/node_modules/commitlint/node_modules/cosmiconfig-typescript-loader/dist/loader.js:7:51)
    at loadConfig (/usr/local/lib/node_modules/commitlint/node_modules/@commitlint/load/src/utils/load-config.ts:35:27)
    at load (/usr/local/lib/node_modules/commitlint/node_modules/@commitlint/load/src/load.ts:25:33)
    at main (/usr/local/lib/node_modules/commitlint/node_modules/@commitlint/cli/src/cli.ts:199:27)
    at processTicksAndRejections (node:internal/process/task_queues:95:5) {
  diagnosticCodes: [ 6053 ]
}

Affected packages

cli
core
prompt
config-angular

Possible Solution

Steps to Reproduce (for bugs)

clone the repository https://gitlab.mim-libre.fr/alphabet/laboite-blog-api.git
execute commitlint --from HEAD~2 --to HEAD

commitlint.config.js

module.exports = {
  extends: ['@commitlint/config-conventional'],
  rules: {
    'body-max-line-length': [2, 'always', 120],
    'footer-max-line-length': [2, 'always', 120],
    'header-max-length': [2, 'always', 72],
  },
};

Context

We upgraded our commitlint container for our CI and now all typeScript project are failling.

Your Environment

Executable	Version
`commitlint --version`	16.3.0
`git --version`	2.36.1
`node --version`	18.4.0

The text was updated successfully, but these errors were encountered:

baby-gnu · 2022-06-27T10:07:08Z

I tested with latest @commitlint/[email protected] to be sure and I have the same problem.

Regards.

escapedcat · 2022-06-27T12:42:27Z

Pity, looks like it's somehow picking this up?: https://gitlab.mim-libre.fr/alphabet/laboite-blog-api/-/blob/dev/tsconfig.json#L3
Never had an issue with other projects using tsconfig.

Not sure when we can get to this.

baby-gnu · 2022-06-27T12:46:47Z

Pity, looks like it's somehow picking this up?: https://gitlab.mim-libre.fr/alphabet/laboite-blog-api/-/blob/dev/tsconfig.json#L3 Never had an issue with other projects using tsconfig.

It looks like yes, I'm not sure it's a good idea for commitlint to load the project configuration but I don't know how to prevent that.

baby-gnu · 2022-06-27T13:19:16Z

It looks like yes, I'm not sure it's a good idea for commitlint to load the project configuration but I don't know how to prevent that.

I managed to work around this issue by cd /tmp and execute commitlint --cwd /my/sources

…onfiguration **@commitlint/cli** added support for TypeScript-based configurations via `ts-node`, and that has caused a good deal of grief: conventional-changelog/commitlint#3420 conventional-changelog/commitlint#3351 conventional-changelog/commitlint#3218 conventional-changelog/commitlint#3256 hoverinc/web-react#1792 Both because it's a heavy-ass dependency and because it requires configuration to work properly. It seems like project-local configuration can affect it's invocation of ts-node, which happens even JavaScript configuration files now?... lame. Anyways, this ensures we avoid any type-checking that happens in it's ts-node invocation until we get a better solution upstream (or contribute one). Ideally, installing ts-node would be opt-in etc.

soullivaneuh · 2023-03-08T22:43:53Z

I got a similar issue running commitlint on a GitLab CI job.

Here is the Dockerfile of my commitlint command:

FROM node:18.14-alpine
RUN apk add --no-cache git~=2 \
&& npm install --global @commitlint/[email protected] @commitlint/[email protected]
# Contains only commitlint.config.js
COPY rootfs /
USER node
ENTRYPOINT [ "commitlint", "--strict", "--config", "/commitlint.config.js" ]

The related CI job:

release:commitlint:
  stage: release
  needs: []
  image:
    name: registry.gitlab.com/company/images/commitlint
    entrypoint: ['']
  script:
    - git config --global --add safe.directory ${CI_PROJECT_DIR}
    - git fetch --quiet origin ${CI_MERGE_REQUEST_TARGET_BRANCH_NAME}
    - npx commitlint --version
    - npx commitlint --strict --config /commitlint.config.js --from=origin/${CI_MERGE_REQUEST_TARGET_BRANCH_NAME}
  rules:
    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
  allow_failure:
    exit_codes: 2

Works on any of my project excepts the one using tsonfig.json, ending to a similar error.

My workaround was to add a rm -f tsconfig.json just before the commitlint command.

stefanfrede · 2023-03-09T13:14:51Z

I managed to work around this issue by cd /tmp and execute commitlint --cwd /my/sources

@baby-gnu I ~~try to~~ can't wrap my head around how this should work 🤔

ccamel · 2023-04-26T07:36:21Z

🤔 It seems that we suffer from the same problem for the okp4/team-wiki project. The temporary solution was to delete the tsconfig.json file while linting the github action.

TimeCoder · 2023-07-23T21:39:20Z

Just check the encoding of index.ts.
In my case, somehow it was UTF-16. Once I changed it to UTF-8 (in Notepad++) - the problem is gone.

Fierce-Cat · 2023-07-26T09:08:48Z

Just check the encoding of index.ts. In my case, somehow it was UTF-16. Once I changed it to UTF-8 (in Notepad++) - the problem is gone.

I'm getting the same UTF-16 file after following docs https://commitlint.js.org/#/guides-local-setup?id=install-commitlint with command

# Configure commitlint to use conventional config
echo "module.exports = { extends: ['@commitlint/config-conventional'] };" > commitlint.config.js

Error log:

D:\dev\Project\node_modules\.pnpm\[email protected]_@[email protected][email protected]\node_modules\ts-node\src\index.ts:859
    return new TSError(diagnosticText, diagnosticCodes, diagnostics);
           ^
TSError: ⨯ Unable to compile TypeScript:
commitlint.config.js(1,1): error TS1490: File appears to be binary.

The problem is solved after changing the file encoding to UTF-8 manually.

DavidWesley · 2023-07-30T15:46:19Z

Just check the encoding of index.ts. In my case, somehow it was UTF-16. Once I changed it to UTF-8 (in Notepad++) - the problem is gone.

@TimeCoder Can you be a little more specific? Which index.ts file has this problem? I badly need to resolve this conflict

My error message still is:

/home/dwesley/www/node-config-template/node_modules/@commitlint/cli/lib/cli.js:123
        throw err;
        ^

TypeError: value.replace is not a function
    at normalizeSlashes (/home/dwesley/www/node-config-template/node_modules/ts-node/dist/util.js:62:18)
    at Object.getExtendsConfigPath (/home/dwesley/www/node-config-template/node_modules/ts-node/dist/ts-internals.js:24:54)
    at readConfig (/home/dwesley/www/node-config-template/node_modules/ts-node/dist/configuration.js:127:64)
    at findAndReadConfig (/home/dwesley/www/node-config-template/node_modules/ts-node/dist/configuration.js:50:84)
    at create (/home/dwesley/www/node-config-template/node_modules/ts-node/dist/index.js:146:69)
    at register (/home/dwesley/www/node-config-template/node_modules/ts-node/dist/index.js:127:19)
    at TypeScriptLoader (/home/dwesley/www/node-config-template/node_modules/cosmiconfig-typescript-loader/dist/cjs/index.js:52:54)
    at loadConfig (/home/dwesley/www/node-config-template/node_modules/@commitlint/load/lib/utils/load-config.js:12:75)
    at load (/home/dwesley/www/node-config-template/node_modules/@commitlint/load/lib/load.js:19:55)
    at main (/home/dwesley/www/node-config-template/node_modules/@commitlint/cli/lib/cli.js:194:45)

Node.js v18.17.0
husky - commit-msg hook exited with code 1 (error)

shlroland · 2023-08-03T12:26:15Z

Just check the encoding of index.ts. In my case, somehow it was UTF-16. Once I changed it to UTF-8 (in Notepad++) - the problem is gone.

@TimeCoder Can you be a little more specific? Which index.ts file has this problem? I badly need to resolve this conflict

My error message still is:

/home/dwesley/www/node-config-template/node_modules/@commitlint/cli/lib/cli.js:123
        throw err;
        ^

TypeError: value.replace is not a function
    at normalizeSlashes (/home/dwesley/www/node-config-template/node_modules/ts-node/dist/util.js:62:18)
    at Object.getExtendsConfigPath (/home/dwesley/www/node-config-template/node_modules/ts-node/dist/ts-internals.js:24:54)
    at readConfig (/home/dwesley/www/node-config-template/node_modules/ts-node/dist/configuration.js:127:64)
    at findAndReadConfig (/home/dwesley/www/node-config-template/node_modules/ts-node/dist/configuration.js:50:84)
    at create (/home/dwesley/www/node-config-template/node_modules/ts-node/dist/index.js:146:69)
    at register (/home/dwesley/www/node-config-template/node_modules/ts-node/dist/index.js:127:19)
    at TypeScriptLoader (/home/dwesley/www/node-config-template/node_modules/cosmiconfig-typescript-loader/dist/cjs/index.js:52:54)
    at loadConfig (/home/dwesley/www/node-config-template/node_modules/@commitlint/load/lib/utils/load-config.js:12:75)
    at load (/home/dwesley/www/node-config-template/node_modules/@commitlint/load/lib/load.js:19:55)
    at main (/home/dwesley/www/node-config-template/node_modules/@commitlint/cli/lib/cli.js:194:45)

Node.js v18.17.0
husky - commit-msg hook exited with code 1 (error)

When I use the latest array values in my tsconfig/extends, I encounter this error. However, when I change it to a string, the error disappears. Therefore, I believe it's an issue with ts-node not supporting parsing of the latest ts configuration. Perhaps upgrading ts-node version could resolve this problem?

escapedcat · 2023-08-04T01:42:49Z

Perhaps upgrading ts-node version could resolve this problem?

According to the lock-file commitlint is on the latest version?:

ts-node@^10.8.1:
  version "10.9.1"

shlroland · 2023-08-04T03:27:33Z

Perhaps upgrading ts-node version could resolve this problem?

According to the lock-file commitlint is on the latest version?:
ts-node@^10.8.1:
  version "10.9.1"

Unfortunately, ts-node did not solve this problem.TypeStrong/ts-node#2000
ts-node has not had a new release for a year, and its support for TypeScript 5.0 seems to be quite poor. Perhaps it's time to migrate to other libraries, such as @swc/register or sucrase

escapedcat · 2023-08-04T03:39:25Z

Perhaps it's time to migrate to other libraries [...]

Sounds like a good idea. You up for a PR?

escapedcat · 2023-08-10T05:48:09Z

Reopening because of #3641
This will then hopefully be fixed with a new mayor version.
yolo

brc-dd · 2023-10-14T10:22:22Z

Another issue here is why TypeScriptLoader is being init in first place when loading the config does not require it. Most of us are using JS/JSON/YAML based configs. It would probably be better to lazy load that loader here:

commitlint/@commitlint/load/src/utils/load-config.ts

Line 16 in 0281f55

const tsLoader = TypeScriptLoader();

All internal loaders of cosmiconfig are already lazily loaded. Refer this commit - cosmiconfig/cosmiconfig@08ebcd5

This comment was marked as duplicate.

Sign in to view

escapedcat added bug help wanted labels Jul 31, 2022

This comment was marked as duplicate.

Sign in to view

tgallacher mentioned this issue Oct 13, 2022

Fails to run with error: Unable to compile TypeScript error wagoid/commitlint-github-action#560

Closed

This comment was marked as duplicate.

Sign in to view

feanil mentioned this issue Feb 28, 2023

Update standard workflow files. openedx/openedx-backstage#25

Merged

feanil mentioned this issue Mar 7, 2023

Update standard workflow files. openedx/openedx-backstage#26

Merged

escapedcat mentioned this issue Apr 26, 2023

fix: SyntaxError: Invalid or unexpected token. commit-msg run error. #3588

Open

4 tasks

escapedcat pinned this issue Apr 26, 2023

joberstein mentioned this issue Aug 8, 2023

feat(load): Remove dependency on ts-node for @commitlint/load #3633

Merged

7 tasks

escapedcat closed this as completed Aug 9, 2023

escapedcat reopened this Aug 10, 2023

lqc mentioned this issue Oct 2, 2023

Commit hook fails on a project with tsconfig.json alessandrojcm/commitlint-pre-commit-hook#124

Open

brc-dd mentioned this issue Oct 14, 2023

feat: lazy load cosmiconfig-typescript-loader #3694

Merged

7 tasks

brian-smith-tcril mentioned this issue Nov 27, 2023

Update standard workflow files. openedx/paragon#2867

Merged

ybiquitous mentioned this issue Nov 27, 2023

chore(deps-dev): bump the typescript group with 1 update ybiquitous/npm-audit-fix-action#825

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Can't run commitlint on project with tsconfig.json #3256

Can't run commitlint on project with tsconfig.json #3256

baby-gnu commented Jun 27, 2022

baby-gnu commented Jun 27, 2022

escapedcat commented Jun 27, 2022 •

edited

Loading

baby-gnu commented Jun 27, 2022

baby-gnu commented Jun 27, 2022

This comment was marked as duplicate.

This comment was marked as duplicate.

This comment was marked as duplicate.

soullivaneuh commented Mar 8, 2023 •

edited

Loading

stefanfrede commented Mar 9, 2023 •

edited

Loading

ccamel commented Apr 26, 2023

TimeCoder commented Jul 23, 2023

Fierce-Cat commented Jul 26, 2023

DavidWesley commented Jul 30, 2023 •

edited

Loading

shlroland commented Aug 3, 2023

escapedcat commented Aug 4, 2023

shlroland commented Aug 4, 2023

escapedcat commented Aug 4, 2023

escapedcat commented Aug 10, 2023

brc-dd commented Oct 14, 2023 •

edited

Loading

Can't run commitlint on project with tsconfig.json #3256

Can't run commitlint on project with tsconfig.json #3256

Comments

baby-gnu commented Jun 27, 2022

Expected Behavior

Current Behavior

Affected packages

Possible Solution

Steps to Reproduce (for bugs)

Context

Your Environment

baby-gnu commented Jun 27, 2022

escapedcat commented Jun 27, 2022 • edited Loading

baby-gnu commented Jun 27, 2022

baby-gnu commented Jun 27, 2022

This comment was marked as duplicate.

This comment was marked as duplicate.

This comment was marked as duplicate.

soullivaneuh commented Mar 8, 2023 • edited Loading

stefanfrede commented Mar 9, 2023 • edited Loading

ccamel commented Apr 26, 2023

TimeCoder commented Jul 23, 2023

Fierce-Cat commented Jul 26, 2023

DavidWesley commented Jul 30, 2023 • edited Loading

shlroland commented Aug 3, 2023

escapedcat commented Aug 4, 2023

shlroland commented Aug 4, 2023

escapedcat commented Aug 4, 2023

escapedcat commented Aug 10, 2023

brc-dd commented Oct 14, 2023 • edited Loading

escapedcat commented Jun 27, 2022 •

edited

Loading

soullivaneuh commented Mar 8, 2023 •

edited

Loading

stefanfrede commented Mar 9, 2023 •

edited

Loading

DavidWesley commented Jul 30, 2023 •

edited

Loading

brc-dd commented Oct 14, 2023 •

edited

Loading