Merge pull request #5 from code4rena-dev/feat/template-ci

feat: add mustache generator and use it for ci

Author: jacobheun

.gitignore

@@ -9,6 +9,7 @@
 !/.github/
 !/.gitignore
 !/.npmrc
+!/Dockerfile
 !/bin/
 !/CHANGELOG*
 !/docs/
@@ -23,7 +24,6 @@
 !/tap-snapshots/
 !/test/
 !/tsconfig*.json
-!Dockerfile
 
 # re-ignore typescript output artifacts
 /knexfile.js

lib/content/ci.yml

@@ -38,6 +38,22 @@ jobs:
     defaults:
       run:
         shell: bash
+    <%#postgres%>
+    services:
+      postgres:
+        image: "postgres:14"
+        env:
+          POSTGRES_USER: ${{ vars.POSTGRES_USER }}
+          POSTGRES_PASSWORD: ${{ vars.POSTGRES_PASSWORD }}
+          POSTGRES_DB: ${{ vars.POSTGRES_DB }}
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+        - "${{ vars.POSTGRES_PORT }}:5432"
+    <%/postgres%>
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -52,4 +68,8 @@ jobs:
       - name: Add tap problem matcher
         run: echo "::add-matcher::.github/matchers/tap.json"
       - name: Test
+        <%#env_vault%>
+        env:
+          DOTENV_KEY: ${{ secrets.DOTENV_KEY }}
+        <%/env_vault%>
         run: npm test --ignore-scripts

lib/content/gitignore

@@ -4,10 +4,12 @@
 
 # keep these
 !**/.gitignore
+!/.devcontainer/
 !/.eslintrc.js
 !/.github/
 !/.gitignore
 !/.npmrc
+!/Dockerfile
 !/bin/
 !/CHANGELOG*
 !/docs/

lib/index.ts

@@ -2,6 +2,7 @@ import { dirname, join } from "node:path";
 import { readFileSync } from "node:fs";
 import { readFile, rm } from "node:fs/promises";
 import { copy, json, pkg, type Skeleton } from "code-skeleton";
+import { mustache } from "./mustache";
 
 const ownPkg = JSON.parse(
   readFileSync(join(dirname(__dirname), "package.json"), { encoding: "utf8" })
@@ -10,6 +11,7 @@ const ownPkg = JSON.parse(
 interface Variables {
   dogfood?: boolean;
   library?: boolean;
+  ci?: object;
 }
 
 export default async function (root: string, variables: Variables) {
@@ -51,12 +53,14 @@ export default async function (root: string, variables: Variables) {
       },
       types: "lib/index.d.ts",
       devDependencies: {
-        "@tsconfig/node18": "^2.0.0",
+        "@tsconfig/node18": "^18.0.0",
+        "@types/mustache": "^4.0.0",
         "@types/node": "^18.0.0",
         "@types/tap": "^15.0.0",
         "@typescript-eslint/eslint-plugin": "^5.0.0",
         "@typescript-eslint/parser": "^5.0.0",
         "eslint": "^8.0.0",
+        "mustache": "^4.0.0",
         "tap": "^16.0.0",
         "ts-node": "^10.0.0",
         "typescript": "^5.0.0"
@@ -94,7 +98,7 @@ export default async function (root: string, variables: Variables) {
     ".eslintrc.js": copy(join(__dirname, "content", "eslintrc.js")),
     ".gitignore": copy(join(__dirname, "content", "gitignore")),
     "scripts/clean.ts": copy(join(__dirname, "content", "clean.ts")),
-    ".github/workflows/ci.yml": copy(join(__dirname, "content", "ci.yml")),
+    ".github/workflows/ci.yml": mustache(join(__dirname, "content", "ci.yml"), variables.ci),
     ".github/matchers/tap.json": copy(join(__dirname, "content", "tap.json")),
   };
 

lib/mustache.ts

@@ -0,0 +1,69 @@
+import {
+  Generator,
+  GeneratorResults,
+  GeneratorOptions
+} from "code-skeleton/lib/generators/abstract";
+import { dirname } from "node:path";
+import { writeFile, mkdir, readFile } from "node:fs/promises";
+import Mustache from "mustache";
+Mustache.tags = [ "<%", "%>" ];
+
+interface MustacheGeneratorOptions extends GeneratorOptions {
+  sourcePath: string;
+}
+
+class MustacheGenerator extends Generator {
+  declare options: MustacheGeneratorOptions;
+
+  constructor (options: MustacheGeneratorOptions) {
+    super(options);
+
+    if (!this.options.sourcePath) {
+      throw new Error("Must specify a source path");
+    }
+  }
+
+  async apply(targetPath: string): Promise<GeneratorResults> {
+    await mkdir(dirname(targetPath), { recursive: true });
+    try {
+      const source = await readFile(this.options.sourcePath);
+
+      const rendered = Mustache.render(source.toString(), this.options);
+      await writeFile(targetPath, rendered);
+      return this.pass();
+    } catch (err) {
+      const { code, message } = err as { code?: string; message: string };
+      // istanbul ignore next - no need to test message fallback
+      return this.fail(code ?? message);
+    }
+  }
+  async verify(targetPath: string): Promise<GeneratorResults> {
+    let actual;
+    try {
+      actual = await readFile(targetPath);
+    } catch (err) {
+      const { code, message } = err as { code?: string; message: string };
+      // istanbul ignore next - no need to test passthrough throws
+      if (code !== "ENOENT") {
+        return this.fail(code ?? message);
+      }
+
+      return this.fail("file missing");
+    }
+
+    const source = await readFile(this.options.sourcePath);
+    const expected = Buffer.from(Mustache.render(source.toString(), this.options));
+    if (actual.compare(expected) === 0) {
+      return this.pass();
+    }
+
+    return this.fail("contents do not match");
+  }
+}
+
+export function mustache (sourcePath: string, options: GeneratorOptions = {}) {
+  return new MustacheGenerator({
+    ...options,
+    sourcePath
+  });
+}

package.json

@@ -18,12 +18,14 @@
   "author": "Nathan LaFreniere <[email protected]>",
   "license": "ISC",
   "devDependencies": {
-    "@tsconfig/node18": "^2.0.0",
+    "@tsconfig/node18": "^18.0.0",
+    "@types/mustache": "^4.0.0",
     "@types/node": "^18.0.0",
     "@types/tap": "^15.0.0",
     "@typescript-eslint/eslint-plugin": "^5.0.0",
     "@typescript-eslint/parser": "^5.0.0",
     "eslint": "^8.0.0",
+    "mustache": "^4.0.0",
     "tap": "^16.0.0",
     "ts-node": "^10.0.0",
     "typescript": "^5.0.0"
@@ -34,7 +36,11 @@
   "skeleton": {
     "module": ".",
     "variables": {
-      "library": true
+      "library": true,
+      "ci": {
+        "postgres": false,
+        "env_vault": false
+      }
     }
   },
   "files": [