@tsparticles/cli 1.6.5 → 1.8.0

package/src/create/shape/create-shape.ts

@@ -0,0 +1,175 @@
+import { camelize, capitalize, dash } from "../../utils/string-utils";
+import {
+    copyEmptyTemplateFiles,
+    copyFilter,
+    runBuild,
+    runInstall,
+    updatePackageDistFile,
+    updatePackageFile,
+    updateWebpackFile,
+} from "../../utils/template-utils";
+import fs from "fs-extra";
+import path from "path";
+
+/**
+ * Updates the index file with the correct function name
+ * @param destPath - The path where the project is located
+ * @param name - The name of the project
+ */
+async function updateIndexFile(destPath: string, name: string): Promise<void> {
+    const indexPath = path.resolve(destPath, "src", "index.ts"),
+        index = await fs.readFile(indexPath, "utf-8"),
+        capitalizedName = capitalize(capitalize(name, "-"), " "),
+        camelizedName = camelize(capitalizedName),
+        indexFunctionRegex = /loadTemplateShape/g,
+        replacedFuncText = index.replace(indexFunctionRegex, `load${capitalizedName}Shape`),
+        indexNameRegex = /"#template#"/g,
+        replacedNameText = replacedFuncText.replace(indexNameRegex, `"${camelizedName}"`);
+
+    await fs.writeFile(indexPath, replacedNameText);
+}
+
+/**
+ * Updates the shape package file
+ * @param destPath - The path where the project is located
+ * @param name - The name of the project
+ * @param description - The description of the project
+ * @param repoUrl - The repository url
+ */
+async function updateShapePackageFile(
+    destPath: string,
+    name: string,
+    description: string,
+    repoUrl: string,
+): Promise<void> {
+    const camelizedName = camelize(camelize(name, "-"), " "),
+        dashedName = dash(camelizedName);
+
+    updatePackageFile(
+        destPath,
+        `"tsparticles-shape-${dashedName}"`,
+        description,
+        `"tsparticles.shape.${camelizedName}.min.js"`,
+        repoUrl,
+    );
+}
+
+/**
+ * Updates the shape package dist file
+ * @param destPath - The path where the project is located
+ * @param name - The name of the project
+ * @param description - The description of the project
+ * @param repoUrl - The repository url
+ */
+async function updateShapePackageDistFile(
+    destPath: string,
+    name: string,
+    description: string,
+    repoUrl: string,
+): Promise<void> {
+    const camelizedName = camelize(camelize(name, "-"), " "),
+        dashedName = dash(camelizedName);
+
+    updatePackageDistFile(
+        destPath,
+        `"tsparticles-shape-${dashedName}"`,
+        description,
+        `"tsparticles.shape.${camelizedName}.min.js"`,
+        repoUrl,
+    );
+}
+
+/**
+ * Updates the shape readme file
+ * @param destPath - The path where the project is located
+ * @param name - The name of the project
+ * @param description - The description of the project
+ * @param repoUrl - The repository url
+ */
+async function updateReadmeFile(destPath: string, name: string, description: string, repoUrl: string): Promise<void> {
+    const readmePath = path.resolve(destPath, "README.md"),
+        readme = await fs.readFile(readmePath, "utf-8"),
+        capitalizedName = capitalize(capitalize(name, "-"), " "),
+        camelizedName = camelize(capitalizedName),
+        dashedName = dash(camelizedName),
+        readmeDescriptionRegex = /tsParticles Template Shape/g,
+        replacedDescriptionText = readme.replace(readmeDescriptionRegex, `tsParticles ${description} Shape`),
+        readmePackageNameRegex = /tsparticles-shape-template/g,
+        replacedPackageNameText = replacedDescriptionText.replace(
+            readmePackageNameRegex,
+            `tsparticles-shape-${dashedName}`,
+        ),
+        readmeFileNameRegex = /tsparticles\.shape\.template(\.bundle)?\.min\.js/g,
+        replacedFileNameText = replacedPackageNameText.replace(
+            readmeFileNameRegex,
+            `tsparticles.shape.${camelizedName}$1.min.js`,
+        ),
+        readmeFunctionNameRegex = /loadTemplateShape/g,
+        replacedFunctionNameText = replacedFileNameText.replace(readmeFunctionNameRegex, `load${capitalizedName}Shape`),
+        readmeMiniDescriptionRegex =
+            /\[tsParticles]\(https:\/\/github.com\/matteobruni\/tsparticles\) additional template shape\./g,
+        replacedMiniDescriptionText = replacedFunctionNameText.replace(
+            readmeMiniDescriptionRegex,
+            `[tsParticles](https://github.com/matteobruni/tsparticles) additional ${name} shape.`,
+        ),
+        readmeUsageRegex = /shape\.type: "template"/g,
+        replacedUsageText = replacedMiniDescriptionText.replace(readmeUsageRegex, `shape.type: "${camelizedName}`),
+        sampleImageRegex =
+            /!\[demo]\(https:\/\/raw.githubusercontent.com\/tsparticles\/shape-template\/main\/images\/sample.png\)/g,
+        repoPath = repoUrl.includes("github.com")
+            ? repoUrl.substring(repoUrl.indexOf("github.com/") + 11, repoUrl.indexOf(".git"))
+            : "tsparticles/shape-template",
+        replacedText = replacedUsageText.replace(
+            sampleImageRegex,
+            `![demo](https://raw.githubusercontent.com/${repoPath}/main/images/sample.png)`,
+        );
+
+    await fs.writeFile(readmePath, replacedText);
+}
+
+/**
+ * Updates the shape webpack file
+ * @param destPath - The path where the project is located
+ * @param name - The name of the project
+ * @param description - The description of the project
+ */
+async function updateShapeWebpackFile(destPath: string, name: string, description: string): Promise<void> {
+    await updateWebpackFile(
+        destPath,
+        camelize(capitalize(capitalize(name, "-"), " ")),
+        `tsParticles ${description} Shape`,
+        "loadParticlesShape",
+    );
+}
+
+/**
+ * Creates the shape project
+ * @param name - The name of the project
+ * @param description - The description of the project
+ * @param repoUrl - The repository url
+ * @param destPath - The path where the project is located
+ */
+export async function createShapeTemplate(
+    name: string,
+    description: string,
+    repoUrl: string,
+    destPath: string,
+): Promise<void> {
+    const sourcePath = path.resolve(__dirname, "..", "..", "..", "files", "create-shape");
+
+    await copyEmptyTemplateFiles(destPath);
+
+    await fs.copy(sourcePath, destPath, {
+        overwrite: true,
+        filter: copyFilter,
+    });
+
+    await updateIndexFile(destPath, name);
+    await updateShapePackageFile(destPath, name, description, repoUrl);
+    await updateShapePackageDistFile(destPath, name, description, repoUrl);
+    await updateReadmeFile(destPath, name, description, repoUrl);
+    await updateShapeWebpackFile(destPath, name, description);
+
+    runInstall(destPath);
+    runBuild(destPath);
+}

