Merge pull request #18 from code4rena-dev/fix/ci-shebang

fix: shebang should support non published modules

Author: jacobheun

lib/content/update-shebang.ts

@@ -15,7 +15,7 @@ async function updateShebang (path: string) {
 }
 
 async function main () {
-  const npmResult = spawnSync("npm", ["show", ".", "bin", "--json"], {
+  const npmResult = spawnSync("npm", ["show", `file://${ROOT}`, "bin", "--json"], {
     cwd: ROOT,
     shell: true,
     encoding: "utf8",

lib/index.ts

@@ -117,7 +117,7 @@ export default async function (root: string, variables: Variables) {
     ".gitignore": copy(join(__dirname, "content", "gitignore")),
     "scripts/clean.ts": copy(join(__dirname, "content", "clean.ts")),
     ".github/workflows/ci.yml": mustache({
-      sourcePath: join(__dirname, "content", "ci.yml"),
+      path: join(__dirname, "content", "ci.yml"),
       variables: variables.ci || {},
     }),
     ".github/matchers/tap.json": copy(join(__dirname, "content", "tap.json")),

lib/mustache.ts

@@ -1,11 +1,10 @@
-import { Generator, ValidateInput } from "code-skeleton/lib/generators/abstract";
-import { GeneratorReportResult } from "code-skeleton/lib/generators/report";
+import { Generator } from "code-skeleton/lib/generators/abstract";
 import { readFile } from "node:fs/promises";
 import Mustache from "mustache";
 Mustache.tags = [ "<%", "%>" ];
 
 interface MustacheGeneratorOptions {
-  sourcePath: string;
+  path: string;
   variables: unknown;
 }
 
@@ -15,31 +14,17 @@ class MustacheGenerator extends Generator<MustacheGeneratorOptions> {
   constructor (options: MustacheGeneratorOptions) {
     super(options);
 
-    if (!this.options.sourcePath) {
+    if (!this.options.path) {
       throw new Error("Must specify a source path");
     }
   }
 
   async generate () {
-    const source = await readFile(this.options.sourcePath);
+    const source = await readFile(this.options.path);
 
     const rendered = Mustache.render(source.toString(), this.options.variables);
     return rendered;
   }
-
-  async validate(options: ValidateInput) : Promise<GeneratorReportResult> {
-    const expected = await this.generate();
-
-    if (!options.found.includes(expected)) {
-      this.report({
-        expected,
-        found: options.found,
-        message: `${this.options.sourcePath} does not include the original template`
-      });
-      return GeneratorReportResult.Fail;
-    }
-    return GeneratorReportResult.Pass;
-  }
 }
 
 export function mustache (options: MustacheGeneratorOptions) {

package.json

@@ -31,7 +31,7 @@
     "eslint": "^8.0.0",
     "tap": "^16.0.0",
     "ts-node": "^10.0.0",
-    "typescript": "^5.0.0"
+    "typescript": "5.2.2"
   },
   "peerDependencies": {
     "code-skeleton": "^2.0.0"

scripts/update-shebang.ts

@@ -15,7 +15,7 @@ async function updateShebang (path: string) {
 }
 
 async function main () {
-  const npmResult = spawnSync("npm", ["show", ".", "bin", "--json"], {
+  const npmResult = spawnSync("npm", ["show", `file://${ROOT}`, "bin", "--json"], {
     cwd: ROOT,
     shell: true,
     encoding: "utf8",

test/index.test.ts

@@ -0,0 +1,6 @@
+import t from "tap";
+
+void t.test("this is not a real test", (t) => {
+  t.pass();
+  t.end();
+});