[GH-ISSUE #928] Why there are no binary/executable? #2402

New issue

Closed

opened 2026-03-07 20:07:26 +03:00 by kerem · 3 comments

kerem commented

2026-03-07 20:07:26 +03:00

Owner

Originally created by @jcubic on GitHub (Aug 10, 2023).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/928

Why provide only the NodeJS module? This is a common thing to run the executable. In order to add lint to the pre-commit hook I need to create an executable. It would be much more useful if there was a binary.

The first thing I did after the installation was use npx markdownlint which give an error, next was searching node_module/.bin for the binary.

Originally created by @jcubic on GitHub (Aug 10, 2023). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/928 Why provide only the NodeJS module? This is a common thing to run the executable. In order to add lint to the pre-commit hook I need to create an executable. It would be much more useful if there was a binary. The first thing I did after the installation was use `npx markdownlint` which give an error, next was searching node_module/.bin for the binary.

kerem

2026-03-07 20:07:26 +03:00

closed this issue
added the
question
label

kerem commented

2026-03-07 20:07:27 +03:00

Author

Owner

@nschonni commented on GitHub (Aug 10, 2023):

The CLIs are the executable versions https://github.com/DavidAnson/markdownlint#related

@nschonni commented on GitHub (Aug 10, 2023): The CLIs are the executable versions https://github.com/DavidAnson/markdownlint#related

kerem commented

2026-03-07 20:07:28 +03:00

Author

Owner

@DavidAnson commented on GitHub (Aug 10, 2023):

Distributing the library as a standalone package along with another package for the command-line interface is a pretty common pattern in the Node.js ecosystem.

Regarding your workflow, if you are going to use NPX, then you do not need to also install the package.

As Nick points out, there are two CLI options for this library: a more traditional one (markdownlint-cli)and an alternative (markdownlint-cli2).

@DavidAnson commented on GitHub (Aug 10, 2023): Distributing the library as a standalone package along with another package for the command-line interface is a pretty common pattern in the Node.js ecosystem. Regarding your workflow, if you are going to use NPX, then you do not need to also install the package. As Nick points out, there are two CLI options for this library: a more traditional one (markdownlint-cli)and an alternative (markdownlint-cli2).

kerem commented

2026-03-07 20:07:28 +03:00

Author

Owner

@jcubic commented on GitHub (Aug 10, 2023):

Thanks for your quick response, I just assumed that those were similar but different projects.

@jcubic commented on GitHub (Aug 10, 2023): Thanks for your quick response, I just assumed that those were similar but different projects.