ember.nvp 0.1.0 → 0.2.0

package/src/bases/minimal-app/app.test.ts

@@ -0,0 +1,203 @@
+import { beforeAll, describe, it, expect as hardExpect, afterAll } from "vitest";
+import { generate, build, reapply } from "#test-helpers";
+import { packageJson } from "ember-apply";
+
+import type { Project } from "ember.nvp";
+import { rm } from "node:fs/promises";
+import { globSync } from "node:fs";
+
+const expect = hardExpect.soft;
+
+describe("typescript", () => {
+  let project: Project;
+  beforeAll(async () => {
+    project = await generate({
+      type: "app",
+      layers: ["typescript"],
+    });
+
+    let { exitCode } = await project.install();
+
+    hardExpect(exitCode, "Install succeeds").toBe(0);
+  });
+
+  afterAll(async () => {
+    await rm(project.directory, { recursive: true, force: true });
+  });
+
+  it("project check", () => {
+    expect(project.desires.layers.map((layer) => layer.name)).toMatchInlineSnapshot(`
+      [
+        "typescript",
+      ]
+    `);
+    expect(project.wantsTypeScript).toBe(true);
+    expect(project.type).toBe("app");
+  });
+
+  it("has the typescript babel plugin", async () => {
+    let content = await project.read("babel.config.js");
+
+    expect(content).toContain("@babel/plugin-transform-typescript");
+  });
+
+  it("build for development (testing, etc)", async () => {
+    let { exitCode } = await build(project);
+
+    expect(exitCode).toBe(0);
+  });
+
+  it("build for production", async () => {
+    let { exitCode } = await build(project, "production");
+
+    expect(exitCode).toBe(0);
+  });
+
+  it("has no JS files", async () => {
+    let results = globSync("app/**/*", {
+      exclude: ["node_modules", "dist"],
+      cwd: project.directory,
+    });
+    expect(results).toMatchInlineSnapshot(`
+      [
+        "app/app.ts",
+        "app/config.ts",
+        "app/router.ts",
+        "app/templates",
+        "app/templates/application.gts",
+      ]
+    `);
+  });
+
+  it("when re-applying, it no-ops correctly", async () => {
+    let files = new Set(
+      globSync("**/*", { cwd: project.directory, exclude: ["node_modules", "dist"] }),
+    );
+
+    await reapply(project, []);
+
+    let filesAfter = new Set(
+      globSync("**/*", { cwd: project.directory, exclude: ["node_modules", "dist"] }),
+    );
+
+    expect(filesAfter).toEqual(files);
+    expect(files).toMatchInlineSnapshot(`
+      Set {
+        "app",
+        "babel.config.js",
+        "index.html",
+        "package.json",
+        "pnpm-lock.yaml",
+        "tsconfig.json",
+        "vite.config.mjs",
+        "app/app.ts",
+        "app/config.ts",
+        "app/router.ts",
+        "app/templates",
+        "app/templates/application.gts",
+      }
+    `);
+  });
+});
+
+describe("javascript", () => {
+  let project: Project;
+  beforeAll(async () => {
+    project = await generate({
+      type: "app",
+      layers: [],
+    });
+
+    let { exitCode } = await project.install();
+
+    hardExpect(exitCode, "Install succeeds").toBe(0);
+  });
+
+  afterAll(async () => {
+    await rm(project.directory, { recursive: true, force: true });
+  });
+
+  it("project check", () => {
+    expect(project.desires.layers.map((layer) => layer.name)).toMatchInlineSnapshot(`[]`);
+    expect(project.wantsTypeScript).toBe(false);
+    expect(project.type).toBe("app");
+  });
+
+  it("does not have the typescript babel plugin", async () => {
+    let content = await project.read("babel.config.js");
+
+    expect(content).not.toContain("@babel/plugin-transform-typescript");
+  });
+
+  it("updated the sub-path imports to not have ts extensions", async () => {
+    let manifest = await packageJson.read(project.directory);
+
+    expect(manifest.imports).toMatchInlineSnapshot(`
+      {
+        "#app/*": "./app/*",
+        "#components/*": "./app/components/*",
+        "#config": "./app/config.js",
+        "#services/*": "./app/services/*",
+        "#test-helpers/*": "./tests/helpers/*",
+        "#utils/*": "./app/utils/*",
+      }
+    `);
+  });
+
+  it("build for development (testing, etc)", async () => {
+    let { exitCode } = await build(project);
+
+    expect(exitCode).toBe(0);
+  });
+
+  it("build for production", async () => {
+    let { exitCode } = await build(project, "production");
+
+    expect(exitCode).toBe(0);
+  });
+
+  it("has no TS files", async () => {
+    let results = globSync("app/**/*", {
+      exclude: ["node_modules", "dist"],
+      cwd: project.directory,
+    });
+    expect(results).toMatchInlineSnapshot(`
+      [
+        "app/app.js",
+        "app/config.js",
+        "app/router.js",
+        "app/templates",
+        "app/templates/application.gjs",
+      ]
+    `);
+  });
+
+  it("when re-applying, it no-ops correctly", async () => {
+    let files = new Set(
+      globSync("**/*", { cwd: project.directory, exclude: ["node_modules", "dist"] }),
+    );
+
+    await reapply(project, []);
+
+    let filesAfter = new Set(
+      globSync("**/*", { cwd: project.directory, exclude: ["node_modules", "dist"] }),
+    );
+
+    expect(filesAfter).toEqual(files);
+    expect(files).toMatchInlineSnapshot(`
+      Set {
+        "app",
+        "babel.config.js",
+        "index.html",
+        "package.json",
+        "pnpm-lock.yaml",
+        "vite.config.mjs",
+        "app/app.js",
+        "app/config.js",
+        "app/router.js",
+        "app/templates",
+        "app/templates/application.gjs",
+      }
+    `);
+  });
+});

