Remove use of scaffdog (improves performance)

README.md

@@ -5,8 +5,6 @@
 
 Generate components, helpers, modifiers and services in v1/v2 apps/addons.
 
-Uses [scaffdog](https://scaff.dog/) underneath.
-
 > NOTE: Only supports `.gjs` (default) and `.gts` files for components.
 
 ## Installation
@@ -162,7 +160,7 @@ export type Config = {
     // A hook that will be executed post running a generator:
     postGenerate?: (info: {
       entityName: string;
-      files: File[];
+      files: GeneratorFile[];
       generatorName: GeneratorName;
     }) => Promise<void> | void;
   };

eslint.config.js

@@ -6,7 +6,16 @@ export default typescriptEslint.config(
   eslint.configs.recommended,
   typescriptEslint.configs.recommended,
   eslintPluginNode.configs["flat/recommended-module"],
-  { ignores: ["bin", "coverage", "dist", "test/output", "test/packages"] },
+  {
+    ignores: [
+      "bin",
+      "coverage",
+      "dist",
+      "templates",
+      "test/output",
+      "test/packages",
+    ],
+  },
   {
     files: ["**/*.ts"],
     rules: {

package.json

@@ -34,7 +34,7 @@
     "consola": "^3.3.3",
     "find-up": "^7.0.0",
     "fs-extra": "^11.2.0",
-    "scaffdog": "^4.1.0",
+    "handlebars": "^4.7.8",
     "yargs": "^17.7.2"
   },
   "devDependencies": {

src/config.ts

@@ -1,7 +1,7 @@
 import { findUp } from "find-up";
 import { pathToFileURL } from "node:url";
 import { GemberError } from "./errors.js";
-import type { GeneratorName, File } from "./types.js";
+import type { GeneratorFile, GeneratorName } from "./types.js";
 
 export type Config = {
   generators?: {
@@ -33,7 +33,7 @@ export type Config = {
        */
       documentName: GeneratorName;
       entityName: string;
-      files: File[];
+      files: GeneratorFile[];
       generatorName: GeneratorName;
     }) => Promise<void> | void;
   };

src/generate.ts

@@ -1,126 +1,131 @@
-import { camelCase, kebabCase, pascalCase } from "change-case";
+import { camelCase, pascalCase } from "change-case";
 import { consola } from "consola";
 import { ensureDir, readJson } from "fs-extra/esm";
-import { writeFile } from "node:fs/promises";
+import Handlebars from "handlebars";
+import { readFile, writeFile } from "node:fs/promises";
 import { dirname, isAbsolute, join, parse, relative } from "node:path";
 import { cwd } from "node:process";
 import { fileURLToPath } from "node:url";
-import { type GenerateInputs, loadScaffdog } from "scaffdog";
 import { resolveConfig } from "./config.js";
-import { GemberError } from "./errors.js";
 import { isV1Addon, isV2Addon, pathCase } from "./helpers.js";
-import type { GeneratorName } from "./types.js";
-
-export async function generate(
-  generatorName: GeneratorName,
-  entityName: string,
-  packagePath: string,
-  {
-    inputs,
-    nested = false,
-    path,
-  }: {
-    inputs?: GenerateInputs;
-    nested?: boolean;
-    path?: string;
-  },
-): Promise<void> {
-  const scaffdog = await loadScaffdog(
-    join(dirname(fileURLToPath(import.meta.url)), "../templates"),
+import type {
+  EmberPackageJson,
+  GeneratorFile,
+  GeneratorName,
+} from "./types.js";
+
+export async function generate({
+  customTargetPath,
+  entityName,
+  generatorName,
+  nested = false,
+  packagePath,
+  targetDir,
+  templateFilename,
+}: {
+  customTargetPath?: string;
+  entityName: string;
+  generatorName: GeneratorName;
+  nested?: boolean;
+  packagePath: string;
+  targetDir: string;
+  templateFilename: string;
+}): Promise<void> {
+  const templatePath = join(
+    dirname(fileURLToPath(import.meta.url)),
+    "../templates",
+    generatorName,
+    templateFilename,
   );
 
-  const templates = await scaffdog.list();
-  const template = templates.find((t) => t.name === generatorName);
-
-  if (template === undefined) {
-    throw new GemberError(`[BUG] Template \`${generatorName}\` not found.`);
-  }
+  const templateContent = await readFile(templatePath, "utf-8");
+  const template = Handlebars.compile(templateContent);
 
-  const generatePath = await resolveGeneratePath(
-    generatorName,
+  const packageJson = await readJson(join(packagePath, "package.json"));
+  const filePath = await generateFilePath(
+    packageJson,
     packagePath,
-    path,
+    targetDir,
+    entityName + (nested ? "/index" : "") + parse(templateFilename).ext,
+    customTargetPath,
   );
 
-  const files = await scaffdog.generate(template, generatePath, {
-    inputs: {
-      ...inputs,
+  const fileParsed = parse(filePath);
+  const file: GeneratorFile = {
+    base: fileParsed.base,
+    content: template({
       name: {
         camel: camelCase(entityName),
-        kebab: kebabCase(entityName),
         pascal: pascalCase(entityName),
-        path: pathCase(entityName) + (nested ? "/index" : ""),
-        raw: entityName,
+        path: entityName,
         registryPath: pathCase(entityName),
+        signature: pascalCase(entityName) + "Signature",
       },
-      signature: pascalCase(entityName) + "Signature",
-    },
-  });
-
-  const filesToGenerate = files.filter((file) => file.skip === false);
-
-  for (const file of filesToGenerate) {
-    await ensureDir(parse(file.path).dir);
-    await writeFile(file.path, file.content);
-
-    consola.success(
-      `🫚 Generated ${generatorName} \`${entityName}\` at \`${relative(cwd(), file.path)}\`.`,
-    );
-  }
+      package: packageJson,
+    }),
+    dir: fileParsed.dir,
+    ext: fileParsed.ext,
+    name: fileParsed.name,
+    path: filePath,
+    root: fileParsed.root,
+  };
+
+  await ensureDir(file.dir);
+  await writeFile(file.path, file.content);
+
+  consola.success(
+    `🫚 Generated ${generatorName} \`${entityName}\` at \`${relative(cwd(), file.path)}\`.`,
+  );
 
   const config = await resolveConfig(packagePath);
+  const postGenerate = config.hooks?.postGenerate;
 
-  await config.hooks?.postGenerate?.({
-    get documentName() {
-      consola.warn(
-        "🫚 `documentName` is deprecated. Please use `generatorName` instead.",
-      );
+  if (postGenerate) {
+    consola.success("🫚 `hooks.postGenerate`: Running...");
 
-      return generatorName;
-    },
+    await postGenerate({
+      get documentName() {
+        consola.warn(
+          "🫚 `documentName` is deprecated. Please use `generatorName` instead.",
+        );
 
-    entityName,
-    files: filesToGenerate.map((file) => ({
-      content: file.content,
-      name: file.name,
-      path: file.path,
-    })),
-    generatorName,
-  });
-}
+        return generatorName;
+      },
+      entityName,
+      files: [file],
+      generatorName,
+    });
 
-const TARGET_DIR: Record<GeneratorName, string> = {
-  component: "components",
-  helper: "helpers",
-  modifier: "modifiers",
-  service: "services",
-};
+    consola.success("🫚 `hooks.postGenerate`: Done!");
+  }
+}
 
 const SRC_DIR: Record<string, string> = {
   APP: "app",
   V1_ADDON: "addon",
   V2_ADDON: "src",
 };
 
-export async function resolveGeneratePath(
-  generatorName: GeneratorName,
+export async function generateFilePath(
+  packageJson: EmberPackageJson,
   packagePath: string,
-  path?: string,
+  targetDir: string,
+  fileBase: string,
+  customTargetPath?: string,
 ): Promise<string> {
-  if (path) {
-    if (isAbsolute(path)) {
-      return path;
+  if (customTargetPath) {
+    if (isAbsolute(customTargetPath)) {
+      return join(customTargetPath, fileBase);
     } else {
-      return join(packagePath, path);
+      return join(packagePath, customTargetPath, fileBase);
     }
   }
 
-  const packageJson = await readJson(join(packagePath, "package.json"));
   const srcDir = isV2Addon(packageJson)
     ? SRC_DIR.V2_ADDON
     : isV1Addon(packageJson)
       ? SRC_DIR.V1_ADDON
       : SRC_DIR.APP;
 
-  return join(packagePath, srcDir, TARGET_DIR[generatorName]);
+  return join(packagePath, srcDir, targetDir, fileBase);
 }

src/generators.ts

@@ -15,10 +15,16 @@ export function generateComponent(
     typescript?: boolean;
   } = {},
 ): Promise<void> {
-  return generate("component", name, packagePath, {
-    inputs: { classBased, typescript },
+  return generate({
+    customTargetPath: path,
+    entityName: name,
+    generatorName: "component",
     nested,
-    path,
+    packagePath,
+    targetDir: "components",
+    templateFilename:
+      (classBased ? "class-based" : "template-only") +
+      (typescript ? ".gts" : ".gjs"),
   });
 }
 
@@ -35,9 +41,15 @@ export function generateHelper(
     typescript?: boolean;
   } = {},
 ): Promise<void> {
-  return generate("helper", name, packagePath, {
-    inputs: { classBased, typescript },
-    path,
+  return generate({
+    customTargetPath: path,
+    entityName: name,
+    generatorName: "helper",
+    packagePath,
+    targetDir: "helpers",
+    templateFilename:
+      (classBased ? "class-based" : "function-based") +
+      (typescript ? ".ts" : ".js"),
   });
 }
 
@@ -54,9 +66,15 @@ export function generateModifier(
     typescript?: boolean;
   } = {},
 ): Promise<void> {
-  return generate("modifier", name, packagePath, {
-    inputs: { classBased, typescript },
-    path,
+  return generate({
+    customTargetPath: path,
+    entityName: name,
+    generatorName: "modifier",
+    packagePath,
+    targetDir: "modifiers",
+    templateFilename:
+      (classBased ? "class-based" : "function-based") +
+      (typescript ? ".ts" : ".js"),
   });
 }
 
@@ -71,8 +89,12 @@ export function generateService(
     typescript?: boolean;
   } = {},
 ): Promise<void> {
-  return generate("service", name, packagePath, {
-    inputs: { typescript },
-    path,
+  return generate({
+    customTargetPath: path,
+    entityName: name,
+    generatorName: "service",
+    packagePath,
+    targetDir: "services",
+    templateFilename: typescript ? "service.ts" : "service.js",
   });
 }

src/types.ts

@@ -1,8 +1,6 @@
 // eslint-disable-next-line n/no-missing-import
 import type { PackageJson } from "type-fest";
 
-export type GeneratorName = "component" | "helper" | "modifier" | "service";
-
 export type EmberPackageJson = PackageJson & {
   ember?: {
     edition?: string;
@@ -12,8 +10,14 @@ export type EmberPackageJson = PackageJson & {
   };
 };
 
-export type File = {
+export type GeneratorFile = {
+  base: string;
   content: string;
+  dir: string;
+  ext: string;
   name: string;
   path: string;
+  root: string;
 };
+
+export type GeneratorName = "component" | "helper" | "modifier" | "service";