From ac05c2b2260fe7ddad04bdb72cb8119c57742ce3 Mon Sep 17 00:00:00 2001
From: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Date: Sat, 21 Apr 2018 05:41:16 +0300
Subject: [PATCH] tools: modernize and optimize doc/addon-verify.js

Modernize:
* Replace `var` with `const` / `let`.
* Replace common functions with arrow functions.
* Use destructuring.
* Use `String.prototype.padStart()`, `String.prototype.endsWith()`.

Optimize:
* Reduce function calls.
* Reduce intermediate variables.
* Cache retrieved object properties.
* Move RegExp declaration out of a cycle.
* Simplify RegExps.
* Replace RegExp with string when string suffices.
* Remove conditions that cannot be false.
* Replace for..in with `Object.keys().forEach()`.

Also, eliminate needlessly complicated function chains:
* `ondone` callback only checks errors;
* if there is an error, it is called once and throws, then script exits;
* if there are no errors, it is noop;
* so there is no need to wrap it into `once()` function
* and there is no need to call it without errors;
* we can eliminate it and replace with `throw` where an error occurs;
* we can also replace `onprogress` callback with `console.log` in place;
* at last, we can eliminate `waiting` counter and `once()` utility.

The new script produces results identical to the old ones.

PR-URL: https://github.com/nodejs/node/pull/20188
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
---
 tools/doc/addon-verify.js | 98 +++++++++++++++------------------------
 1 file changed, 37 insertions(+), 61 deletions(-)

diff --git a/tools/doc/addon-verify.js b/tools/doc/addon-verify.js
index 9fcc71ed93f0c9..a3d1beb4b8e12e 100644
--- a/tools/doc/addon-verify.js
+++ b/tools/doc/addon-verify.js
@@ -1,68 +1,52 @@
 'use strict';
 
-const fs = require('fs');
-const path = require('path');
-const marked = require('marked');
+const { mkdir, readFileSync, writeFile } = require('fs');
+const { resolve } = require('path');
+const { lexer } = require('marked');
 
-const rootDir = path.resolve(__dirname, '..', '..');
-const doc = path.resolve(rootDir, 'doc', 'api', 'addons.md');
-const verifyDir = path.resolve(rootDir, 'test', 'addons');
+const rootDir = resolve(__dirname, '..', '..');
+const doc = resolve(rootDir, 'doc', 'api', 'addons.md');
+const verifyDir = resolve(rootDir, 'test', 'addons');
 
-const contents = fs.readFileSync(doc).toString();
-
-const tokens = marked.lexer(contents);
+const tokens = lexer(readFileSync(doc, 'utf8'));
+const addons = {};
 let id = 0;
-
 let currentHeader;
-const addons = {};
-tokens.forEach((token) => {
-  if (token.type === 'heading' && token.text) {
-    currentHeader = token.text;
-    addons[currentHeader] = {
-      files: {}
-    };
+
+const validNames = /^\/\/\s+(.*\.(?:cc|h|js))[\r\n]/;
+tokens.forEach(({ type, text }) => {
+  if (type === 'heading') {
+    currentHeader = text;
+    addons[currentHeader] = { files: {} };
   }
-  if (token.type === 'code') {
-    var match = token.text.match(/^\/\/\s+(.*\.(?:cc|h|js))[\r\n]/);
+  if (type === 'code') {
+    const match = text.match(validNames);
     if (match !== null) {
-      addons[currentHeader].files[match[1]] = token.text;
+      addons[currentHeader].files[match[1]] = text;
     }
   }
 });
-for (var header in addons) {
-  verifyFiles(addons[header].files,
-              header,
-              console.log.bind(null, 'wrote'),
-              function(err) { if (err) throw err; });
-}
 
-function once(fn) {
-  var once = false;
-  return function() {
-    if (once)
-      return;
-    once = true;
-    fn.apply(this, arguments);
-  };
-}
+Object.keys(addons).forEach((header) => {
+  verifyFiles(addons[header].files, header);
+});
+
+function verifyFiles(files, blockName) {
+  const fileNames = Object.keys(files);
 
-function verifyFiles(files, blockName, onprogress, ondone) {
   // Must have a .cc and a .js to be a valid test.
-  if (!Object.keys(files).some((name) => /\.cc$/.test(name)) ||
-      !Object.keys(files).some((name) => /\.js$/.test(name))) {
+  if (!fileNames.some((name) => name.endsWith('.cc')) ||
+      !fileNames.some((name) => name.endsWith('.js'))) {
     return;
   }
 
-  blockName = blockName
-    .toLowerCase()
-    .replace(/\s/g, '_')
-    .replace(/[^a-z\d_]/g, '');
-  const dir = path.resolve(
+  blockName = blockName.toLowerCase().replace(/\s/g, '_').replace(/\W/g, '');
+  const dir = resolve(
     verifyDir,
-    `${(++id < 10 ? '0' : '') + id}_${blockName}`
+    `${String(++id).padStart(2, '0')}_${blockName}`
   );
 
-  files = Object.keys(files).map(function(name) {
+  files = fileNames.map((name) => {
     if (name === 'test.js') {
       files[name] = `'use strict';
 const common = require('../../common');
@@ -73,42 +57,34 @@ ${files[name].replace(
 `;
     }
     return {
-      path: path.resolve(dir, name),
+      path: resolve(dir, name),
       name: name,
       content: files[name]
     };
   });
 
   files.push({
-    path: path.resolve(dir, 'binding.gyp'),
+    path: resolve(dir, 'binding.gyp'),
     content: JSON.stringify({
       targets: [
         {
           target_name: 'addon',
           defines: [ 'V8_DEPRECATION_WARNINGS=1' ],
-          sources: files.map(function(file) {
-            return file.name;
-          })
+          sources: files.map(({ name }) => name)
         }
       ]
     })
   });
 
-  fs.mkdir(dir, function() {
+  mkdir(dir, () => {
     // Ignore errors.
 
-    const done = once(ondone);
-    var waiting = files.length;
-    files.forEach(function(file) {
-      fs.writeFile(file.path, file.content, function(err) {
+    files.forEach(({ path, content }) => {
+      writeFile(path, content, (err) => {
         if (err)
-          return done(err);
-
-        if (onprogress)
-          onprogress(file.path);
+          throw err;
 
-        if (--waiting === 0)
-          done();
+        console.log(`Wrote ${path}`);
       });
     });
   });