tools,test: apply markdown linting to test dir by Trott · Pull Request #22221 · nodejs/node

Trott · 2018-08-09T22:25:42Z

Enable markdown linting of the test directory. This change is applied
only to Makefile and not vcbuild.bat because we do not currently lint
anything outside of the doc directory using vcbuild.bat. In the
Makefile, the other targets are called "misc" but that feature does not
currently exist in vcbuild.bat. Adding it would be good, but outside the
scope of this change.

@vsemozhetbyt

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
documentation is changed or added
commit message follows commit guidelines

Add first-level header to .md file in fixture directory. The file in question is documentation for the fixture and is not part of any tests. This is in prepration for markdown linting of the `test` directory.

In preparation for markdown linting of files in the `test` directory, make sure all lines in `test/common/README.md` are no more than 80 characters long.

First header should be a first-level header according to our lint rules. Make it so in prepartion for applying the markdown linting to the test directory.

In preparation for applying markdown linting to the `test` directory, adjust the table in `test/README.md` to comply with our markdown rules.

Enable markdown linting of the test directory. This change is applied only to Makefile and not vcbuild.bat because we do not currently lint anything outside of the doc directory using vcbuild.bat. In the Makefile, the other targets are called "misc" but that feature does not currently exist in vcbuild.bat. Adding it would be good, but outside the scope of this change.

nodejs-github-bot · 2018-08-09T22:25:43Z

@Trott build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/483/pipeline

Trott · 2018-08-09T22:27:32Z

CI: https://ci.nodejs.org/job/node-test-pull-request/16316/

richardlau · 2018-08-09T22:34:27Z

test/README.md

-|v8-updates         |No             |Tests for V8 performance integration.|
+| Directory           | Runs on CI      | Purpose         |
+| ------------------- | --------------- | --------------- |
+| `abort`             | Yes             | Tests for when the  ``` --abort-on-uncaught-exception ``` flag is used. |


Out of interest, are the added backticks for the Directory column because of the linter or a stylistic change?

It's a clunky workaround for the linter flagging bare-text v8. If it sees v8 in backticks, it assumes it's part of code or a directory listing or something like that, but if it sees it bare, it flags it as a prohibited string and assumes you meant V8 instead.

I actually do think the directory names should be in backticks, but I also acknowledge that's a debatable position. :-D

Thanks for the explanation. I'm okay with the backticks, it just wasn't obvious to me why they were added.

sagirk

LGTM! 🎉

XadillaX

LGTM!

Add first-level header to .md file in fixture directory. The file in question is documentation for the fixture and is not part of any tests. This is in prepration for markdown linting of the `test` directory. PR-URL: nodejs#22221 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: George Adams <george.adams@uk.ibm.com>

In preparation for markdown linting of files in the `test` directory, make sure all lines in `test/common/README.md` are no more than 80 characters long. PR-URL: nodejs#22221 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: George Adams <george.adams@uk.ibm.com>

First header should be a first-level header according to our lint rules. Make it so in prepartion for applying the markdown linting to the test directory. PR-URL: nodejs#22221 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: George Adams <george.adams@uk.ibm.com>

In preparation for applying markdown linting to the `test` directory, adjust the table in `test/README.md` to comply with our markdown rules. PR-URL: nodejs#22221 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: George Adams <george.adams@uk.ibm.com>

Enable markdown linting of the test directory. This change is applied only to Makefile and not vcbuild.bat because we do not currently lint anything outside of the doc directory using vcbuild.bat. In the Makefile, the other targets are called "misc" but that feature does not currently exist in vcbuild.bat. Adding it would be good, but outside the scope of this change. PR-URL: nodejs#22221 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: George Adams <george.adams@uk.ibm.com>

Trott · 2018-08-12T22:31:23Z

Landed in d3d5982...7cec27c

Add first-level header to .md file in fixture directory. The file in question is documentation for the fixture and is not part of any tests. This is in prepration for markdown linting of the `test` directory. PR-URL: nodejs/node#22221 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: George Adams <george.adams@uk.ibm.com>

In preparation for markdown linting of files in the `test` directory, make sure all lines in `test/common/README.md` are no more than 80 characters long. PR-URL: nodejs/node#22221 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: George Adams <george.adams@uk.ibm.com>

First header should be a first-level header according to our lint rules. Make it so in prepartion for applying the markdown linting to the test directory. PR-URL: nodejs/node#22221 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: George Adams <george.adams@uk.ibm.com>

In preparation for applying markdown linting to the `test` directory, adjust the table in `test/README.md` to comply with our markdown rules. PR-URL: nodejs/node#22221 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: George Adams <george.adams@uk.ibm.com>

Enable markdown linting of the test directory. This change is applied only to Makefile and not vcbuild.bat because we do not currently lint anything outside of the doc directory using vcbuild.bat. In the Makefile, the other targets are called "misc" but that feature does not currently exist in vcbuild.bat. Adding it would be good, but outside the scope of this change. PR-URL: nodejs/node#22221 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: George Adams <george.adams@uk.ibm.com>

