Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Typescript config files support #192

Open
2 tasks done
Mister-Hope opened this issue Oct 12, 2024 · 6 comments
Open
2 tasks done

Typescript config files support #192

Mister-Hope opened this issue Oct 12, 2024 · 6 comments
Assignees
Labels
enhancement New feature or request

Comments

@Mister-Hope
Copy link

βœ… Checklist

  • I am using the latest version
  • I have searched FAQ

πŸ“„ System Info

not needed

πŸ”Ž Description

See https://commitlint.js.org/reference/configuration.html

So https://cz-git.qbb.sh/config/#typescript-template should be fixed

πŸ”— Reproduction link / repo:

No response

@Mister-Hope Mister-Hope added the bug Something isn't working label Oct 12, 2024
@Zhengqbbb
Copy link
Owner

Zhengqbbb commented Oct 12, 2024

commitlint Replace ts-node with cosmiconfig-typescript-loader package conventional-changelog/commitlint#3722

Although the speed has improved, The cosmiconfig-typescript-loader package added ,cz-git and czg will double the size, and I am still considering it. πŸ˜Άβ€πŸŒ«οΈ
This makes me wonder the TypeScript support is important. If it's just type support, the issue #193 also can do this

image

@Mister-Hope
Copy link
Author

  1. commitlint.config.ts is supported by commitlint directly, so the docs need to be corrected, there is nothing to do with your pacakge
  2. Even if you want to have cz.config.ts supported, you should externalize cosmiconfig-typescript-loader, tools like rollup and tsup can do that easily

@Mister-Hope
Copy link
Author

Mister-Hope commented Oct 12, 2024

Besides, I think you have misunderstood my original issue complaining about the deps number.

Since your package is strongly relying on commitlint, so you should try to reuse package that is required by it as much as possible while keeping the same major, this way you can externalize them safely as they are supposed to be installed to workspace anyway. (e.g.: cosmiconfig-typescript-loader)

The main target for tool package like this is trying to avoid requiring any new package that is heavy. A package is heavy means that it has too many deps or a lot of unused features for your usage. You can try to bundle packages with cz-git, only if they:

  • are large, treeshakable and unpopular, so you can greatly reduce code size by bundling them

@Zhengqbbb
Copy link
Owner

Zhengqbbb commented Oct 12, 2024

Thank you for your reply.

  1. However, I don't understand with my documentation not supporting commitlint.config.ts Please feel free to point it out.

Since your package is strongly relying on commitlint, so you should try to reuse package

  1. Like @commitlint/load package have too many dep package.json. I have try but cjs project treeshakable effect is not well
  2. Although I don't agree that a lightweight CLI tool, which requires the fastest startup speed (Include npx bunx usage), should resolve the ts configuration file at this time, I will keep an open opinion and will not add it in the short term.

@Mister-Hope
Copy link
Author

However, I don't understand with my documentation not supporting commitlint.config.ts Please feel free to point it out.

image
image

No offense, but as I am pointing out the link in issue body, it should not be hard to find these.

Zhengqbbb added a commit that referenced this issue Oct 12, 2024
@Zhengqbbb
Copy link
Owner

Zhengqbbb commented Oct 12, 2024

Done
Btw, I will try to configure loading for TypeScript using node > 22 LTS (2024-10-29), instead of adding extra dependencies.

@Zhengqbbb Zhengqbbb added enhancement New feature or request and removed bug Something isn't working labels Oct 12, 2024
@Zhengqbbb Zhengqbbb changed the title [Bug report] Typescript config files are still supported upstream by commitlint Typescript config files support Oct 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants