v2.0 :: replace a whole directory of files

Author: petersamokhin

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Night Story Ltd
+Copyright (c) 2023 Night Story Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,11 +1,11 @@
-# Replace environment variabels in files in a GitHub Action
+# Replace environment variables in files in a GitHub Action
 
 ## Inputs
 
 - `input_file`
-    - Path to file with the placeholders to replace.
-- `input_file`
-    - Path to output file.
+    - Path to file with the placeholders to replace. If directory, will replace all files in the directory.
+- `output_file`
+    - Path to output file. If `input_file` is directory, will be a directory too.
     - Optional, defaults to `input_file`
 - `pattern`
     - Which placeholders to replace.

action.yml

@@ -5,10 +5,10 @@ branding:
   color: blue
 inputs:
   input_file:
-    description: 'Input file path'
+    description: 'Path to file with the placeholders to replace. If directory, will replace all files in the directory.'
     required: true
   output_file:
-    description: 'Output file path'
+    description: 'Path to output file. If `input_file` is directory, will be a directory too. Optional, defaults to `input_file`'
     default: ''
     required: false
   fail_on_missing_env:

lib/index.js

@@ -58,3 +58,16 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
+
+
+uuid
+MIT
+The MIT License (MIT)
+
+Copyright (c) 2010-2020 Robert Kieffer and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

lib/index.js.map

