feat: update tap to 18

BREAKING CHANGE: This update is not backwards compatible with previous versions of testing.

This also adds some tests to the skeleton itself showcases how to use mocking with built in plugins, and spies via the added sinon plugin. A .taprc file has also been added as an example of adding some tap configuration.

Author: jacobheun

.gitignore

@@ -10,6 +10,7 @@
 !/.gitignore
 !/.npmrc
 !/.prettierrc.json
+!/.taprc
 !/Dockerfile
 !/bin/
 !/CHANGELOG*

.taprc

@@ -0,0 +1,6 @@
+# vim: set filetype=yaml :
+disable-coverage: false
+allow-incomplete-coverage: false
+plugin:
+  - "@tapjs/sinon"
+  - "!@tapjs/intercept"

lib/content/gitignore

@@ -10,6 +10,7 @@
 !/.gitignore
 !/.npmrc
 !/.prettierrc.json
+!/.taprc
 !/Dockerfile
 !/bin/
 !/CHANGELOG*

lib/index.ts

@@ -67,22 +67,20 @@ export default async function (root: string, variables: Variables) {
           }
         ),
       },
-      tap: {
-        coverage: true,
-        ts: true,
-      },
       types: "lib/index.d.ts",
       devDependencies: {
         "@tsconfig/node18": "^18.0.0",
         "@types/node": "^18.0.0",
-        "@types/tap": "^15.0.0",
         "@typescript-eslint/eslint-plugin": "^6.0.0",
         "@typescript-eslint/parser": "^6.0.0",
         "eslint": "^8.0.0",
-        "tap": "^16.0.0",
+        "tap": "^18.7.0",
         "ts-node": "^10.0.0",
         "typescript": "^5.0.0"
       },
+      removeDependencies: [
+        "@types/tap"
+      ]
     }),
     "tsconfig.json": json({
       set: {

package.json

@@ -22,14 +22,15 @@
     "mustache": "^4.2.0"
   },
   "devDependencies": {
+    "@tapjs/sinon": "^1.1.18",
     "@tsconfig/node18": "^18.0.0",
     "@types/mustache": "^4.0.0",
     "@types/node": "^18.0.0",
-    "@types/tap": "^15.0.0",
+    "@types/sinon": "^17.0.3",
     "@typescript-eslint/eslint-plugin": "^6.0.0",
     "@typescript-eslint/parser": "^6.0.0",
     "eslint": "^8.0.0",
-    "tap": "^16.0.0",
+    "tap": "^18.7.0",
     "ts-node": "^10.0.0",
     "typescript": "5.2.2"
   },
@@ -54,9 +55,5 @@
     "lib/**/*.d.ts",
     "!lib/types/**",
     "lib/content/**"
-  ],
-  "tap": {
-    "coverage": true,
-    "ts": true
-  }
+  ]
 }

test/index.test.ts

@@ -0,0 +1,91 @@
+import t from "tap";
+import { mustache } from "../lib/mustache.ts";
+
+void t.test("mustache", async (t) => {
+  await t.test("must include a path", (t) => {
+    // @ts-expect-error bad data on purpose
+    t.throws(() => mustache({}));
+    t.end();
+  });
+
+  await t.test("should generate", async (t) => {
+    const { mustache } = t.mockRequire<typeof import("../lib/mustache.ts")>("../lib/mustache.ts", {
+      "node:fs/promises": {
+        readFile: (path: string) => {
+          t.equal(path, "path/to/file.txt");
+          return Promise.resolve("<% title %>");
+        }
+      }
+    });
+    const variables = {
+      title: "it generates"
+    };
+
+    const generator = mustache({
+      path: "path/to/file.txt",
+      variables,
+    });
+
+    const output = await generator.generate();
+    t.equal(output, "it generates");
+  });
+
+  await t.test("should validate partials", async (t) => {
+    const { mustache } = t.mockRequire<typeof import("../lib/mustache.ts")>("../lib/mustache.ts", {
+      "node:fs/promises": {
+        readFile: () => Promise.resolve("<% title %>")
+      }
+    });
+    const variables = {
+      title: "it generates"
+    };
+
+    const generator = mustache({
+      path: "path/to/file.txt",
+      variables,
+    });
+
+    const generateSpy = t.sinon.spy(generator, "generate");
+    const reportSpy = t.sinon.spy(generator, "report");
+
+    await generator.validate({
+      path: "path/to/file.txt",
+      found: "it generates\nand handles extras"
+    });
+
+    t.equal(generateSpy.callCount, 1);
+    // Report not called because we passed
+    t.equal(reportSpy.callCount, 0);
+  });
+
+  await t.test("should fail validation when base template not found", async (t) => {
+    const { mustache } = t.mockRequire<typeof import("../lib/mustache.ts")>("../lib/mustache.ts", {
+      "node:fs/promises": {
+        readFile: () => Promise.resolve("<% title %>")
+      }
+    });
+    const variables = {
+      title: "it generates"
+    };
+
+    const generator = mustache({
+      path: "path/to/file.txt",
+      variables,
+    });
+
+    const generateSpy = t.sinon.spy(generator, "generate");
+    const reportSpy = t.sinon.spy(generator, "report");
+
+    await generator.validate({
+      path: "path/to/file.txt",
+      found: "a new file"
+    });
+
+    t.equal(generateSpy.callCount, 1);
+    t.ok(reportSpy.calledOnceWithExactly({
+      expected: "it generates",
+      found: "a new file",
+      message: "path/to/file.txt does not include the original template"
+    }));
+  });
+});

test/mustache.test.ts

@@ -5,6 +5,8 @@
     ".eslintrc.js"
   ],
   "compilerOptions": {
+    "allowImportingTsExtensions": true,
+    "noEmit": true,
     "typeRoots": [
       "./node_modules/@types",
       "./lib/types"