@tsparticles/cli 3.0.14 → 3.0.16

package/dist/utils/template-utils.d.ts

@@ -0,0 +1,47 @@
+/**
+ * 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
+ */
+export declare function updatePackageFile(destPath: string, packageName: string, description: string, fileName: string, repoUrl: string): 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
+ */
+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>;
+/**
+ * Copies the empty template files to the destination path
+ * @param destPath - The path where the project will be created
+ */
+export declare function copyEmptyTemplateFiles(destPath: string): Promise<void>;
+/**
+ * Filters the files to copy
+ * @param src - The source file path
+ * @returns true if the file should be copied
+ */
+export declare function copyFilter(src: string): boolean;
+/**
+ * Runs npm install in the given path
+ * @param destPath - The path where the project will be created
+ */
+export declare function runInstall(destPath: string): Promise<void>;
+/**
+ * Runs npm run build in the given path
+ * @param destPath - The path where the project will be build
+ */
+export declare function runBuild(destPath: string): Promise<void>;

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

@@ -1,13 +1,15 @@
-import { type Container, type Engine, type IContainerPlugin } from "@tsparticles/engine";
+import { /*type Container, type Engine,*/ type IContainerPlugin } from "@tsparticles/engine";
 
 export class PluginInstance implements IContainerPlugin {
+    /*
     private readonly _container;
     private readonly _engine;
 
     constructor(container: Container, engine: Engine) {
-        this._container = container;
+        /*this._container = container;
         this._engine = engine;
     }
+    */
 
     async init(): Promise<void> {
         // add your plugin initialization here, replace the empty promise

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

@@ -6,5 +6,5 @@ import type { Engine } from "@tsparticles/engine";
 export async function loadTemplatePlugin(engine: Engine): Promise<void> {
     const { Plugin } = await import("./plugin.js");
 
-    await engine.addPlugin(new Plugin(engine));
+    await engine.addPlugin(new Plugin(/*engine*/));
 }

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

@@ -1,4 +1,4 @@
-import { type Container, type Engine, type IPlugin, type ISourceOptions, type Options } from "@tsparticles/engine";
+import { /*type Container, type Engine,*/ type IPlugin, type ISourceOptions, type Options } from "@tsparticles/engine";
 import type { PluginInstance } from "./PluginInstance.js";
 
 /**
@@ -6,18 +6,18 @@ import type { PluginInstance } from "./PluginInstance.js";
 export class Plugin implements IPlugin {
     readonly id;
 
-    private readonly _engine;
+    //private readonly _engine;
 
-    constructor(engine: Engine) {
+    constructor(/*engine: Engine*/) {
         this.id = "#template#";
 
-        this._engine = engine;
+        //this._engine = engine;
     }
 
-    async getPlugin(container: Container): Promise<PluginInstance> {
+    async getPlugin(/*container: Container*/): Promise<PluginInstance> {
         const { PluginInstance } = await import("./PluginInstance.js");
 
-        return new PluginInstance(container, this._engine);
+        return new PluginInstance(/*container, this._engine*/);
     }
 
     loadOptions(_options: Options, _source?: ISourceOptions): void {

package/files/empty-project/.browserslistrc

@@ -1,2 +1,2 @@
-since 2019
+since 2021
 not dead

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

@@ -73,6 +73,6 @@
   "module": "index.js",
   "types": "index.d.ts",
   "dependencies": {
-    "@tsparticles/engine": "^3.3.0"
+    "@tsparticles/engine": "^3.9.1"
   }
 }

package/files/empty-project/package.json

@@ -83,25 +83,25 @@
   "types": "dist/types/index.d.ts",
   "prettier": "@tsparticles/prettier-config",
   "devDependencies": {
-    "@babel/core": "^7.28.5",
-    "@tsparticles/cli": "^3.0.14",
-    "@tsparticles/eslint-config": "^3.0.6",
-    "@tsparticles/prettier-config": "^3.0.6",
-    "@tsparticles/tsconfig": "^3.0.6",
-    "@tsparticles/webpack-plugin": "^3.0.6",
+    "@babel/core": "^7.28.6",
+    "@tsparticles/cli": "^3.0.16",
+    "@tsparticles/eslint-config": "^3.0.11",
+    "@tsparticles/prettier-config": "^3.0.11",
+    "@tsparticles/tsconfig": "^3.0.9",
+    "@tsparticles/webpack-plugin": "^3.0.11",
     "@types/webpack-env": "^1.18.8",
     "babel-loader": "^10.0.0",
     "browserslist": "^4.28.1",
     "copyfiles": "^2.4.1",
     "eslint": "^9.39.2",
     "eslint-config-prettier": "^10.1.8",
-    "prettier": "^3.7.4",
+    "prettier": "^3.8.1",
     "rimraf": "^6.1.2",
     "terser-webpack-plugin": "^5.3.16",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.50.0",
+    "typescript-eslint": "^8.53.1",
     "webpack": "^5.104.1",
-    "webpack-bundle-analyzer": "^5.1.0",
+    "webpack-bundle-analyzer": "^5.2.0",
     "webpack-cli": "^6.0.1"
   },
   "dependencies": {

package/files/empty-project/tsconfig.base.json

@@ -1,7 +1,8 @@
 {
   "extends": "@tsparticles/tsconfig/tsconfig.base.json",
   "compilerOptions": {
-    "rootDir": "./src"
+    "rootDir": "./src",
+    "strictNullChecks": true
   },
   "include": [
     "./src"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsparticles/cli",
-  "version": "3.0.14",
+  "version": "3.0.16",
   "license": "MIT",
   "type": "module",
   "bin": {
@@ -11,31 +11,31 @@
   },
   "prettier": "@tsparticles/prettier-config",
   "dependencies": {
-    "@tsparticles/eslint-config": "^3.0.9",
-    "@tsparticles/prettier-config": "^3.0.7",
+    "@tsparticles/eslint-config": "^3.0.11",
+    "@tsparticles/prettier-config": "^3.0.11",
     "@tsparticles/tsconfig": "^3.0.9",
-    "@tsparticles/webpack-plugin": "^3.0.9",
+    "@tsparticles/webpack-plugin": "^3.0.11",
     "commander": "^14.0.2",
     "eslint": "^9.39.2",
     "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-jsdoc": "^61.5.0",
-    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-plugin-jsdoc": "^62.3.0",
+    "eslint-plugin-prettier": "^5.5.5",
     "eslint-plugin-tsdoc": "^0.5.0",
     "fs-extra": "^11.3.3",
     "klaw": "^4.1.0",
     "lookpath": "^1.2.3",
     "madge": "^8.0.0",
     "path-scurry": "^2.0.1",
-    "prettier": "^3.7.4",
+    "prettier": "^3.8.1",
     "prettier-plugin-multiline-arrays": "^4.1.3",
     "prompts": "^2.4.2",
     "rimraf": "^6.1.2",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.51.0",
+    "typescript-eslint": "^8.53.1",
     "webpack": "^5.104.1"
   },
   "devDependencies": {
-    "@babel/core": "^7.28.5",
+    "@babel/core": "^7.28.6",
     "@tsparticles/cli": "^3.0.14",
     "@tsparticles/engine": "^3.9.1",
     "@types/eslint": "^9.6.1",
@@ -43,7 +43,7 @@
     "@types/fs-extra": "^11.0.4",
     "@types/klaw": "^3.0.7",
     "@types/madge": "^5.0.3",
-    "@types/node": "^25.0.3",
+    "@types/node": "^25.0.10",
     "@types/prompts": "^2.4.9",
     "@types/webpack-env": "^1.18.8",
     "babel-loader": "^10.0.0",
@@ -52,8 +52,8 @@
     "cross-env": "^10.1.0",
     "terser-webpack-plugin": "^5.3.16",
     "ts-node": "^10.9.2",
-    "vitest": "^4.0.16",
-    "webpack-bundle-analyzer": "^5.1.0",
+    "vitest": "^4.0.17",
+    "webpack-bundle-analyzer": "^5.2.0",
     "webpack-cli": "^6.0.1"
   },
   "description": "tsParticles CLI",

package/src/build/build-bundle.ts

@@ -6,55 +6,55 @@ import webpack from "webpack";
  * @returns true if the bundle was created
  */
 export async function bundle(basePath: string): Promise<boolean> {
-    console.log("Bundling started");
+  console.log("Bundling started");
 
-    let res = false;
+  let res = false;
 
-    try {
-        const options = (await import(path.join(basePath, "webpack.config.js"))) as { default: webpack.Configuration };
+  try {
+    const options = (await import(path.join(basePath, "webpack.config.js"))) as { default: webpack.Configuration };
 
-        res = await new Promise<boolean>((resolve, reject) => {
-            webpack(options.default, (err, stats) => {
-                if (err) {
-                    console.error(err.stack ?? err);
+    res = await new Promise<boolean>((resolve, reject) => {
+      webpack(options.default, (err, stats) => {
+        if (err) {
+          console.error(err.stack ?? err);
 
-                    reject(err);
+          reject(err);
 
-                    return;
-                }
+          return;
+        }
 
-                if (!stats) {
-                    const err = new Error("No stats returned from webpack");
+        if (!stats) {
+          const err = new Error("No stats returned from webpack");
 
-                    console.error(err);
+          console.error(err);
 
-                    reject(err);
+          reject(err);
 
-                    return;
-                }
+          return;
+        }
 
-                const info = stats.toJson();
+        const info = stats.toJson();
 
-                if (stats.hasErrors()) {
-                    console.error(info.errors);
+        if (stats.hasErrors()) {
+          console.error(info.errors);
 
-                    reject(new Error(info.errors?.map(error => error.message).join("\n")));
-                }
+          reject(new Error(info.errors?.map(error => error.message).join("\n")));
+        }
 
-                if (stats.hasWarnings()) {
-                    console.warn(info.warnings);
-                }
+        if (stats.hasWarnings()) {
+          console.warn(info.warnings);
+        }
 
-                resolve(true);
-            });
-        });
-    } catch (e) {
-        console.error(e);
+        resolve(true);
+      });
+    });
+  } catch (e) {
+    console.error(e);
 
-        res = false;
-    }
+    res = false;
+  }
 
-    console.log("Bundling done");
+  console.log("Bundling done");
 
-    return res;
+  return res;
 }

package/src/build/build-circular-deps.ts

@@ -7,33 +7,33 @@ import path from "path";
  * @returns true if no circular dependencies are found, false otherwise
  */
 export async function buildCircularDeps(basePath: string): Promise<boolean> {
-    let res = false;
+  let res = false;
 
-    try {
-        const madgeRes = await madge(path.join(basePath, "src"), {
-                fileExtensions: ["ts"],
-                detectiveOptions: {
-                    ts: {
-                        skipTypeImports: true,
-                    },
-                },
-            }),
-            circularDeps = madgeRes.circular();
+  try {
+    const madgeRes = await madge(path.join(basePath, "src"), {
+        fileExtensions: ["ts"],
+        detectiveOptions: {
+          ts: {
+            skipTypeImports: true,
+          },
+        },
+      }),
+      circularDeps = madgeRes.circular();
 
-        if (circularDeps.length) {
-            console.error("Circular dependencies found!");
+    if (circularDeps.length) {
+      console.error("Circular dependencies found!");
 
-            for (const dep of circularDeps) {
-                console.error(dep.join(" > "));
-            }
-        } else {
-            res = true;
-        }
-    } catch (e) {
-        console.error(e);
+      for (const dep of circularDeps) {
+        console.error(dep.join(" > "));
+      }
+    } else {
+      res = true;
     }
+  } catch (e) {
+    console.error(e);
+  }
 
-    console.log("Finished checking circular dependencies.");
+  console.log("Finished checking circular dependencies.");
 
-    return res;
+  return res;
 }

package/src/build/build-clear.ts

@@ -6,21 +6,21 @@ import { rimraf } from "rimraf";
  * @returns true if the dist folder was cleared
  */
 export async function clearDist(basePath: string): Promise<boolean> {
-    console.log("Clearing dist folder");
+  console.log("Clearing dist folder");
 
-    let res = false;
+  let res = false;
 
-    try {
-        await rimraf(path.join(basePath, "dist"));
+  try {
+    await rimraf(path.join(basePath, "dist"));
 
-        res = true;
-    } catch (e) {
-        console.error(e);
+    res = true;
+  } catch (e) {
+    console.error(e);
 
-        res = false;
-    }
+    res = false;
+  }
 
-    console.log("Clearing dist folder done");
+  console.log("Clearing dist folder done");
 
-    return res;
+  return res;
 }

package/src/build/build-distfiles.ts

@@ -7,80 +7,77 @@ import path from "path";
  * @returns true if the dist files process was successful
  */
 export async function buildDistFiles(basePath: string): Promise<boolean> {
-    console.log("Build - started on dist files");
-
-    let res: boolean;
-
-    try {
-        const pkgInfo = JSON.parse((await fs.readFile(path.join(basePath, "package.json"))).toString()) as {
-                dependencies?: Record<string, string>;
-                peerDependencies?: Record<string, string>;
-                publishConfig?: { directory?: string };
-                version: string;
-            },
-            libPackage = path.join(basePath, "package.dist.json"),
-            distPath = path.join(basePath, pkgInfo.publishConfig?.directory ?? "dist");
-
-        const data = await fs.readFile(libPackage),
-            text = data.toString(),
-            libObj = JSON.parse(text) as Record<string, unknown>;
-
-        libObj["version"] = pkgInfo.version;
-
-        if (pkgInfo.dependencies) {
-            libObj["dependencies"] = JSON.parse(JSON.stringify(pkgInfo.dependencies).replaceAll("workspace:", ""));
-        } else if (pkgInfo.peerDependencies) {
-            libObj["peerDependencies"] = JSON.parse(
-                JSON.stringify(pkgInfo.peerDependencies).replaceAll("workspace:", ""),
-            );
-        }
+  console.log("Build - started on dist files");
+
+  let res: boolean;
+
+  try {
+    const pkgInfo = JSON.parse((await fs.readFile(path.join(basePath, "package.json"))).toString()) as {
+        dependencies?: Record<string, string>;
+        peerDependencies?: Record<string, string>;
+        publishConfig?: { directory?: string };
+        version: string;
+      },
+      libPackage = path.join(basePath, "package.dist.json"),
+      distPath = path.join(basePath, pkgInfo.publishConfig?.directory ?? "dist"),
+      data = await fs.readFile(libPackage),
+      text = data.toString(),
+      libObj = JSON.parse(text) as Record<string, unknown>;
+
+    libObj["version"] = pkgInfo.version;
+
+    if (pkgInfo.dependencies) {
+      libObj["dependencies"] = JSON.parse(JSON.stringify(pkgInfo.dependencies).replaceAll("workspace:", ""));
+    } else if (pkgInfo.peerDependencies) {
+      libObj["peerDependencies"] = JSON.parse(JSON.stringify(pkgInfo.peerDependencies).replaceAll("workspace:", ""));
+    }
 
-        const jsonIndent = 2;
+    const jsonIndent = 2;
 
-        await fs.writeFile(libPackage, `${JSON.stringify(libObj, undefined, jsonIndent)}\n`, "utf8");
+    await fs.writeFile(libPackage, `${JSON.stringify(libObj, undefined, jsonIndent)}\n`, "utf8");
 
-        console.log(`package.dist.json updated successfully to version ${pkgInfo.version}`);
+    console.log(`package.dist.json updated successfully to version ${pkgInfo.version}`);
 
-        const rootFilesToCopy = [
-            "LICENSE",
-            "README.md",
-            {
-                source: "package.dist.json",
-                destination: "package.json",
-            },
-        ];
+    const rootFilesToCopy = [
+      "LICENSE",
+      "README.md",
+      {
+        source: "package.dist.json",
+        destination: "package.json",
+      },
+    ];
 
-        for (const file of rootFilesToCopy) {
-            const src = path.join(basePath, typeof file === "string" ? file : file.source),
-                dest = path.join(distPath, typeof file === "string" ? file : file.destination);
+    for (const file of rootFilesToCopy) {
+      const src = path.join(basePath, typeof file === "string" ? file : file.source),
+        dest = path.join(distPath, typeof file === "string" ? file : file.destination);
 
-            await fs.copyFile(src, dest);
-        }
+      await fs.copyFile(src, dest);
+    }
 
-        const scriptsPath = path.join(basePath, "scripts"),
-            distScriptsPath = path.join(distPath, "scripts");
+    const scriptsPath = path.join(basePath, "scripts"),
+      distScriptsPath = path.join(distPath, "scripts");
 
-        if ((await fs.exists(scriptsPath)) && !(await fs.exists(distScriptsPath))) {
-            await fs.mkdir(distScriptsPath);
+    if ((await fs.exists(scriptsPath)) && !(await fs.exists(distScriptsPath))) {
+      await fs.mkdir(distScriptsPath);
 
-            const installPath = path.join(scriptsPath, "install.js");
+      const installPath = path.join(scriptsPath, "install.js");
 
-            if (await fs.exists(installPath)) {
-                await fs.copyFile(installPath, path.join(distScriptsPath, "install.js"));
-            }
-        }
+      if (await fs.exists(installPath)) {
+        await fs.copyFile(installPath, path.join(distScriptsPath, "install.js"));
+      }
+    }
 
-        for await (const file of klaw(distPath)) {
-            if (file.stats.isDirectory()) {
-                continue;
-            }
+    for await (const file of klaw(distPath)) {
+      if (file.stats.isDirectory()) {
+        continue;
+      }
 
-            const contents = await fs.readFile(file.path, "utf8");
+      const contents = await fs.readFile(file.path, "utf8");
 
-            await fs.writeFile(file.path, contents.replaceAll("__VERSION__", `"${pkgInfo.version}"`), "utf8");
-        }
+      await fs.writeFile(file.path, contents.replaceAll("__VERSION__", `"${pkgInfo.version}"`), "utf8");
+    }
 
-        /* for await (const file of klaw(path.join(distPath, "cjs"))) {
+    /* for await (const file of klaw(path.join(distPath, "cjs"))) {
             await fs.rename(file.path, file.path.replace(/\.js$/, ".cjs"));
         }
 
@@ -88,18 +85,18 @@ export async function buildDistFiles(basePath: string): Promise<boolean> {
             await fs.rename(file.path, file.path.replace(/\.js$/, ".mjs"));
         } */
 
-        await fs.writeFile(path.join(distPath, "cjs", "package.json"), `{ "type": "commonjs" }`);
-        await fs.writeFile(path.join(distPath, "esm", "package.json"), `{ "type": "module" }`);
-        await fs.writeFile(path.join(distPath, "browser", "package.json"), `{ "type": "module" }`);
+    await fs.writeFile(path.join(distPath, "cjs", "package.json"), `{ "type": "commonjs" }`);
+    await fs.writeFile(path.join(distPath, "esm", "package.json"), `{ "type": "module" }`);
+    await fs.writeFile(path.join(distPath, "browser", "package.json"), `{ "type": "module" }`);
 
-        res = true;
-    } catch (e) {
-        console.error(e);
+    res = true;
+  } catch (e) {
+    console.error(e);
 
-        res = false;
-    }
+    res = false;
+  }
 
-    console.log("Build - done on dist files");
+  console.log("Build - done on dist files");
 
-    return res;
+  return res;
 }