Skip to content

docs: package managers CLI instructions across OS's #4381

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

Closed
juliolmuller opened this issue Apr 25, 2025 · 0 comments · Fixed by #4382
Closed

docs: package managers CLI instructions across OS's #4381

juliolmuller opened this issue Apr 25, 2025 · 0 comments · Fixed by #4382
Assignees

Comments

@juliolmuller
Copy link
Contributor

The duplicate npm commands in the documentation draw my attention and I saw some of the CLI commands uses the @commitlint/{cli,config-conventional} syntax. In the case of npm (for Windows), however, it uses the good old verbose one (@commitlint/cli @commitlint/config-conventional).

However, this differentiation does not only apply to npm, but for other package managers like yarn and pnpm in Windows as well. So, for simplification and consistency, I'd suggest defining a single command for each package manager and use the syntax compatible across operating systems.

escapedcat pushed a commit that referenced this issue Apr 29, 2025
…based systems (#4381) (#4382)

* docs: fix JSON syntax

* docs: adjust package managers CLI instructions for both Win and Unix based systems (#4381)

* docs: fix CLI instruction not compatible to Windows

* docs: adjust markdown
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants