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.

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

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

Closed

Conversation

@vsemozhetbyt
Copy link
Contributor

commented Apr 21, 2017

Checklist
Affected core subsystem(s)

doc, tools

Refs: #12557 (comment)

Commit 1: an initial step to eliminate parsing errors. Fixing strategies:

  • Mixed conflicting contexts: split into separate code blocks.
  • Object literals erroneously parsed as code blocks:
  • Terminal / REPL interaction logs in repl.md: add <!-- eslint-disable --> to disable linting + preserve syntax highlighting. (see #12563 (comment))
  • Non-js outputs: wrap in ``` ``` instead of ```js ```.
  • Truncated constructions: complete the code.
  • Uncommented ellipses; comment out.
  • Syntax errors: fix.
  • Line numbers in front of the code: move to the line ends and comment out.

Commit 2: conform most of the problematic code to the rules.

Code is checked with this doc/.eslintrc.yaml (see https://gist.github.com/not-an-aardvark/f3cb021e854414128d197dde8d0f62b2)

plugins: [markdown]

rules:
  strict: 0
  no-restricted-properties: 0
  no-undef: 0
  no-unused-vars: 0

Commit 3: add eslint-plugin-markdown stuff

  • npm install eslint-plugin-markdown.
  • Add doc/.eslintrc.yaml; add plugins: [markdown] to the main .eslintrc.yaml.
  • Add <!-- eslint-disable rule --> or <!-- eslint-disable --> for the rest problematic code.
  • .js files in doc folder added to .eslintignore.
  • Update Makefile and vcbuild.bat.

Commit 4: make doc linting a bit more specific (as we do for tests code)

  • Add no-var: 2 and prefer-const: 2 in doc/.eslintrc.yaml.
  • Fix some fragments in docs accordingly.
@not-an-aardvark

This comment has been minimized.

Copy link
Member

commented Apr 21, 2017

In terms of keeping a clean git commit history, I think it might be better to fix style/syntax in the docs in one commit (without adding directives like eslint-disable), and then add eslint-plugin-markdown and eslint-disable directives at the same time. Otherwise, the codebase will be in an intermediate state after this commit where there are eslint-disable directives that aren't actually used by anything.

@vsemozhetbyt vsemozhetbyt force-pushed the vsemozhetbyt:eslint-md-no-parsing-errors branch Apr 21, 2017

@vsemozhetbyt

This comment has been minimized.

Copy link
Contributor Author

commented Apr 21, 2017

@not-an-aardvark I've reverted <!-- eslint-disable --> part for repl.md for now.

@vsemozhetbyt vsemozhetbyt force-pushed the vsemozhetbyt:eslint-md-no-parsing-errors branch Apr 21, 2017

@vsemozhetbyt

This comment has been minimized.

Copy link
Contributor Author

commented Apr 21, 2017

@not-an-aardvark I've checked the whole doc directory now, not only doc/api. Two fixes for guides added.

doc/api/dns.md Outdated
@@ -353,15 +353,15 @@ be an object with the following properties:
* `minttl`

```js
{
({

This comment has been minimized.

Copy link
@thefourtheye

thefourtheye Apr 21, 2017

Contributor

Why?

This comment has been minimized.

Copy link
@vsemozhetbyt

vsemozhetbyt Apr 21, 2017

Author Contributor

ESLint parses this as a code block with statements and breaks with parsing errors. With () it is parsed as an expression with an object literal.

This comment has been minimized.

Copy link
@thefourtheye

thefourtheye Apr 21, 2017

Contributor

This doesn't feel right to me... If everybody else is okay with this, then fine.

This comment has been minimized.

Copy link
@vsemozhetbyt

vsemozhetbyt Apr 21, 2017

Author Contributor

In some places, I've added something like const defaults = { };, but it seems to me this does not fit everywhere. Maybe, somebody can think up a better approach.

This comment has been minimized.

Copy link
@not-an-aardvark

not-an-aardvark Apr 21, 2017

Member

I think readability should be our main concern in the docs. If a code block which isn't technically valid JS communicates more clearly than the valid-JS alternative, then we should keep using invalid JS and put a disable comment above it. In this case, I don't have a strong opinion on whether the parentheses increase readability.

@vsemozhetbyt vsemozhetbyt force-pushed the vsemozhetbyt:eslint-md-no-parsing-errors branch Apr 21, 2017

@vsemozhetbyt

This comment has been minimized.

Copy link
Contributor Author

commented Apr 21, 2017

@not-an-aardvark, @thefourtheye

  • I've reverted wrapping objects in ().
  • Most of the rule violations addressed in the second commit (the first post is updated). Currently, we have only these ones for <!-- --> notes:
ESLint utput after the second commit:
doc\api\assert.md
  559:27  error  Unexpected string as second argument  assert-throws-arguments

doc\api\debugger.md
  33:3  error  Unexpected 'debugger' statement  no-debugger

doc\api\dns.md
  299:10  error  Parsing error: Unexpected token :
  358:13  error  Parsing error: Unexpected token :
  388:9   error  Parsing error: Unexpected token :

doc\api\http.md
    16:19  error  Parsing error: Unexpected token :
    43:20  error  Missing semicolon                  semi
  1464:20  error  Missing semicolon                  semi

doc\api\modules.md
  560:18  error  Function name `Constructor` should match variable name `exports`  func-name-matching

doc\api\os.md
  164:2  error  Missing semicolon                  semi
  274:7  error  Parsing error: Unexpected token :

doc\api\process.md
   751:8   error  Parsing error: Unexpected token :
   836:14  error  Missing semicolon                  semi
   842:50  error  Missing semicolon                  semi
   858:22  error  Missing semicolon                  semi
  1179:12  error  Parsing error: Unexpected token :
  1350:6   error  Parsing error: Unexpected token :
  1711:7   error  Parsing error: Unexpected token :

doc\api\querystring.md
  65:6  error  Parsing error: Unexpected token :

doc\api\repl.md
   44:1  error  Parsing error: Unexpected token >
   79:1  error  Parsing error: Unexpected token >
  107:3  error  Parsing error: Unexpected token node
  136:1  error  Parsing error: Unexpected token >
  146:1  error  Parsing error: Unexpected token >
  292:4  error  Parsing error: Unexpected token /
  442:3  error  Parsing error: Unexpected token node

doc\api\v8.md
  122:29  error  Parsing error: Unexpected token :

✖ 27 problems (27 errors, 0 warnings)


@vsemozhetbyt

This comment has been minimized.

Copy link
Contributor Author

commented Apr 21, 2017

@not-an-aardvark What are the steps for the proceeding? Are these right?

  1. run npm install eslint-plugin-markdown in the tools/eslint
  2. Add doc/.eslintrc.yaml from the first post.
  3. Add <!-- --> notes.
  4. Update configs for build and CI — I am afraid I will be no good for this.
@not-an-aardvark

This comment has been minimized.

Copy link
Member

commented Apr 21, 2017

Yes, I think those are the right steps. If doc/api/addons.md is modified, I think we should run full CI since that is used to autogenerate something IIRC.

@vsemozhetbyt

This comment has been minimized.

Copy link
Contributor Author

commented Apr 21, 2017

@not-an-aardvark
Plugin, doc/.eslintrc.yaml and directives are added in the third commit.

What should I add in build configs so that doc are checked in build and CI?

@vsemozhetbyt

This comment has been minimized.

Copy link
Contributor Author

commented Apr 21, 2017

We also should ignore .js files in the doc/api_assets, they are full of linting errors.

@not-an-aardvark

This comment has been minimized.

Copy link
Member

commented Apr 21, 2017

cc @Trott: I'm not sure about the best place to put eslint-plugin-markdown. ESLint needs to be able to call require('eslint-plugin-markdown') to get the module, and this would normally work fine if eslint-plugin-markdown was installed into a node_modules folder on the same level as eslint. However, that doesn't work here since eslint is in tools/, so the plugin is installed into tools/eslint/node_modules/ instead. This works, but it doesn't seem ideal (e.g. if ESLint is reinstalled, its node_modules folder might be purged so we might forget to reinstall eslint-plugin-markdown). Where would be the best place to put the plugin?

@not-an-aardvark

This comment has been minimized.

Copy link
Member

commented Apr 21, 2017

@vsemozhetbyt

To add this to the build process, I think you would need to replace these lines with:

$(NODE) tools/eslint/bin/eslint.js --cache --rulesdir=tools/eslint-rules --ext=.js,.md \
  benchmark lib test tools docs

In other words, add docs to the list of globs to be linted, and also add .md to the list of default file extensions to lint. (On its own this would override the default .js extension, so also add .js to make sure JS files are linted as well.)

To ignore files like doc/api_assets, you can add globs to the .eslintignore file.

Dismissing my review for now because a few new commits have been added.

@vsemozhetbyt

This comment has been minimized.

Copy link
Contributor Author

commented Apr 21, 2017

Should this glob be doc/api_assets/*.js or a wider glob to be safe? I am not very good at globs here. How can we exclude any *.js files in the doc and all subdirectories with any depth?

Hopefully, make all *.js files in doc ignored.

@Trott

This comment has been minimized.

Copy link
Member

commented Apr 21, 2017

I'm not sure about the best place to put eslint-plugin-markdown.

@not-an-aardvark I'm not sure either. If we were starting from scratch, I'd probably say put everything (including eslint itself) in tools/eslint/node_modules and maybe put some symlinks in tools/eslint to tools/eslint/node_modules/eslint.

As is, I'm OK with putting eslint-plugin-markdown into tools/eslint/node_modules as long as things break in an understandable way when the plugin is missing after an upgrade. For that matter, the upgrade process probably needs to be documented somewhere and that would be a good place to include the instructions to include the plugin. I might try to do that if I get some time today, but as always, I'd be thrilled if someone beats me to it. (I always forget a step in the upgrade anyway involving a symlink or something to .bin/eslint.js I think? @sam-github is usually the person that fixes it when I make that error, which I'm pretty sure I've made more than once. Will have to go through git history and figure it out unless my @-mention above summons Sam and Sam's memory is solid on it.)

@TimothyGu
Copy link
Member

left a comment

Nice work!

doc/api/cluster.md Outdated
worker.process.pid, signal || code);
cluster.fork();
}
);

This comment has been minimized.

Copy link
@TimothyGu

TimothyGu Apr 21, 2017

Member

I'd prefer the older more concise style, if possible.

doc/api/console.md Outdated
for (let i = 0; i < 100; i++) {
;
}
for (let i = 0; i < 100; i++) ;

This comment has been minimized.

Copy link
@TimothyGu

TimothyGu Apr 21, 2017

Member

Would

for (let i = 0; i < 100; i++) {}

work?

Some people may be unfamiliar with the syntax of an empty statement.

doc/api/crypto.md Outdated
@@ -288,7 +288,8 @@ decipher.on('end', () => {
// Prints: some clear text data
});

const encrypted = 'ca981be48e90867604588e75d04feabb63cc007a8f8ad89b10616ed84d815504';
const encrypted =
'ca981be48e90867604588e75d04feabb63cc007a8f8ad89b10616ed84d815504';

This comment has been minimized.

Copy link
@TimothyGu

TimothyGu Apr 21, 2017

Member

4-space indent, and break the string into multiple lines using + if needed.

doc/api/fs.md Outdated
@@ -217,7 +217,7 @@ synchronous counterparts are of this type.
For a regular file [`util.inspect(stats)`][] would return a string very
similar to this:

```js
```txt

This comment has been minimized.

Copy link
@TimothyGu

TimothyGu Apr 21, 2017

Member

You can just remove the language.

doc/api/modules.md Outdated
@@ -70,7 +70,7 @@ When a file is run directly from Node.js, `require.main` is set to its
directly by testing

```js
require.main === module
require.main === module;

This comment has been minimized.

Copy link
@TimothyGu

TimothyGu Apr 21, 2017

Member

I feel in this case the code block should just be inlined, as

... directly by testing require.main === module.

doc/api/console.md Outdated
@@ -139,7 +142,7 @@ the default behavior of `console` in Node.js.
// new impl for assert without monkey-patching.
const myConsole = Object.create(console, {
assert: {
value: function assert(assertion, message, ...args) {
value(assertion, message, ...args) {

This comment has been minimized.

Copy link
@TimothyGu

TimothyGu Apr 21, 2017

Member

This will result in myConsole.assert.name === 'value', which may not be desirable. I'd add an exclusion for func-name-matching.

doc/api/process.md Outdated
@@ -529,7 +528,7 @@ running the `./configure` script.

An example of the possible output looks like:

```js
```txt

This comment has been minimized.

Copy link
@TimothyGu

TimothyGu Apr 21, 2017

Member

Ditto about txt language. Or, disabling ESLint for this block and keep js also works for me.

doc/api/readline.md Outdated
@@ -414,7 +414,7 @@ For instance: `[[substr1, substr2, ...], originalsubstring]`.
```js
function completer(line) {
const completions = '.help .error .exit .quit .q'.split(' ');
const hits = completions.filter((c) => { return c.indexOf(line) === 0 });
const hits = completions.filter((c) => { return c.indexOf(line) === 0; });

This comment has been minimized.

Copy link
@TimothyGu

TimothyGu Apr 21, 2017

Member

Can this instead be:

const hits = completions.filter((c) => c.indexOf(line) === 0);
doc/api/zlib.md Outdated
@@ -149,7 +152,7 @@ From `zlib/zconf.h`, modified to node.js's usage:
The memory requirements for deflate are (in bytes):

```js
(1 << (windowBits+2)) + (1 << (memLevel+9))
(1 << (windowBits + 2)) + (1 << (memLevel + 9));

This comment has been minimized.

Copy link
@TimothyGu

TimothyGu Apr 21, 2017

Member

The semicolon looks out of place here as well.

doc/api/zlib.md Outdated
```

This will, however, generally degrade compression.

The memory requirements for inflate are (in bytes)

```js
1 << windowBits
1 << windowBits;

This comment has been minimized.

Copy link
@TimothyGu

TimothyGu Apr 21, 2017

Member

Ditto. This should be short enough to make it inlined.

@vsemozhetbyt

This comment has been minimized.

Copy link
Contributor Author

commented Apr 21, 2017

Some more questions:

  1. Should plugins: [markdown] be placed in doc/.eslintrc.yaml or root .eslintrc.yaml ? Placed in root .eslintrc.yaml to check docs in other folders.
  2. Should we also add to .eslintignore all .md files in non-doc folders? Currently no need.
doc/api/stream.md Outdated
@@ -280,7 +280,7 @@ has been called, and all data has been flushed to the underlying system.

```js
const writer = getWritableStreamSomehow();
for (var i = 0; i < 100; i ++) {
for (var i = 0; i < 100; i++) {

This comment has been minimized.

Copy link
@hiroppy

hiroppy Apr 21, 2017

Member

You can use let.

@vsemozhetbyt vsemozhetbyt referenced this pull request Apr 21, 2017
2 of 2 tasks complete

@vsemozhetbyt vsemozhetbyt force-pushed the vsemozhetbyt:eslint-md-no-parsing-errors branch Apr 21, 2017

@vsemozhetbyt

This comment has been minimized.

Copy link
Contributor Author

commented Apr 21, 2017

@TimothyGu @abouthiroppy Thank you. Comments hopefully addressed.

@TimothyGu
Copy link
Member

left a comment

LGTM after one last nit.

doc/api/zlib.md Outdated
```js
1 << windowBits
```
The memory requirements for inflate are (in bytes) `1 << windowBits`.

This comment has been minimized.

Copy link
@TimothyGu

TimothyGu Apr 21, 2017

Member

This empty line can now be removed.

This comment has been minimized.

Copy link
@vsemozhetbyt

vsemozhetbyt Apr 21, 2017

Author Contributor

Done.

@vsemozhetbyt vsemozhetbyt force-pushed the vsemozhetbyt:eslint-md-no-parsing-errors branch Apr 21, 2017

vsemozhetbyt added a commit to vsemozhetbyt/node that referenced this pull request Jul 4, 2017
doc: prepare js code for eslint-plugin-markdown
This is an initial step to eliminate most of parsing errors.

PR-URL: nodejs#12563
Refs: nodejs#12557 (comment)
Reviewed-By: Teddy Katz <teddy.katz@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>
@vsemozhetbyt

This comment has been minimized.

Copy link
Contributor Author

commented Jul 4, 2017

@gibfahn Well, that was something. PTAL: #14067

See also the first comment. Sorry for the mess, I do not know how to do this easier(

@refack refack referenced this pull request Jul 4, 2017
4 of 4 tasks complete
vsemozhetbyt added a commit to vsemozhetbyt/node that referenced this pull request Jul 10, 2017
doc: conform to rules for eslint-plugin-markdown
PR-URL: nodejs#12563
Refs: nodejs#12557 (comment)
Reviewed-By: Teddy Katz <teddy.katz@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>
vsemozhetbyt added a commit to vsemozhetbyt/node that referenced this pull request Jul 10, 2017
build, doc, tools: add eslint-plugin-markdown
* Install eslint-plugin-markdown@1.0.0-beta.7
* 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: nodejs#12563
Refs: nodejs#12640
Refs: nodejs#14047
vsemozhetbyt added a commit to vsemozhetbyt/node that referenced this pull request Jul 11, 2017
doc: prepare js code for eslint-plugin-markdown
This is an initial step to eliminate most of parsing errors.

PR-URL: nodejs#12563
Refs: nodejs#12557 (comment)
Reviewed-By: Teddy Katz <teddy.katz@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>
vsemozhetbyt added a commit to vsemozhetbyt/node that referenced this pull request Jul 11, 2017
doc: conform to rules for eslint-plugin-markdown
PR-URL: nodejs#12563
Refs: nodejs#12557 (comment)
Reviewed-By: Teddy Katz <teddy.katz@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>
vsemozhetbyt added a commit to vsemozhetbyt/node that referenced this pull request Jul 11, 2017
build, doc, tools: add eslint-plugin-markdown
* Install eslint-plugin-markdown@1.0.0-beta.7
* 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: nodejs#12563
Refs: nodejs#12640
Refs: nodejs#14047
vsemozhetbyt added a commit to vsemozhetbyt/node that referenced this pull request Jul 11, 2017
build, doc, tools: add eslint-plugin-markdown
* Install eslint-plugin-markdown@1.0.0-beta.7
* 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: nodejs#12563
Refs: nodejs#12640
Refs: nodejs#14047
vsemozhetbyt added a commit to vsemozhetbyt/node that referenced this pull request Jul 19, 2017
doc: prepare js code for eslint-plugin-markdown
This is an initial step to eliminate most of parsing errors.

PR-URL: nodejs#12563
Refs: nodejs#12557 (comment)
Reviewed-By: Teddy Katz <teddy.katz@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>
vsemozhetbyt added a commit to vsemozhetbyt/node that referenced this pull request Jul 19, 2017
doc: conform to rules for eslint-plugin-markdown
PR-URL: nodejs#12563
Refs: nodejs#12557 (comment)
Reviewed-By: Teddy Katz <teddy.katz@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>
vsemozhetbyt added a commit to vsemozhetbyt/node that referenced this pull request Jul 19, 2017
build, doc, tools: add eslint-plugin-markdown
* Install eslint-plugin-markdown@1.0.0-beta.7
* 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: nodejs#12563
Refs: nodejs#12640
Refs: nodejs#14047
MylesBorins added a commit that referenced this pull request Jul 21, 2017
doc: prepare js code for eslint-plugin-markdown
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 <teddy.katz@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>
MylesBorins added a commit that referenced this pull request Jul 21, 2017
doc: conform to rules for eslint-plugin-markdown
Backport-PR-URL: #14067
PR-URL: #12563
Refs: #12557 (comment)
Reviewed-By: Teddy Katz <teddy.katz@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>
MylesBorins added a commit that referenced this pull request Jul 21, 2017
build, doc, tools: add eslint-plugin-markdown
* Install eslint-plugin-markdown@1.0.0-beta.7
* 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 <jasnell@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
MylesBorins added a commit that referenced this pull request Jul 21, 2017
doc: prepare js code for eslint-plugin-markdown
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 <teddy.katz@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>
MylesBorins added a commit that referenced this pull request Jul 21, 2017
doc: conform to rules for eslint-plugin-markdown
Backport-PR-URL: #14067
PR-URL: #12563
Refs: #12557 (comment)
Reviewed-By: Teddy Katz <teddy.katz@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>
MylesBorins added a commit that referenced this pull request Jul 21, 2017
build, doc, tools: add eslint-plugin-markdown
* Install eslint-plugin-markdown@1.0.0-beta.7
* 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 <jasnell@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
@MylesBorins MylesBorins referenced this pull request Jul 21, 2017
MylesBorins added a commit that referenced this pull request Jul 31, 2017
doc: prepare js code for eslint-plugin-markdown
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 <teddy.katz@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>
MylesBorins added a commit that referenced this pull request Jul 31, 2017
doc: conform to rules for eslint-plugin-markdown
Backport-PR-URL: #14067
PR-URL: #12563
Refs: #12557 (comment)
Reviewed-By: Teddy Katz <teddy.katz@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>
MylesBorins added a commit that referenced this pull request Jul 31, 2017
build, doc, tools: add eslint-plugin-markdown
* Install eslint-plugin-markdown@1.0.0-beta.7
* 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 <jasnell@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
You can’t perform that action at this time.