nodejs/node#20894 / 2930bd1 was introduced on master which removed an offending line in this doc before linting was applied to test/ in nodejs/node#22221 / 56103ab. Since 20894 is semver-major, the full changes were not backported. PR-URL: nodejs/node#22296 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: George Adams <george.adams@uk.ibm.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>

Trott added 5 commits August 9, 2018 15:03

fix lint error in test fixtures

3251cef

Add first-level header to .md file in fixture directory. The file in question is documentation for the fixture and is not part of any tests. This is in prepration for markdown linting of the `test` directory.

test,doc: wrap common module md doc at 80 chars

858f791

In preparation for markdown linting of files in the `test` directory, make sure all lines in `test/common/README.md` are no more than 80 characters long.

test,doc: adjust async-hooks coverage doc for lint

81a98f0

First header should be a first-level header according to our lint rules. Make it so in prepartion for applying the markdown linting to the test directory.

test,doc: adjust markdown table for linting

61901d4

In preparation for applying markdown linting to the `test` directory, adjust the table in `test/README.md` to comply with our markdown rules.

nodejs-github-bot added the build Issues and PRs related to build files or the CI. label Aug 9, 2018

Trott mentioned this pull request Aug 9, 2018

test: add a common.debuglog function #22206

Closed

4 tasks

richardlau approved these changes Aug 9, 2018

View reviewed changes

richardlau reviewed Aug 9, 2018

View reviewed changes

Trott added tools Issues and PRs related to the tools directory. test Issues and PRs related to the tests. doc Issues and PRs related to the documentations. and removed test Issues and PRs related to the tests. labels Aug 9, 2018

maclover7 approved these changes Aug 9, 2018

View reviewed changes

vsemozhetbyt approved these changes Aug 9, 2018

View reviewed changes

sagirk approved these changes Aug 10, 2018

View reviewed changes

XadillaX approved these changes Aug 10, 2018

View reviewed changes

danbev approved these changes Aug 10, 2018

View reviewed changes

jasnell approved these changes Aug 10, 2018

View reviewed changes

maclover7 added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Aug 10, 2018

gdams approved these changes Aug 12, 2018

View reviewed changes

Trott closed this Aug 12, 2018

beevelop mentioned this pull request Aug 16, 2018

2018-08-15 Version 10.9.0 (Current) @rvagg beevelop/docker-nodejs#215

Closed

This was referenced Aug 16, 2018

Update Node.js to v10.23.3 peranakanfrancis/hugo-foresty#12

Open

Update Node.js to v10.9.0 algolia/rollup-jest-boilerplate#18

Merged

Update Node.js to 10.9.x terales/socatar#107

Merged

Update Node.js to v10.9.0 Automattic/wp-calypso#26716

Merged

This was referenced Aug 18, 2018

chore(deps): update node.js to >= 10.9.0 rkaneko/graphql-concat#75

Merged

chore(deps): update node.js to v10.9.0 vvo/tokenify#30

Merged

chore(deps): update node.js to v10.9.0 algolia/places#570

Merged

jessestuart mentioned this pull request Aug 21, 2018

chore(deps): update node.js to v10.9.0 jessestuart/jesses.io#580

Closed

renovate bot mentioned this pull request Aug 28, 2018

Update Node.js to v10.9.0 KSXGitHub/application-installer#1

Merged

Trott deleted the lint-md-test branch January 13, 2022 22:50

renovate bot mentioned this pull request Oct 5, 2025

chore(deps): update node.js to >=10.9.0 allanice001/cloudstartup.net#38

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

tools,test: apply markdown linting to test dir#22221

tools,test: apply markdown linting to test dir#22221
Trott wants to merge 5 commits intonodejs:masterfrom
Trott:lint-md-test

Trott commented Aug 9, 2018

Uh oh!

nodejs-github-bot commented Aug 9, 2018

Uh oh!

Trott commented Aug 9, 2018

Uh oh!

richardlau Aug 9, 2018

Uh oh!

Trott Aug 9, 2018

Uh oh!

richardlau Aug 9, 2018

Uh oh!

sagirk left a comment

Uh oh!

XadillaX left a comment

Uh oh!

Trott commented Aug 12, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

Uh oh!

Conversation

Trott commented Aug 9, 2018

Checklist

Uh oh!

nodejs-github-bot commented Aug 9, 2018

Uh oh!

Trott commented Aug 9, 2018

Uh oh!

richardlau Aug 9, 2018

Choose a reason for hiding this comment

Uh oh!

Trott Aug 9, 2018

Choose a reason for hiding this comment

Uh oh!

richardlau Aug 9, 2018

Choose a reason for hiding this comment

Uh oh!

sagirk left a comment

Choose a reason for hiding this comment

Uh oh!

XadillaX left a comment

Choose a reason for hiding this comment

Uh oh!

Trott commented Aug 12, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants