@tsparticles/cli 1.11.0 → 1.13.0

package/dist/utils/template-utils.js

@@ -7,6 +7,7 @@ exports.runBuild = exports.runInstall = exports.copyFilter = exports.copyEmptyTe
 const child_process_1 = require("child_process");
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const path_1 = __importDefault(require("path"));
+const file_utils_1 = require("./file-utils");
 /**
  * Updates the package.json file
  * @param destPath - The path where the package.json file is located
@@ -16,8 +17,35 @@ const path_1 = __importDefault(require("path"));
  * @param repoUrl - The repository URL
  */
 async function updatePackageFile(destPath, packageName, description, fileName, repoUrl) {
-    const packagePath = path_1.default.resolve(destPath, "package.json"), packageContents = await fs_extra_1.default.readFile(packagePath, "utf-8"), descriptionRegex = /"tsParticles empty template"/g, replacedDescriptionText = packageContents.replace(descriptionRegex, `"${description}"`), fileRegex = /"tsparticles.empty.template.min.js"/g, replacedFileText = replacedDescriptionText.replace(fileRegex, fileName), privateRegex = /\s{4}"private": true,\r?\n?/g, replacedPrivateText = replacedFileText.replace(privateRegex, ""), nameRegex = /"@tsparticles\/empty-template"/g, nameReplacedText = replacedPrivateText.replace(nameRegex, packageName), repoUrlRegex = /"url": "git\+https:\/\/github\.com\/tsparticles\/empty-template\.git"/g, repoUrlReplacedText = nameReplacedText.replace(repoUrlRegex, `"url": "git+${repoUrl}"`), issuesUrlRegex = /"url": "https:\/\/github\.com\/tsparticles\/empty-template\/issues"/g, replacedText = repoUrlReplacedText.replace(issuesUrlRegex, `"url": "${repoUrl.replace(".git", "/issues")}"`);
-    await fs_extra_1.default.writeFile(packagePath, replacedText);
+    await (0, file_utils_1.replaceTokensInFile)({
+        path: path_1.default.resolve(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")}"`,
+            },
+        ],
+    });
 }
 exports.updatePackageFile = updatePackageFile;
 /**
@@ -29,8 +57,35 @@ exports.updatePackageFile = updatePackageFile;
  * @param repoUrl - The url of the repository
  */
 async function updatePackageDistFile(destPath, packageName, description, fileName, repoUrl) {
-    const packagePath = path_1.default.resolve(destPath, "package.dist.json"), packageContents = await fs_extra_1.default.readFile(packagePath, "utf-8"), descriptionRegex = /"tsParticles empty template"/g, replacedDescriptionText = packageContents.replace(descriptionRegex, `"${description}"`), fileRegex = /"tsparticles.empty.template.min.js"/g, replacedFileText = replacedDescriptionText.replace(fileRegex, fileName), privateRegex = /\s{4}"private": true,\r?\n?/g, replacedPrivateText = replacedFileText.replace(privateRegex, ""), nameRegex = /"@tsparticles\/empty-template"/g, nameReplacedText = replacedPrivateText.replace(nameRegex, packageName), repoUrlRegex = /"url": "git\+https:\/\/github\.com\/tsparticles\/empty-template\.git"/g, repoUrlReplacedText = nameReplacedText.replace(repoUrlRegex, `"url": "git+${repoUrl}"`), issuesUrlRegex = /"url": "https:\/\/github\.com\/tsparticles\/empty-template\/issues"/g, replacedText = repoUrlReplacedText.replace(issuesUrlRegex, `"url": "${repoUrl.replace(".git", "/issues")}"`);
-    await fs_extra_1.default.writeFile(packagePath, replacedText);
+    await (0, file_utils_1.replaceTokensInFile)({
+        path: path_1.default.resolve(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")}"`,
+            },
+        ],
+    });
 }
 exports.updatePackageDistFile = updatePackageDistFile;
 /**
@@ -41,8 +96,23 @@ exports.updatePackageDistFile = updatePackageDistFile;
  * @param fnName - The name of the function to load the template
  */
 async function updateWebpackFile(destPath, name, description, fnName) {
-    const webpackPath = path_1.default.resolve(destPath, "webpack.config.js"), webpack = await fs_extra_1.default.readFile(webpackPath, "utf-8"), webpackDescriptionRegex = /tsParticles Empty Template/g, replacedDescriptionText = webpack.replace(webpackDescriptionRegex, description), webpackEntryRegex = /"template(\.bundle)?"/g, replacedNameText = replacedDescriptionText.replace(webpackEntryRegex, `"${name}$1"`), webpackFunctionNameRegex = /loadParticlesTemplate/g, replacedFunctionNameText = replacedNameText.replace(webpackFunctionNameRegex, fnName);
-    await fs_extra_1.default.writeFile(webpackPath, replacedFunctionNameText);
+    await (0, file_utils_1.replaceTokensInFile)({
+        path: path_1.default.resolve(destPath, "webpack.config.js"),
+        tokens: [
+            {
+                from: /"Empty"/g,
+                to: `"${description}"`,
+            },
+            {
+                from: /"empty"/g,
+                to: `"${name}"`,
+            },
+            {
+                from: /loadParticlesTemplate/g,
+                to: fnName,
+            },
+        ],
+    });
 }
 exports.updateWebpackFile = updateWebpackFile;
 /**
@@ -50,8 +120,7 @@ exports.updateWebpackFile = updateWebpackFile;
  * @param destPath - The path where the project will be created
  */
 async function copyEmptyTemplateFiles(destPath) {
-    const emptyPath = path_1.default.resolve(__dirname, "..", "..", "files", "empty-project");
-    await fs_extra_1.default.copy(emptyPath, destPath, {
+    await fs_extra_1.default.copy(path_1.default.resolve(__dirname, "..", "..", "files", "empty-project"), destPath, {
         overwrite: true,
         filter: copyFilter,
     });

package/files/create-preset/README.md

@@ -21,8 +21,8 @@ Once installed you need one more script to be included in your page (or you can
 from [jsDelivr](https://www.jsdelivr.com/package/npm/tsparticles-preset-template):
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/tsparticles@1/tsparticles.min.js"></script>
-<script src="https://cdn.jsdelivr.net/npm/tsparticles-preset-template@1/tsparticles.preset.template.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/tsparticles-engine@2/tsparticles.engine.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/tsparticles-preset-template/tsparticles.preset.template.min.js"></script>
 ```
 
 This script **MUST** be placed after the `tsParticles` one.
@@ -32,7 +32,7 @@ This script **MUST** be placed after the `tsParticles` one.
 A bundled script can also be used, this will include every needed plugin needed by the preset.
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/tsparticles-preset-template@1/tsparticles.preset.template.bundle.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/tsparticles-preset-template/tsparticles.preset.template.bundle.min.js"></script>
 ```
 
 ### Usage

package/files/empty-project/package.dist.json

@@ -72,6 +72,6 @@
   "module": "index.js",
   "types": "index.d.ts",
   "dependencies": {
-    "tsparticles-engine": "^2.10.0"
+    "tsparticles-engine": "^2.12.0"
   }
 }

package/files/empty-project/package.json

@@ -83,7 +83,7 @@
   "prettier": "@tsparticles/prettier-config",
   "devDependencies": {
     "@babel/core": "^7.22.9",
-    "@tsparticles/cli": "1.11.0",
+    "@tsparticles/cli": "^1.13.0",
     "@tsparticles/eslint-config": "^1.19.0",
     "@tsparticles/prettier-config": "^1.12.0",
     "@tsparticles/tsconfig": "^1.14.0",
@@ -95,7 +95,7 @@
     "browserslist": "^4.21.10",
     "copyfiles": "^2.4.1",
     "eslint": "^8.46.0",
-    "eslint-config-prettier": "^8.10.0",
+    "eslint-config-prettier": "^9.0.0",
     "prettier": "^3.0.1",
     "rimraf": "^5.0.1",
     "terser-webpack-plugin": "^5.3.9",
@@ -105,6 +105,6 @@
     "webpack-cli": "^5.1.4"
   },
   "dependencies": {
-    "tsparticles-engine": "^2.11.1"
+    "tsparticles-engine": "^2.12.0"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsparticles/cli",
-  "version": "1.11.0",
+  "version": "1.13.0",
   "license": "MIT",
   "bin": {
     "tsparticles-cli": "dist/cli.js"
@@ -10,32 +10,38 @@
   },
   "prettier": "@tsparticles/prettier-config",
   "dependencies": {
-    "@tsparticles/eslint-config": "^1.19.0",
+    "@tsparticles/eslint-config": "^1.20.0",
     "@tsparticles/prettier-config": "^1.12.0",
     "@tsparticles/tsconfig": "^1.14.0",
-    "@tsparticles/webpack-plugin": "^1.23.0",
-    "@typescript-eslint/eslint-plugin": "^6.1.0",
-    "@typescript-eslint/parser": "^6.1.0",
+    "@tsparticles/webpack-plugin": "^1.24.0",
+    "@typescript-eslint/eslint-plugin": "^6.3.0",
+    "@typescript-eslint/parser": "^6.3.0",
     "commander": "^11.0.0",
-    "eslint": "^8.45.0",
-    "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-jsdoc": "^46.4.4",
+    "eslint": "^8.46.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-jsdoc": "^46.4.6",
     "eslint-plugin-tsdoc": "^0.2.17",
     "fs-extra": "^11.1.1",
     "klaw": "^4.1.0",
     "path-scurry": "^1.10.1",
-    "prettier": "^3.0.0",
+    "prettier": "^3.0.1",
     "prompts": "^2.4.2",
     "rimraf": "^5.0.1",
     "typescript": "^5.1.6",
     "webpack": "^5.88.2"
   },
   "devDependencies": {
-    "@types/eslint": "^8.44.0",
+    "@types/chai": "^4.3.5",
     "@types/fs-extra": "^11.0.1",
     "@types/klaw": "^3.0.3",
-    "@types/node": "^20.4.4",
-    "@types/prompts": "^2.4.4"
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^20.4.8",
+    "@types/prompts": "^2.4.4",
+    "chai": "^4.3.7",
+    "cross-env": "^7.0.3",
+    "mocha": "^10.2.0",
+    "nyc": "^15.1.0",
+    "ts-node": "^10.9.1"
   },
   "description": "tsParticles CLI",
   "main": ".eslintrc.js",
@@ -51,6 +57,7 @@
     "compile:ci": "pnpm run build:ts",
     "build:ts": "pnpm run build:ts:cjs",
     "build:ts:cjs": "tsc -p src",
+    "test": "cross-env TS_NODE_PROJECT='./tests/tsconfig.json' nyc mocha --timeout 300000",
     "build": "pnpm run clear:dist && pnpm run prettify:src && pnpm run lint && pnpm run compile && pnpm run prettify:readme && chmod +x dist/cli.js && chmod +x dist/build/build.js && chmod +x dist/create/create.js && chmod +x dist/create/preset/preset.js",
     "build:ci": "pnpm run clear:dist && pnpm run prettify:ci:src && pnpm run lint:ci && pnpm run compile && pnpm run prettify:ci:readme",
     "clear:dist": "rimraf ./dist",

package/scripts/postversion.js

@@ -14,7 +14,7 @@ const emptyProjectPkgPath = path.join(__dirname, "..", "files", "empty-project",
 
         const obj = JSON.parse(data);
 
-        obj["devDependencies"]["@tsparticles/cli"] = pkg.version;
+        obj["devDependencies"]["@tsparticles/cli"] = `^${pkg.version}`;
 
         const result = JSON.stringify(obj, undefined, 2);
 

package/src/build/build.ts

@@ -11,7 +11,7 @@ import path from "path";
 
 const buildCommand = new Command("build");
 
-buildCommand.description("Build the library using TypeScript");
+buildCommand.description("Build the tsParticles library using TypeScript");
 buildCommand.option(
     "-a, --all",
     "Do all build steps (default if no flags are specified) (same as -b -c -d -l -p -t)",

package/src/cli.ts

@@ -4,8 +4,8 @@ import { createCommand } from "./create/create";
 import pkgInfo from "../package.json";
 import { program } from "commander";
 
-program.name("tsparticles-cli build");
-program.description("tsParticles Builder");
+program.name("tsparticles-cli");
+program.description("tsParticles CLI");
 program.version(pkgInfo.version, "-v, --version", "output the current version");
 program.addCommand(buildCommand);
 program.addCommand(createCommand);

package/src/create/plugin/create-plugin.ts

@@ -10,6 +10,7 @@ import {
 } from "../../utils/template-utils";
 import fs from "fs-extra";
 import path from "path";
+import { replaceTokensInFile } from "../../utils/file-utils";
 
 /**
  * Updates the index file with the correct function name
@@ -17,16 +18,22 @@ import path from "path";
  * @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 = /loadTemplatePlugin/g,
-        replacedFuncText = index.replace(indexFunctionRegex, `load${capitalizedName}Plugin`),
-        indexNameRegex = /"#template#"/g,
-        replacedNameText = replacedFuncText.replace(indexNameRegex, `"${camelizedName}"`);
+    const capitalizedName = capitalize(name, "-", " "),
+        camelizedName = camelize(capitalizedName);
 
-    await fs.writeFile(indexPath, replacedNameText);
+    await replaceTokensInFile({
+        path: path.resolve(destPath, "src", "index.ts"),
+        tokens: [
+            {
+                from: /loadTemplatePlugin/g,
+                to: `load${capitalizedName}Plugin`,
+            },
+            {
+                from: /"#template#"/g,
+                to: `"${camelizedName}"`,
+            },
+        ],
+    });
 }
 
 /**
@@ -45,11 +52,11 @@ async function updatePluginPackageFile(
     const camelizedName = camelize(camelize(name, "-"), " "),
         dashedName = dash(camelizedName);
 
-    updatePackageFile(
+    await updatePackageFile(
         destPath,
-        `"tsparticles-plugin-${dashedName}"`,
+        `tsparticles-plugin-${dashedName}`,
         description,
-        `"tsparticles.plugin.${camelizedName}.min.js"`,
+        `tsparticles.plugin.${camelizedName}.min.js`,
         repoUrl,
     );
 }
@@ -70,11 +77,11 @@ async function updatePluginPackageDistFile(
     const camelizedName = camelize(camelize(name, "-"), " "),
         dashedName = dash(camelizedName);
 
-    updatePackageDistFile(
+    await updatePackageDistFile(
         destPath,
-        `"tsparticles-plugin-${dashedName}"`,
+        `tsparticles-plugin-${dashedName}`,
         description,
-        `"tsparticles.plugin.${camelizedName}.min.js"`,
+        `tsparticles.plugin.${camelizedName}.min.js`,
         repoUrl,
     );
 }
@@ -88,46 +95,46 @@ async function updatePluginPackageDistFile(
  */
 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, "-"), " "),
+        capitalizedName = capitalize(name, "-", " "),
         camelizedName = camelize(capitalizedName),
         dashedName = dash(camelizedName),
-        readmeDescriptionRegex = /tsParticles Template Plugin/g,
-        replacedDescriptionText = readme.replace(readmeDescriptionRegex, `tsParticles ${description} Plugin`),
-        readmePackageNameRegex = /tsparticles-plugin-template/g,
-        replacedPackageNameText = replacedDescriptionText.replace(
-            readmePackageNameRegex,
-            `tsparticles-plugin-${dashedName}`,
-        ),
-        readmeFileNameRegex = /tsparticles\.plugin\.template(\.bundle)?\.min\.js/g,
-        replacedFileNameText = replacedPackageNameText.replace(
-            readmeFileNameRegex,
-            `tsparticles.plugin.${camelizedName}$1.min.js`,
-        ),
-        readmeFunctionNameRegex = /loadTemplatePlugin/g,
-        replacedFunctionNameText = replacedFileNameText.replace(
-            readmeFunctionNameRegex,
-            `load${capitalizedName}Plugin`,
-        ),
-        readmeMiniDescriptionRegex =
-            /\[tsParticles]\(https:\/\/github.com\/matteobruni\/tsparticles\) additional template plugin\./g,
-        replacedMiniDescriptionText = replacedFunctionNameText.replace(
-            readmeMiniDescriptionRegex,
-            `[tsParticles](https://github.com/matteobruni/tsparticles) additional ${name} plugin.`,
-        ),
-        readmeUsageRegex = /plugin\.type: "template"/g,
-        replacedUsageText = replacedMiniDescriptionText.replace(readmeUsageRegex, `plugin.type: "${camelizedName}`),
-        sampleImageRegex =
-            /!\[demo]\(https:\/\/raw.githubusercontent.com\/tsparticles\/plugin-template\/main\/images\/sample.png\)/g,
         repoPath = repoUrl.includes("github.com")
             ? repoUrl.substring(repoUrl.indexOf("github.com/") + 11, repoUrl.indexOf(".git"))
-            : "tsparticles/plugin-template",
-        replacedText = replacedUsageText.replace(
-            sampleImageRegex,
-            `![demo](https://raw.githubusercontent.com/${repoPath}/main/images/sample.png)`,
-        );
+            : "tsparticles/plugin-template";
 
-    await fs.writeFile(readmePath, replacedText);
+    await replaceTokensInFile({
+        path: readmePath,
+        tokens: [
+            {
+                from: /tsParticles Template Plugin/g,
+                to: `tsParticles ${description} Plugin`,
+            },
+            {
+                from: /tsparticles-plugin-template/g,
+                to: `tsparticles-plugin-${dashedName}`,
+            },
+            {
+                from: /tsparticles\.plugin\.template(\.bundle)?\.min\.js/g,
+                to: `tsparticles.plugin.${camelizedName}$1.min.js`,
+            },
+            {
+                from: /loadTemplatePlugin/g,
+                to: `load${capitalizedName}Plugin`,
+            },
+            {
+                from: /\[tsParticles]\(https:\/\/github.com\/matteobruni\/tsparticles\) additional template plugin\./g,
+                to: `[tsParticles](https://github.com/matteobruni/tsparticles) additional ${name} plugin.`,
+            },
+            {
+                from: /plugin\.type: "template"/g,
+                to: `plugin.type: "${camelizedName}"`,
+            },
+            {
+                from: /!\[demo]\(https:\/\/raw.githubusercontent.com\/tsparticles\/plugin-template\/main\/images\/sample.png\)/g,
+                to: `![demo](https://raw.githubusercontent.com/${repoPath}/main/images/sample.png)`,
+            },
+        ],
+    });
 }
 
 /**
@@ -137,12 +144,7 @@ async function updateReadmeFile(destPath: string, name: string, description: str
  * @param description - The description of the project
  */
 async function updatePluginWebpackFile(destPath: string, name: string, description: string): Promise<void> {
-    await updateWebpackFile(
-        destPath,
-        camelize(capitalize(capitalize(name, "-"), " ")),
-        `tsParticles ${description} Plugin`,
-        "loadParticlesPlugin",
-    );
+    await updateWebpackFile(destPath, camelize(capitalize(name, "-", " ")), description, "loadParticlesPlugin");
 }
 
 /**

package/src/create/plugin/plugin.ts

@@ -1,9 +1,8 @@
+import { getDestinationDir, getRepositoryUrl } from "../../utils/file-utils";
 import prompts, { type PromptObject } from "prompts";
 import { Command } from "commander";
 import { capitalize } from "../../utils/string-utils";
 import { createPluginTemplate } from "./create-plugin";
-import { execSync } from "child_process";
-import fs from "fs-extra";
 import path from "path";
 
 const pluginCommand = new Command("plugin");
@@ -11,27 +10,8 @@ const pluginCommand = new Command("plugin");
 pluginCommand.description("Create a new tsParticles plugin");
 pluginCommand.argument("<destination>", "Destination folder");
 pluginCommand.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 destPath = await getDestinationDir(destination),
+        repoUrl = getRepositoryUrl();
 
     const initialName = destPath.split(path.sep).pop(),
         questions: PromptObject[] = [
@@ -59,7 +39,7 @@ pluginCommand.action(async (destination: string) => {
 
     const { name, description, repositoryUrl } = await prompts(questions);
 
-    createPluginTemplate(name.trim(), description.trim(), repositoryUrl.trim(), destPath);
+    await createPluginTemplate(name.trim(), description.trim(), repositoryUrl.trim(), destPath);
 });
 
 export { pluginCommand };