tools: enable more remark-lint rules

New rules: 1. rule-style 2. strong-marker 3. no-shell-dollars 4. no-inline-padding 5. code-block-style 6. no-multiple-toplevel-headings Fixes to the existing files applied. PR-URL: #8708 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ilkka Myller <ilkka.myller@nodefield.com> Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: James M Snell <jasnell@gmail.com>
nodejs · Sep 25, 2016 · 50be885 · 50be885
1 parent d196c5d
commit 50be885
Show file tree

Hide file tree

Showing 18 changed files with 154 additions and 144 deletions.
diff --git a/.remarkrc b/.remarkrc
@@ -4,7 +4,7 @@
       "blockquote-indentation": 2,
       "checkbox-character-style": { "checked": "x", "unchecked": " " },
       "checkbox-content-indent": true,
-      "code-block-style": false,
+      "code-block-style": "fenced",
       "definition-case": false,
       "definition-spacing": true,
       "emphasis-marker": false,
@@ -39,11 +39,11 @@
       "no-heading-indent": true,
       "no-heading-punctuation": false,
       "no-html": false,
-      "no-inline-padding": false,
+      "no-inline-padding": true,
       "no-literal-urls": false,
       "no-missing-blank-lines": false,
-      "no-multiple-toplevel-headings": false,
-      "no-shell-dollars": false,
+      "no-multiple-toplevel-headings": true,
+      "no-shell-dollars": true,
       "no-shortcut-reference-image": true,
       "no-shortcut-reference-link": false,
       "no-table-indentation": true,
@@ -52,8 +52,8 @@
       "no-unused-definitions": true,
       "ordered-list-marker-style": false,
       "ordered-list-marker-value": false,
-      "rule-style": false,
-      "strong-marker": false,
+      "rule-style": true,
+      "strong-marker": "*",
       "table-cell-padding": "padded",
       "table-pipe-alignment": false,
       "table-pipes": true,

diff --git a/ROADMAP.md b/ROADMAP.md
@@ -38,9 +38,9 @@ In order for Node.js to stay competitive we need to work on the next generation
 
 While this constitutes a great leap forward for the platform we will be making this leap without breaking backwards compatibility with the existing ecosystem of modules.
 
-# Immediate Priorities
+## Immediate Priorities
 
-## Debugging and Tracing
+### Debugging and Tracing
 
 Debugging is one of the first things from everyone's mouth, both developer and enterprise, when describing trouble they've had with Node.js.
 
