ember.nvp 0.7.0 → 1.1.0

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

@@ -0,0 +1,251 @@
+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 { readFile, rm } from "node:fs/promises";
+import { globSync } from "node:fs";
+import { join } from "node:path";
+
+const expect = hardExpect.soft;
+
+describe("typescript", () => {
+  let project: Project;
+  beforeAll(async () => {
+    project = await generate({
+      name: "my-extension",
+      type: "extension",
+      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("extension");
+  });
+
+  it("has the typescript babel plugin", async () => {
+    let content = await project.read("babel.config.js");
+
+    expect(content).toContain("@babel/plugin-transform-typescript");
+  });
+
+  it("named the extension in the manifest", async () => {
+    let manifest = JSON.parse((await project.read("public/manifest.json"))!);
+
+    expect(manifest.name).toBe("my-extension");
+    expect(manifest.manifest_version).toBe(3);
+  });
+
+  it("boots from an external script (extension CSP forbids inline scripts)", async () => {
+    let html = await project.read("index.html");
+
+    expect(html).toContain(`src="./app/boot.ts"`);
+    expect(html).not.toContain("Application.create");
+  });
+
+  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("dist is loadable as an unpacked extension", async () => {
+    let manifest = JSON.parse(
+      await readFile(join(project.directory, "dist/manifest.json"), "utf-8"),
+    );
+
+    expect(manifest.name).toBe("my-extension");
+    expect(manifest.action.default_popup).toBe("index.html");
+
+    let html = await readFile(join(project.directory, "dist/index.html"), "utf-8");
+
+    expect(html).toContain(`<script type="module"`);
+    expect(html).not.toContain("Application.create");
+  });
+
+  it("has no JS files", async () => {
+    let results = globSync("app/**/*", {
+      exclude: ["node_modules", "dist"],
+      cwd: project.directory,
+    });
+    expect(results).toMatchInlineSnapshot(`
+      [
+        "app/app.ts",
+        "app/boot.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 {
+        "README.md",
+        "app",
+        "babel.config.js",
+        "index.html",
+        "package.json",
+        "pnpm-lock.yaml",
+        "public",
+        "tsconfig.json",
+        "vite.config.mjs",
+        "public/manifest.json",
+        "app/app.ts",
+        "app/boot.ts",
+        "app/config.ts",
+        "app/router.ts",
+        "app/templates",
+        "app/templates/application.gts",
+      }
+    `);
+  });
+});
+
+describe("javascript", () => {
+  let project: Project;
+  beforeAll(async () => {
+    project = await generate({
+      name: "my-extension",
+      type: "extension",
+      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("extension");
+  });
+
+  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("the popup points at the renamed boot script", async () => {
+    let html = await project.read("index.html");
+
+    expect(html).toContain(`src="./app/boot.js"`);
+    expect(html).not.toContain("boot.ts");
+  });
+
+  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/boot.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 {
+        "README.md",
+        "app",
+        "babel.config.js",
+        "index.html",
+        "package.json",
+        "pnpm-lock.yaml",
+        "public",
+        "vite.config.mjs",
+        "public/manifest.json",
+        "app/app.js",
+        "app/boot.js",
+        "app/config.js",
+        "app/router.js",
+        "app/templates",
+        "app/templates/application.gjs",
+      }
+    `);
+  });
+});

package/src/bases/minimal-extension/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-extension/files/README.md

@@ -0,0 +1,36 @@
+# minimal-extension
+
+A [Manifest V3](https://developer.chrome.com/docs/extensions/develop/migrate/what-is-mv3) browser extension whose popup is an Ember app.
+
+## Developing
+
+The popup is a regular web page, so the fastest feedback loop is the vite dev server in a normal browser tab:
+
+```bash
+pnpm dev
+```
+
+To run as an actual extension, build (in watch mode) and load the `dist/` directory as an unpacked extension:
+
+```bash
+pnpm build:watch
+```
+
+- **Chrome / Edge / Brave**: `chrome://extensions` → enable "Developer mode" → "Load unpacked" → select `dist/`
+- **Firefox**: `about:debugging#/runtime/this-firefox` → "Load Temporary Add-on…" → select `dist/manifest.json`
+
+After a rebuild, re-open the popup (or reload the extension) to see changes.
+
+## Anatomy
+
+- `public/manifest.json` — the extension manifest; copied verbatim into `dist/`. Add [`background`](https://developer.chrome.com/docs/extensions/reference/manifest/background), [`content_scripts`](https://developer.chrome.com/docs/extensions/reference/manifest/content-scripts), permissions, and icons here as your extension grows.
+- `index.html` — the popup page (`action.default_popup`). Extension pages are served with a `script-src 'self'` Content-Security-Policy, so the app boots from `app/boot.ts` rather than an inline script.
+- `app/` — a normal Ember app. Routing uses `locationType: "none"`, since extension pages have no URL bar to bind to.
+
+## Building for release
+
+```bash
+pnpm build
+```
+
+Zip the contents of `dist/` and upload it to the extension store(s) of your choosing.

package/src/bases/minimal-extension/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-extension/files/app/boot.ts

@@ -0,0 +1,8 @@
+/**
+ * Extension pages disallow inline scripts (`script-src 'self'`),
+ * so booting the app lives here instead of in index.html.
+ */
+import Application from "#app/app";
+import environment from "#config";
+
+Application.create(environment.APP);

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

@@ -0,0 +1,22 @@
+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: "/",
+  /**
+   * Extension pages live at chrome-extension://<id>/index.html (or
+   * moz-extension://), where history-based routing has nothing to bind
+   * to. "none" keeps routing fully programmatic.
+   */
+  locationType: "none",
+  EmberENV: {},
+  APP: {},
+};
+
+export default ENV;

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

@@ -0,0 +1,10 @@
+import EmbroiderRouter from "@embroider/router";
+
+import config from "#config";
+
+export default class Router extends EmbroiderRouter {
+  location = config.locationType;
+  rootURL = config.rootURL;
+}
+
+Router.map(function () {});

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

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

package/src/bases/minimal-extension/files/babel.config.js

@@ -0,0 +1,49 @@
+import { buildMacros } from "@embroider/macros/babel";
+
+const macros = buildMacros({
+  configure(config) {
+    if (process.env.EMBER_ENV === "test") {
+      config.enableRuntimeMode();
+    }
+  },
+});
+
+export default {
+  plugins: [
+    [
+      "@babel/plugin-transform-typescript",
+      {
+        allExtensions: true,
+        onlyRemoveTypeImports: true,
+        allowDeclareFields: true,
+      },
+    ],
+    [
+      "babel-plugin-ember-template-compilation",
+      {
+        transforms: [...macros.templateMacros],
+      },
+    ],
+    [
+      "module:decorator-transforms",
+      {
+        runtime: {
+          import: import.meta.resolve("decorator-transforms/runtime-esm"),
+        },
+      },
+    ],
+    [
+      "@babel/plugin-transform-runtime",
+      {
+        absoluteRuntime: import.meta.dirname,
+        useESModules: true,
+        regenerator: false,
+      },
+    ],
+    ...macros.babelMacros,
+  ],
+
+  generatorOpts: {
+    compact: false,
+  },
+};

package/src/bases/minimal-extension/files/index.html

@@ -0,0 +1,17 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>Minimal Extension</title>
+    <meta name="description" content="" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+  </head>
+  <body>
+    <!--
+      Unlike a web app, this boot script cannot be inlined:
+      extension pages are served with a Content-Security-Policy of
+      `script-src 'self'`, which forbids inline scripts.
+    -->
+    <script type="module" src="./app/boot.ts"></script>
+  </body>
+</html>

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

@@ -0,0 +1,58 @@
+{
+  "name": "minimal-extension",
+  "version": "0.0.0",
+  "private": true,
+  "description": "Your Browser Extension'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",
+    "build:watch": "vite build --watch --mode development",
+    "dev": "vite",
+    "start": "vite"
+  },
+  "dependencies": {
+    "@embroider/macros": "^1.20.3",
+    "@embroider/router": "^3.0.6",
+    "@glimmer/component": "^2.1.1",
+    "decorator-transforms": "^2.3.2",
+    "ember-source": "~7.0.0",
+    "ember-strict-application-resolver": "^0.1.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.29.7",
+    "@babel/plugin-transform-runtime": "^7.29.7",
+    "@babel/plugin-transform-typescript": "^7.29.7",
+    "@babel/runtime": "^7.29.7",
+    "@ember/app-tsconfig": "^2.0.0",
+    "@embroider/core": "^4.4.2",
+    "@glint/ember-tsc": "^1.7.5",
+    "@glint/template": "^1.7.7",
+    "@glint/tsserver-plugin": "^2.5.5",
+    "@nullvoxpopuli/ember-vite": "workspace:*",
+    "@rollup/plugin-babel": "^7.1.0",
+    "babel-plugin-ember-template-compilation": "^4.0.0",
+    "typescript": "^6.0.3",
+    "vite": "^8.0.14"
+  },
+  "engines": {
+    "node": ">= 24"
+  },
+  "ember": {
+    "edition": "octane"
+  }
+}

package/src/bases/minimal-extension/files/public/manifest.json

@@ -0,0 +1,9 @@
+{
+  "manifest_version": 3,
+  "name": "minimal-extension",
+  "version": "0.0.0",
+  "description": "Your Browser Extension's description here",
+  "action": {
+    "default_popup": "index.html"
+  }
+}

package/src/bases/minimal-extension/files/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "@ember/app-tsconfig",
+  "compilerOptions": {
+    "allowJs": true,
+    "lib": ["esnext", "dom", "dom.iterable"],
+    "types": [
+      "ember-source/types",
+      "@embroider/core/virtual",
+      "vite/client",
+      "@glint/ember-tsc/types"
+    ]
+  }
+}

package/src/bases/minimal-extension/files/vite.config.mjs

@@ -0,0 +1,6 @@
+import { defineConfig } from "vite";
+import { ember } from "@nullvoxpopuli/ember-vite";
+
+export default defineConfig({
+  plugins: [ember()],
+});

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

@@ -0,0 +1,142 @@
+import { packageJson } from "ember-apply";
+import { readFile, writeFile } from "node:fs/promises";
+import { join } from "node:path";
+import { getLatest } from "#utils/npm.js";
+import { applyFolderTo } from "#utils/fs.js";
+import { removeConfiguredPlugin } from "#utils/babel.js";
+
+/**
+ * Minimal Extension Base
+ *
+ * Provides the absolute bare minimum for a browser extension (Manifest V3)
+ * whose popup is an Ember app:
+ * - type: "module" in package.json
+ * - public/manifest.json copied verbatim into dist
+ * - index.html popup booting from an external script (extension pages
+ *   forbid inline scripts via CSP)
+ * - No testing framework
+ * - No linting or formatting
+ * - No ember-welcome-page
+ */
+export default {
+  label: "Minimal Extension Base",
+  description: "Bare minimum browser extension structure with an Ember popup",
+
+  /**
+   * 1. Apply files
+   *   a. Remove TS if needed
+   * 2. Remove TS deps/files if needed
+   * 3. Update name(s)
+   * 4. Upgrade in-range dependencies
+   * 5. Update an existing babel config, if any
+   *
+   * @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 = join(import.meta.dirname, "files");
+
+  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);
+
+  if (!project.hasFile("public/manifest.json")) return;
+
+  let manifestPath = project.path("public/manifest.json");
+  let manifest = JSON.parse(await readFile(manifestPath, "utf-8"));
+
+  manifest.name = project.desires.name;
+
+  await writeFile(manifestPath, JSON.stringify(manifest, null, 2) + "\n");
+}
+
+/**
+ * @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 ||= {};
+    json.imports["#config"] = "./app/config.js";
+  }, project.directory);
+
+  /**
+   * The import-rewriting pass only handles module files; the popup's
+   * <script src> points at the boot module by path, so it has to follow
+   * the .ts -> .js rename by hand.
+   */
+  if (!project.hasFile("index.html")) return;
+
+  let indexPath = project.path("index.html");
+  let indexHtml = await readFile(indexPath, "utf-8");
+
+  await writeFile(indexPath, indexHtml.replace("./app/boot.ts", "./app/boot.js"));
+}
+
+/**
+ * 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) => {
+    if (json.dependencies) {
+      Object.assign(json.dependencies, await getLatest(existing.dependencies));
+    }
+    if (json.devDependencies) {
+      Object.assign(json.devDependencies, await getLatest(existing.devDependencies));
+    }
+  }, project.directory);
+}

package/src/bases/minimal-library/files/tsdown.config.js

@@ -1,4 +1,5 @@
-import { defineConfig, ember } from "@nullvoxpopuli/ember-rolldown";
+import { defineConfig } from "tsdown";
+import { ember } from "@nullvoxpopuli/ember-rolldown";
 
 export default defineConfig({
   entry: ["./src/index.ts"],