package/src/bases/minimal-app/files/.env.development

@@ -0,0 +1,8 @@
+# This file is committed to git and should not contain any secrets.
+# 
+# Vite recommends using .env.local or .env.[mode].local if you need to manage secrets
+# SEE: https://vite.dev/guide/env-and-mode.html#env-files for more information.
+
+
+# Default NODE_ENV with vite build --mode=test is production
+NODE_ENV=development

package/src/bases/minimal-app/files/app/app.ts

@@ -0,0 +1,21 @@
+/**
+ * Looking for services that come from addons?
+ *
+ * See: https://github.com/embroider-build/embroider/issues/2659
+ *
+ * We currently don't support app-tree merging from libraries.
+ *
+ * For services, I highly recommend looking in to either of
+ * - https://github.com/chancancode/ember-polaris-service-
+ * - https://ember-primitives.pages.dev/6-utils/createService.md
+ *   - https://ember-primitives.pages.dev/6-utils/createAsyncService.md
+ */
+import Application from "ember-strict-application-resolver";
+
+export default class App extends Application {
+  modules = {
+    ...import.meta.glob("./router.*", { eager: true }),
+    ...import.meta.glob("./templates/**/*", { eager: true }),
+    ...import.meta.glob("./services/**/*", { eager: true }),
+  };
+}

package/src/bases/minimal-app/files/app/config.ts

@@ -0,0 +1,30 @@
+interface Config {
+  environment: "development" | "production";
+  locationType: "history" | "hash" | "none" | "auto";
+  rootURL: string;
+  EmberENV?: Record<string, unknown>;
+  APP: Record<string, unknown> & { rootElement?: string; autoboot?: boolean };
+}
+
+const ENV: Config = {
+  environment: import.meta.env.DEV ? "development" : "production",
+  rootURL: "/",
+  locationType: "history",
+  EmberENV: {},
+  APP: {},
+};
+
+export default ENV;
+
+// @ts-expect-error: Ignoreing private API
+import { getGlobalConfig } from "@embroider/macros/src/addon/runtime";
+
+export function enterTestMode() {
+  ENV.locationType = "none";
+  ENV.APP.rootElement = "#ember-testing";
+  ENV.APP.autoboot = false;
+
+  const theMacrosGlobal = getGlobalConfig();
+  theMacrosGlobal["@embroider/macros"] ||= {};
+  theMacrosGlobal["@embroider/macros"].isTesting ||= true;
+}

package/src/bases/minimal-app/files/app/router.ts

@@ -0,0 +1,51 @@
+import EmbroiderRouter from "@embroider/router";
+import config from "#config";
+
+export default class Router extends EmbroiderRouter {
+  location = config.locationType;
+  rootURL = config.rootURL;
+}
+
+Router.map(function () {});
+
+/**
+ * Caveat:
+ * - https://github.com/embroider-build/embroider/issues/2521
+ *   We don't yet have a way to do this in a nice way
+ *
+ */
+// function bundle(name: string, loader: () => Promise<{ default: unknown }>[]) {
+//   return {
+//     names: [name],
+//     load: async () => {
+//       const [template, route, controller] = await Promise.all(loader());
+//       let slashName = name.replaceAll(".", "/");
+//       let results: Record<string, unknown> = {};
+
+//       if (template) results[`./templates/${slashName}`] = template.default;
+//       if (route) results[`./routes/${slashName}`] = route.default;
+//       if (controller) results[`./controllers/${slashName}`] = controller.default;
+
+//       return {
+//         default: results,
+//       };
+//     },
+//   };
+// }
+
+/**
+ * Examples from:
+ * - https://github.com/NullVoxPopuli/limber/blob/67e2f54bbe224052e38f9a9e566d704411e65e86/apps/repl/app/router.ts#L35
+ */
+// (window as any)._embroiderRouteBundles_ = [
+// bundle("docs", () => [import("./templates/docs.gts")]),
+// bundle("docs.repl-sdk", () => [import("./templates/docs/repl-sdk.gts")]),
+// bundle("docs.ember-repl", () => [import("./templates/docs/ember-repl.gts")]),
+// bundle("docs.embedding", () => [import("./templates/docs/embedding.gts")]),
+// bundle("docs.editor", () => [import("./templates/docs/editor.gts")]),
+// bundle("docs.whatever", () => [
+//   import("./the/template.gts"),
+//   import("./the/route.ts"),
+//   import("./the/controller.ts"),
+// ]),
+// ];

package/src/bases/minimal-app/files/app/templates/application.gts

@@ -0,0 +1,5 @@
+<template>
+  <h1>Welcome to Ember</h1>
+
+  {{outlet}}
+</template>

package/src/{layers/minimal/files-ts → bases/minimal-app/files}/babel.config.js

@@ -1,5 +1,3 @@
-import { dirname } from "node:path";
-import { fileURLToPath } from "node:url";
 import { buildMacros } from "@embroider/macros/babel";
 
 const macros = buildMacros();
@@ -17,7 +15,6 @@ export default {
     [
       "babel-plugin-ember-template-compilation",
       {
-        compilerPath: "ember-source/dist/ember-template-compiler.js",
         transforms: [...macros.templateMacros],
       },
     ],
@@ -32,7 +29,7 @@ export default {
     [
       "@babel/plugin-transform-runtime",
       {
-        absoluteRuntime: dirname(fileURLToPath(import.meta.url)),
+        absoluteRuntime: import.meta.dirname,
         useESModules: true,
         regenerator: false,
       },

package/src/{layers/minimal → bases/minimal-app}/files/index.html

@@ -2,16 +2,14 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <title><%= namespace %></title>
+    <title>Minimal App</title>
     <meta name="description" content="" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
-
-    <link rel="stylesheet" href="/app/styles/app.css" />
   </head>
   <body>
     <script type="module">
-      import Application from "./app/app";
-      import environment from "./app/config/environment";
+      import Application from "#app/app";
+      import environment from "#config";
 
       Application.create(environment.APP);
     </script>

package/src/bases/minimal-app/files/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "minimal-app",
+  "version": "0.0.0",
+  "private": true,
+  "description": "Your Ember App's description here",
+  "repository": "",
+  "license": "MIT",
+  "author": "",
+  "type": "module",
+  "imports": {
+    "#app/*": "./app/*",
+    "#config": "./app/config.ts",
+    "#components/*": "./app/components/*",
+    "#services/*": "./app/services/*",
+    "#test-helpers/*": "./tests/helpers/*",
+    "#utils/*": "./app/utils/*"
+  },
+  "exports": {
+    "./tests/*": "./tests/*",
+    "./*": "./app/*"
+  },
+  "scripts": {
+    "build": "vite build",
+    "dev": "vite",
+    "start": "vite"
+  },
+  "dependencies": {
+    "@embroider/macros": "^1.19.6",
+    "@embroider/router": "^3.0.6",
+    "@glimmer/component": "^2.0.0",
+    "decorator-transforms": "^2.3.1",
+    "ember-source": "~6.10.0",
+    "ember-strict-application-resolver": "^0.1.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.28.5",
+    "@babel/plugin-transform-runtime": "^7.28.5",
+    "@babel/plugin-transform-typescript": "^7.28.5",
+    "@babel/runtime": "^7.28.4",
+    "@ember/app-tsconfig": "^2.0.0",
+    "@embroider/core": "^4.4.2",
+    "@embroider/vite": "^1.5.0",
+    "@glint/ember-tsc": "^1.0.8",
+    "@glint/template": "^1.7.3",
+    "@glint/tsserver-plugin": "^2.0.8",
+    "@rollup/plugin-babel": "^6.1.0",
+    "babel-plugin-ember-template-compilation": "^4.0.0",
+    "typescript": "^5.9.3",
+    "vite": "^7.3.0"
+  },
+  "engines": {
+    "node": ">= 24"
+  },
+  "ember": {
+    "edition": "octane"
+  }
+}

package/src/{layers/minimal → bases/minimal-app}/files/tsconfig.json

@@ -1,13 +1,7 @@
 {
   "extends": "@ember/app-tsconfig",
-  "include": ["app", "tests", "types"],
   "compilerOptions": {
     "allowJs": true,
-    "paths": {
-      "<%= name %>/tests/*": ["./tests/*"],
-      "<%= name %>/*": ["./app/*"],
-      "*": ["./types/*"]
-    },
     "types": [
       "ember-source/types",
       "@embroider/core/virtual",

package/src/bases/minimal-app/index.js

@@ -0,0 +1,111 @@
+import { packageJson, js } from "ember-apply";
+import { getLatest } from "#utils/npm.js";
+import { fileURLToPath } from "node:url";
+import { applyFolderTo } from "#utils/fs.js";
+import { removeConfiguredPlugin } from "#utils/babel.js";
+
+/**
+ * Minimal Layer
+ *
+ * Provides the absolute bare minimum for an Ember app:
+ * - type: "module" in package.json
+ * - No @embroider/compat (no-compat mode)
+ * - No testing framework
+ * - No linting or formatting
+ * - No ember-welcome-page
+ * - No warp-drive (opt-in if needed)
+ */
+export default {
+  label: "Minimal App Base",
+  description: "Bare minimum Ember app structure",
+
+  /**
+   * 1. Apply files
+   *   a. Remove TS if needed
+   * 2. Remove TS deps/files if needed
+   * 3. Update name(s)
+   *
+   * @param {import('#utils/project.js').Project} project
+   */
+  async run(project) {
+    await applyFiles(project);
+    await updateName(project);
+    await makeJavaScript(project);
+    await upgradeDependencies(project);
+    await updateBabelConfig(project);
+  },
+};
+
+/**
+ * @param {import('#utils/project.js').Project} project
+ */
+async function updateBabelConfig(project) {
+  if (await project.hasOrWantsLayer("typescript")) return;
+
+  await removeConfiguredPlugin(project, "@babel/plugin-transform-typescript");
+}
+
+/**
+ * @param {import('#utils/project.js').Project} project
+ */
+async function applyFiles(project) {
+  let filePath = fileURLToPath(new URL("files", import.meta.url));
+
+  await applyFolderTo(filePath, project);
+}
+
+/**
+ * Operates on known files where the name matters
+ *
+ * @param {import('#utils/project.js').Project} project
+ */
+async function updateName(project) {
+  await packageJson.modify((json) => {
+    json.name = project.desires.name;
+  }, project.directory);
+}
+
+/**
+ * @param {import('#utils/project.js').Project} project
+ */
+async function makeJavaScript(project) {
+  if (await project.hasOrWantsLayer("typescript")) return;
+
+  /**
+   * We don't actually remove anything, because we want intellisense for JS
+   *
+   * But perhaps for the sake of minimal, we do remoev it.
+   * And we add a layer later for JSDoc ased TS or something
+   */
+  await packageJson.removeDevDependencies(
+    [
+      "@ember/app-tsconfig",
+      "@glint/ember-tsc",
+      "@glint/template",
+      "@glint/tsserver-plugin",
+      "typescript",
+    ],
+    project.directory,
+  );
+
+  await project.removeFile("tsconfig.json");
+
+  await packageJson.modify((json) => {
+    json.imports["#config"] = "./app/config.js";
+  }, project.directory);
+}
+
+/**
+ * Bumps in-range only.
+ * Majors will need to go through PR to this repo.
+ *
+ * @param {import('#utils/project.js').Project} project
+ */
+async function upgradeDependencies(project) {
+  let existing = await packageJson.read(project.directory);
+
+  await packageJson.modify(async (json) => {
+    Object.assign(json.dependencies, await getLatest(existing.dependencies));
+    Object.assign(json.devDependencies, await getLatest(existing.devDependencies));
+  }, project.directory);
+}

package/src/bases/minimal-library/index.js

@@ -0,0 +1,10 @@
+export default {
+  label: "Minimal Library Base",
+  description: "Bare minimum library structure",
+
+  /**
+   *
+   * @param {import('#utils/project.js').Project} project
+   */
+  async run(project) {},
+};

package/src/cli/args.js

@@ -0,0 +1,57 @@
+import * as p from "@clack/prompts";
+import { styleText, parseArgs } from "node:util";
+
+const { values } = parseArgs({
+  options: {
+    name: {
+      type: "string",
+    },
+
+    path: {
+      type: "string",
+    },
+
+    type: {
+      type: "string",
+      choices: ["app", "addon", "library"],
+    },
+
+    confirm: {
+      type: "string",
+      choices: ["yes", "no"],
+    },
+
+    layers: {
+      type: "string",
+      multiple: true,
+    },
+
+    packageManager: {
+      type: "string",
+      choices: ["npm", "pnpm"],
+    },
+  },
+});
+
+const { name, type, layers = [], packageManager, path, confirm } = values;
+
+export const answers = {
+  name,
+  type,
+  layers,
+  packageManager,
+  path,
+  confirm,
+};
+
+/**
+ *
+ * @param {string} label
+ * @param {string} value
+ */
+export function printArgInUse(label, value) {
+  let l = styleText(["gray", "bold"], label);
+  let v = styleText(["yellow", "italic"], value);
+  let u = styleText("dim", "using");
+  p.log.info(`${u} ${l}: ${v}`);
+}