tools,test: apply markdown linting to test dir #22221
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
added
the
build
4 tasks
richardlau
approved these changes
Aug 9, 2018
richardlau
reviewed
Aug 9, 2018
| |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. | |
There was a problem hiding this comment.
Out of interest, are the added backticks for the Directory column because of the linter or a stylistic change?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Thanks for the explanation. I'm okay with the backticks, it just wasn't obvious to me why they were added.
maclover7
approved these changes
Aug 9, 2018
vsemozhetbyt
approved these changes
Aug 9, 2018
danbev
approved these changes
Aug 10, 2018
jasnell
approved these changes
Aug 10, 2018
maclover7
added
the
author ready
gdams
approved these changes
Aug 12, 2018
Trott
added a commit
to Trott/io.js
that referenced
this pull request
Aug 12, 2018
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>
Trott
added a commit
to Trott/io.js
that referenced
this pull request
Aug 12, 2018
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>
Trott
added a commit
to Trott/io.js
that referenced
this pull request
Aug 12, 2018
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>
Trott
added a commit
to Trott/io.js
that referenced
this pull request
Aug 12, 2018
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>
Trott
added a commit
to Trott/io.js
that referenced
this pull request
Aug 12, 2018
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>
|
Landed in d3d5982...7cec27c |
rvagg
added a commit
that referenced
this pull request
Aug 13, 2018
#20894 / 2930bd1 was introduced on master which removed an offending line in this doc before linting was applied to test/ in #22221 / 56103ab. Since 20894 is semver-major, the full changes were not backported. PR-URL: #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>
rvagg
added a commit
that referenced
this pull request
Aug 15, 2018
#20894 / 2930bd1 was introduced on master which removed an offending line in this doc before linting was applied to test/ in #22221 / 56103ab. Since 20894 is semver-major, the full changes were not backported. PR-URL: #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>
This was referenced Aug 16, 2018
This was referenced Aug 16, 2018
This was referenced Aug 16, 2018
This was referenced Aug 18, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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), orvcbuild test(Windows) passes