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

package/dist/file-utils.d.ts

@@ -6,6 +6,7 @@ export interface ReplaceTokensData {
     from: string | RegExp;
     to: string;
 }
+export type JsonUpdater<T> = (data: T) => T;
 /**
  *
  * @param options -
@@ -16,6 +17,12 @@ export declare function replaceTokensInFiles(options: ReplaceTokensOptions[]): P
  * @param options -
  */
 export declare function replaceTokensInFile(options: ReplaceTokensOptions): Promise<void>;
+/**
+ * Updates a JSON file preserving standard indentation.
+ * @param filePath - The JSON file path
+ * @param updater - The updater callback
+ */
+export declare function updateJsonFile<T>(filePath: string, updater: JsonUpdater<T>): Promise<void>;
 /**
  *
  * @param destination -

package/dist/file-utils.js

@@ -3,6 +3,7 @@ import { exec } from "node:child_process";
 import { existsSync } from "node:fs";
 import { lookpath } from "lookpath";
 import path from "node:path";
+const jsonIndentation = 2;
 /**
  *
  * @param options -
@@ -25,6 +26,15 @@ export async function replaceTokensInFiles(options) {
 export async function replaceTokensInFile(options) {
     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(filePath, updater) {
+    const data = JSON.parse(await readFile(filePath, "utf-8")), updatedData = updater(data);
+    await writeFile(filePath, `${JSON.stringify(updatedData, undefined, jsonIndentation)}\n`);
+}
 /**
  *
  * @param destination -
@@ -48,13 +58,13 @@ export async function getRepositoryUrl() {
     if (!(await lookpath("git"))) {
         return "";
     }
-    return new Promise((resolve, reject) => {
+    return new Promise(resolve => {
         exec("git config --get remote.origin.url", (error, stdout) => {
             if (error) {
-                reject(error);
+                resolve("");
                 return;
             }
-            resolve(stdout);
+            resolve(stdout.trim());
         });
     });
 }

package/dist/index.d.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/dist/index.js

@@ -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/dist/prompt-utils.d.ts

@@ -0,0 +1,27 @@
+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 declare function promptProjectData<T extends string = string>(options: IProjectPromptOptions<T>): Promise<IProjectPromptResult<T>>;

package/dist/prompt-utils.js

@@ -0,0 +1,50 @@
+import { getDestinationDir, getRepositoryUrl } from "./file-utils.js";
+import prompts from "prompts";
+import { capitalize } from "./string-utils.js";
+import path from "node:path";
+/**
+ * Prompts for common project creation data.
+ * @param options - Prompt options
+ * @returns Prompt result with normalized values
+ */
+export async function promptProjectData(options) {
+    const destinationPath = await getDestinationDir(options.destination), repositoryUrl = await getRepositoryUrl(), initialName = destinationPath.split(path.sep).pop() ?? "", questions = [
+        {
+            type: "text",
+            name: "name",
+            message: `What is the name of the ${options.nameLabel}?`,
+            validate: (value) => (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) => (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)), type = options.select ? answers[options.select.name] : undefined;
+    return {
+        description: answers.description.trim(),
+        destinationPath,
+        name: answers.name.trim(),
+        repositoryUrl: answers.repositoryUrl.trim(),
+        type,
+    };
+}

package/dist/template-utils.d.ts

@@ -1,29 +1,22 @@
+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 declare function updatePackageFile(destPath: string, packageName: string, description: string, fileName: string, repoUrl: string): Promise<void>;
+export declare function updatePackageFile(destPath: string, metadata: IProjectMetadata): Promise<void>;
 /**
  * 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 declare function updatePackageDistFile(destPath: string, packageName: string, description: string, fileName: string, repoUrl: string): Promise<void>;
-/**
- * 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 declare function updateWebpackFile(destPath: string, name: string, description: string, fnName: string): Promise<void>;
+export declare function updatePackageDistFile(destPath: string, metadata: IProjectMetadata): Promise<void>;
 /**
  * Copies the empty template files to the destination path
  * @param destPath - The path where the project will be created

package/dist/template-utils.js

@@ -1,43 +1,41 @@
-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";
 /**
  * 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, packageName, description, fileName, repoUrl) {
+export async function updatePackageFile(destPath, metadata) {
+    await updateJsonFile(path.join(destPath, "package.json"), data => {
+        const publishConfig = (data["publishConfig"] ?? {});
+        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}"`,
             },
         ],
     });
@@ -45,64 +43,36 @@ export async function updatePackageFile(destPath, packageName, description, file
 /**
  * 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, packageName, description, fileName, repoUrl) {
-    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}"`,
+export async function updatePackageDistFile(destPath, metadata) {
+    await updateJsonFile(path.join(destPath, "package.dist.json"), data => {
+        const publishConfig = (data["publishConfig"] ?? {});
+        return {
+            ...data,
+            name: metadata.packageName,
+            description: metadata.description,
+            repository: {
+                type: "git",
+                url: `git+${metadata.repoUrl}`,
+                directory: metadata.directory,
             },
-            {
-                from: /"url": "git\+https:\/\/github\.com\/tsparticles\/empty-template\.git"/g,
-                to: `"url": "git+${repoUrl}"`,
+            bugs: {
+                url: metadata.repoUrl.replace(/\.git$/, "/issues"),
             },
-            {
-                from: /"url": "https:\/\/github\.com\/tsparticles\/empty-template\/issues"/g,
-                to: `"url": "${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, name, description, fnName) {
     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}"`,
             },
         ],
     });
@@ -112,7 +82,7 @@ export async function updateWebpackFile(destPath, name, description, fnName) {
  * @param destPath - The path where the project will be created
  */
 export async function copyEmptyTemplateFiles(destPath) {
-    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,
@@ -135,7 +105,7 @@ export async function runInstall(destPath) {
         return;
     }
     return new Promise((resolve, reject) => {
-        exec("npm install", {
+        childProcess.exec("npm install", {
             cwd: destPath,
         }, error => {
             if (error) {
@@ -155,7 +125,7 @@ export async function runBuild(destPath) {
         return;
     }
     return new Promise((resolve, reject) => {
-        exec("npm run build", {
+        childProcess.exec("npm run build", {
             cwd: destPath,
         }, error => {
             if (error) {