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

tools: update remark configuration #8666

Merged
merged 1 commit into from
Sep 21, 2016
Merged

Conversation

ChALkeR
Copy link
Member

@ChALkeR ChALkeR commented Sep 20, 2016

Checklist
  • make -j4 test (UNIX), or vcbuild test nosign (Windows) passes
  • commit message follows commit guidelines
Affected core subsystem(s)

tools

Description of change

Update remark configuration:

  1. Specify the plugin name as 'remark-lint/', as new remark-cli refused to find it when cwd is different from the directory where node_modules are put. Trailing slash fixes this, as the plugin name gets treated as a path, so require works on it.
  2. Explicitly specify the list of rules we want to enable, as the new
    remark-lint is opt-in and doesn't come with any rules by default.
  3. Reorder the rules alphabetically.

Previous work in #7729.

This change is extracted from #8551, as the tooling might take more time to land and would probably be not backported, and this config update is required to file further doc cleanups in order to avoid conflicts in this config file. Also, I am planning to backport at least some of the doc cleanups.

/cc @Trott, @addaleax, @nodejs/documentation

@ChALkeR ChALkeR added the tools Issues and PRs related to the tools directory. label Sep 20, 2016
Copy link
Member

@addaleax addaleax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Member

@Trott Trott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Specify the plugin name as 'remark-lint/', as new remark-cli refused to
find it when cwd is different from the directory where node_modules are
put. Trailing slash fixes this, as the plugin name gets treated as a
path, so `require` works on it.

Explicitly specify the list of rules we want to enable, as the new
remark-lint is opt-in and doesn't come with any rules by default.

Reorder the rules alphabetically.

PR-URL: nodejs#8666
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
@ChALkeR
Copy link
Member Author

ChALkeR commented Sep 21, 2016

Landed in 7b7d50a.

@ChALkeR ChALkeR merged commit 7b7d50a into nodejs:master Sep 21, 2016
jasnell pushed a commit that referenced this pull request Sep 29, 2016
Specify the plugin name as 'remark-lint/', as new remark-cli refused to
find it when cwd is different from the directory where node_modules are
put. Trailing slash fixes this, as the plugin name gets treated as a
path, so `require` works on it.

Explicitly specify the list of rules we want to enable, as the new
remark-lint is opt-in and doesn't come with any rules by default.

Reorder the rules alphabetically.

PR-URL: #8666
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
@ChALkeR ChALkeR mentioned this pull request Oct 4, 2016
3 tasks
Fishrock123 pushed a commit that referenced this pull request Oct 11, 2016
Specify the plugin name as 'remark-lint/', as new remark-cli refused to
find it when cwd is different from the directory where node_modules are
put. Trailing slash fixes this, as the plugin name gets treated as a
path, so `require` works on it.

Explicitly specify the list of rules we want to enable, as the new
remark-lint is opt-in and doesn't come with any rules by default.

Reorder the rules alphabetically.

PR-URL: #8666
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tools Issues and PRs related to the tools directory.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants