Improve change-version.js (#33148)

* switch to async/await
* remove shelljs
* switch to globby; supports .gitignore out of the box
* don't write any files to the disk if they are indentical
* add two more cmd switches: --dry and --verbose
* strip leading "v" from version arguments so that we don't end up with duplicate `v`s

build/change-version.js

@@ -9,11 +9,21 @@
 
 'use strict'
 
-const fs = require('fs')
+const fs = require('fs').promises
 const path = require('path')
-const sh = require('shelljs')
+const globby = require('globby')
 
-sh.config.fatal = true
+const VERBOSE = process.argv.includes('--verbose')
+const DRY_RUN = process.argv.includes('--dry') || process.argv.includes('--dry-run')
+
+// These are the filetypes we only care about replacing the version
+const GLOB = [
+  '**/*.{css,html,js,json,md,scss,txt,yml}'
+]
+const GLOBBY_OPTIONS = {
+  cwd: path.join(__dirname, '..'),
+  gitignore: true
+}
 
 // Blame TC39... https://github.com/benjamingr/RegExp.escape/issues/37
 function regExpQuote(string) {
@@ -24,89 +34,48 @@ function regExpQuoteReplacement(string) {
   return string.replace(/\$/g, '$$')
 }
 
-const DRY_RUN = false
+async function replaceRecursively(file, oldVersion, newVersion) {
+  const originalString = await fs.readFile(file, 'utf8')
+  const newString = originalString.replace(
+    new RegExp(regExpQuote(oldVersion), 'g'), regExpQuoteReplacement(newVersion)
+  )
 
-function walkAsync(directory, excludedDirectories, fileCallback, errback) {
+  // No need to move any further if the strings are identical
-  if (excludedDirectories.has(path.parse(directory).base)) {
+  if (originalString === newString) {
     return
   }
 
-  fs.readdir(directory, (err, names) => {
+  if (VERBOSE) {
-    if (err) {
+    console.log(`FILE: ${file}`)
-      errback(err)
+  }
+
+  if (DRY_RUN) {
     return
   }
 
-    names.forEach(name => {
+  await fs.writeFile(file, newString, 'utf8')
-      const filepath = path.join(directory, name)
-      fs.lstat(filepath, (err, stats) => {
-        if (err) {
-          process.nextTick(errback, err)
-          return
-        }
-
-        if (stats.isDirectory()) {
-          process.nextTick(walkAsync, filepath, excludedDirectories, fileCallback, errback)
-        } else if (stats.isFile()) {
-          process.nextTick(fileCallback, filepath)
-        }
-      })
-    })
-  })
 }
 
-function replaceRecursively(directory, excludedDirectories, allowedExtensions, original, replacement) {
+async function main(args) {
-  original = new RegExp(regExpQuote(original), 'g')
+  const [oldVersion, newVersion] = args
-  replacement = regExpQuoteReplacement(replacement)
-  const updateFile = DRY_RUN ?
-    filepath => {
-      if (allowedExtensions.has(path.parse(filepath).ext)) {
-        console.log(`FILE: ${filepath}`)
-      } else {
-        console.log(`EXCLUDED:${filepath}`)
-      }
-    } :
-    filepath => {
-      if (allowedExtensions.has(path.parse(filepath).ext)) {
-        sh.sed('-i', original, replacement, filepath)
-      }
-    }
 
-  walkAsync(directory, excludedDirectories, updateFile, err => {
+  if (!oldVersion || !newVersion) {
-    console.error('ERROR while traversing directory!:')
+    console.error('USAGE: change-version old_version new_version [--verbose] [--dry[-run]]')
-    console.error(err)
-    process.exit(1)
-  })
-}
-
-function main(args) {
-  if (args.length !== 2) {
-    console.error('USAGE: change-version old_version new_version')
     console.error('Got arguments:', args)
     process.exit(1)
   }
 
-  const oldVersion = args[0]
+  // Strip any leading `v` from arguments because otherwise we will end up with duplicate `v`s
-  const newVersion = args[1]
+  [oldVersion, newVersion].map(arg => arg.startsWith('v') ? arg.slice(1) : arg)
-  const EXCLUDED_DIRS = new Set([
+
-    '.git',
+  try {
-    '_site',
+    const files = await globby(GLOB, GLOBBY_OPTIONS)
-    'node_modules',
+
-    'resources'
+    await Promise.all(files.map(file => replaceRecursively(file, oldVersion, newVersion)))
-  ])
+  } catch (error) {
-  const INCLUDED_EXTENSIONS = new Set([
+    console.error(error)
-    // This extension allowlist is how we avoid modifying binary files
+    process.exit(1)
-    '',
+  }
-    '.css',
-    '.html',
-    '.js',
-    '.json',
-    '.md',
-    '.scss',
-    '.txt',
-    '.yml'
-  ])
-  replaceRecursively('.', EXCLUDED_DIRS, INCLUDED_EXTENSIONS, oldVersion, newVersion)
 }
 
 main(process.argv.slice(2))

package.json

@@ -118,6 +118,7 @@
     "eslint-plugin-unicorn": "^28.0.2",
     "find-unused-sass-variables": "^3.1.0",
     "glob": "^7.1.6",
+    "globby": "^11.0.2",
     "hammer-simulator": "0.0.1",
     "hugo-bin": "^0.69.0",
     "ip": "^1.1.5",