[v6.x backport] build, doc, tools: use eslint-plugin-markdown #14067

vsemozhetbyt · 2017-07-04T00:27:18Z

Checklist

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

Affected core subsystem(s)

build, doc, tools

vsemozhetbyt · 2017-07-04T00:40:19Z

This backport departs from canonical way due to a complicated situation with all eslint-plugin-markdown history in Node.js repository.

1.+2. First and second commits from #12563 were backported as is (with conflicts resolved), metadata is preserved.

3. Conform more docs to eslint-plugin-markdown. There was a pretty different situation with docs in the v6.x-staging branch, so the last sweep needed a high-touch manual approach.

4. As all the commits after the third commit in #12563 were various patches, all of them were combined in one commit (i.e: the third and the fourth commits from #12563 + all the appropriate commits from #12640 and #14047). This commit has these changes in one transaction (without old metadata):

Install [email protected]
Add doc/.eslintrc.yaml
Add plugins: [markdown] to the main .eslintrc.yaml
.js files in doc folder added to .eslintignore
Update Makefile, vcbuild.bat, and tools/jslint.js

As I used npm 5.0.3, I am not sure if tools/eslint/package-lock.json should be checked and corrected/deleted.

vsemozhetbyt · 2017-07-04T00:55:35Z

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

MylesBorins · 2017-07-10T11:27:04Z

Failures look unrelated. It might be nice to have the changes to the doc files in their own commit prior to landing the linter. Thoguhts?

vsemozhetbyt · 2017-07-10T14:44:52Z

@MylesBorins I've split the last commit in doc commit + other changes commit.

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

vsemozhetbyt · 2017-07-11T17:34:44Z

Something wrong has happened with the PR since my last push.

MylesBorins · 2017-07-11T20:02:27Z

You are going to have to rebase against staging.

…

On Jul 11, 2017 6:34 PM, "Vse Mozhet Byt" ***@***.***> wrote: Something wrong happens with the PR since my last push. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#14067 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAecVzkXaRivBTTl_lCs2UttHnTFi0UJks5sM7I8gaJpZM4OMxf9> .

vsemozhetbyt · 2017-07-11T20:22:43Z

It is strange. After rebasing I have this commit order:

$ git log --oneline
49b9634453 (HEAD -> backport-eslint-md-to-v6.x, origin/backport-eslint-md-to-v6.x) build, doc, tools: add eslint-plugin-markdown
dce79a4b49 doc: conform more docs to eslint-plugin-markdown
74d2932751 doc: conform to rules for eslint-plugin-markdown
59b93bccb0 doc: prepare js code for eslint-plugin-markdown
8860117600 (upstream/v6.x-staging) addons: remove semicolons from after module definition
...

But after pushing, in the PR the last two commit are swapped. How can I fix this?

vsemozhetbyt · 2017-07-11T20:29:57Z

Fixed by re-push after interactive quasi-rebase.
CI: https://ci.nodejs.org/job/node-test-pull-request/9070/

MylesBorins · 2017-07-18T21:20:29Z

this will have to be rebased again. Thanks for patience.

Some of the commits are missing meta data... are some of them new to this backport?

This is an initial step to eliminate most of parsing errors. PR-URL: #12563 Refs: #12557 (comment) Reviewed-By: Teddy Katz <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Yuta Hiroto <[email protected]>

PR-URL: #12563 Refs: #12557 (comment) Reviewed-By: Teddy Katz <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Yuta Hiroto <[email protected]>

* Install [email protected] * Add doc/.eslintrc.yaml * Add `plugins: [markdown]` to the main .eslintrc.yaml * .js files in doc folder added to .eslintignore * Update Makefile, vcbuild.bat, and tools/jslint.js Refs: #12563 Refs: #12640 Refs: #14047

vsemozhetbyt · 2017-07-19T00:22:12Z

@MylesBorins Rebased. PR has a complicated story (see the second comment), so the metadata from the original commits would not be completely proper here.

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

jasnell

Rubber stamp LGTM

MylesBorins

LGTM

This is an initial step to eliminate most of parsing errors. Backport-PR-URL: #14067 PR-URL: #12563 Refs: #12557 (comment) Reviewed-By: Teddy Katz <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Yuta Hiroto <[email protected]>

Backport-PR-URL: #14067 PR-URL: #12563 Refs: #12557 (comment) Reviewed-By: Teddy Katz <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Yuta Hiroto <[email protected]>

* Install [email protected] * Add doc/.eslintrc.yaml * Add `plugins: [markdown]` to the main .eslintrc.yaml * .js files in doc folder added to .eslintignore * Update Makefile, vcbuild.bat, and tools/jslint.js Refs: #12563 Refs: #12640 Refs: #14047 PR-URL: #14067 Reviewed-By: James Snell <[email protected]> Reviewed-By: Myles Borins <[email protected]>

MylesBorins · 2017-07-21T17:57:56Z

landed in 0b17a45...ce4718f

vsemozhetbyt · 2017-07-21T18:00:20Z

@nodejs/collaborators, if you have any x6 backports with new/edited code fragments in docs, you may need re-run linter CI after this landing.

sam-github · 2017-07-21T18:10:27Z

@vsemozhetbyt I assume make lint will lint docs?

This is an initial step to eliminate most of parsing errors. Backport-PR-URL: #14067 PR-URL: #12563 Refs: #12557 (comment) Reviewed-By: Teddy Katz <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Yuta Hiroto <[email protected]>

Backport-PR-URL: #14067 PR-URL: #12563 Refs: #12557 (comment) Reviewed-By: Teddy Katz <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Yuta Hiroto <[email protected]>

