feat(cli): add global config file

swordev · Nov 21, 2023 · 6028a36 · 6028a36
1 parent 166af56
commit 6028a36
Show file tree

Hide file tree

Showing 20 changed files with 292 additions and 183 deletions.
diff --git a/.changeset/weak-weeks-poke.md b/.changeset/weak-weeks-poke.md
@@ -0,0 +1,5 @@
+---
+"@rtpl/cli": minor
+---
+
+Add global config file
diff --git a/.gitignore b/.gitignore
@@ -7,5 +7,7 @@ lib
 node_modules
 /resources
 rtpl-lock.json
+rtpl-secrets.json
+rtpl-config.*
 /rtpl.*
 tsconfig.tsbuildinfo
diff --git a/packages/cli/src/actions/backup.ts b/packages/cli/src/actions/backup.ts
@@ -1,4 +1,5 @@
 import { GlobalOptions, pkg } from "../cli.js";
+import { parseConfigFile } from "../utils/self/config.js";
 import * as lock from "../utils/self/lock.js";
 import chalk from "chalk";
 import { createHash } from "crypto";
@@ -14,10 +15,12 @@ export type BackupOptions = GlobalOptions & {
 };
 
 export default async function backup(options: BackupOptions) {
+  const config = await parseConfigFile(options.config);
+
   const log = options.log ?? true;
-  const lockData = (lock.parseFile(options.lockPath, true) ?? {
-    templates: {},
-  }) as any as lock.LockData<{ contents: string }>;
+  const lockData = lock.parseFile(config.lock.path) as any as lock.LockData<{
+    contents: string;
+  }>;
 
   let files = 0;
 
@@ -39,7 +42,7 @@ export default async function backup(options: BackupOptions) {
   ];
 
   const file = [...header, yaml].join("\n");
-  const path = join(options.backupPath, `${Date.now()}.yaml`);
+  const path = join(config.backup.path, `${Date.now()}.yaml`);
 
   await mkdir(dirname(path), { recursive: true });
   await writeFile(path, file);

diff --git a/packages/cli/src/actions/diff.ts b/packages/cli/src/actions/diff.ts
@@ -1,6 +1,14 @@
 import { GlobalOptions } from "../cli.js";
+import { AbstractRes } from "../index.js";
 import { readIfExists } from "../utils/fs.js";
-import { readTplFile, resolveTpl } from "../utils/self/resolve.js";
+import { parseConfigFile } from "../utils/self/config.js";
+import {
+  ActionEnum,
+  getFileActions,
+  logAction,
+} from "../utils/self/install.js";
+import { parseFile } from "../utils/self/lock.js";
+import { parseTplFile, resolveTpl } from "../utils/self/resolve.js";
 import chalk from "chalk";
 import { diffLines } from "diff";
 
@@ -10,69 +18,83 @@ export type DiffOptions = GlobalOptions & {
   lines: number;
 };
 export default async function diff(options: DiffOptions) {
-  const tpl = await readTplFile(options.templatePath);
+  const config = await parseConfigFile(options.config);
+  const tpl = await parseTplFile(config.template.path);
   const { resources } = await resolveTpl(tpl, {
+    config,
     filter: options.filter,
-    lockPath: options.lockPath,
-    outPath: options.outPath,
   });
   let changes = 0;
-  for (const path in resources) {
-    const res = resources[path];
-    let resValue: string;
-    try {
-      resValue = res.toString();
-    } catch (error) {
-      console.info("\x1b[36m%s\x1b[0m", path);
-      throw error;
+  const lockData = parseFile(config.lock.path);
+  const selfLockData = lockData.templates[tpl.config.name] || {
+    files: {},
+    dirs: {},
+  };
+  const actions = await getFileActions(resources, selfLockData);
+  for (const path in actions) {
+    const action = actions[path];
+    if (action.type === ActionEnum.NONE) continue;
+    logAction(action.type, path);
+    changes++;
+    if (action.type === ActionEnum.ADD || action.type === ActionEnum.UPDATE) {
+      await showDiff(resources[path], path, options);
     }
+  }
 
-    const old = (await readIfExists(path))?.toString();
-    const lines = diffLines(old ?? "", resValue);
-    const haveChanges =
-      typeof old !== "string" ||
-      lines.some((line) => line.added || line.removed);
+  if (!changes) process.stderr.write(`${chalk.grey("No changes")}\n`);
+  return { exitCode: changes ? 1 : 0, changes };
+}
 
-    if (haveChanges) changes++;
-    if (!options.showAll && !haveChanges) continue;
+async function showDiff(
+  res: AbstractRes<any, any>,
+  path: string,
+  options: DiffOptions,
+) {
+  let resValue: string;
+  try {
+    resValue = res.toString();
+  } catch (error) {
     console.info("\x1b[36m%s\x1b[0m", path);
+    throw error;
+  }
+  const old = (await readIfExists(path))?.toString();
+  const lines = diffLines(old ?? "", resValue);
+  const haveChanges =
+    typeof old !== "string" || lines.some((line) => line.added || line.removed);
 
-    let lineIndex = 0;
-    let removed = 0;
+  if (!options.showAll && !haveChanges) return;
 
-    for (const line of lines) {
-      const sublines = line.value.split(/\r?\n/).slice(0, line.count);
-      for (const subline of sublines) {
-        ++lineIndex;
-        let result: string;
+  let lineIndex = 0;
+  let removed = 0;
 
-        if (line.added) {
-          lineIndex -= removed;
-          removed = 0;
-          result = chalk.green(subline);
-        } else if (line.removed) {
-          removed++;
-          result = chalk.red(subline);
-        } else {
-          result = subline;
-        }
+  for (const line of lines) {
+    const sublines = line.value.split(/\r?\n/).slice(0, line.count);
+    for (const subline of sublines) {
+      ++lineIndex;
+      let result: string;
 
-        const haveLineChanges = line.added || line.removed;
-        if (options.lines === 1 && !haveLineChanges) continue;
+      if (line.added) {
+        lineIndex -= removed;
+        removed = 0;
+        result = chalk.green(subline);
+      } else if (line.removed) {
+        removed++;
+        result = chalk.red(subline);
+      } else {
+        result = subline;
+      }
+
+      const haveLineChanges = line.added || line.removed;
+      if (options.lines === 1 && !haveLineChanges) continue;
 
-        if (options.hideLines) {
-          console.info(result);
-        } else {
-          const lineIndexStr = lineIndex.toString().padStart(3, " ");
-          console.info(
-            `${chalk.grey(lineIndexStr)} ${chalk.white("|")} ${result}`,
-          );
-        }
+      if (options.hideLines) {
+        console.info(result);
+      } else {
+        const lineIndexStr = lineIndex.toString().padStart(3, " ");
+        console.info(
+          `${chalk.grey(lineIndexStr)} ${chalk.white("|")} ${result}`,
+        );
       }
     }
-    console.info();
   }
-
-  if (!changes) process.stderr.write(`${chalk.grey("No changes")}\n`);
-  return { exitCode: changes ? 1 : 0, changes };
 }
diff --git a/packages/cli/src/actions/install.ts b/packages/cli/src/actions/install.ts
@@ -1,5 +1,6 @@
 import { GlobalOptions } from "../cli.js";
 import { confirmPrompt } from "../utils/cli.js";
+import { parseConfigFile } from "../utils/self/config.js";
 import {
   ActionEnum,
   execFileAction,
@@ -8,12 +9,12 @@ import {
 } from "../utils/self/install.js";
 import * as lock from "../utils/self/lock.js";
 import { splitGlobalOptions } from "../utils/self/options.js";
-import { readTplFile, resolveTpl } from "../utils/self/resolve.js";
+import { parseTplFile, resolveTpl } from "../utils/self/resolve.js";
 import backup from "./backup.js";
 import diff from "./diff.js";
 import chalk from "chalk";
 import { rmdir, writeFile } from "fs/promises";
-import { dirname, join } from "path";
+import { join } from "path";
 
 export type InstallActionOptions = GlobalOptions & {
   dryRun: boolean;
@@ -39,7 +40,9 @@ export default async function install(options: InstallActionOptions) {
     console.info();
   }
 
-  if (!options.noBackup) {
+  const config = await parseConfigFile(globalOptions.config);
+
+  if (!options.noBackup && config.backup.enabled) {
     const backupResult = await backup({
       ...globalOptions,
       log: false,
@@ -48,24 +51,19 @@ export default async function install(options: InstallActionOptions) {
       return { exitCode: backupResult.exitCode, changes: 0 };
   }
 
-  const tpl = await readTplFile(options.templatePath);
+  const tpl = await parseTplFile(config.template.path);
   const { resources, secrets } = await resolveTpl(tpl, {
+    config,
     filter: options.filter,
-    lockPath: options.lockPath,
-    outPath: options.outPath,
   });
 
-  const secretsPath = join(dirname(options.lockPath), "rtpl.secrets.json");
-
-  await writeFile(secretsPath, JSON.stringify(secrets, null, 2));
+  if (secrets)
+    await writeFile(config.secrets.path, JSON.stringify(secrets, null, 2));
 
   //await tpl.onBeforeInstall?.(options);
 
-  const lockData = lock.parseFile(options.lockPath, true) ?? {
-    templates: {},
-  };
+  const lockData = lock.parseFile(config.lock.path);
 
-  const lockDir = dirname(options.lockPath);
   let changes = 0;
   let errors = 0;
 
@@ -83,7 +81,12 @@ export default async function install(options: InstallActionOptions) {
       changes++;
     }
     try {
-      const dirs = await execFileAction(action, lockDir, path, options.dryRun);
+      const dirs = await execFileAction(
+        action,
+        config.root,
+        path,
+        options.dryRun,
+      );
       if (action.lock) {
         selfLockData.files[path] = action.lock;
         if (dirs) {
@@ -109,14 +112,14 @@ export default async function install(options: InstallActionOptions) {
   const dirs = Object.keys(selfLockData.dirs).sort().reverse();
   for (const dir of dirs) {
     try {
-      await rmdir(join(lockDir, dir));
+      await rmdir(join(config.root, dir));
       delete selfLockData.dirs[dir];
     } catch (error) {}
   }
 
   lockData.templates[tpl.config.name] = selfLockData;
 
-  if (!options.dryRun) await lock.writeFile(options.lockPath, lockData);
+  if (!options.dryRun) await lock.writeFile(config.lock.path, lockData);
 
   //await tpl.onInstall?.(options);
 

diff --git a/packages/cli/src/actions/options.ts b/packages/cli/src/actions/options.ts
@@ -1,5 +1,6 @@
 import { GlobalOptions } from "../cli.js";
-import { readTplFile } from "../utils/self/resolve.js";
+import { parseConfigFile } from "../utils/self/config.js";
+import { parseTplFile } from "../utils/self/resolve.js";
 import camelCase from "lodash.camelcase";
 import { stringify } from "yaml";
 
@@ -8,7 +9,8 @@ export type OptionsOptions = GlobalOptions & {
 };
 
 export default async function options(options: OptionsOptions) {
-  const tpl = await readTplFile(options.templatePath);
+  const config = await parseConfigFile(options.config);
+  const tpl = await parseTplFile(config.template.path);
   const tplOptions = await tpl.options();
 
   if (options.format === "yaml") {

diff --git a/packages/cli/src/actions/render.ts b/packages/cli/src/actions/render.ts
@@ -1,12 +1,13 @@
 import { GlobalOptions } from "../cli.js";
-import { readTplFile, resolveTpl } from "../utils/self/resolve.js";
+import { parseConfigFile } from "../utils/self/config.js";
+import { parseTplFile, resolveTpl } from "../utils/self/resolve.js";
 
 export default async function render(options: GlobalOptions) {
-  const tpl = await readTplFile(options.templatePath);
+  const config = await parseConfigFile(options.config);
+  const tpl = await parseTplFile(config.template.path);
   const { resources } = await resolveTpl(tpl, {
+    config,
     filter: options.filter,
-    lockPath: options.lockPath,
-    outPath: options.outPath,
   });
   for (const path in resources) {
     const res = resources[path];

diff --git a/packages/cli/src/actions/repair-lock.ts b/packages/cli/src/actions/repair-lock.ts
@@ -1,15 +1,15 @@
 import { GlobalOptions } from "../cli.js";
 import { confirmPrompt } from "../utils/cli.js";
+import { parseConfigFile } from "../utils/self/config.js";
 import * as lock from "../utils/self/lock.js";
 import chalk from "chalk";
 import { existsSync } from "fs";
 
 export type RepairLockOptions = GlobalOptions & {};
 
 export default async function repairLock(options: RepairLockOptions) {
-  const lockData = (lock.parseFile(options.lockPath, true) ?? {
-    templates: {},
-  }) as any as lock.LockData;
+  const config = await parseConfigFile(options.config);
+  const lockData = lock.parseFile(config.lock.path) as any as lock.LockData;
 
   const notfounds: string[] = [];
 
@@ -38,7 +38,7 @@ export default async function repairLock(options: RepairLockOptions) {
 
   if (!confirm) return { exitCode: 1 };
 
-  await lock.writeFile(options.lockPath, lockData);
+  await lock.writeFile(config.lock.path, lockData);
 
   console.info(chalk.green("Lock file repared."));
 

diff --git a/packages/cli/src/actions/restore.ts b/packages/cli/src/actions/restore.ts
@@ -1,5 +1,6 @@
 import { GlobalOptions } from "../cli.js";
 import { confirmPrompt } from "../utils/cli.js";
+import { parseConfigFile } from "../utils/self/config.js";
 import { LockData } from "../utils/self/lock.js";
 import chalk from "chalk";
 import { existsSync } from "fs";
@@ -43,8 +44,9 @@ const normalizePath = (path: string) =>
   relative(process.cwd(), path).replace(/\\/g, "/");
 
 export default async function restore(options: RestoreOptions) {
+  const config = await parseConfigFile(options.config);
   const path = normalizePath(
-    await findBackup(options.backupPath, options.input),
+    await findBackup(config.backup.path, options.input),
   );
   const yaml = (await readFile(path)).toString();
   const lockData = parse(yaml, { version: "1.1" }) as LockData<{
@@ -74,7 +76,7 @@ export default async function restore(options: RestoreOptions) {
     errorFiles.push(path);
   };
 
-  if (existsSync(options.lockPath)) logError(options.lockPath);
+  if (existsSync(config.lock.path)) logError(config.lock.path);
 
   for (const name in lockData.templates) {
     const tpl = lockData.templates[name];
@@ -105,7 +107,7 @@ export default async function restore(options: RestoreOptions) {
     }
   }
 
-  await writeFile(options.lockPath, JSON.stringify(lockData, null, 2));
+  await writeFile(config.lock.path, JSON.stringify(lockData, null, 2));
 
   console.info();
   console.info(chalk.green("Backup restored successfully."));