tools: capitalize sentences

This adds the `capitalized-comments` eslint rule to verify that
actual sentences use capital letters as starting letters. It ignores
special words and all lines below 62 characters.
PR-URL: #24808
Reviewed-By: Sam Ruby <rubys@intertwingly.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ujjwal Sharma <usharma1998@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>

Author: BridgeAR

.eslintrc.js

@@ -58,6 +58,18 @@ module.exports = {
 'arrow-spacing': ['error',{before: true,after: true}],
 'block-spacing': 'error',
 'brace-style': ['error','1tbs',{allowSingleLine: true}],
+'capitalized-comments': ['error','always',{
+line: {
+// Ignore all lines that have less characters than 62 and all lines that
+// start with something that looks like a variable name or code.
+ignorePattern: '^.{0,62}$|^ [a-z]+ ?[0-9A-Z_.(/=:-]',
+ignoreInlineComments: true,
+ignoreConsecutiveComments: true
+},
+block: {
+ignorePattern: '.*'
+}
+}],
 'comma-dangle': ['error','only-multiline'],
 'comma-spacing': 'error',
 'comma-style': 'error',

benchmark/_cli.js

@@ -49,7 +49,7 @@ function CLI(usage, settings) {
 this.optional[currentOptional]=true;
 mode='both';
 }else{
-// expect the next value to be option related (either -- or the value)
+// Expect the next value to be option related (either -- or the value)
 mode='option';
 }
 }elseif(mode==='option'){

benchmark/child_process/child-process-exec-stdout.js

@@ -31,7 +31,7 @@ function childProcessExecStdout({ dur, len }) {
 try{
 execSync(`taskkill /f /t /pid ${child.pid}`);
 }catch{
-// this is a best effort kill. stderr is piped to parent for tracing.
+// This is a best effort kill. stderr is piped to parent for tracing.
 }
 }else{
 child.kill();

benchmark/common.js

@@ -146,7 +146,7 @@ Benchmark.prototype._run = function() {
 (functionrecursive(queueIndex){
 constconfig=self.queue[queueIndex];
 
-// set NODE_RUN_BENCHMARK_FN to indicate that the child shouldn't construct
+// Set NODE_RUN_BENCHMARK_FN to indicate that the child shouldn't construct
 // a configuration queue, but just execute the benchmark function.
 constchildEnv=Object.assign({},process.env);
 childEnv.NODE_RUN_BENCHMARK_FN='';
@@ -187,7 +187,7 @@ Benchmark.prototype.start = function() {
 };
 
 Benchmark.prototype.end=function(operations){
-// get elapsed time now and do error checking later for accuracy.
+// Get elapsed time now and do error checking later for accuracy.
 constelapsed=process.hrtime(this._time);
 
 if(!this._started){

benchmark/crypto/cipher-stream.js

@@ -58,7 +58,7 @@ function main({ api, cipher, type, len, writes }) {
 
 constfn=api==='stream' ? streamWrite : legacyWrite;
 
-// write data as fast as possible to alice, and have bob decrypt.
+// Write data as fast as possible to alice, and have bob decrypt.
 // use old API for comparison to v0.8
 bench.start();
 fn(alice_cipher,bob_cipher,message,encoding,writes);

benchmark/dgram/array-vs-concat.js

@@ -1,4 +1,4 @@
-// test UDP send throughput with the multi buffer API against Buffer.concat
+// Test UDP send throughput with the multi buffer API against Buffer.concat
 'use strict';
 
 constcommon=require('../common.js');

benchmark/dgram/offset-length.js

@@ -1,4 +1,4 @@
-// test UDP send/recv throughput with the "old" offset/length API
+// Test UDP send/recv throughput with the "old" offset/length API
 'use strict';
 
 constcommon=require('../common.js');

benchmark/napi/function_call/index.js

@@ -7,7 +7,7 @@
 constassert=require('assert');
 constcommon=require('../../common.js');
 
-// this fails when we try to open with a different version of node,
+// This fails when we try to open with a different version of node,
 // which is quite common for benchmarks. so in that case, just
 // abort quietly.
 

benchmark/net/net-wrap-js-stream-passthrough.js

@@ -1,4 +1,4 @@
-// test the speed of .pipe() with JSStream wrapping for PassThrough streams
+// Test the speed of .pipe() with JSStream wrapping for PassThrough streams
 'use strict';
 
 constcommon=require('../common.js');

doc/api/async_hooks.md

@@ -61,12 +61,12 @@ asyncHook.disable();
 // resource referenced by "asyncId" may not have been populated.
 functioninit(asyncId, type, triggerAsyncId, resource) { }
 
-//before is called just before the resource's callback is called. It can be
+//Before is called just before the resource's callback is called. It can be
 // called 0-N times for handles (e.g. TCPWrap), and will be called exactly 1
 // time for requests (e.g. FSReqCallback).
 functionbefore(asyncId) { }
 
-//after is called just after the resource's callback has finished.
+//After is called just after the resource's callback has finished.
 functionafter(asyncId) { }
 
 // destroy is called when an AsyncWrap instance is destroyed.
@@ -159,7 +159,7 @@ const fs = require('fs');
 constutil=require('util');
 
 functiondebug(...args) {
-//use a function like this one when debugging inside an AsyncHooks callback
+//Use a function like this one when debugging inside an AsyncHooks callback
 fs.writeFileSync('log.out', `${util.format(...args)}\n`, { flag:'a' });
 }
 ```