package/src/create/shape/shape.ts

@@ -0,0 +1,65 @@
+import prompts, { type PromptObject } from "prompts";
+import { Command } from "commander";
+import { capitalize } from "../../utils/string-utils";
+import { createShapeTemplate } from "./create-shape";
+import { execSync } from "child_process";
+import fs from "fs-extra";
+import path from "path";
+
+const shapeCommand = new Command("shape");
+
+shapeCommand.description("Create a new tsParticles shape");
+shapeCommand.argument("<destination>", "Destination folder");
+shapeCommand.action(async (destination: string) => {
+    let repoUrl: string;
+
+    const destPath = path.resolve(path.join(process.cwd(), destination)),
+        destExists = await fs.pathExists(destPath);
+
+    if (destExists) {
+        const destContents = await fs.readdir(destPath),
+            destContentsNoGit = destContents.filter(t => t !== ".git" && t !== ".gitignore");
+
+        if (destContentsNoGit.length) {
+            throw new Error("Destination folder already exists and is not empty");
+        }
+    }
+
+    await fs.ensureDir(destPath);
+
+    try {
+        repoUrl = execSync("git config --get remote.origin.url").toString();
+    } catch {
+        repoUrl = "";
+    }
+
+    const initialName = destPath.split(path.sep).pop(),
+        questions: PromptObject[] = [
+            {
+                type: "text",
+                name: "name",
+                message: "What is the name of the shape?",
+                validate: (value: string) => (value ? true : "The name can't be empty"),
+                initial: initialName,
+            },
+            {
+                type: "text",
+                name: "description",
+                message: "What is the description of the shape?",
+                validate: (value: string) => (value ? true : "The description can't be empty"),
+                initial: capitalize(initialName || ""),
+            },
+            {
+                type: "text",
+                name: "repositoryUrl",
+                message: "What is the repository URL? (optional)",
+                initial: repoUrl.trim(),
+            },
+        ];
+
+    const { name, description, repositoryUrl } = await prompts(questions);
+
+    createShapeTemplate(name.trim(), description.trim(), repositoryUrl.trim(), destPath);
+});
+
+export { shapeCommand };

package/src/utils/template-utils.ts

@@ -15,7 +15,7 @@ export async function updatePackageFile(
     packageName: string,
     description: string,
     fileName: string,
-    repoUrl: string
+    repoUrl: string,
 ): Promise<void> {
     const packagePath = path.resolve(destPath, "package.json"),
         packageContents = await fs.readFile(packagePath, "utf-8"),
@@ -48,7 +48,7 @@ export async function updatePackageDistFile(
     packageName: string,
     description: string,
     fileName: string,
-    repoUrl: string
+    repoUrl: string,
 ): Promise<void> {
     const packagePath = path.resolve(destPath, "package.dist.json"),
         packageContents = await fs.readFile(packagePath, "utf-8"),
@@ -79,7 +79,7 @@ export async function updateWebpackFile(
     destPath: string,
     name: string,
     description: string,
-    fnName: string
+    fnName: string,
 ): Promise<void> {
     const webpackPath = path.resolve(destPath, "webpack.config.js"),
         webpack = await fs.readFile(webpackPath, "utf-8"),
@@ -112,11 +112,7 @@ export async function copyEmptyTemplateFiles(destPath: string): Promise<void> {
  * @returns true if the file should be copied
  */
 export function copyFilter(src: string): boolean {
-    if (src.endsWith("node_modules") || src.endsWith("dist")) {
-        return false;
-    }
-
-    return true;
+    return !(src.endsWith("node_modules") || src.endsWith("dist"));
 }
 
 /**