* Install [email protected] * Add doc/.eslintrc.yaml * Add `plugins: [markdown]` to the main .eslintrc.yaml * .js files in doc folder added to .eslintignore * Update Makefile, vcbuild.bat, and tools/jslint.js Refs: #12563 Refs: #12640 Refs: #14047 PR-URL: #14067 Reviewed-By: James Snell <[email protected]> Reviewed-By: Myles Borins <[email protected]>

vsemozhetbyt · 2017-07-21T18:36:43Z

@sam-github Maybe, I am not sure.

I usually do tools/eslint/bin/eslint.js --rulesdir tools/eslint-rules/ --ext=.js,.md benchmark doc lib test tools
locally or do https://ci.nodejs.org/job/node-test-linter/ with refs/pull/<PR_ID>/head in GIT_REMOTE_REF in CI.

sam-github · 2017-07-21T18:51:19Z

That's what make lint does, and I confirmed it works.

This is an initial step to eliminate most of parsing errors. Backport-PR-URL: #14067 PR-URL: #12563 Refs: #12557 (comment) Reviewed-By: Teddy Katz <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Yuta Hiroto <[email protected]>

Backport-PR-URL: #14067 PR-URL: #12563 Refs: #12557 (comment) Reviewed-By: Teddy Katz <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Yuta Hiroto <[email protected]>

* Install [email protected] * Add doc/.eslintrc.yaml * Add `plugins: [markdown]` to the main .eslintrc.yaml * .js files in doc folder added to .eslintignore * Update Makefile, vcbuild.bat, and tools/jslint.js Refs: #12563 Refs: #12640 Refs: #14047 PR-URL: #14067 Reviewed-By: James Snell <[email protected]> Reviewed-By: Myles Borins <[email protected]>

nodejs-github-bot added build Issues and PRs related to build files or the CI. tools Issues and PRs related to the tools directory. v6.x labels Jul 4, 2017

vsemozhetbyt added the doc Issues and PRs related to the documentations. label Jul 4, 2017

vsemozhetbyt changed the title ~~[v6.x backport] doc, tools: use eslint-plugin-markdown~~ [v6.x backport] build, doc, tools: use eslint-plugin-markdown Jul 4, 2017

vsemozhetbyt mentioned this pull request Jul 4, 2017

doc, tools: use eslint-plugin-markdown #12563

Closed

2 tasks

gibfahn self-assigned this Jul 4, 2017

MylesBorins force-pushed the v6.x-staging branch from 8850007 to 8860117 Compare July 11, 2017 16:44

refack mentioned this pull request Jul 12, 2017

CI status updates to GitHub stuck at yellow nodejs/build#790

Closed

vsemozhetbyt added 4 commits July 19, 2017 02:59

doc: conform more docs to eslint-plugin-markdown

830d6f7

jasnell approved these changes Jul 19, 2017

View reviewed changes

MylesBorins approved these changes Jul 21, 2017

View reviewed changes

MylesBorins closed this Jul 21, 2017

vsemozhetbyt deleted the backport-eslint-md-to-v6.x branch July 21, 2017 18:02

MylesBorins mentioned this pull request Jul 21, 2017

v6.11.2 proposal #14356

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[v6.x backport] build, doc, tools: use eslint-plugin-markdown #14067

[v6.x backport] build, doc, tools: use eslint-plugin-markdown #14067

vsemozhetbyt commented Jul 4, 2017 •

edited

Loading

vsemozhetbyt commented Jul 4, 2017 •

edited

Loading

vsemozhetbyt commented Jul 4, 2017

MylesBorins commented Jul 10, 2017

vsemozhetbyt commented Jul 10, 2017

vsemozhetbyt commented Jul 11, 2017 •

edited

Loading

MylesBorins commented Jul 11, 2017 via email

vsemozhetbyt commented Jul 11, 2017

vsemozhetbyt commented Jul 11, 2017

MylesBorins commented Jul 18, 2017

vsemozhetbyt commented Jul 19, 2017

jasnell left a comment

MylesBorins left a comment

MylesBorins commented Jul 21, 2017

vsemozhetbyt commented Jul 21, 2017

sam-github commented Jul 21, 2017

vsemozhetbyt commented Jul 21, 2017 •

edited

Loading

sam-github commented Jul 21, 2017

[v6.x backport] build, doc, tools: use eslint-plugin-markdown #14067

[v6.x backport] build, doc, tools: use eslint-plugin-markdown #14067

Conversation

vsemozhetbyt commented Jul 4, 2017 • edited Loading

Checklist

Affected core subsystem(s)

vsemozhetbyt commented Jul 4, 2017 • edited Loading

vsemozhetbyt commented Jul 4, 2017

MylesBorins commented Jul 10, 2017

vsemozhetbyt commented Jul 10, 2017

vsemozhetbyt commented Jul 11, 2017 • edited Loading

MylesBorins commented Jul 11, 2017 via email

vsemozhetbyt commented Jul 11, 2017

vsemozhetbyt commented Jul 11, 2017

MylesBorins commented Jul 18, 2017

vsemozhetbyt commented Jul 19, 2017

jasnell left a comment

Choose a reason for hiding this comment

MylesBorins left a comment

Choose a reason for hiding this comment

MylesBorins commented Jul 21, 2017

vsemozhetbyt commented Jul 21, 2017

sam-github commented Jul 21, 2017

vsemozhetbyt commented Jul 21, 2017 • edited Loading

sam-github commented Jul 21, 2017

vsemozhetbyt commented Jul 4, 2017 •

edited

Loading

vsemozhetbyt commented Jul 4, 2017 •

edited

Loading

vsemozhetbyt commented Jul 11, 2017 •

edited

Loading

vsemozhetbyt commented Jul 21, 2017 •

edited

Loading