Merge pull request #52 from bertdeblock/remove-use-of-the-word-document

Remove use of the words document, documents, ...

Author: bertdeblock

.prettierignore

@@ -1,6 +1,6 @@
 /coverage/
 /dist/
-/documents/*.md
+/templates/
 /test/output/
 /CHANGELOG.md
 /pnpm-lock.yaml

README.md

@@ -161,9 +161,9 @@ export type Config = {
   hooks?: {
     // A hook that will be executed post running a generator:
     postGenerate?: (info: {
-      documentName: DocumentName;
       entityName: string;
       files: File[];
+      generatorName: GeneratorName;
     }) => Promise<void> | void;
   };
 

package.json

@@ -12,7 +12,7 @@
   "files": [
     "bin/",
     "dist/",
-    "documents/",
+    "templates/",
     "CHANGELOG.md"
   ],
   "scripts": {

src/cli.ts

@@ -9,7 +9,7 @@ import {
   generateModifier,
   generateService,
 } from "./generators.js";
-import type { DocumentName } from "./types.js";
+import type { GeneratorName } from "./types.js";
 
 yargs(hideBin(process.argv))
   .command({
@@ -180,11 +180,11 @@ yargs(hideBin(process.argv))
 type Options = Record<string, unknown>;
 
 async function applyGemberConfig(
-  documentName: DocumentName,
+  generatorName: GeneratorName,
   options: Options,
 ): Promise<Options> {
   const config = await resolveConfig(cwd());
-  const generatorConfig: Options = config.generators?.[documentName] ?? {};
+  const generatorConfig: Options = config.generators?.[generatorName] ?? {};
   const result: Options = { typescript: config.typescript };
 
   for (const key in options) {

src/config.ts

@@ -1,7 +1,7 @@
 import { findUp } from "find-up";
 import { pathToFileURL } from "node:url";
 import { GemberError } from "./errors.js";
-import type { DocumentName, File } from "./types.js";
+import type { GeneratorName, File } from "./types.js";
 
 export type Config = {
   generators?: {
@@ -28,9 +28,13 @@ export type Config = {
 
   hooks?: {
     postGenerate?: (info: {
-      documentName: DocumentName;
+      /**
+       * @deprecated Please use `generatorName` instead.
+       */
+      documentName: GeneratorName;
       entityName: string;
       files: File[];
+      generatorName: GeneratorName;
     }) => Promise<void> | void;
   };
 

src/generate.ts

@@ -9,10 +9,10 @@ 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 { DocumentName } from "./types.js";
+import type { GeneratorName } from "./types.js";
 
 export async function generate(
-  documentName: DocumentName,
+  generatorName: GeneratorName,
   entityName: string,
   packagePath: string,
   {
@@ -26,23 +26,23 @@ export async function generate(
   },
 ): Promise<void> {
   const scaffdog = await loadScaffdog(
-    join(dirname(fileURLToPath(import.meta.url)), "../documents"),
+    join(dirname(fileURLToPath(import.meta.url)), "../templates"),
   );
 
-  const documents = await scaffdog.list();
-  const document = documents.find((document) => document.name === documentName);
+  const templates = await scaffdog.list();
+  const template = templates.find((t) => t.name === generatorName);
 
-  if (document === undefined) {
-    throw new GemberError(`[BUG] Document \`${documentName}\` not found.`);
+  if (template === undefined) {
+    throw new GemberError(`[BUG] Template \`${generatorName}\` not found.`);
   }
 
   const generatePath = await resolveGeneratePath(
-    documentName,
+    generatorName,
     packagePath,
     path,
   );
 
-  const files = await scaffdog.generate(document, generatePath, {
+  const files = await scaffdog.generate(template, generatePath, {
     inputs: {
       ...inputs,
       name: {
@@ -64,24 +64,32 @@ export async function generate(
     await writeFile(file.path, file.content);
 
     consola.success(
-      `🫚 Generated ${documentName} \`${entityName}\` at \`${relative(cwd(), file.path)}\`.`,
+      `🫚 Generated ${generatorName} \`${entityName}\` at \`${relative(cwd(), file.path)}\`.`,
     );
   }
 
   const config = await resolveConfig(packagePath);
 
   await config.hooks?.postGenerate?.({
-    documentName,
+    get documentName() {
+      consola.warn(
+        "🫚 `documentName` is deprecated. Please use `generatorName` instead.",
+      );
+
+      return generatorName;
+    },
+
     entityName,
     files: filesToGenerate.map((file) => ({
       content: file.content,
       name: file.name,
       path: file.path,
     })),
+    generatorName,
   });
 }
 
-const DOCUMENT_DIR: Record<DocumentName, string> = {
+const TARGET_DIR: Record<GeneratorName, string> = {
   component: "components",
   helper: "helpers",
   modifier: "modifiers",
@@ -95,7 +103,7 @@ const SRC_DIR: Record<string, string> = {
 };
 
 export async function resolveGeneratePath(
-  documentName: DocumentName,
+  generatorName: GeneratorName,
   packagePath: string,
   path?: string,
 ): Promise<string> {
@@ -114,5 +122,5 @@ export async function resolveGeneratePath(
       ? SRC_DIR.V1_ADDON
       : SRC_DIR.APP;
 
-  return join(packagePath, srcDir, DOCUMENT_DIR[documentName]);
+  return join(packagePath, srcDir, TARGET_DIR[generatorName]);
 }

src/types.ts

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