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

[vsemozhetbyt]

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

Backport of: #12563 + #12640 + #14047

[vsemozhetbyt]

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]

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

[MylesBorins]

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]

@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]

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

[MylesBorins]

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]

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

$ git log --oneline49b9634453 (HEAD -> backport-eslint-md-to-v6.x, origin/backport-eslint-md-to-v6.x) build, doc, tools: add eslint-plugin-markdowndce79a4b49 doc: conform more docs to eslint-plugin-markdown74d2932751 doc: conform to rules for eslint-plugin-markdown59b93bccb0 doc: prepare js code for eslint-plugin-markdown8860117600 (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]

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

[MylesBorins]

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?

[vsemozhetbyt]

@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

[MylesBorins]

landed in 0b17a45...ce4718f

[vsemozhetbyt]

@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]

@vsemozhetbyt I assume make lint will lint docs?

[vsemozhetbyt]

@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]

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