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.

Sign up for GitHub

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

Jump to bottom

tools: Markdown lint script's --help does not work as advertised #30156

Closed
DerekNonGeneric opened this issue Oct 28, 2019 · 3 comments
Closed

tools: Markdown lint script's --help does not work as advertised #30156

DerekNonGeneric opened this issue Oct 28, 2019 · 3 comments
Assignees
@Xstoudi
Labels
tools Issues and PRs related to the tools directory.

Comments

@DerekNonGeneric
Copy link
Contributor

Running node tools/lint-md <PATH> always outputs the contents of the document it is linting. When used in combination with other checks, this unnecessary output causes results from previous checks to become very difficult to locate. I have not been able to find a way to stop it from outputting file contents even when passing it arguments to silence it.
@Xstoudi
Copy link
Contributor

Xstoudi commented Oct 29, 2019

I'll look into it.

@targos targos added the tools Issues and PRs related to the tools directory. label Oct 29, 2019
@Xstoudi
Copy link
Contributor

Xstoudi commented Oct 29, 2019

Okay, I don't think it's a problem since you can simply do : node tools/lint-md your.md --no-stdout
Can you please confirm that it solve your issue?

@DerekNonGeneric
Copy link
Contributor Author

Ah yes, that seems to do it. Thanks, @Xstoudi! For some reason the help menu doesn't come up when running node tools/lint-md --help. Maybe that's the real issue at hand. I had to run node tools/lint-md --wtf to get to it. 😉

@DerekNonGeneric DerekNonGeneric changed the title doc: Markdown lint script outputs entire contents of file tools: Markdown lint script's --help does not work as advertised Oct 30, 2019
@Trott Trott closed this as completed in 80fb153 Dec 15, 2019
MylesBorins pushed a commit that referenced this issue Dec 17, 2019
@MylesBorins
tools: enable Markdown linter's usage information
b20ddde 
Prior to this commit, running `node tools/lint-md --help` and
`node tools/lint-md --version` resulted in an error.

* Use `unified-args` to start processor
* Use `unified-args`'s error handler

Fixes: #30156
PR-URL: #30216
Reviewed-By: Rich Trott <rtrott@gmail.com>
targos pushed a commit that referenced this issue Jan 14, 2020
@targos
tools: enable Markdown linter's usage information
47067ce 
Prior to this commit, running `node tools/lint-md --help` and
`node tools/lint-md --version` resulted in an error.

* Use `unified-args` to start processor
* Use `unified-args`'s error handler

Fixes: #30156
PR-URL: #30216
Reviewed-By: Rich Trott <rtrott@gmail.com>
BethGriggs pushed a commit that referenced this issue Feb 6, 2020
@BethGriggs
tools: enable Markdown linter's usage information
f2cc093 
Prior to this commit, running `node tools/lint-md --help` and
`node tools/lint-md --version` resulted in an error.

* Use `unified-args` to start processor
* Use `unified-args`'s error handler

Fixes: #30156
PR-URL: #30216
Reviewed-By: Rich Trott <rtrott@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Xstoudi Xstoudi

Labels
tools Issues and PRs related to the tools directory.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

tools: enable Markdown linter's usage information
3 participants
@targos @Xstoudi @DerekNonGeneric