Add new templates

PythonCoderAS · PythonCoderAS · commit 7ee1fb1f7c2e · 2022-06-28T17:16:53.000-04:00
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "github-run-script",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "description": "Run a script on multiple repositories, cloning them if needed.",
   "main": "dist/index.js",
   "type": "commonjs",
diff --git a/src/cli.ts b/src/cli.ts
@@ -1,12 +1,16 @@
 import * as sade from "sade";
 import handler from "./handler";
+import addTemplates from "./template";
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires -- Needed in order to not copy over package.json and make new src directory inside of dist
 const { version, description } = require("../package.json");
 
-const cli = sade("github-run-script <script>", true)
+let cli = sade("github-run-script")
   .version(version)
   .describe(description)
+  .command("execute <script>", "Execute a script on the given repositories", {
+    default: true,
+  })
   .option(
     "-o, --owner",
     "The owner for repositories without an explicit owner."
@@ -16,4 +20,6 @@ const cli = sade("github-run-script <script>", true)
   .option("--signal", "The signal to terminate a process with.")
   .action(handler);
 
+cli = addTemplates(cli);
+
 export default cli;
diff --git a/src/template.ts b/src/template.ts
@@ -0,0 +1,41 @@
+import { Template } from "./types";
+import { Sade } from "sade";
+import templates from "./templates";
+
+function generateCLIFromTemplate(sade: Sade, template: Template): Sade {
+  const argString: string = template.arguments
+    ? " " +
+      template.arguments
+        .map((arg) => (typeof arg === "string" ? { name: arg } : arg))
+        .map((arg) => `<${arg.name}>`)
+        .join(" ")
+    : "";
+  sade = sade.command(
+    `template ${template.name}${argString}`,
+    template.description,
+    {
+      alias: template.aliases?.map((alias) => `template ${alias}`),
+    }
+  );
+  template.flags
+    ?.map((flag) => (typeof flag === "string" ? { name: flag } : flag))
+    .forEach((flag) => {
+      sade = sade.option(flag.name, flag.description, flag.value);
+    });
+  sade = sade
+    .option("--output-dir", "The directory to output the template to.")
+    .option(
+      "--output-file",
+      "The filename to output the template to.",
+      template.defaultFileName
+    )
+    .action(template.handler);
+  return sade;
+}
+
+export default function main(sade: Sade): Sade {
+  for (const template of templates) {
+    sade = generateCLIFromTemplate(sade, template);
+  }
+  return sade;
+}
diff --git a/src/templates/cp.ts b/src/templates/cp.ts
@@ -0,0 +1,49 @@
+import { GenerateTemplateCliFlags, Template } from "../types";
+import { getOutputPath } from "../utils";
+import { writeFile } from "fs/promises";
+
+export default class CpTemplate implements Template {
+  readonly name = "copy";
+  readonly description =
+    "A template to copy a signle source file to multiple repositories and commit the changes.";
+  readonly aliases = ["cp"];
+
+  readonly defaultFileName = "cp.sh";
+
+  readonly arguments = [
+    {
+      name: "source_path",
+      description: "The path that will be copied to the destination.",
+    },
+    {
+      name: "dest_path",
+      description:
+        "Relative path to copy to. May omit the filename in order to use the filename of the source file.",
+    },
+    {
+      name: "commit_message",
+      description: "The commit message to use when committing the changes.",
+    },
+  ];
+
+  async handler(
+    source_file: string,
+    dest_path: string,
+    commit_message: string,
+    flags: GenerateTemplateCliFlags
+  ) {
+    const templateString = `
+#!/bin/bash
+$FILE="${source_file}"
+$RELATIVE_DEST="${dest_path}"
+git pull
+cp -r $FILE $RELATIVE_DEST
+git add $RELATIVE_DEST
+git commit -m "${commit_message}"
+git push
+`;
+    const outputPath = await getOutputPath(this, flags);
+    await writeFile(outputPath, templateString);
+    console.log(`Output log written to: ${outputPath}`);
+  }
+}
diff --git a/src/templates/index.ts b/src/templates/index.ts
@@ -0,0 +1,6 @@
+import { Template } from "../types";
+import CpTemplate from "./cp";
+
+const Templates: Template[] = [new CpTemplate()];
+
+export default Templates;
diff --git a/src/types.ts b/src/types.ts
@@ -1,12 +1,34 @@
-export interface CliFlags {
+export interface BaseCliFlags {
+  _: string[];
+}
+
+export interface CliFlags extends BaseCliFlags {
   owner?: string;
   search?: string | string[];
   terminate?: string | boolean;
   signal?: string;
-  _: string[];
 }
 
 /**
  * A two-element tuple that contains [owner, repository].
  */
 export type RepoOwner = [string, string];
+
+export interface GenerateTemplateCliFlags extends BaseCliFlags {
+  outputDir?: string;
+  outputFile?: string;
+}
+
+export interface Template {
+  name: string;
+  description?: string;
+  aliases?: string[];
+
+  defaultFileName: string;
+
+  arguments?: (string | { name: string; description?: string })[];
+  flags?: (string | { name: string; description?: string; value?: any })[];
+  handler: (...args: any[]) => any;
+}
+
+export type TemplateJSON = { [name: string]: Template };
diff --git a/src/utils.ts b/src/utils.ts
@@ -1,5 +1,7 @@
 import { ChildProcess } from "child_process";
-import { RepoOwner } from "./types";
+import { GenerateTemplateCliFlags, RepoOwner, Template } from "./types";
+import { mkdtemp } from "fs/promises";
+import { tmpdir } from "os";
 
 export function getRepoAndOwner(
   input: string,
@@ -28,3 +30,14 @@ export async function waitOnChildProcessToExit(process: ChildProcess) {
     process.on("error", reject);
   });
 }
+
+export async function getOutputPath(
+  template: Template,
+  flags: GenerateTemplateCliFlags
+) {
+  let { outputDir, outputFile } = flags;
+  outputDir =
+    outputDir ?? (await mkdtemp(`${tmpdir()}/github-run-script-template-`));
+  outputFile = outputFile ?? template.defaultFileName;
+  return `${outputDir}/${outputFile}`;
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -4,7 +4,8 @@
     "module": "commonjs",
     "outDir": "dist",
     "strict": true,
-    "target": "es2019"
+    "target": "es2019",
+    "resolveJsonModule": true
   },
   "include": ["src/**/*"]
 }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "github-run-script",`
`3`		`- "version": "1.0.4",`
	`3`	`+ "version": "1.1.0",`
`4`	`4`	`"description": "Run a script on multiple repositories, cloning them if needed.",`
`5`	`5`	`"main": "dist/index.js",`
`6`	`6`	`"type": "commonjs",`