doc: add new documentation lint rule

estrada9166 · BridgeAR · commit b0e2fd0dd84b · 2018-05-01T04:12:52.000+02:00
Add 80 characters limit to docs. Change docs to fit 80 characters per row. PR-URL: nodejs#18726 Fixes: nodejs#18703 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
diff --git a/BUILDING.md b/BUILDING.md
@@ -34,7 +34,7 @@ Support is divided into three tiers:
 ### Supported platforms
 
 The community does not build or test against end-of-life distributions (EoL).
-Thus we do not recommend that you use Node on end-of-life or unsupported 
+Thus we do not recommend that you use Node on end-of-life or unsupported
 platforms in production.
 
 |  System      | Support type | Version                          | Architectures        | Notes            |
@@ -108,10 +108,10 @@ installed, you can find them under the menu `Xcode -> Open Developer Tool ->
 More Developer Tools...`. This step will install `clang`, `clang++`, and
 `make`.
 * After building, you may want to setup [firewall rules](tools/macosx-firewall.sh)
-to avoid popups asking to accept incoming network connections when running 
+to avoid popups asking to accept incoming network connections when running
 tests:
 
-If the path to your build directory contains a space, the build will likely 
+If the path to your build directory contains a space, the build will likely
 fail.
 
 ```console
@@ -244,7 +244,7 @@ Prerequisites:
 * **Optional** (to build the MSI): the [WiX Toolset v3.11](http://wixtoolset.org/releases/)
   and the [Wix Toolset Visual Studio 2017 Extension](https://marketplace.visualstudio.com/items?itemName=RobMensching.WixToolsetVisualStudio2017Extension).
 
-If the path to your build directory contains a space or a non-ASCII character, 
+If the path to your build directory contains a space or a non-ASCII character,
 the build will likely fail.
 
 ```console
diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md
@@ -208,19 +208,24 @@ confirm that the changes are not resulting in an unreliable test.
 #### Useful CI Jobs
 
 * [`node-test-pull-request`](https://ci.nodejs.org/job/node-test-pull-request/)
-is the standard CI run we do to check Pull Requests. It triggers 
-`node-test-commit`, which runs the `build-ci` and `test-ci` targets on all 
+is the standard CI run we do to check Pull Requests. It triggers
+`node-test-commit`, which runs the `build-ci` and `test-ci` targets on all
 supported platforms.
 
+* [`node-test-linter`](https://ci.nodejs.org/job/node-test-linter/)
+only runs the linter targets, which is useful for changes that only affect
+comments or documentation.
+
 * [`node-test-pull-request-lite`](https://ci.nodejs.org/job/node-test-pull-request-lite/)
 only runs the linter job, as well as the tests on LinuxONE, which is very fast.
 This is useful for changes that only affect comments or documentation.
 
 * [`citgm-smoker`](https://ci.nodejs.org/job/citgm-smoker/)
-uses [`CitGM`](https://github.com/nodejs/citgm) to allow you to run `npm 
-install && npm test` on a large selection of common modules. This is useful to 
-check whether a change will cause breakage in the ecosystem. To test Node.js 
-ABI changes you can run [`citgm-abi-smoker`](https://ci.nodejs.org/job/citgm-abi-smoker/).
+uses [`CitGM`](https://github.com/nodejs/citgm) to allow you to run
+`npm install && npm test` on a large selection of common modules. This is useful
+to check whether a change will cause breakage in the ecosystem. To test Node.js
+ABI changes you can run
+[`citgm-abi-smoker`](https://ci.nodejs.org/job/citgm-abi-smoker/).
 
 * [`node-stress-single-test`](https://ci.nodejs.org/job/node-stress-single-test/)
 is designed to allow one to run a group of tests over and over on a specific
@@ -561,7 +566,7 @@ Apply external patches:
 $ curl -L https://github.com/nodejs/node/pull/xxx.patch | git am --whitespace=fix
 ```
 
-If the merge fails even though recent CI runs were successful, then a 3-way 
+If the merge fails even though recent CI runs were successful, then a 3-way
 merge may be required.  In this case try:
 
 ```text
@@ -570,8 +575,8 @@ $ curl -L https://github.com/nodejs/node/pull/xxx.patch | git am -3 --whitespace
 ```
 If the 3-way merge succeeds you can proceed, but make sure to check the changes
 against the original PR carefully and build/test on at least one platform
-before landing. If the 3-way merge fails, then it is most likely that a 
-conflicting PR has landed since the CI run and you will have to ask the author 
+before landing. If the 3-way merge fails, then it is most likely that a
+conflicting PR has landed since the CI run and you will have to ask the author
 to rebase.
 
 Check and re-review the changes:
diff --git a/GOVERNANCE.md b/GOVERNANCE.md
@@ -160,7 +160,7 @@ repository, with a summary of the nominee's contributions, for example:
   Node.js organization
   * Can be shown using the links
   `https://github.com/search?q=author%3A${GITHUB_ID}++org%3Anodejs&type=Issues`
-  and
+    and
 `https://github.com/search?q=commenter%3A${GITHUB_ID}++org%3Anodejs&type=Issues`
 * Other participation in the wider Node.js community
 
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
 <p align="center">
   <a href="https://nodejs.org/">
-    <img 
-      alt="Node.js" 
-      src="https://nodejs.org/static/images/logo-light.svg" 
+    <img
+      alt="Node.js"
+      src="https://nodejs.org/static/images/logo-light.svg"
       width="400"
     />
   </a>
diff --git a/doc/api/cluster.md b/doc/api/cluster.md
@@ -269,7 +269,7 @@ changes:
 
 * Returns: {cluster.Worker} A reference to `worker`.
 
-In a worker, this function will close all servers, wait for the `'close'` event 
+In a worker, this function will close all servers, wait for the `'close'` event
 on those servers, and then disconnect the IPC channel.
 
 In the master, an internal message is sent to the worker causing it to call
@@ -280,7 +280,7 @@ Causes `.exitedAfterDisconnect` to be set.
 Note that after a server is closed, it will no longer accept new connections,
 but connections may be accepted by any other listening worker. Existing
 connections will be allowed to close as usual. When no more connections exist,
-see [`server.close()`][], the IPC channel to the worker will close allowing it 
+see [`server.close()`][], the IPC channel to the worker will close allowing it
 to die gracefully.
 
 The above applies *only* to server connections, client connections are not
@@ -639,7 +639,7 @@ Calls `.disconnect()` on each worker in `cluster.workers`.
 When they are disconnected all internal handles will be closed, allowing the
 master process to die gracefully if no other event is waiting.
 
-The method takes an optional callback argument which will be called when 
+The method takes an optional callback argument which will be called when
 finished.
 
 This can only be called from the master process.
diff --git a/doc/api/console.md b/doc/api/console.md
@@ -441,7 +441,7 @@ added: v8.0.0
 * `label` {string} **Default:** `'default'`
 
 This method does not display anything unless used in the inspector. The
-`console.markTimeline()` method is the deprecated form of 
+`console.markTimeline()` method is the deprecated form of
 [`console.timeStamp()`][].
 
 ### console.profile([label])
@@ -508,7 +508,7 @@ added: v8.0.0
 * `label` {string} **Default:** `'default'`
 
 This method does not display anything unless used in the inspector. The
-`console.timelineEnd()` method is the deprecated form of 
+`console.timelineEnd()` method is the deprecated form of
 [`console.timeEnd()`][].
 
 [`console.error()`]: #console_console_error_data_args
diff --git a/doc/api/debugger.md b/doc/api/debugger.md
@@ -8,7 +8,7 @@
 
 Node.js includes an out-of-process debugging utility accessible via a
 [V8 Inspector][] and built-in debugging client. To use it, start Node.js
-with the `inspect` argument followed by the path to the script to debug; a 
+with the `inspect` argument followed by the path to the script to debug; a
 prompt will be displayed indicating successful launch of the debugger:
 
 ```txt
@@ -173,7 +173,7 @@ breakpoint)
 ### V8 Inspector Integration for Node.js
 
 V8 Inspector integration allows attaching Chrome DevTools to Node.js
-instances for debugging and profiling. It uses the 
+instances for debugging and profiling. It uses the
 [Chrome Debugging Protocol][].
 
 V8 Inspector can be enabled by passing the `--inspect` flag when starting a
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md
@@ -699,8 +699,8 @@ Type: Runtime
 
 `Module._debug()` has been deprecated.
 
-The `Module._debug()` function was never documented as an officially
-supported API.
+The `Module._debug()` function was never documented as an officially supported
+API.
 
 <a id="DEP0078"></a>
 ### DEP0078: REPLServer.turnOffEditorMode()
diff --git a/doc/api/dgram.md b/doc/api/dgram.md
@@ -394,7 +394,7 @@ added: v8.6.0
 
 *Note: All references to scope in this section are referring to
 [IPv6 Zone Indices][], which are defined by [RFC 4007][]. In string form, an IP
-with a scope index is written as `'IP%scope'` where scope is an interface name 
+with a scope index is written as `'IP%scope'` where scope is an interface name
 or interface number.*
 
 Sets the default outgoing multicast interface of the socket to a chosen
diff --git a/doc/api/dns.md b/doc/api/dns.md
@@ -143,7 +143,7 @@ changes:
   - `verbatim` {boolean} When `true`, the callback receives IPv4 and IPv6
     addresses in the order the DNS resolver returned them. When `false`,
     IPv4 addresses are placed before IPv6 addresses.
-    **Default:** currently `false` (addresses are reordered) but this is 
+    **Default:** currently `false` (addresses are reordered) but this is
     expected to change in the not too distant future.
     New code should use `{ verbatim: true }`.
 - `callback` {Function}
diff --git a/doc/api/documentation.md b/doc/api/documentation.md
@@ -85,7 +85,7 @@ like [`fs.open()`][], will document that. The docs link to the corresponding man
 pages (short for manual pages) which describe how the syscalls work.
 
 Some syscalls, like lchown(2), are BSD-specific. That means, for
-example, that [`fs.lchown()`][] only works on macOS and other BSD-derived 
+example, that [`fs.lchown()`][] only works on macOS and other BSD-derived
 systems, and is not available on Linux.
 
 Most Unix syscalls have Windows equivalents, but behavior may differ on Windows
diff --git a/doc/api/domain.md b/doc/api/domain.md
@@ -337,8 +337,8 @@ d.on('error', (er) => {
 The `enter` method is plumbing used by the `run`, `bind`, and `intercept`
 methods to set the active domain. It sets `domain.active` and `process.domain`
 to the domain, and implicitly pushes the domain onto the domain stack managed
-by the domain module (see [`domain.exit()`][] for details on the domain stack). 
-The call to `enter` delimits the beginning of a chain of asynchronous calls and 
+by the domain module (see [`domain.exit()`][] for details on the domain stack).
+The call to `enter` delimits the beginning of a chain of asynchronous calls and
 I/O operations bound to a domain.
 
 Calling `enter` changes only the active domain, and does not alter the domain
diff --git a/doc/api/errors.md b/doc/api/errors.md
@@ -227,8 +227,8 @@ Error.captureStackTrace(myObject);
 myObject.stack;  // similar to `new Error().stack`
 ```
 
-The first line of the trace will be prefixed with `${myObject.name}: 
-${myObject.message}`.
+The first line of the trace will be prefixed with
+`${myObject.name}: ${myObject.message}`.
 
 The optional `constructorOpt` argument accepts a function. If given, all frames
 above `constructorOpt`, including `constructorOpt`, will be omitted from the
diff --git a/doc/api/events.md b/doc/api/events.md
@@ -515,9 +515,9 @@ listener array for the specified `eventName`, then `removeListener` must be
 called multiple times to remove each instance.
 
 Note that once an event has been emitted, all listeners attached to it at the
-time of emitting will be called in order. This implies that any 
+time of emitting will be called in order. This implies that any
 `removeListener()` or `removeAllListeners()` calls *after* emitting and *before*
-the last listener finishes execution will not remove them from `emit()` 
+the last listener finishes execution will not remove them from `emit()`
 in progress. Subsequent events will behave as expected.
 
 ```js
diff --git a/doc/api/http2.md b/doc/api/http2.md
@@ -1457,9 +1457,9 @@ a request with an HTTP `Expect: 100-continue` is received. If this event is
 not listened for, the server will automatically respond with a status
 `100 Continue` as appropriate.
 
-Handling this event involves calling [`response.writeContinue()`][] if the 
-client should continue to send the request body, or generating an appropriate 
-HTTP response (e.g. 400 Bad Request) if the client should not continue to send 
+Handling this event involves calling [`response.writeContinue()`][] if the
+client should continue to send the request body, or generating an appropriate
+HTTP response (e.g. 400 Bad Request) if the client should not continue to send
 the request body.
 
 Note that when this event is emitted and handled, the [`'request'`][] event will
@@ -1572,9 +1572,9 @@ time a request with an HTTP `Expect: 100-continue` is received. If this event
 is not listened for, the server will automatically respond with a status
 `100 Continue` as appropriate.
 
-Handling this event involves calling [`response.writeContinue()`][] if the 
-client should continue to send the request body, or generating an appropriate 
-HTTP response (e.g. 400 Bad Request) if the client should not continue to send 
+Handling this event involves calling [`response.writeContinue()`][] if the
+client should continue to send the request body, or generating an appropriate
+HTTP response (e.g. 400 Bad Request) if the client should not continue to send
 the request body.
 
 Note that when this event is emitted and handled, the [`'request'`][] event will
diff --git a/doc/api/https.md b/doc/api/https.md
@@ -158,7 +158,7 @@ changes:
     pr-url: https://github.com/nodejs/node/pull/10638
     description: The `options` parameter can be a WHATWG `URL` object.
 -->
-- `options` {Object | string | URL} Accepts all `options` from 
+- `options` {Object | string | URL} Accepts all `options` from
   [`http.request()`][], with some differences in default values:
   - `protocol` **Default:** `'https:'`
   - `port` **Default:** `443`
diff --git a/doc/api/n-api.md b/doc/api/n-api.md
@@ -139,8 +139,8 @@ create a scope before invoking any functions that can result in the creation
 of JavaScript values.
 
 Handle scopes are created using [`napi_open_handle_scope`][] and are destroyed
-using [`napi_close_handle_scope`][]. Closing the scope can indicate to the GC 
-that all `napi_value`s created during the lifetime of the handle scope are no 
+using [`napi_close_handle_scope`][]. Closing the scope can indicate to the GC
+that all `napi_value`s created during the lifetime of the handle scope are no
 longer referenced from the current stack frame.
 
 For more details, review the [Object Lifetime Management][].
@@ -667,7 +667,7 @@ current scope and the lifespan of the handle changes from the current
 scope to that of the outer scope.
 
 The methods available to open/close escapable scopes are
-[`napi_open_escapable_handle_scope`][] and 
+[`napi_open_escapable_handle_scope`][] and
 [`napi_close_escapable_handle_scope`][].
 
 The request to promote a handle is made through [`napi_escape_handle`][] which
@@ -1371,7 +1371,7 @@ TypedArray objects provide an array-like view over an underlying data buffer
 where each element has the same underlying binary scalar datatype.
 
 It's required that (length * size_of_element) + byte_offset should
-be <= the size in bytes of the array passed in. If not, a RangeError exception 
+be <= the size in bytes of the array passed in. If not, a RangeError exception
 is raised.
 
 JavaScript TypedArray Objects are described in
@@ -1617,10 +1617,10 @@ its length.
 
 *WARNING*: Use caution while using this API. The lifetime of the underlying data
 buffer is managed by the ArrayBuffer even after it's returned. A
-possible safe way to use this API is in conjunction with 
-[`napi_create_reference`][], which can be used to guarantee control over the 
-lifetime of the ArrayBuffer. It's also safe to use the returned data buffer 
-within the same callback as long as there are no calls to other APIs that might 
+possible safe way to use this API is in conjunction with
+[`napi_create_reference`][], which can be used to guarantee control over the
+lifetime of the ArrayBuffer. It's also safe to use the returned data buffer
+within the same callback as long as there are no calls to other APIs that might
 trigger a GC.
 
 #### napi_get_buffer_info
@@ -1909,7 +1909,7 @@ napi_status napi_get_value_string_utf16(napi_env env,
 passed in, the length of the string (in 2-byte code units) is returned.
 - `[in] bufsize`: Size of the destination buffer. When this value is
 insufficient, the returned string will be truncated.
-- `[out] result`: Number of 2-byte code units copied into the buffer, excluding 
+- `[out] result`: Number of 2-byte code units copied into the buffer, excluding
 the null terminator.
 
 Returns `napi_ok` if the API succeeded. If a non-String `napi_value`
@@ -2770,7 +2770,7 @@ Returns `napi_ok` if the API succeeded.
 
 This method allows the efficient definition of multiple properties on a given
 object. The properties are defined using property descriptors (See
-[`napi_property_descriptor`][]). Given an array of such property descriptors, 
+[`napi_property_descriptor`][]). Given an array of such property descriptors,
 this API will set the properties on the object one at a time, as defined by
 DefineOwnProperty (described in [Section 9.1.6][] of the ECMA262 specification).
 
@@ -3182,7 +3182,7 @@ This API may modify the prototype chain of the wrapper object. Afterward,
 additional manipulation of the wrapper's prototype chain may cause
 `napi_unwrap()` to fail.
 
-Calling napi_wrap() a second time on an object will return an error. To 
+Calling napi_wrap() a second time on an object will return an error. To
 associate another native instance with the object, use napi_remove_wrap() first.
 
 ### napi_unwrap
diff --git a/doc/api/process.md b/doc/api/process.md
@@ -193,9 +193,9 @@ of allocated resources (e.g. file descriptors, handles, etc) before shutting
 down the process. **It is not safe to resume normal operation after
 `'uncaughtException'`.**
 
-To restart a crashed application in a more reliable way, whether 
-`uncaughtException` is emitted or not, an external monitor should be employed 
-in a separate process to detect application failures and recover or restart as 
+To restart a crashed application in a more reliable way, whether
+`uncaughtException` is emitted or not, an external monitor should be employed
+in a separate process to detect application failures and recover or restart as
 needed.
 
 ### Event: 'unhandledRejection'
@@ -380,7 +380,7 @@ process.on('SIGTERM', handle);
   installed its default behavior will be removed.
 * `SIGTERM` is not supported on Windows, it can be listened on.
 * `SIGINT` from the terminal is supported on all platforms, and can usually be
-  generated with `<Ctrl>+C` (though this may be configurable). It is not 
+  generated with `<Ctrl>+C` (though this may be configurable). It is not
   generated when terminal raw mode is enabled.
 * `SIGBREAK` is delivered on Windows when `<Ctrl>+<Break>` is pressed, on
   non-Windows platforms it can be listened on, but there is no way to send or
@@ -417,7 +417,7 @@ added: v0.5.0
 
 * {string}
 
-The `process.arch` property returns a string identifying the operating system 
+The `process.arch` property returns a string identifying the operating system
 CPU architecture for which the Node.js binary was compiled.
 
 The current possible values are: `'arm'`, `'arm64'`, `'ia32'`, `'mips'`,
@@ -1631,7 +1631,7 @@ added: v0.9.4
 * `groups` {integer[]}
 
 The `process.setgroups()` method sets the supplementary group IDs for the
-Node.js process. This is a privileged operation that requires the Node.js 
+Node.js process. This is a privileged operation that requires the Node.js
 process to have `root` or the `CAP_SETGID` capability.
 
 The `groups` array can contain numeric group IDs, group names or both.
diff --git a/doc/api/tracing.md b/doc/api/tracing.md
@@ -5,12 +5,12 @@
 Trace Event provides a mechanism to centralize tracing information generated by
 V8, Node core, and userspace code.
 
-Tracing can be enabled by passing the `--trace-events-enabled` flag when 
+Tracing can be enabled by passing the `--trace-events-enabled` flag when
 starting a Node.js application.
 
 The set of categories for which traces are recorded can be specified using the
-`--trace-event-categories` flag followed by a list of comma separated category 
-names. By default the `node`, `node.async_hooks`, and `v8` categories are 
+`--trace-event-categories` flag followed by a list of comma separated category
+names. By default the `node`, `node.async_hooks`, and `v8` categories are
 enabled.
 
 ```txt
diff --git a/doc/api/util.md b/doc/api/util.md
diff --git a/doc/api/v8.md b/doc/api/v8.md
diff --git a/doc/guides/building-node-with-ninja.md b/doc/guides/building-node-with-ninja.md
diff --git a/doc/guides/maintaining-V8.md b/doc/guides/maintaining-V8.md
diff --git a/doc/guides/maintaining-the-build-files.md b/doc/guides/maintaining-the-build-files.md
diff --git a/doc/guides/writing-and-running-benchmarks.md b/doc/guides/writing-and-running-benchmarks.md
diff --git a/doc/guides/writing-tests.md b/doc/guides/writing-tests.md
diff --git a/tools/icu/README.md b/tools/icu/README.md
diff --git a/tools/remark-preset-lint-node/package-lock.json b/tools/remark-preset-lint-node/package-lock.json
