tools: add 'spaced-comment' into eslint rules

PR-URL: #19596
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>

Author: starkwang

.eslintrc.js

@@ -224,6 +224,10 @@ module.exports = {
     'space-in-parens': ['error', 'never'],
     'space-infix-ops': 'error',
     'space-unary-ops': 'error',
+    'spaced-comment': ['error', 'always', {
+      'block': { 'balanced': true },
+      'exceptions': ['-']
+    }],
     'strict': ['error', 'global'],
     'symbol-description': 'error',
     'template-curly-spacing': 'error',

benchmark/buffers/buffer-swap.js

@@ -4,7 +4,7 @@ const common = require('../common.js');
 
 const bench = common.createBenchmark(main, {
   aligned: ['true', 'false'],
-  method: ['swap16', 'swap32', 'swap64'/*, 'htons', 'htonl', 'htonll'*/],
+  method: ['swap16', 'swap32', 'swap64'/* , 'htons', 'htonl', 'htonll' */],
   len: [8, 64, 128, 256, 512, 768, 1024, 1536, 2056, 4096, 8192],
   n: [5e7]
 });

doc/api/assert.md

@@ -456,7 +456,7 @@ assert.equal(1, '1');
 assert.equal(1, 2);
 // AssertionError: 1 == 2
 assert.equal({ a: { b: 1 } }, { a: { b: 1 } });
-//AssertionError: { a: { b: 1 } } == { a: { b: 1 } }
+// AssertionError: { a: { b: 1 } } == { a: { b: 1 } }
 ```
 
 If the values are not equal, an `AssertionError` is thrown with a `message`

doc/api/child_process.md

@@ -166,11 +166,11 @@ directly by the shell and special characters (vary based on
 need to be dealt with accordingly:
 ```js
 exec('"/path/to/test file/test.sh" arg1 arg2');
-//Double quotes are used so that the space in the path is not interpreted as
-//multiple arguments
+// Double quotes are used so that the space in the path is not interpreted as
+// multiple arguments
 
 exec('echo "The \\$HOME variable is $HOME"');
-//The $HOME variable is escaped in the first instance, but not in the second
+// The $HOME variable is escaped in the first instance, but not in the second
 ```
 
 **Never pass unsanitized user input to this function. Any input containing shell

doc/api/http2.md

@@ -203,7 +203,7 @@ settings do not take effect until the `'localSettings'` event is emitted.
 session.settings({ enablePush: false });
 
 session.on('localSettings', (settings) => {
-  /** use the new settings **/
+  /* Use the new settings */
 });
 ```
 
@@ -218,7 +218,7 @@ of the remote settings.
 
 ```js
 session.on('remoteSettings', (settings) => {
-  /** use the new settings **/
+  /* Use the new settings */
 });
 ```
 
@@ -280,7 +280,7 @@ activity on the `Http2Session` after the configured number of milliseconds.
 
 ```js
 session.setTimeout(2000);
-session.on('timeout', () => { /** .. **/ });
+session.on('timeout', () => { /* .. */ });
 ```
 
 #### http2session.alpnProtocol
@@ -706,8 +706,8 @@ const {
 const req = clientSession.request({ [HTTP2_HEADER_PATH]: '/' });
 req.on('response', (headers) => {
   console.log(headers[HTTP2_HEADER_STATUS]);
-  req.on('data', (chunk) => { /** .. **/ });
-  req.on('end', () => { /** .. **/ });
+  req.on('data', (chunk) => { /* .. */ });
+  req.on('end', () => { /* .. */ });
 });
 ```
 
@@ -1928,7 +1928,7 @@ Returns a `ClientHttp2Session` instance.
 const http2 = require('http2');
 const client = http2.connect('https://localhost:1234');
 
-/** use the client **/
+/* Use the client */
 
 client.close();
 ```

doc/api/net.md

@@ -914,7 +914,7 @@ in the [`net.createServer()`][] section:
 ```js
 const net = require('net');
 const client = net.createConnection({ port: 8124 }, () => {
-  //'connect' listener
+  // 'connect' listener
   console.log('connected to server!');
   client.write('world!\r\n');
 });

lib/_http_agent.js

@@ -134,8 +134,8 @@ Agent.prototype.getName = function getName(options) {
   return name;
 };
 
-Agent.prototype.addRequest = function addRequest(req, options, port/*legacy*/,
-                                                 localAddress/*legacy*/) {
+Agent.prototype.addRequest = function addRequest(req, options, port/* legacy */,
+                                                 localAddress/* legacy */) {
   // Legacy API: addRequest(req, host, port, localAddress)
   if (typeof options === 'string') {
     options = {

lib/_http_client.js

@@ -194,7 +194,7 @@ function ClientRequest(options, cb) {
       var posColon = hostHeader.indexOf(':');
       if (posColon !== -1 &&
           hostHeader.indexOf(':', posColon + 1) !== -1 &&
-          hostHeader.charCodeAt(0) !== 91/*'['*/) {
+          hostHeader.charCodeAt(0) !== 91/* '[' */) {
         hostHeader = `[${hostHeader}]`;
       }
 

lib/_http_common.js

@@ -237,7 +237,7 @@ const tokenRegExp = /^[\^_`a-zA-Z\-0-9!#$%&'*+.|~]+$/;
  * Verifies that the given val is a valid HTTP token
  * per the rules defined in RFC 7230
  * See https://tools.ietf.org/html/rfc7230#section-3.2.6
-**/
+ */
 function checkIsHttpToken(val) {
   return tokenRegExp.test(val);
 }
@@ -248,7 +248,7 @@ const headerCharRegex = /[^\t\x20-\x7e\x80-\xff]/;
  *  field-value    = *( field-content / obs-fold )
  *  field-content  = field-vchar [ 1*( SP / HTAB ) field-vchar ]
  *  field-vchar    = VCHAR / obs-text
- **/
+ */
 function checkInvalidHeaderChar(val) {
   return headerCharRegex.test(val);
 }

lib/buffer.js

@@ -170,7 +170,7 @@ const doFlaggedDeprecation =
  * runtime deprecation would introduce too much breakage at this time. It's not
  * likely that the Buffer constructors would ever actually be removed.
  * Deprecation Code: DEP0005
- **/
+ */
 function Buffer(arg, encodingOrOffset, length) {
   doFlaggedDeprecation();
   // Common case.
@@ -196,7 +196,7 @@ Object.defineProperty(Buffer, Symbol.species, {
  * Buffer.from(array)
  * Buffer.from(buffer)
  * Buffer.from(arrayBuffer[, byteOffset[, length]])
- **/
+ */
 Buffer.from = function from(value, encodingOrOffset, length) {
   if (typeof value === 'string')
     return fromString(value, encodingOrOffset);
@@ -260,7 +260,7 @@ function assertSize(size) {
 /**
  * Creates a new filled Buffer instance.
  * alloc(size[, fill[, encoding]])
- **/
+ */
 Buffer.alloc = function alloc(size, fill, encoding) {
   assertSize(size);
   if (fill !== undefined && size > 0) {
@@ -272,7 +272,7 @@ Buffer.alloc = function alloc(size, fill, encoding) {
 /**
  * Equivalent to Buffer(num), by default creates a non-zero-filled Buffer
  * instance. If `--zero-fill-buffers` is set, will zero-fill the buffer.
- **/
+ */
 Buffer.allocUnsafe = function allocUnsafe(size) {
   assertSize(size);
   return allocate(size);
@@ -282,7 +282,7 @@ Buffer.allocUnsafe = function allocUnsafe(size) {
  * Equivalent to SlowBuffer(num), by default creates a non-zero-filled
  * Buffer instance that is not allocated off the pre-initialized pool.
  * If `--zero-fill-buffers` is set, will zero-fill the buffer.
- **/
+ */
 Buffer.allocUnsafeSlow = function allocUnsafeSlow(size) {
   assertSize(size);
   return createUnsafeBuffer(size);