ember.nvp 0.0.0 → 0.1.0

package/.github/workflows/plan-release.yml

@@ -0,0 +1,61 @@
+name: Plan Release
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+      - master
+  pull_request_target: # This workflow has permissions on the repo, do NOT run code from PRs in this workflow. See https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
+    types:
+      - labeled
+      - unlabeled
+
+concurrency:
+  group: plan-release # only the latest one of these should ever be running
+  cancel-in-progress: true
+
+jobs:
+  should-run-release-plan-prepare:
+    name: Should we run release-plan prepare?
+    runs-on: ubuntu-latest
+    outputs:
+      should-prepare: ${{ steps.should-prepare.outputs.should-prepare }}
+    steps:
+      - uses: release-plan/actions/should-prepare-release@v1
+        with:
+          ref: 'main'
+        id: should-prepare
+
+  create-prepare-release-pr:
+    name: Create Prepare Release PR
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    needs: should-run-release-plan-prepare
+    permissions:
+      contents: write
+      issues: read
+      pull-requests: write
+    if: needs.should-run-release-plan-prepare.outputs.should-prepare == 'true'
+    steps:
+      - uses: release-plan/actions/prepare@v1
+        name: Run release-plan prepare
+        with:
+          ref: 'main'
+        env:
+          GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
+        id: explanation
+
+      - uses: peter-evans/create-pull-request@v8
+        name: Create Prepare Release PR
+        with:
+          commit-message: "Prepare Release ${{ steps.explanation.outputs.new-version}} using 'release-plan'"
+          labels: "internal"
+          sign-commits: true
+          branch: release-preview
+          title: Prepare Release ${{ steps.explanation.outputs.new-version }}
+          body: |
+            This PR is a preview of the release that [release-plan](https://github.com/embroider-build/release-plan) has prepared. To release you should just merge this PR 👍
+
+            -----------------------------------------
+
+            ${{ steps.explanation.outputs.text }}

package/.github/workflows/publish.yml

@@ -0,0 +1,41 @@
+# For every push to the primary branch with .release-plan.json modified,
+# runs release-plan.
+
+name: Publish Stable
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+      - master
+    paths:
+      - '.release-plan.json'
+
+concurrency:
+  group: publish-${{ github.head_ref || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  publish:
+    name: "NPM Publish"
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+      attestations: write
+
+    steps:
+      - uses: actions/checkout@v6
+      - uses: pnpm/action-setup@v4
+      - uses: actions/setup-node@v6
+        with:
+          node-version: 22
+          registry-url: 'https://registry.npmjs.org'
+          cache: pnpm
+      - run: npm install -g npm@latest # ensure that the globally installed npm is new enough to support OIDC
+      - run: pnpm install --frozen-lockfile
+      - name: Publish to NPM
+        run: NPM_CONFIG_PROVENANCE=true pnpm release-plan publish
+        env:
+          GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}

package/.nvmrc

@@ -0,0 +1 @@
+24

package/.prettierignore

@@ -0,0 +1,2 @@
+pnpm-lock.yaml
+

package/.release-plan.json

@@ -0,0 +1,22 @@
+{
+  "solution": {
+    "ember.nvp": {
+      "impact": "minor",
+      "oldVersion": "0.0.0",
+      "newVersion": "0.1.0",
+      "tagName": "latest",
+      "constraints": [
+        {
+          "impact": "minor",
+          "reason": "Appears in changelog section :rocket: Enhancement"
+        },
+        {
+          "impact": "patch",
+          "reason": "Appears in changelog section :house: Internal"
+        }
+      ],
+      "pkgJSONPath": "./package.json"
+    }
+  },
+  "description": "## Release (2026-01-21)\n\n* ember.nvp 0.1.0 (minor)\n\n#### :rocket: Enhancement\n* `ember.nvp`\n  * [#1](https://github.com/NullVoxPopuli/ember.nvp/pull/1) Implementation planning ([@NullVoxPopuli](https://github.com/NullVoxPopuli))\n\n#### :house: Internal\n* `ember.nvp`\n  * [#2](https://github.com/NullVoxPopuli/ember.nvp/pull/2) pnpm dlx create-release-plan-setup@latest --update ([@NullVoxPopuli](https://github.com/NullVoxPopuli))\n  * [#1](https://github.com/NullVoxPopuli/ember.nvp/pull/1) Implementation planning ([@NullVoxPopuli](https://github.com/NullVoxPopuli))\n\n#### Committers: 1\n- [@NullVoxPopuli](https://github.com/NullVoxPopuli)\n"
+}

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## Release (2026-01-21)
+
+* ember.nvp 0.1.0 (minor)
+
+#### :rocket: Enhancement
+* `ember.nvp`
+  * [#1](https://github.com/NullVoxPopuli/ember.nvp/pull/1) Implementation planning ([@NullVoxPopuli](https://github.com/NullVoxPopuli))
+
+#### :house: Internal
+* `ember.nvp`
+  * [#2](https://github.com/NullVoxPopuli/ember.nvp/pull/2) pnpm dlx create-release-plan-setup@latest --update ([@NullVoxPopuli](https://github.com/NullVoxPopuli))
+  * [#1](https://github.com/NullVoxPopuli/ember.nvp/pull/1) Implementation planning ([@NullVoxPopuli](https://github.com/NullVoxPopuli))
+
+#### Committers: 1
+- [@NullVoxPopuli](https://github.com/NullVoxPopuli)

package/README.md

@@ -2,7 +2,6 @@
 
 _ember project generator: alternative to the official blueprints, but more modern -- hopefully one day to upstream back in to ember-cli / official blueprints_
 
-
 ## Reqs
 
 - node 24+
@@ -14,7 +13,229 @@ _ember project generator: alternative to the official blueprints, but more moder
   - choose your features
 
 Good for:
+
 - demos
 - reproductions
 - existing monorepos
 - example integrations with other tools
+
+## Usage
+
+Install dependencies first:
+
+```bash
+pnpm install
+```
+
+Then run the interactive CLI:
+
+```bash
+node src/cli/index.js
+```
+
+Or link it locally for easier testing:
+
+```bash
+pnpm link --global
+ember.nvp
+```
+
+### Example Session
+
+```
+┌  ember.nvp
+│
+◆  What is your project name?
+│  my-awesome-app
+│
+◇  Base Layer
+│  minimal layer is always included.
+│  It provides: type: "module", no compat, no testing, no linting.
+│  Perfect for demos and reproductions.
+│
+◆  Select additional features: (press space to select)
+│  ◻ ESLint - Code linting with ESLint
+│  ◻ Prettier - Code formatting with Prettier
+│  ◻ QUnit - Testing with QUnit
+│  ◻ Vitest - Testing with Vitest (modern & fast)
+│
+◆  Which package manager?
+│  ● pnpm - Fast, disk space efficient
+│    npm - Node default
+│    yarn - Classic alternative
+│
+◇  Project created!
+│
+◇  Next steps
+│  cd my-awesome-app
+│  pnpm install
+│  pnpm start
+│
+└  ✓ Project ready! Happy coding!
+```
+
+The CLI will guide you through:
+
+1. **Project name** - Choose your project name
+2. **Feature selection** - Select which layers you want (linting, testing, formatting)
+3. **Package manager** - Choose pnpm, npm, or yarn
+
+## Layers
+
+Each layer is a standalone module that can add features to your ember project:
+
+### 🎯 Minimal (always included)
+
+The base layer, matching the `--minimal` flag from [ember-cli/ember-app-blueprint#49](https://github.com/ember-cli/ember-app-blueprint/pull/49):
+
+- ✅ `"type": "module"` in package.json
+- ✅ No @embroider/compat (faster builds)
+- ✅ No testing framework (minimal setup)
+- ✅ No linting or formatting
+- ✅ No ember-welcome-page
+- ✅ Vite-based with modern Ember
+
+Perfect for demos, reproductions, and learning!
+
+### 📝 ESLint (optional)
+
+Adds modern ESLint configuration with:
+
+- TypeScript support
+- Ember plugin
+- Flat config (ESLint 9+)
+- Prettier compatibility
+
+### 🎨 Prettier (optional)
+
+Code formatting with:
+
+- GTS/GJS template support
+- Sensible defaults
+- Format scripts
+
+### 🧪 QUnit (optional)
+
+Traditional Ember testing with:
+
+- QUnit test framework
+- @ember/test-helpers
+- Test HTML setup
+- Playwright for CI
+
+### ⚡ Vitest (optional)
+
+Modern testing alternative:
+
+- Vitest (faster than QUnit)
+- @ember/test-helpers
+- Happy DOM
+- Watch mode & UI
+
+## Architecture
+
+```
+src/
+├── cli/          # Interactive CLI entry point
+│   └── index.js  # Main CLI with prompts
+├── layers/       # Feature layers (auto-discovered)
+│   ├── minimal/  # Base layer (always included)
+│   │   ├── index.js    # Layer definition with run function
+│   │   └── files/      # Template files to copy
+│   ├── eslint/
+│   │   ├── index.js
+│   │   └── files/
+│   ├── prettier/
+│   │   ├── index.js
+│   │   └── files/
+│   ├── qunit/
+│   │   ├── index.js
+│   │   └── files/
+│   └── vitest/
+│       ├── index.js
+│       └── files/
+└── lib/          # Shared utilities
+    └── generator.js  # Project generation orchestration
+```
+
+### Layer Architecture
+
+Each layer now uses **ember-apply** utilities for robust file and package.json manipulation:
+
+- **`index.js`** - Exports an object with:
+  - `label` - Display name
+  - `description` - Short description
+  - `run({ targetDir, projectName })` - Async function that applies the layer
+
+- **`files/`** - Directory containing template files to copy to the target project
+  - Use `__PROJECT_NAME__` placeholder for project name substitution
+  - Files are copied using `ember-apply`'s `files.applyFolder()`
+
+### How Layers Work
+
+1. **Discovery**: CLI scans `src/layers/` and imports each `index.js`
+2. **Selection**: User selects which optional layers to include
+3. **Execution**: Each layer's `run()` function is called in sequence:
+   ```js
+   await layer.run({ targetDir: "/path/to/project", projectName: "my-app" });
+   ```
+4. **Layer Functions**: Inside `run()`, layers use `ember-apply` to:
+   - Copy files from `files/` directory
+   - Add dependencies/devDependencies to package.json
+   - Add npm scripts
+   - Modify package.json metadata
+   - Transform existing files (e.g., replace placeholders)
+
+### Adding New Layers
+
+To add a new layer, create a new directory in `src/layers/` with:
+
+1. **`index.js`** - Layer definition:
+
+```js
+import { packageJson, files } from "ember-apply";
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+export default {
+  label: "My Feature",
+  description: "What this feature does",
+
+  async run({ targetDir, projectName }) {
+    // Copy files from files/ directory
+    await files.applyFolder(join(__dirname, "files"), targetDir);
+
+    // Add dependencies
+    await packageJson.addDependencies(
+      {
+        "some-package": "^1.0.0",
+      },
+      targetDir,
+    );
+
+    // Add devDependencies
+    await packageJson.addDevDependencies(
+      {
+        "dev-package": "^2.0.0",
+      },
+      targetDir,
+    );
+
+    // Add scripts
+    await packageJson.addScripts(
+      {
+        "my-script": 'echo "Hello"',
+      },
+      targetDir,
+    );
+  },
+};
+```
+
+2. **`files/`** directory - Template files to copy:
+   - Use `__PROJECT_NAME__` as a placeholder for the project name
+   - Files will be copied to the target directory maintaining structure
+
+The CLI will automatically discover and offer it as an option!

package/RELEASE.md

@@ -0,0 +1,27 @@
+# Release Process
+
+Releases in this repo are mostly automated using [release-plan](https://github.com/embroider-build/release-plan/). Once you label all your PRs correctly (see below) you will have an automatically generated PR that updates your CHANGELOG.md file and a `.release-plan.json` that is used to prepare the release once the PR is merged.
+
+## Preparation
+
+Since the majority of the actual release process is automated, the remaining tasks before releasing are:
+
+- correctly labeling **all** pull requests that have been merged since the last release
+- updating pull request titles so they make sense to our users
+
+Some great information on why this is important can be found at [keepachangelog.com](https://keepachangelog.com/en/1.1.0/), but the overall
+guiding principle here is that changelogs are for humans, not machines.
+
+When reviewing merged PR's the labels to be used are:
+
+- breaking - Used when the PR is considered a breaking change.
+- enhancement - Used when the PR adds a new feature or enhancement.
+- bug - Used when the PR fixes a bug included in a previous release.
+- documentation - Used when the PR adds or updates documentation.
+- internal - Internal changes or things that don't fit in any other category.
+
+**Note:** `release-plan` requires that **all** PRs are labeled. If a PR doesn't fit in a category it's fine to label it as `internal`
+
+## Release
+
+Once the prep work is completed, the actual release is straight forward: you just need to merge the open [Plan Release](https://github.com/NullVoxPopuli/ember.nvp/pulls?q=is%3Apr+is%3Aopen+%22Prepare+Release%22+in%3Atitle) PR

package/package.json

@@ -1,10 +1,35 @@
 {
   "name": "ember.nvp",
-  "version": "0.0.0",
+  "version": "0.1.0",
   "description": "ember project generator, alternative to the official blueprints, but more modern -- hopefully one day to upstream back in to ember-cli / official blueprints",
-  "dependencies": {},
-  "devDependencies": {},
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:NullVoxPopuli/ember.nvp.git"
+  },
+  "type": "module",
+  "bin": "./src/cli/index.js",
+  "dependencies": {
+    "@clack/prompts": "^0.11.0",
+    "ember-apply": "^2.16.0",
+    "picocolors": "^1.1.1"
+  },
+  "devDependencies": {
+    "@ember/app-tsconfig": "^2.0.0",
+    "@ember/library-tsconfig": "^2.0.0",
+    "@glint/ember-tsc": "^1.0.9",
+    "@glint/template": "^1.7.3",
+    "@glint/tsserver-plugin": "^2.0.9",
+    "ember-source": "^6.10.0",
+    "prettier": "^3.7.4",
+    "prettier-plugin-ember-template-tag": "^2.1.2",
+    "release-plan": "^0.17.4"
+  },
   "engines": {
     "node": ">= 24"
+  },
+  "scripts": {
+    "format": "prettier . --write",
+    "lint:format": "prettier . --check",
+    "new": "node ./src/cli/index.js"
   }
 }

package/src/cli/generator.js

@@ -0,0 +1,19 @@
+import { mkdir } from "node:fs/promises";
+
+/**
+ * Generate project files by running layer functions
+ */
+export async function generateProject(projectPath, projectName, layers) {
+  // Create project directory
+  await mkdir(projectPath, { recursive: true });
+
+  // Run each layer's run function in sequence
+  for (const layer of layers) {
+    if (typeof layer.run === "function") {
+      await layer.run({
+        targetDir: projectPath,
+        projectName,
+      });
+    }
+  }
+}

package/src/cli/index.js

@@ -0,0 +1,48 @@
+#!/usr/bin/env node
+
+import * as p from "@clack/prompts";
+import { join } from "node:path";
+import pc from "picocolors";
+import { generateProject } from "./generator.js";
+import { askName } from './questions/name.js';
+import { askLayers } from './questions/layers.js';
+import { askPackageManager } from './questions/package-manager.js';
+
+async function main() {
+  console.clear();
+
+  p.intro(pc.bgCyan(pc.black(" ember.nvp ")));
+
+  const projectName = await askName();
+  const selectedLayers = await askLayers();
+  const packageManager = await askPackageManager();
+
+  const s = p.spinner();
+  s.start("Creating your Ember app...");
+
+  try {
+    // Generate the project
+    const projectPath = join(process.cwd(), projectName);
+    await generateProject(projectPath, projectName, selectedLayers);
+
+    s.stop("Project created!");
+
+    p.note(
+      `cd ${projectName}\n` +
+      `${packageManager} install\n` +
+      `${packageManager} ${packageManager === "npm" ? "run " : ""}start`,
+      "Next steps",
+    );
+
+    p.outro(pc.green("✓") + " Project ready! " + pc.dim("Happy coding!"));
+  } catch (err) {
+    s.stop("Failed to create project");
+    p.cancel(`Error: ${err.message}`);
+    throw err;
+  }
+}
+
+main().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});

package/src/cli/questions/layers.js

@@ -0,0 +1,75 @@
+import { readdir } from "node:fs/promises";
+import { join } from "node:path";
+
+import * as p from "@clack/prompts";
+
+export async function askLayers() {
+
+  // Discover available layers
+  const layers = await discoverLayers();
+
+  // Separate minimal from other layers
+  const minimalLayer = layers.find((l) => l.name === "minimal");
+  const optionalLayers = layers.filter((l) => l.name !== "minimal");
+
+  p.note(
+    `${pc.cyan("minimal")} layer is always included.\n` +
+    'It provides: type: "module", no compat, no testing, no linting.\n' +
+    "Perfect for demos and reproductions.",
+    "Base Layer",
+  );
+
+  // Let user select additional features
+  const selectedFeatures = await p.multiselect({
+    message: "Select additional features:",
+    options: optionalLayers.map((layer) => ({
+      value: layer.name,
+      label: layer.label || layer.name,
+      hint: layer.description,
+    })),
+    required: false,
+  });
+
+  if (p.isCancel(selectedFeatures)) {
+    p.cancel("Operation cancelled");
+    return process.exit(0);
+  }
+
+  // Build the final configuration
+  const selectedLayers = [
+    minimalLayer,
+    ...optionalLayers.filter((l) => selectedFeatures.includes(l.name)),
+  ].filter(Boolean);
+
+  return selectedLayers;
+
+}
+
+async function discoverLayers() {
+  const layersDir = join(import.meta.dirname, '..', "..", "layers");
+  const entries = await readdir(layersDir, { withFileTypes: true });
+
+  const layers = [];
+
+  for (const entry of entries) {
+    if (entry.isDirectory()) {
+      const layerPath = join(layersDir, entry.name, "index.js");
+      try {
+        const layer = await import(layerPath);
+        layers.push({
+          name: entry.name,
+          ...layer.default,
+        });
+      } catch (err) {
+        // Skip layers that don't have proper exports
+        console.warn(
+          `Warning: Could not load layer ${entry.name}:`,
+          err.message,
+        );
+      }
+    }
+  }
+
+  return layers;
+}
+

package/src/cli/questions/name.js

@@ -0,0 +1,22 @@
+import * as p from "@clack/prompts";
+
+export async function askName() {
+  const projectName = await p.text({
+    message: "What is your project name?",
+    placeholder: "my-app",
+    defaultValue: 'my-app',
+    validate(value) {
+      if (value.length === 0) return "Project name is required";
+      if (!/^[a-z0-9-]+$/.test(value)) {
+        return "Project name must be lowercase and can only contain letters, numbers, and hyphens";
+      }
+    },
+  });
+
+  if (p.isCancel(projectName)) {
+    p.cancel("Operation cancelled");
+    return process.exit(0);
+  }
+
+  return projectName;
+}

package/src/cli/questions/package-manager.js

@@ -0,0 +1,21 @@
+import * as p from "@clack/prompts";
+
+export async function askPackageManager() {
+
+  const packageManager = await p.select({
+    message: "Which package manager?",
+    options: [
+      { value: "pnpm", label: "pnpm", hint: "Fast, disk space efficient" },
+      { value: "npm", label: "npm", hint: "Node default" },
+      { value: "yarn", label: "yarn", hint: "Classic alternative" },
+    ],
+  });
+
+  if (p.isCancel(packageManager)) {
+    p.cancel("Operation cancelled");
+    return process.exit(0);
+  }
+
+  return packageManager;
+}
+

package/src/layers/eslint/files/eslint.config.mjs

@@ -0,0 +1,37 @@
+import globals from "globals";
+import js from "@eslint/js";
+import ts from "typescript-eslint";
+import ember from "eslint-plugin-ember";
+import prettier from "eslint-config-prettier";
+
+export default [
+  js.configs.recommended,
+  ...ts.configs.recommended,
+  ...ember.configs["flat/recommended"],
+  prettier,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.browser,
+      },
+      parserOptions: {
+        ecmaVersion: "latest",
+        sourceType: "module",
+      },
+    },
+  },
+  {
+    files: ["**/*.gts", "**/*.gjs"],
+    languageOptions: {
+      parser: ts.parser,
+      parserOptions: {
+        ecmaVersion: "latest",
+        sourceType: "module",
+        extraFileExtensions: [".gts", ".gjs"],
+      },
+    },
+  },
+  {
+    ignores: ["dist/", "node_modules/", ".vite/"],
+  },
+];