@@ -55,7 +55,7 @@ The [Tracing WG](https://github.com/nodejs/tracing-wg) is driving this effort:
   * [Unify the Tracing endpoint](https://github.com/nodejs/node/issues/729).
   * New Chrome Debugger - Google is working on a version of Chrome's debugger that is without Chrome and can be used with Node.js.
 
-## Ecosystem Automation
+### Ecosystem Automation
 
 In order to maintain a good release cadence without harming compatibility we must do a better job of understanding exactly what impact a particular change or release will have on the ecosystem. This requires new automation.
 
@@ -65,19 +65,19 @@ The initial goals for this automation are relatively simple but will create a ba
 * Produce a list of modules that use a particular core API.
 * Produce detailed code coverage data for the tests in core.
 
-## Improve Installation and Upgrades
+### Improve Installation and Upgrades
 
 * Host and maintain registry endpoints (Homebrew, apt, etc).
 * Document installation and upgrade procedures with an emphasis on using nvm or nave for development and our registry endpoints for traditional package managers and production.
 
-## Streams
+### Streams
 
 * Fix all existing compatibility issues.
 * Simplify stream creation to avoid user error.
 * Explore and identify compatibility issues with [WHATWG Streams](https://github.com/whatwg/streams).
 * Improve stream performance.
 
-## Internationalization / Localization
+### Internationalization / Localization
 
 * Build documentation tooling with localization support built in.
 * Reduce size of ICU and ship with it by default.

diff --git a/doc/api/addons.md b/doc/api/addons.md
@@ -243,7 +243,7 @@ filename to the `sources` array. For example:
 Once the `binding.gyp` file is ready, the example Addons can be configured and
 built using `node-gyp`:
 
-```sh
+```console
 $ node-gyp configure build
 ```
 

diff --git a/doc/api/debugger.md b/doc/api/debugger.md
@@ -181,7 +181,7 @@ localhost:5858
 
 ## V8 Inspector Integration for Node.js
 
-__NOTE: This is an experimental feature.__
+**NOTE: This is an experimental feature.**
 
 V8 Inspector integration allows attaching Chrome DevTools to Node.js
 instances for debugging and profiling.

diff --git a/doc/api/dns.md b/doc/api/dns.md
@@ -6,9 +6,9 @@ The `dns` module contains functions belonging to two different categories:
 
 1) Functions that use the underlying operating system facilities to perform
 name resolution, and that do not necessarily perform any network communication.
-This category contains only one function: [`dns.lookup()`][]. __Developers
+This category contains only one function: [`dns.lookup()`][]. **Developers
 looking to perform name resolution in the same way that other applications on
-the same operating system behave should use [`dns.lookup()`][].__
+the same operating system behave should use [`dns.lookup()`][].**
 
 For example, looking up `nodejs.org`.
 

diff --git a/doc/api/net.md b/doc/api/net.md
@@ -207,8 +207,10 @@ persist*, they are removed when the last reference to them is closed. Do not
 forget JavaScript string escaping requires paths to be specified with
 double-backslashes, such as:
 
-    net.createServer().listen(
-        path.join('\\\\?\\pipe', process.cwd(), 'myctl'))
+```js
+net.createServer().listen(
+    path.join('\\\\?\\pipe', process.cwd(), 'myctl'))
+```
 
 The parameter `backlog` behaves the same as in
 [`server.listen([port][, hostname][, backlog][, callback])`][`server.listen(port, host, backlog, callback)`].
@@ -363,7 +365,7 @@ Emitted when data is received.  The argument `data` will be a `Buffer` or
 `String`.  Encoding of data is set by `socket.setEncoding()`.
 (See the [Readable Stream][] section for more information.)
 
-Note that the __data will be lost__ if there is no listener when a `Socket`
+Note that the **data will be lost** if there is no listener when a `Socket`
 emits a `'data'` event.
 
 ### Event: 'drain'

diff --git a/doc/api/process.md b/doc/api/process.md
@@ -478,7 +478,7 @@ process.argv.forEach((val, index) => {
 
 Launching the Node.js process as:
 
-```sh
+```console
 $ node process-2.js one two=three four
 ```
 
@@ -500,7 +500,7 @@ added: 6.4.0
 The `process.argv0` property stores a read-only copy of the original value of
 `argv[0]` passed when Node.js starts.
 
-```js
+```console
 $ bash -c 'exec -a customArgv0 ./node'
 > process.argv[0]
 '/Volumes/code/external/node/out/Release/node'
@@ -672,7 +672,7 @@ It is possible to modify this object, but such modifications will not be
 reflected outside the Node.js process. In other words, the following example
 would not work:
 
-```sh
+```console
 $ node -e 'process.env.foo = "bar"' && echo $foo
 ```
 
@@ -811,7 +811,7 @@ the same execution environment as the parent.
 
 For example:
 
-```sh
+```console
 $ node --harmony script.js --version
 ```
 
@@ -1461,7 +1461,7 @@ in several ways:
 3. Writes _can_ block when output is redirected to a file.
   - Note that disks are fast and operating systems normally employ write-back
     caching so this is very uncommon.
-4. Writes on UNIX __will__ block by default if output is going to a TTY
+4. Writes on UNIX **will** block by default if output is going to a TTY
    (a terminal).
 5. Windows functionality differs. Writes block except when output is going to a
    TTY.
@@ -1519,7 +1519,7 @@ in several ways:
 3. Writes _can_ block when output is redirected to a file.
   - Note that disks are fast and operating systems normally employ write-back
     caching so this is very uncommon.
-4. Writes on UNIX __will__ block by default if output is going to a TTY
+4. Writes on UNIX **will** block by default if output is going to a TTY
    (a terminal).
 5. Windows functionality differs. Writes block except when output is going to a
    TTY.
@@ -1537,7 +1537,7 @@ To check if Node.js is being run in a [TTY][] context, check the `isTTY`
 property on `process.stderr`, `process.stdout`, or `process.stdin`.
 
 For instance:
-```sh
+```console
 $ node -p "Boolean(process.stdin.isTTY)"
 true
 $ echo "foo" | node -p "Boolean(process.stdin.isTTY)"

diff --git a/doc/api/util.md b/doc/api/util.md
@@ -626,7 +626,7 @@ deprecated: v4.0.0
 
 * `object` {any}
 
-Returns `true` if the given `object` is strictly an `Object` __and__ not a
+Returns `true` if the given `object` is strictly an `Object` **and** not a
 `Function`. Otherwise, returns `false`.
 
 ```js

diff --git a/doc/changelogs/CHANGELOG_ARCHIVE.md b/doc/changelogs/CHANGELOG_ARCHIVE.md
@@ -2175,7 +2175,7 @@ https://github.com/nodejs/node/commit/cfba1f59224ff8602c3fe9145181cad4c6df89a9
   --use-http1
 
 * Fixes https host header default port handling. (Mikeal Rogers)
-* [#1440](https://github.com/joyent/node/issues/1440) strip byte order marker when loading *.js and *.json files
+* [#1440](https://github.com/joyent/node/issues/1440) strip byte order marker when loading `*.js` and `*.json` files
   (Ben Noordhuis)
 
 * [#1434](https://github.com/joyent/node/issues/1434) Improve util.format() compatibility with browser. (Koichi Kobayashi)
@@ -3089,8 +3089,9 @@ https://github.com/nodejs/node/commit/61c801413544a50000faa7f58376e9b33ba6254f
 
 https://github.com/nodejs/node/commit/39b63dfe1737d46a8c8818c92773ef181fd174b3
 
-  * API: - Move process.watchFile into fs module
-         - Move process.inherits to sys
+  * API:
+    - Move process.watchFile into fs module
+    - Move process.inherits to sys
 
   * Improve Solaris port
   * tcp.Connection.prototype.write now returns boolean to indicate if
@@ -3424,7 +3425,7 @@ https://github.com/nodejs/node/commit/726865af7bbafe58435986f4a193ff11c84e4bfe
     - __module becomes module
 
   * API: Many namespacing changes
-    - Move node.* into process.*
+    - Move node.\* into process.\*
     - Move node.dns into module "dns"
     - Move node.fs into module "posix"
     - process is no longer the global object. GLOBAL is.

diff --git a/doc/changelogs/CHANGELOG_V4.md b/doc/changelogs/CHANGELOG_V4.md
@@ -1486,11 +1486,11 @@ Maintenance update.
 
 * Roughly 78% of the commits are documentation and test improvements
 * **domains**:
-** Fix handling of uncaught exceptions (Julien Gilli) [#3884](https://github.com/nodejs/node/pull/3884)
+  * Fix handling of uncaught exceptions (Julien Gilli) [#3884](https://github.com/nodejs/node/pull/3884)
 * **deps**:
-** Upgrade to npm 2.14.12 (Kat Marchán) [#4110](https://github.com/nodejs/node/pull/4110)
-** Backport 819b40a from V8 upstream (Michaël Zasso) [#3938](https://github.com/nodejs/node/pull/3938)
-** Updated node LICENSE file with new npm license (Kat Marchán) [#4110](https://github.com/nodejs/node/pull/4110)
+  * Upgrade to npm 2.14.12 (Kat Marchán) [#4110](https://github.com/nodejs/node/pull/4110)
+  * Backport 819b40a from V8 upstream (Michaël Zasso) [#3938](https://github.com/nodejs/node/pull/3938)
+  * Updated node LICENSE file with new npm license (Kat Marchán) [#4110](https://github.com/nodejs/node/pull/4110)
 
 ### Known issues
 
@@ -1590,7 +1590,7 @@ Maintenance update.
 * [[`fe3ae3cea4`](https://github.com/nodejs/node/commit/fe3ae3cea4)] - **doc**: add LTS info to COLLABORATOR_GUIDE.md (Myles Borins) [#3442](https://github.com/nodejs/node/pull/3442)
 * [[`daa10a345e`](https://github.com/nodejs/node/commit/daa10a345e)] - **doc**: typo fix in readme.md (Sam P Gallagher-Bishop) [#3649](https://github.com/nodejs/node/pull/3649)
 * [[`eca5720761`](https://github.com/nodejs/node/commit/eca5720761)] - **doc**: fix wrong date and known issue in changelog.md (James M Snell) [#3650](https://github.com/nodejs/node/pull/3650)
-* [[`83494f8f3e`](https://github.com/nodejs/node/commit/83494f8f3e)] - **doc**: rename iojs-* groups to nodejs-* (Steven R. Loomis) [#3634](https://github.com/nodejs/node/pull/3634)
+* [[`83494f8f3e`](https://github.com/nodejs/node/commit/83494f8f3e)] - **doc**: rename iojs-\* groups to nodejs-\* (Steven R. Loomis) [#3634](https://github.com/nodejs/node/pull/3634)
 * [[`347fb65aee`](https://github.com/nodejs/node/commit/347fb65aee)] - **doc**: fix crypto spkac function descriptions (Jason Gerfen) [#3614](https://github.com/nodejs/node/pull/3614)
 * [[`11d2050d63`](https://github.com/nodejs/node/commit/11d2050d63)] - **doc**: Updated streams simplified constructor API (Tom Gallacher) [#3602](https://github.com/nodejs/node/pull/3602)
 * [[`6db4392bfb`](https://github.com/nodejs/node/commit/6db4392bfb)] - **doc**: made code spans more visible in the API docs (phijohns) [#3573](https://github.com/nodejs/node/pull/3573)

diff --git a/doc/changelogs/CHANGELOG_V5.md b/doc/changelogs/CHANGELOG_V5.md
@@ -1499,7 +1499,7 @@ This is an important security release. All Node.js users should consult the secu
 * [[`b14d9c5f16`](https://github.com/nodejs/node/commit/b14d9c5f16)] - **doc**: add method links in events.markdown (Alejandro Oviedo) [#3187](https://github.com/nodejs/node/pull/3187)
 * [[`44f779b112`](https://github.com/nodejs/node/commit/44f779b112)] - **doc**: add caveats of algs and key size in crypto (Shigeki Ohtsu) [#3479](https://github.com/nodejs/node/pull/3479)
 * [[`a0db5fb355`](https://github.com/nodejs/node/commit/a0db5fb355)] - **doc**: stdout/stderr can block when directed to file (Ben Noordhuis) [#3170](https://github.com/nodejs/node/pull/3170)
-* [[`409f29972e`](https://github.com/nodejs/node/commit/409f29972e)] - **doc**: rename iojs-* groups to nodejs-* (Steven R. Loomis) [#3634](https://github.com/nodejs/node/pull/3634)
+* [[`409f29972e`](https://github.com/nodejs/node/commit/409f29972e)] - **doc**: rename iojs-\* groups to nodejs-\* (Steven R. Loomis) [#3634](https://github.com/nodejs/node/pull/3634)
 * [[`801866280e`](https://github.com/nodejs/node/commit/801866280e)] - **doc**: fix wrong date and known issue in changelog.md (James M Snell) [#3650](https://github.com/nodejs/node/pull/3650)
 * [[`325c4c7af5`](https://github.com/nodejs/node/commit/325c4c7af5)] - **doc**: fix function param order in assert doc (David Woods) [#3533](https://github.com/nodejs/node/pull/3533)
 * [[`045e04e531`](https://github.com/nodejs/node/commit/045e04e531)] - **doc**: typo fix in readme.md (Sam P Gallagher-Bishop) [#3649](https://github.com/nodejs/node/pull/3649)

diff --git a/doc/ctc-meetings/2016-06-15.md b/doc/ctc-meetings/2016-06-15.md
@@ -42,8 +42,8 @@ Extracted from **ctc-agenda** labelled issues and pull requests from the **nodej
     * some issue/PRs reviews
 
 * Chris Dickinson @chrisdickinson (CTC)
-      * NodeConf
-      * modules.guide
+    * NodeConf
+    * modules.guide
 
 * Evan Lucas @evanlucas (CTC)
     * Preparing for security release

diff --git a/doc/guides/timers-in-node.md b/doc/guides/timers-in-node.md
@@ -82,7 +82,7 @@ console.log('after immediate');
 The above function passed to `setImmediate()` will execute after all runnable
 code has executed, and the console output will be:
 
-```shell
+```console
 before immediate
 after immediate
 executing immediate: so immediate

diff --git a/doc/releases.md b/doc/releases.md
@@ -34,7 +34,7 @@ A SHASUMS256.txt file is produced for every promoted build, nightly, and release
 
 The GPG keys should be fetchable from a known third-party keyserver. The SKS Keyservers at <https://sks-keyservers.net> are recommended. Use the [submission](https://sks-keyservers.net/i/#submit) form to submit a new GPG key. Keys should be fetchable via:
 
-```sh
+```console
 $ gpg --keyserver pool.sks-keyservers.net --recv-keys <FINGERPRINT>
 ```
 
@@ -55,7 +55,7 @@ Create a new branch named _"vx.y.z-proposal"_, or something similar. Using `git
 
 For a list of commits that could be landed in a patch release on v5.x
 
-```sh
+```console
 $ branch-diff v5.x master --exclude-label=semver-major,semver-minor,dont-land-on-v5.x --filter-release --format=simple
 ```
 
@@ -94,13 +94,13 @@ The general rule is to bump this version when there are _breaking ABI_ changes a
 
 Collect a formatted list of commits since the last release. Use [`changelog-maker`](https://github.com/rvagg/changelog-maker) to do this.
 
-```sh
+```console
 $ changelog-maker --group
 ```
 
 Note that changelog-maker counts commits since the last tag and if the last tag in the repository was not on the current branch you may have to supply a `--start-ref` argument:
 
-```sh
+```console
 $ changelog-maker --group --start-ref v2.3.1
 ```
 
@@ -224,15 +224,15 @@ $ npm install -g git-secure-tag
 
 Create a tag using the following command:
 
-```sh
+```console
 $ git secure-tag <vx.y.z> <commit-sha> -sm 'YYYY-MM-DD Node.js vx.y.z (Release Type) Release'
 ```
 
 The tag **must** be signed using the GPG key that's listed for you on the project README.
 
 Push the tag to the repo before you promote the builds. If you haven't pushed your tag first, then build promotion won't work properly. Push the tag using the following command:
 
-```sh
+```console
 $ git push <remote> <vx.y.z>
 ```