@@ -1,7 +1,7 @@
 {
   "name": "replace-env",
   "description": "Replace environment variables in files",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "keywords": [
     "github",
     "actions",
@@ -21,12 +21,12 @@
   "homepage": "https://github.com/nightstory/replace-env#readme",
   "author": "nightstory",
   "dependencies": {
-    "@actions/core": "^1.8.2"
+    "@actions/core": "^1.9.1"
   },
   "devDependencies": {
-    "@types/node": "^17.0.17",
-    "@vercel/ncc": "^0.33.3",
-    "typescript": "^4.5.5"
+    "@types/node": "^20.7.0",
+    "@vercel/ncc": "^0.38.0",
+    "typescript": "^5.2.2"
   },
   "scripts": {
     "build": "node_modules/.bin/ncc build --license licenses.txt --source-map -m -q src/main.ts -o lib"

lib/licenses.txt

@@ -1,74 +1,110 @@
 import * as core from '@actions/core'
-import fs from 'fs';
+import fs from 'node:fs/promises'
+import path from 'node:path'
 
-import getOptions, {Options, ReplacementPattern, validateOptions} from './options'
+import getOptions, { Options, ReplacementPattern, validateOptions } from './options'
+import { checkPath } from './utils'
 
-const main = async () => {
+async function main() {
   const options: Options = getOptions()
 
   if (!validateOptions(options)) {
     process.exit(1)
   }
 
-  let pattern = /\${\w+}/gi;
-  let matcher = /\${(?<var>\w+)}/i;
+  let pattern = /\${\w+}/gi
+  let matcher = /\${(?<var>\w+)}/i
 
   switch (options.pattern) {
-    case ReplacementPattern.SingleDollarBrackets:
-      pattern = /\${\w+}/gi;
-      matcher = /\${(?<var>\w+)}/i;
-      break;
-    case ReplacementPattern.DoubleDollarBrackets:
-      pattern = /\${{\w+}}/gi;
-      matcher = /\${{(?<var>\w+)}}/i;
-      break;
-    case ReplacementPattern.DoubleUnderscore:
-      pattern = /__\w+__/gi;
-      matcher = /__(?<var>\w+)__/i;
-      break;
+    case ReplacementPattern.SingleDollarBrackets: {
+      pattern = /\${\w+}/gi
+      matcher = /\${(?<var>\w+)}/i
+      break
+    }
+    case ReplacementPattern.DoubleDollarBrackets: {
+      pattern = /\${{\w+}}/gi
+      matcher = /\${{(?<var>\w+)}}/i
+      break
+    }
+    case ReplacementPattern.DoubleUnderscore: {
+      pattern = /__\w+__/gi
+      matcher = /__(?<var>\w+)__/i
+      break
+    }
   }
 
-  if (fs.existsSync(options.inputFile)) {
-    const data = fs.readFileSync(options.inputFile, 'utf8');
-    const res = data.replace(pattern, (c) => {
-      const match = c.match(matcher);
+  switch (checkPath(options.inputFile)) {
+    case 'directory': {
+      const resultDirectory = options.outputFile ?? options.inputFile
 
-      if (match === null) {
-        core.warning(`[replace-env] error happened, invalid match for ${c}: ${match}`)
-        return c;
+      if (resultDirectory !== options.inputFile) {
+        await fs.mkdir(resultDirectory, { recursive: true })
       }
 
-      let env = process.env[match[1]];
+      const files = await fs.readdir(options.inputFile)
 
-      if (typeof env === 'undefined') {
-        if (options.failOnMissingEnv) {
-          core.error(`[replace-env] Environment Variable ${match[1]} not found!`);
-          throw new Error('[replace-env] Environment Variable ${match[1]} not found!');
-        } else {
-          core.warning(`[replace-env] Environment Variable ${match[1]} not found!`);
-          env = c;
-        }
-      } else {
-        core.info(`[replace-env] Replacing Environment Variable ${match[1]}.`);
-      }
+      await Promise.all(
+        files.map(async file => (
+          await replaceFile({
+            pattern, matcher,
+            inputFile: path.join(options.inputFile, file),
+            failOnMissingEnv: options.failOnMissingEnv,
+            resultFile: path.join(resultDirectory, file),
+          })
+        )),
+      )
+      break
+    }
+    case 'file': {
+      await replaceFile({
+        pattern, matcher,
+        inputFile: options.inputFile,
+        failOnMissingEnv: options.failOnMissingEnv,
+        resultFile: options.outputFile ?? options.inputFile,
+      })
+      break
+    }
+    case 'otherwise': {
+      throw new Error('[replace-env] input_file does not exist or an error occured')
+    }
+  }
+}
 
-      return env;
-    });
+async function replaceFile(
+  { inputFile, pattern, matcher, failOnMissingEnv, resultFile }: {
+    pattern: RegExp, matcher: RegExp, failOnMissingEnv: boolean,
+    inputFile: string, resultFile: string
+  },
+) {
+  const data = await fs.readFile(inputFile, 'utf8')
+  const res = data.replace(pattern, (c) => {
+    const match = c.match(matcher)
 
-    let resultFile = options.inputFile;
-    if (options.outputFile !== null) {
-      resultFile = options.outputFile;
+    if (match === null) {
+      core.warning(`[replace-env] error happened, invalid match for ${c}: ${match}`)
+      return c
     }
 
-    fs.writeFileSync(resultFile, res);
-    core.info(`[replace-env] File ${resultFile} saved.`);
-  } else {
-    throw new Error('[replace-env] input_file is missing')
-  }
+    let env = process.env[match[1]]
+
+    if (typeof env === 'undefined') {
+      if (failOnMissingEnv) {
+        core.error(`[replace-env] Environment Variable ${match[1]} not found!`)
+        throw new Error('[replace-env] Environment Variable ${match[1]} not found!')
+      } else {
+        core.warning(`[replace-env] Environment Variable ${match[1]} not found!`)
+        env = c
+      }
+    } else {
+      core.info(`[replace-env] Replacing Environment Variable ${match[1]}.`)
+    }
+
+    return env
+  })
+
+  await fs.writeFile(resultFile, res)
+  core.info(`[replace-env] File ${resultFile} saved.`)
 }
 
-try {
-  main()
-} catch (error) {
-  core.setFailed(`${error}`)
-}
+main()
+  .catch((error) => core.setFailed(`${error}`))

lib/sourcemap-register.js

@@ -19,59 +19,57 @@ const patternMap: { [key: string]: ReplacementPattern } = {
 
 const defaultPattern = 'single_dollar_brackets'
 
-const findOption: (inputKey: string, envKey: string | null) => (string | null) =
-  (inputKey, envKey) => {
-    const input = core.getInput(inputKey)
+function findOption(inputKey: string, envKey: string | null) {
+  const input = core.getInput(inputKey)
 
-    if (input.length === 0) {
-      if (envKey !== null) {
-        return process.env[envKey] ?? null
-      } else {
-        return null
-      }
+  if (input.length === 0) {
+    if (envKey !== null) {
+      return process.env[envKey] ?? null
     } else {
-      return input
+      return null
     }
+  } else {
+    return input
   }
+}
 
-const requireOption: (inputKey: string, envKey: string | null) => string =
-  (inputKey, envKey) => {
-    const result = findOption(inputKey, envKey)
-    if (!result) {
-      core.setFailed(`input ${inputKey} (or env ${envKey}) is required but was missing`)
-      process.exit(1)
-    }
-    return result!
-  }
-
-const getFlag: (inputKey: string, envKey: string | null, def: boolean) => boolean =
-  (inputKey, envKey, def) => {
-    const result = findOption(inputKey, envKey)
-    return result ? result === 'true' : def
+function requireOption(inputKey: string, envKey: string | null) {
+  const result = findOption(inputKey, envKey)
+  if (!result) {
+    core.setFailed(`input ${inputKey} (or env ${envKey}) is required but was missing`)
+    process.exit(1)
   }
+  return result!
+}
 
-const getOptions: () => Options = () => ({
-  inputFile: requireOption('input_file', null),
-  outputFile: findOption('output_file', null),
-  failOnMissingEnv: getFlag('fail_on_missing_env', null, false),
-  pattern: patternMap[findOption('pattern', null) ?? defaultPattern]!,
-})
+function getFlag(inputKey: string, envKey: string | null, def: boolean) {
+  const result = findOption(inputKey, envKey)
+  return result ? result === 'true' : def
+}
 
-export const validateOptions: (options: Options) => boolean =
-  (o) => {
-    let result = true
+function getOptions(): Options {
+  return {
+    inputFile: requireOption('input_file', null),
+    outputFile: findOption('output_file', null),
+    failOnMissingEnv: getFlag('fail_on_missing_env', null, false),
+    pattern: patternMap[findOption('pattern', null) ?? defaultPattern]!,
+  }
+}
 
-    if ([o.inputFile].some(v => v.length === 0)) {
-      core.setFailed(`input_file must not be empty`)
-      result = false
-    }
+export function validateOptions(o: Options) {
+  let result = true
 
-    if (o.outputFile !== null && o.outputFile.length === 0) {
-      core.setFailed(`output_file must not be empty`)
-      result = false
-    }
+  if ([ o.inputFile ].some(v => v.length === 0)) {
+    core.setFailed(`input_file must not be empty`)
+    result = false
+  }
 
-    return result
+  if (o.outputFile !== null && o.outputFile.length === 0) {
+    core.setFailed(`output_file must not be empty`)
+    result = false
   }
 
+  return result
+}
+
 export default getOptions