Support v1 apps and addons

package.json

@@ -49,6 +49,7 @@
     "prettier": "^3.2.5",
     "recursive-copy": "^2.0.14",
     "release-plan": "^0.8.0",
+    "type-fest": "^4.13.1",
     "typescript": "^5.3.3",
     "uuid": "^9.0.1",
     "vitest": "^1.2.2"

src/generate-document.ts

@@ -1,11 +1,12 @@
 import chalk from "chalk";
 import { camelCase, kebabCase, pascalCase } from "change-case";
-import { ensureDir } from "fs-extra";
+import { ensureDir, readJson } from "fs-extra/esm";
 import { writeFile } from "node:fs/promises";
 import { dirname, isAbsolute, join, parse, relative } from "node:path";
 import { cwd as processCwd } from "node:process";
 import { fileURLToPath } from "node:url";
 import { type GenerateInputs, loadScaffdog } from "scaffdog";
+import { isAddon, isV2Addon } from "./helpers.js";
 import { type DocumentName } from "./types.js";
 
 export async function generateDocument(
@@ -30,7 +31,7 @@ export async function generateDocument(
     throw new Error(`[BUG] Document \`${documentName}\` not found.`);
   }
 
-  const documentPath = getDocumentPath(documentName, cwd, path);
+  const documentPath = await getDocumentPath(documentName, cwd, path);
   const files = await scaffdog.generate(document, documentPath, {
     inputs: {
       ...inputs,
@@ -67,11 +68,11 @@ const DOCUMENT_DIRECTORY: Record<DocumentName, string> = {
   service: "services",
 };
 
-function getDocumentPath(
+export async function getDocumentPath(
   documentName: DocumentName,
   cwd: string,
-  path: string,
-): string {
+  path?: string,
+): Promise<string> {
   if (path) {
     if (isAbsolute(path)) {
       return path;
@@ -80,5 +81,12 @@ function getDocumentPath(
     }
   }
 
-  return join(cwd, "src", DOCUMENT_DIRECTORY[documentName]);
+  const packageJson = await readJson(join(cwd, "package.json"));
+  const srcDirectory = isAddon(packageJson)
+    ? isV2Addon(packageJson)
+      ? "src" // v2 addon
+      : "addon" // v1 addon
+    : "app"; // v1 app
+
+  return join(cwd, srcDirectory, DOCUMENT_DIRECTORY[documentName]);
 }

src/helpers.ts

@@ -0,0 +1,13 @@
+import { type EmberPackageJson } from "./types.js";
+
+export function isAddon(packageJson: EmberPackageJson): boolean {
+  if (Array.isArray(packageJson.keywords)) {
+    return packageJson.keywords.includes("ember-addon");
+  }
+
+  return false;
+}
+
+export function isV2Addon(packageJson: EmberPackageJson): boolean {
+  return packageJson["ember-addon"]?.version === 2;
+}

src/types.ts

@@ -1 +1,13 @@
+// eslint-disable-next-line n/no-missing-import
+import { type PackageJson } from "type-fest";
+
 export type DocumentName = "component" | "helper" | "modifier" | "service";
+
+export type EmberPackageJson = PackageJson & {
+  ember?: {
+    edition?: string;
+  };
+  "ember-addon"?: {
+    version?: number;
+  };
+};

test/blueprints/v1-addon/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "v1-addon",
+  "keywords": [
+    "ember-addon"
+  ],
+  "ember": {},
+  "ember-addon": {}
+}

test/blueprints/v1-app/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "v1-app",
+  "ember": {},
+  "ember-addon": {}
+}

test/blueprints/v2-addon/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "v2-addon",
+  "keywords": [
+    "ember-addon"
+  ],
+  "ember": {},
+  "ember-addon": {
+    "version": 2
+  }
+}

test/generate-component.test.ts

@@ -1,4 +1,4 @@
-import fsExtra from "fs-extra";
+import { remove } from "fs-extra";
 import { readFile } from "node:fs/promises";
 import { join } from "node:path";
 import { afterEach, it } from "vitest";
@@ -7,7 +7,7 @@ import { copyBlueprint } from "./helpers.ts";
 
 let cwd: string;
 
-afterEach(() => fsExtra.remove(cwd));
+afterEach(() => remove(cwd));
 
 it("generates a template-only `.gjs` component", async (ctx) => {
   cwd = await copyBlueprint("v2-addon");

test/generate-document.test.ts

@@ -0,0 +1,24 @@
+import { it } from "vitest";
+import { getDocumentPath } from "../src/generate-document.ts";
+import { blueprintPath } from "./helpers.ts";
+
+it("supports v1 apps", async (ctx) => {
+  const cwd = blueprintPath("v1-app");
+  const documentPath = await getDocumentPath("component", cwd);
+
+  ctx.expect(documentPath).toEqual("test/blueprints/v1-app/app/components");
+});
+
+it("supports v1 addons", async (ctx) => {
+  const cwd = blueprintPath("v1-addon");
+  const documentPath = await getDocumentPath("component", cwd);
+
+  ctx.expect(documentPath).toEqual("test/blueprints/v1-addon/addon/components");
+});
+
+it("supports v2 addons", async (ctx) => {
+  const cwd = blueprintPath("v2-addon");
+  const documentPath = await getDocumentPath("component", cwd);
+
+  ctx.expect(documentPath).toEqual("test/blueprints/v2-addon/src/components");
+});

test/generate-helper.test.ts

@@ -1,4 +1,4 @@
-import fsExtra from "fs-extra";
+import { remove } from "fs-extra";
 import { readFile } from "node:fs/promises";
 import { join } from "node:path";
 import { afterEach, it } from "vitest";
@@ -7,7 +7,7 @@ import { copyBlueprint } from "./helpers.ts";
 
 let cwd: string;
 
-afterEach(() => fsExtra.remove(cwd));
+afterEach(() => remove(cwd));
 
 it("generates a function-based `.js` helper", async (ctx) => {
   cwd = await copyBlueprint("v2-addon");

test/generate-modifier.test.ts

@@ -1,4 +1,4 @@
-import fsExtra from "fs-extra";
+import { remove } from "fs-extra";
 import { readFile } from "node:fs/promises";
 import { join } from "node:path";
 import { afterEach, it } from "vitest";
@@ -7,7 +7,7 @@ import { copyBlueprint } from "./helpers.ts";
 
 let cwd: string;
 
-afterEach(() => fsExtra.remove(cwd));
+afterEach(() => remove(cwd));
 
 it("generates a function-based `.js` modifier", async (ctx) => {
   cwd = await copyBlueprint("v2-addon");

test/generate-service.test.ts

@@ -1,4 +1,4 @@
-import fsExtra from "fs-extra";
+import { remove } from "fs-extra";
 import { readFile } from "node:fs/promises";
 import { join } from "node:path";
 import { afterEach, it } from "vitest";
@@ -7,7 +7,7 @@ import { copyBlueprint } from "./helpers.ts";
 
 let cwd: string;
 
-afterEach(() => fsExtra.remove(cwd));
+afterEach(() => remove(cwd));
 
 it("generates a `.js` service", async (ctx) => {
   cwd = await copyBlueprint("v2-addon");

test/helpers.ts

@@ -2,10 +2,16 @@ import { join } from "node:path";
 import recursiveCopy from "recursive-copy";
 import { v4 as uuidv4 } from "uuid";
 
-export async function copyBlueprint(name: "v2-addon") {
+type Blueprint = "v1-app" | "v1-addon" | "v2-addon";
+
+export function blueprintPath(name: Blueprint) {
+  return join("test/blueprints", name);
+}
+
+export async function copyBlueprint(name: Blueprint) {
   const cwd = join("test/output", uuidv4());
 
-  await recursiveCopy(join("test/blueprints", name), cwd);
+  await recursiveCopy(blueprintPath(name), cwd);
 
   return cwd;
 }