@tsparticles/cli-create-utils 4.0.0-beta.12 → 4.0.0-beta.16

package/src/file-utils.ts

@@ -4,6 +4,8 @@ import { existsSync } from "node:fs";
 import { lookpath } from "lookpath";
 import path from "node:path";
 
+const jsonIndentation = 2;
+
 export interface ReplaceTokensOptions {
   path: string;
   tokens: ReplaceTokensData[];
@@ -14,6 +16,8 @@ export interface ReplaceTokensData {
   to: string;
 }
 
+export type JsonUpdater<T> = (data: T) => T;
+
 /**
  *
  * @param options -
@@ -42,6 +46,18 @@ export async function replaceTokensInFile(options: ReplaceTokensOptions): Promis
   await replaceTokensInFiles([options]);
 }
 
+/**
+ * Updates a JSON file preserving standard indentation.
+ * @param filePath - The JSON file path
+ * @param updater - The updater callback
+ */
+export async function updateJsonFile<T>(filePath: string, updater: JsonUpdater<T>): Promise<void> {
+  const data = JSON.parse(await readFile(filePath, "utf-8")) as T,
+    updatedData = updater(data);
+
+  await writeFile(filePath, `${JSON.stringify(updatedData, undefined, jsonIndentation)}\n`);
+}
+
 /**
  *
  * @param destination -
@@ -73,15 +89,14 @@ export async function getRepositoryUrl(): Promise<string> {
     return "";
   }
 
-  return new Promise<string>((resolve, reject) => {
+  return new Promise<string>(resolve => {
     exec("git config --get remote.origin.url", (error, stdout) => {
       if (error) {
-        reject(error);
-
+        resolve("");
         return;
       }
 
-      resolve(stdout);
+      resolve(stdout.trim());
     });
   });
 }

package/src/index.ts

@@ -1,3 +1,5 @@
+export * from "./create-project.js";
 export * from "./file-utils.js";
+export * from "./prompt-utils.js";
 export * from "./string-utils.js";
 export * from "./template-utils.js";

package/src/prompt-utils.ts

@@ -0,0 +1,89 @@
+import { getDestinationDir, getRepositoryUrl } from "./file-utils.js";
+import prompts, { type PromptObject } from "prompts";
+import { capitalize } from "./string-utils.js";
+import path from "node:path";
+
+export interface ISelectChoice<T extends string> {
+  title: string;
+  value: T;
+}
+
+export interface IProjectPromptOptions<T extends string = string> {
+  destination: string;
+  nameLabel: string;
+  select?: {
+    choices: ISelectChoice<T>[];
+    initial: T;
+    message: string;
+    name: string;
+  };
+}
+
+export interface IProjectPromptResult<T extends string = string> {
+  description: string;
+  destinationPath: string;
+  name: string;
+  repositoryUrl: string;
+  type: T | undefined;
+}
+
+/**
+ * Prompts for common project creation data.
+ * @param options - Prompt options
+ * @returns Prompt result with normalized values
+ */
+export async function promptProjectData<T extends string = string>(
+  options: IProjectPromptOptions<T>,
+): Promise<IProjectPromptResult<T>> {
+  const destinationPath = await getDestinationDir(options.destination),
+    repositoryUrl = await getRepositoryUrl(),
+    initialName = destinationPath.split(path.sep).pop() ?? "",
+    questions: PromptObject[] = [
+      {
+        type: "text",
+        name: "name",
+        message: `What is the name of the ${options.nameLabel}?`,
+        validate: (value: string) => (value ? true : "The name can't be empty"),
+        initial: initialName,
+      },
+      {
+        type: "text",
+        name: "description",
+        message: `What is the description of the ${options.nameLabel}?`,
+        validate: (value: string) => (value ? true : "The description can't be empty"),
+        initial: capitalize(initialName),
+      },
+      {
+        initial: repositoryUrl,
+        message: "What is the repository URL? (optional)",
+        name: "repositoryUrl",
+        type: "text",
+      },
+    ];
+
+  if (options.select) {
+    questions.push({
+      type: "select",
+      name: options.select.name,
+      message: options.select.message,
+      choices: options.select.choices,
+      initial: options.select.choices.findIndex(t => t.value === options.select?.initial),
+    });
+  }
+
+  const answers = (await prompts(questions)) as {
+      [key: string]: unknown;
+      description: string;
+      name: string;
+      repositoryUrl: string;
+    },
+    type = options.select ? (answers[options.select.name] as T | undefined) : undefined;
+
+  return {
+    description: answers.description.trim(),
+    destinationPath,
+    name: answers.name.trim(),
+    repositoryUrl: answers.repositoryUrl.trim(),
+    type,
+  };
+}

package/src/template-utils.ts

@@ -1,50 +1,52 @@
-import { cp } from "node:fs/promises";
-import { exec } from "node:child_process";
+import * as childProcess from "node:child_process";
+import * as fsPromises from "node:fs/promises";
+import { replaceTokensInFile, updateJsonFile } from "./file-utils.js";
 import { lookpath } from "lookpath";
 import path from "node:path";
-import { replaceTokensInFile } from "./file-utils.js";
+
+export interface IProjectMetadata {
+  description: string;
+  directory: string;
+  packageName: string;
+  repoUrl: string;
+  unpkgFileName: string;
+}
 
 /**
  * Updates the package.json file
  * @param destPath - The path where the package.json file is located
- * @param packageName - The name of the package
- * @param description - The description of the package
- * @param fileName - The name of the output file
- * @param repoUrl - The repository URL
+ * @param metadata - The project metadata used for updates
  */
-export async function updatePackageFile(
-  destPath: string,
-  packageName: string,
-  description: string,
-  fileName: string,
-  repoUrl: string,
-): Promise<void> {
+export async function updatePackageFile(destPath: string, metadata: IProjectMetadata): Promise<void> {
+  await updateJsonFile<Record<string, unknown>>(path.join(destPath, "package.json"), data => {
+    const publishConfig = (data["publishConfig"] ?? {}) as Record<string, unknown>;
+
+    return {
+      ...data,
+      name: metadata.packageName,
+      description: metadata.description,
+      repository: {
+        type: "git",
+        url: `git+${metadata.repoUrl}`,
+        directory: metadata.directory,
+      },
+      bugs: {
+        url: metadata.repoUrl.replace(/\.git$/, "/issues"),
+      },
+      publishConfig: {
+        ...publishConfig,
+        access: "public",
+      },
+      private: undefined,
+    };
+  });
+
   await replaceTokensInFile({
     path: path.join(destPath, "package.json"),
     tokens: [
-      {
-        from: /"tsParticles empty template"/g,
-        to: `"${description}"`,
-      },
       {
         from: /"tsparticles.empty.template.min.js"/g,
-        to: `"${fileName}"`,
-      },
-      {
-        from: /\s{4}"private": true,\r?\n?/g,
-        to: "",
-      },
-      {
-        from: /"@tsparticles\/empty-template"/g,
-        to: `"${packageName}"`,
-      },
-      {
-        from: /"url": "git\+https:\/\/github\.com\/tsparticles\/empty-template\.git"/g,
-        to: `"url": "git+${repoUrl}"`,
-      },
-      {
-        from: /"url": "https:\/\/github\.com\/tsparticles\/empty-template\/issues"/g,
-        to: `"url": "${repoUrl.replace(".git", "/issues")}"`,
+        to: `"${metadata.unpkgFileName}"`,
       },
     ],
   });
@@ -53,76 +55,38 @@ export async function updatePackageFile(
 /**
  * Updates the package.dist.json file with the new project name and description
  * @param destPath - The path where the package.dist.json file is located
- * @param packageName - The name of the package
- * @param description - The description of the package
- * @param fileName - The name of the output file
- * @param repoUrl - The url of the repository
+ * @param metadata - The project metadata used for updates
  */
-export async function updatePackageDistFile(
-  destPath: string,
-  packageName: string,
-  description: string,
-  fileName: string,
-  repoUrl: string,
-): Promise<void> {
-  await replaceTokensInFile({
-    path: path.join(destPath, "package.dist.json"),
-    tokens: [
-      {
-        from: /"tsParticles empty template"/g,
-        to: `"${description}"`,
-      },
-      {
-        from: /"tsparticles.empty.template.min.js"/g,
-        to: `"${fileName}"`,
-      },
-      {
-        from: /\s{4}"private": true,\r?\n?/g,
-        to: "",
-      },
-      {
-        from: /"@tsparticles\/empty-template"/g,
-        to: `"${packageName}"`,
-      },
-      {
-        from: /"url": "git\+https:\/\/github\.com\/tsparticles\/empty-template\.git"/g,
-        to: `"url": "git+${repoUrl}"`,
-      },
-      {
-        from: /"url": "https:\/\/github\.com\/tsparticles\/empty-template\/issues"/g,
-        to: `"url": "${repoUrl.replace(".git", "/issues")}"`,
-      },
-    ],
+export async function updatePackageDistFile(destPath: string, metadata: IProjectMetadata): Promise<void> {
+  await updateJsonFile<Record<string, unknown>>(path.join(destPath, "package.dist.json"), data => {
+    const publishConfig = (data["publishConfig"] ?? {}) as Record<string, unknown>;
+
+    return {
+      ...data,
+      name: metadata.packageName,
+      description: metadata.description,
+      repository: {
+        type: "git",
+        url: `git+${metadata.repoUrl}`,
+        directory: metadata.directory,
+      },
+      bugs: {
+        url: metadata.repoUrl.replace(/\.git$/, "/issues"),
+      },
+      publishConfig: {
+        ...publishConfig,
+        access: "public",
+      },
+      private: undefined,
+    };
   });
-}
 
-/**
- * Updates the webpack file with the new project name and description
- * @param destPath - The path where the project will be created
- * @param name - The name of the project
- * @param description - The description of the project
- * @param fnName - The name of the function to load the template
- */
-export async function updateWebpackFile(
-  destPath: string,
-  name: string,
-  description: string,
-  fnName: string,
-): Promise<void> {
   await replaceTokensInFile({
-    path: path.join(destPath, "webpack.config.js"),
+    path: path.join(destPath, "package.dist.json"),
     tokens: [
       {
-        from: /"Empty"/g,
-        to: `"${description}"`,
-      },
-      {
-        from: /"empty"/g,
-        to: `"${name}"`,
-      },
-      {
-        from: /loadParticlesTemplate/g,
-        to: fnName,
+        from: /"tsparticles.empty.template.min.js"/g,
+        to: `"${metadata.unpkgFileName}"`,
       },
     ],
   });
@@ -133,7 +97,7 @@ export async function updateWebpackFile(
  * @param destPath - The path where the project will be created
  */
 export async function copyEmptyTemplateFiles(destPath: string): Promise<void> {
-  await cp(path.join(__dirname, "..", "files", "empty-project"), destPath, {
+  await fsPromises.cp(path.join(__dirname, "..", "files", "empty-project"), destPath, {
     recursive: true,
     force: true,
     filter: copyFilter,
@@ -159,7 +123,7 @@ export async function runInstall(destPath: string): Promise<void> {
   }
 
   return new Promise((resolve, reject) => {
-    exec(
+    childProcess.exec(
       "npm install",
       {
         cwd: destPath,
@@ -187,7 +151,7 @@ export async function runBuild(destPath: string): Promise<void> {
   }
 
   return new Promise((resolve, reject) => {
-    exec(
+    childProcess.exec(
       "npm run build",
       {
         cwd: destPath,

package/.cache/eslint/.eslintcache

@@ -1 +0,0 @@
-[{"/Users/matteo/Projects/GitHub/tsparticles/tsparticles/cli/commands/create-utils/src/file-utils.ts":"1","/Users/matteo/Projects/GitHub/tsparticles/tsparticles/cli/commands/create-utils/src/index.ts":"2","/Users/matteo/Projects/GitHub/tsparticles/tsparticles/cli/commands/create-utils/src/string-utils.ts":"3","/Users/matteo/Projects/GitHub/tsparticles/tsparticles/cli/commands/create-utils/src/template-utils.ts":"4"},{"size":2011,"mtime":1777824895206,"results":"5","hashOfConfig":"6"},{"size":105,"mtime":1777824895206,"results":"7","hashOfConfig":"6"},{"size":1382,"mtime":1777824895206,"results":"8","hashOfConfig":"6"},{"size":5115,"mtime":1777824895207,"results":"9","hashOfConfig":"6"},{"filePath":"10","messages":"11","suppressedMessages":"12","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"1n6spun",{"filePath":"13","messages":"14","suppressedMessages":"15","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"16","messages":"17","suppressedMessages":"18","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"19","messages":"20","suppressedMessages":"21","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"/Users/matteo/Projects/GitHub/tsparticles/tsparticles/cli/commands/create-utils/src/file-utils.ts",[],[],"/Users/matteo/Projects/GitHub/tsparticles/tsparticles/cli/commands/create-utils/src/index.ts",[],[],"/Users/matteo/Projects/GitHub/tsparticles/tsparticles/cli/commands/create-utils/src/string-utils.ts",[],[],"/Users/matteo/Projects/GitHub/tsparticles/tsparticles/cli/commands/create-utils/src/template-utils.ts",[],[]]