ember.nvp 1.0.0 → 1.1.0

package/test/ember.nvp/layer-qunit.test.ts

@@ -1,30 +1,13 @@
 import { describe, it, beforeAll, afterAll, expect } from "vitest";
-import { generate, pinYukuParser } from "#test-helpers";
+import { generate, listFiles } from "#test-helpers";
 import { writeLibrarySource } from "./library-src-fixtures.ts";
 import { execa } from "execa";
-import { mkdir, readdir, readFile, rm, writeFile } from "node:fs/promises";
-import { dirname, join, relative, sep } from "node:path";
+import { mkdir, rm, writeFile } from "node:fs/promises";
+import { dirname, join } from "node:path";
 
 import type { Project } from "ember.nvp";
 
-async function listFiles(directory: string): Promise<string[]> {
-  const entries = await readdir(directory, { withFileTypes: true, recursive: true });
-
-  return entries
-    .filter((entry) => entry.isFile())
-    .map((entry) => relative(directory, join(entry.parentPath, entry.name)))
-    .filter((path) => !path.split(sep).includes("node_modules"))
-    .filter((path) => !path.startsWith(`dist${sep}`))
-    .sort();
-}
-
-async function read(project: Project, filePath: string): Promise<string> {
-  return readFile(join(project.directory, filePath), "utf-8");
-}
-
 async function installAndTest(project: Project) {
-  await pinYukuParser(project);
-
   let install = await execa("pnpm install", { cwd: project.directory, shell: true });
   expect(install.exitCode).toBe(0);
 
@@ -169,7 +152,7 @@ describe("layer: qunit", () => {
     });
 
     it("generates the expected files, without any index.html", async () => {
-      let files = await listFiles(project.directory);
+      let files = await listFiles(project.directory, { includeDist: false });
 
       expect(files.some((file) => file.endsWith("index.html"))).toBe(false);
       expect(files).toMatchInlineSnapshot(`
@@ -191,7 +174,7 @@ describe("layer: qunit", () => {
     });
 
     it("generates the test build config", async () => {
-      expect(await read(project, "vite.config.mjs")).toMatchInlineSnapshot(`
+      expect(await project.read("vite.config.mjs")).toMatchInlineSnapshot(`
         "import { defineConfig } from "vite";
         import { ember } from "@nullvoxpopuli/ember-vite";
 
@@ -200,7 +183,7 @@ describe("layer: qunit", () => {
         });
         "
       `);
-      expect(await read(project, "config/test/babel.config.js")).toMatchInlineSnapshot(`
+      expect(await project.read("config/test/babel.config.js")).toMatchInlineSnapshot(`
         "import { buildMacros } from "@embroider/macros/babel";
 
         const macros = buildMacros({
@@ -244,7 +227,7 @@ describe("layer: qunit", () => {
         };
         "
       `);
-      expect(await read(project, "config/test/testem.cjs")).toMatchInlineSnapshot(`
+      expect(await project.read("config/test/testem.cjs")).toMatchInlineSnapshot(`
         ""use strict";
 
         if (typeof module !== "undefined") {
@@ -276,7 +259,7 @@ describe("layer: qunit", () => {
     });
 
     it("leaves the publish build config alone", async () => {
-      expect(await read(project, "tsdown.config.js")).toMatchInlineSnapshot(`
+      expect(await project.read("tsdown.config.js")).toMatchInlineSnapshot(`
         "import { defineConfig } from "tsdown";
         import { ember } from "@nullvoxpopuli/ember-rolldown";
 
@@ -298,7 +281,7 @@ describe("layer: qunit", () => {
       let build = await execa("pnpm build", { cwd: project.directory, shell: true });
       expect(build.exitCode).toBe(0);
 
-      let output = await read(project, "dist/index.js");
+      let output = await project.read("dist/index.js");
 
       expect(output).toContain("precompileTemplate");
       expect(output).not.toContain("createTemplateFactory");
@@ -314,7 +297,7 @@ describe("layer: qunit", () => {
     });
 
     it("generates the expected files, without any index.html", async () => {
-      let files = await listFiles(project.directory);
+      let files = await listFiles(project.directory, { includeDist: false });
 
       expect(files.some((file) => file.endsWith("index.html"))).toBe(false);
       expect(files).toMatchInlineSnapshot(`
@@ -335,7 +318,7 @@ describe("layer: qunit", () => {
     });
 
     it("has no TypeScript leftovers in the test build config", async () => {
-      expect(await read(project, "config/test/babel.config.js")).toMatchInlineSnapshot(`
+      expect(await project.read("config/test/babel.config.js")).toMatchInlineSnapshot(`
         "import { buildMacros } from "@embroider/macros/babel";
 
         const macros = buildMacros({
@@ -367,7 +350,7 @@ describe("layer: qunit", () => {
         };
         "
       `);
-      expect(await read(project, "tsdown.config.js")).toMatchInlineSnapshot(`
+      expect(await project.read("tsdown.config.js")).toMatchInlineSnapshot(`
         "import { defineConfig } from "tsdown";
         import { ember } from "@nullvoxpopuli/ember-rolldown";
 
@@ -390,7 +373,7 @@ describe("layer: qunit", () => {
       let build = await execa("pnpm build", { cwd: project.directory, shell: true });
       expect(build.exitCode).toBe(0);
 
-      let output = await read(project, "dist/index.js");
+      let output = await project.read("dist/index.js");
 
       expect(output).toContain("precompileTemplate");
       expect(output).not.toContain("createTemplateFactory");

package/test/ember.nvp/layer-vitest.test.ts

@@ -1,9 +1,9 @@
 import { describe, it, beforeAll, afterAll, expect } from "vitest";
-import { generate } from "#test-helpers";
+import { generate, listFiles } from "#test-helpers";
 import { writeLibrarySource } from "./library-src-fixtures.ts";
 import { execa } from "execa";
-import { mkdir, readdir, readFile, rm, writeFile } from "node:fs/promises";
-import { dirname, join, relative, sep } from "node:path";
+import { mkdir, rm, writeFile } from "node:fs/promises";
+import { dirname, join } from "node:path";
 
 import type { Project } from "ember.nvp";
 
@@ -14,20 +14,6 @@ import type { Project } from "ember.nvp";
  * headless-browser mode), asserting the specs genuinely run and pass.
  */
 
-async function listFiles(directory: string): Promise<string[]> {
-  const entries = await readdir(directory, { withFileTypes: true, recursive: true });
-
-  return entries
-    .filter((entry) => entry.isFile())
-    .map((entry) => relative(directory, join(entry.parentPath, entry.name)))
-    .filter((path) => !path.split(sep).includes("node_modules"))
-    .sort();
-}
-
-async function read(project: Project, filePath: string): Promise<string> {
-  return readFile(join(project.directory, filePath), "utf-8");
-}
-
 async function emit(project: Project, files: Record<string, string>) {
   for (let [path, contents] of Object.entries(files)) {
     let filePath = join(project.directory, path);
@@ -200,7 +186,7 @@ describe("layer: vitest", () => {
     });
 
     it("generates the vitest config", async () => {
-      expect(await read(project, "vitest.config.mjs")).toMatchInlineSnapshot(`
+      expect(await project.read("vitest.config.mjs")).toMatchInlineSnapshot(`
         "import { ember } from "@nullvoxpopuli/ember-vite";
         import { webdriverio } from "@vitest/browser-webdriverio";
         import { defineConfig } from "vitest/config";

package/test/ember.nvp/permutations/app-checks.test.ts

@@ -0,0 +1,3 @@
+import { testPermutations } from "./shared.ts";
+
+testPermutations("minimal-app", { group: "checks" });

package/test/ember.nvp/permutations/extension-1.test.ts

@@ -0,0 +1,3 @@
+import { testPermutations } from "./shared.ts";
+
+testPermutations("minimal-extension", { index: 0, total: 2 });

package/test/ember.nvp/permutations/extension-2.test.ts

@@ -0,0 +1,3 @@
+import { testPermutations } from "./shared.ts";
+
+testPermutations("minimal-extension", { index: 1, total: 2 });

package/test/ember.nvp/permutations/extension-checks.test.ts

@@ -0,0 +1,3 @@
+import { testPermutations } from "./shared.ts";
+
+testPermutations("minimal-extension", { group: "checks" });

package/test/ember.nvp/permutations/library-checks.test.ts

@@ -0,0 +1,3 @@
+import { testPermutations } from "./shared.ts";
+
+testPermutations("minimal-library", { group: "checks" });

package/test/ember.nvp/permutations/shared.ts

@@ -30,30 +30,73 @@ const NOT_YET_SUPPORTED: Record<ProjectType, Set<string>> = {
   app: new Set(["publint", "are-the-types-wrong"]),
   // libraries have no Application to wire inspector support into
   library: new Set(["inspector-support"]),
+  // publish checks: extensions aren't published (to npm)
+  extension: new Set(["publint", "are-the-types-wrong"]),
 };
 
+const TYPE_FOR_BASE: Record<(typeof bases)[number], ProjectType> = {
+  "minimal-app": "app",
+  "minimal-library": "library",
+  "minimal-extension": "extension",
+};
+
+/**
+ * Layers that only add lint / format / publish checks. They don't affect
+ * the runtime shape of a project, so they permutate among themselves in a
+ * small "checks" matrix instead of multiplying the main one. ("apply anew"
+ * still applies each of them on top of every main permutation, so linear
+ * cross-group coverage remains.)
+ */
+const CHECK_LAYERS = new Set<string>([
+  "eslint-bundled-ember",
+  "eslint-bundled-nvp",
+  "eslint-ejected",
+  "prettier",
+  "publint",
+  "are-the-types-wrong",
+]);
+
+type PermutationGroup = "main" | "checks";
+
 const eachBase = bases.map((base) => {
-  const type: ProjectType = base === "minimal-app" ? "app" : "library";
+  const type = TYPE_FOR_BASE[base]!;
 
   const applicableLayers = layers.filter((layer) => !NOT_YET_SUPPORTED[type].has(layer.name));
 
-  const permutations = permutate(applicableLayers.map((layer) => layer.name));
-  permutations.push([baseline]);
+  const toPermutations = (layerNames: string[], withBaseline: boolean) => {
+    const permutations = permutate(layerNames);
+
+    if (withBaseline) {
+      permutations.push([baseline]);
+    }
 
-  const eachPermutation = permutations
-    .filter((permutation) => {
-      if (INITIAL_ONLY.size > 0 && !permutation.some((x) => INITIAL_ONLY.has(x))) {
-        return;
-      }
+    return permutations
+      .filter((permutation) => {
+        if (INITIAL_ONLY.size > 0 && !permutation.some((x) => INITIAL_ONLY.has(x))) {
+          return;
+        }
 
-      // Not implemented yet
-      if (permutation.some((x) => TODO.has(x))) {
-        return;
-      }
+        // Not implemented yet
+        if (permutation.some((x) => TODO.has(x))) {
+          return;
+        }
 
-      return true;
-    })
-    .map((permutation) => ({ permutation, name: permutation.join(", ") }));
+        return true;
+      })
+      .map((permutation) => ({ permutation, name: permutation.join(", ") }));
+  };
+
+  const applicableNames = applicableLayers.map((layer) => layer.name);
+  const eachPermutation: Record<PermutationGroup, ReturnType<typeof toPermutations>> = {
+    main: toPermutations(
+      applicableNames.filter((name) => !CHECK_LAYERS.has(name)),
+      true,
+    ),
+    checks: toPermutations(
+      applicableNames.filter((name) => CHECK_LAYERS.has(name)),
+      false,
+    ),
+  };
 
   return { name: base, type, applicableLayers, eachPermutation };
 });
@@ -62,14 +105,20 @@ const eachBase = bases.map((base) => {
  * The permutation matrix grows exponentially with the layer count, so
  * each base runs from its own test file(s) -- CI runs them as separate,
  * parallel jobs. A base whose matrix outgrows one job's budget runs from
- * several files, each taking a deterministic 1-of-N slice.
+ * several files, each taking a deterministic 1-of-N slice. The "checks"
+ * group (CHECK_LAYERS) runs from its own file(s) the same way.
  *
  * @param base which base's permutations this file runs
- * @param slice which 1-of-N slice of the permutations this file runs
+ * @param options.index / options.total which 1-of-N slice of the permutations this file runs
+ * @param options.group which permutation group this file runs
  */
 export function testPermutations(
   base: (typeof bases)[number],
-  slice: { index: number; total: number } = { index: 0, total: 1 },
+  {
+    index = 0,
+    total = 1,
+    group = "main",
+  }: { index?: number; total?: number; group?: PermutationGroup } = {},
 ) {
   const {
     type,
@@ -77,7 +126,7 @@ export function testPermutations(
     eachPermutation: allPermutations,
   } = eachBase.find((b) => b.name === base)!;
 
-  const eachPermutation = allPermutations.filter((_, i) => i % slice.total === slice.index);
+  const eachPermutation = allPermutations[group].filter((_, i) => i % total === index);
 
   describe(base, () => {
     describe.each(eachPermutation)("layers: $name", ({ permutation }) => {

package/test/test-helpers.ts

@@ -1,18 +1,19 @@
 import { execa } from "execa";
-import { join } from "node:path";
+import { join, relative, sep } from "node:path";
 import { styleText } from "node:util";
 import { Readable, Writable } from "node:stream";
-import { mkdtemp, readFile, writeFile } from "node:fs/promises";
+import { mkdtemp, readdir } from "node:fs/promises";
 import { tmpdir } from "node:os";
 import { generateProject, Project } from "ember.nvp";
 import { discoverLayers } from "#layers";
-import type { DiscoveredLayer } from "#types";
+import type { DiscoveredLayer, ProjectType } from "#types";
 import { expect } from "vitest";
 
 const minimalApp = "minimal-app";
 const minimalAddon = "minimal-library";
+const minimalExtension = "minimal-extension";
 
-export const bases = [minimalApp, minimalAddon];
+export const bases = [minimalApp, minimalAddon, minimalExtension];
 
 export const layers = await discoverLayers();
 
@@ -67,31 +68,6 @@ export async function mktemp(name = "ember.nvp_test-") {
   return await mkdtemp(join(tmpdir(), `${name}-`));
 }
 
-/**
- * Temporary: `rolldown-plugin-dts` (used by tsdown for `.d.ts` generation)
- * imports `walk` from `yuku-parser`, but yuku-parser >= 0.6.6 moved `walk` to
- * `yuku-ast`. Its dependency range still floats to the broken versions, so a
- * fresh install of a generated library crashes when tsdown builds.
- *
- * The yuku toolchain publishes in lockstep on a shared `@yuku-toolchain/types`,
- * so `yuku-parser` and `yuku-codegen` must be pinned together (pinning only one
- * splits the toolchain and the dts/publint pipeline silently bails). Pin the
- * last working set before install -- here in the test harness only, so the
- * generated blueprint stays override-free. Remove once the plugin is fixed:
- * https://github.com/sxzz/rolldown-plugin-dts/issues/277
- */
-export async function pinYukuParser(project: Project): Promise<void> {
-  const manifestPath = join(project.directory, "package.json");
-  const manifest = JSON.parse(await readFile(manifestPath, "utf-8"));
-
-  manifest.pnpm ??= {};
-  manifest.pnpm.overrides ??= {};
-  manifest.pnpm.overrides["yuku-parser"] = "0.6.5";
-  manifest.pnpm.overrides["yuku-codegen"] = "0.6.5";
-
-  await writeFile(manifestPath, JSON.stringify(manifest, null, 2));
-}
-
 export async function reapply(project: Project, layers: string[]) {
   return await generate({
     directory: project.directory,
@@ -112,7 +88,7 @@ export async function generate({
   directory?: string;
   layers?: string[];
   name?: string;
-  type?: "app" | "library";
+  type?: ProjectType;
   packageManager?: "pnpm" | "npm";
 }): Promise<Project> {
   const tempDir = directory ?? (await mktemp(name));
@@ -211,3 +187,22 @@ export async function expectIsSetup(project: Project, layer: DiscoveredLayer) {
 
   expect(result, `${layer.name} is setup`).toBe(true);
 }
+
+/**
+ * List every file under `directory` (recursively) as sorted paths relative
+ * to `directory`. `node_modules` is always excluded; pass
+ * `{ includeDist: false }` to also exclude the `dist/` build output.
+ */
+export async function listFiles(
+  directory: string,
+  { includeDist = true }: { includeDist?: boolean } = {},
+): Promise<string[]> {
+  const entries = await readdir(directory, { withFileTypes: true, recursive: true });
+
+  return entries
+    .filter((entry) => entry.isFile())
+    .map((entry) => relative(directory, join(entry.parentPath, entry.name)))
+    .filter((path) => !path.split(sep).includes("node_modules"))
+    .filter((path) => includeDist || !path.startsWith(`dist${sep}`))
+    .sort();
+}

package/vitest.config.js

@@ -4,6 +4,6 @@ export default defineConfig({
   test: {
     testTimeout: 60_000,
     hookTimeout: 60_000,
-    include: ["test/**/*.test.ts", "src/**/*.test.ts"],
+    include: ["test/**/*.test.ts", "src/**/*.test.ts", "packages/*/src/**/*.test.ts"],
   },
 });