Merge pull request #7 from code4rena-dev/nlf/update-code-skeleton

feat: update to code-skeleton@2

Author: nlf

lib/index.ts

@@ -98,7 +98,10 @@ 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": mustache(join(__dirname, "content", "ci.yml"), variables.ci),
+    ".github/workflows/ci.yml": mustache({
+      sourcePath: join(__dirname, "content", "ci.yml"),
+      variables,
+    }),
     ".github/matchers/tap.json": copy(join(__dirname, "content", "tap.json")),
   };
 

lib/mustache.ts

@@ -1,18 +1,14 @@
-import {
-  Generator,
-  GeneratorResults,
-  GeneratorOptions
-} from "code-skeleton/lib/generators/abstract";
-import { dirname } from "node:path";
-import { writeFile, mkdir, readFile } from "node:fs/promises";
+import { Generator } from "code-skeleton/lib/generators/abstract";
+import { readFile } from "node:fs/promises";
 import Mustache from "mustache";
 Mustache.tags = [ "<%", "%>" ];
 
-interface MustacheGeneratorOptions extends GeneratorOptions {
+interface MustacheGeneratorOptions {
   sourcePath: string;
+  variables: unknown;
 }
 
-class MustacheGenerator extends Generator {
+class MustacheGenerator extends Generator<MustacheGeneratorOptions> {
   declare options: MustacheGeneratorOptions;
 
   constructor (options: MustacheGeneratorOptions) {
@@ -23,47 +19,14 @@ class MustacheGenerator extends Generator {
     }
   }
 
-  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");
-    }
-
+  async generate () {
     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");
+    const rendered = Mustache.render(source.toString(), this.options.variables);
+    return rendered;
   }
 }
 
-export function mustache (sourcePath: string, options: GeneratorOptions = {}) {
-  return new MustacheGenerator({
-    ...options,
-    sourcePath
-  });
-}
+export function mustache (options: MustacheGeneratorOptions) {
+  return new MustacheGenerator(options);
+}

package.json

@@ -12,6 +12,7 @@
     "prelint": "tsc --noEmit",
     "postlint": "npm run skeleton:verify",
     "skeleton:apply": "code-skeleton apply",
+    "preskeleton:verify": "npm run prepack",
     "skeleton:verify": "code-skeleton verify"
   },
   "keywords": [],
@@ -25,13 +26,13 @@
     "@typescript-eslint/eslint-plugin": "^5.0.0",
     "@typescript-eslint/parser": "^5.0.0",
     "eslint": "^8.0.0",
-    "mustache": "^4.0.0",
+    "mustache": "^4.2.0",
     "tap": "^16.0.0",
     "ts-node": "^10.0.0",
     "typescript": "^5.0.0"
   },
   "peerDependencies": {
-    "code-skeleton": "^1.0.0"
+    "code-skeleton": "^2.0.0"
   },
   "skeleton": {
     "module": ".",
@@ -43,6 +44,12 @@
       }
     }
   },
+  "//": "This file is partially managed by code-skeleton. Changes may be overwritten.",
+  "tap": {
+    "coverage": true,
+    "ts": true
+  },
+  "types": "lib/index.d.ts",
   "files": [
     "bin/**/*.js",
     "lib/**/*.js",