@tsparticles/cli 1.1.1 → 1.3.0

package/README.md

@@ -1,3 +1,63 @@
 [![banner](https://particles.js.org/images/banner2.png)](https://particles.js.org)
 
-# tsParticles Builder
+# tsParticles CLI
+
+## Installation
+
+### NPM
+
+```bash
+npm install -g @particlesjs/cli
+```
+
+### Yarn
+
+```bash
+yarn global add @particlesjs/cli
+```
+
+### PNPM
+
+```bash
+pnpm global add @particlesjs/cli
+```
+
+## Usage
+
+### Help
+
+```bash
+npx @particlesjs/cli --help
+```
+
+or
+
+```bash
+tsparticles-cli --help
+```
+
+### Build
+
+```bash
+npx @particlesjs/cli build
+```
+
+or
+
+```bash
+tsparticles-cli build
+```
+
+### Create
+
+#### Preset
+
+```bash
+npx @particlesjs/cli create preset <folder>
+```
+
+or
+
+```bash
+tsparticles-cli create preset <folder>
+```

package/dist/build/build-bundle.js

@@ -30,8 +30,8 @@ exports.bundle = void 0;
 const path_1 = __importDefault(require("path"));
 const webpack_1 = __importDefault(require("webpack"));
 /**
- *
  * @param basePath -
+ * @returns true if the bundle was created
  */
 async function bundle(basePath) {
     console.log("Bundling started");

package/dist/build/build-clear.js

@@ -7,8 +7,8 @@ exports.clearDist = void 0;
 const path_1 = __importDefault(require("path"));
 const rimraf_1 = require("rimraf");
 /**
- *
  * @param basePath -
+ * @returns true if the dist folder was cleared
  */
 async function clearDist(basePath) {
     console.log("Clearing dist folder");

package/dist/build/build-distfiles.js

@@ -31,8 +31,8 @@ const fs_extra_1 = __importDefault(require("fs-extra"));
 const klaw_1 = __importDefault(require("klaw"));
 const path_1 = __importDefault(require("path"));
 /**
- *
  * @param basePath -
+ * @returns true if the dist files process was successful
  */
 async function buildDistFiles(basePath) {
     console.log("Build - started on dist files");

package/dist/build/build-diststats.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDistStats = void 0;
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+/**
+ * @param folderPath - the path to the folder to get the stats for
+ * @returns the given folder stats;
+ */
+async function getFolderStats(folderPath) {
+    const stats = {
+        totalFiles: 0,
+        totalFolders: 0,
+        totalSize: 0,
+    };
+    const dir = await fs_extra_1.default.promises.opendir(folderPath);
+    for await (const dirent of dir) {
+        if (dirent.isDirectory()) {
+            const subDirStats = await getDistStats(path_1.default.join(folderPath, dirent.name));
+            stats.totalFolders += subDirStats.totalFolders + 1;
+            stats.totalFiles += subDirStats.totalFiles;
+            stats.totalSize += subDirStats.totalSize;
+        }
+        else {
+            const fileStats = await fs_extra_1.default.stat(path_1.default.join(folderPath, dirent.name));
+            stats.totalFiles++;
+            stats.totalSize += fileStats.size;
+        }
+    }
+    return stats;
+}
+/**
+ * Gets the stats for the dist folder
+ * @param basePath - the base path to the project
+ * @returns the stats for the dist folder
+ */
+async function getDistStats(basePath) {
+    return await getFolderStats(path_1.default.join(basePath, "dist"));
+}
+exports.getDistStats = getDistStats;

package/dist/build/build-eslint.js

@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.lint = void 0;
 const eslint_1 = require("eslint");
 /**
- *
  * @param ci -
+ * @returns true if the linting was successful
  */
 async function lint(ci) {
     console.log("ESLint - started on src");

package/dist/build/build-prettier.js

@@ -9,10 +9,10 @@ const klaw_1 = __importDefault(require("klaw"));
 const path_1 = __importDefault(require("path"));
 const prettier_1 = __importDefault(require("prettier"));
 /**
- *
  * @param basePath -
  * @param srcPath -
  * @param ci -
+ * @returns true if the prettify src process was successful
  */
 async function prettifySrc(basePath, srcPath, ci) {
     console.log("Prettier - started on src");
@@ -48,9 +48,9 @@ async function prettifySrc(basePath, srcPath, ci) {
 }
 exports.prettifySrc = prettifySrc;
 /**
- *
  * @param basePath -
  * @param ci -
+ * @returns true if the prettify readme process was successful
  */
 async function prettifyReadme(basePath, ci) {
     console.log("Prettier - started on README.md");
@@ -80,9 +80,9 @@ async function prettifyReadme(basePath, ci) {
 }
 exports.prettifyReadme = prettifyReadme;
 /**
- *
  * @param basePath -
  * @param ci -
+ * @returns true if the prettify traductions process was successful
  */
 async function prettifyTraductions(basePath, ci) {
     console.log("Prettier - started on traductions");
@@ -122,9 +122,9 @@ async function prettifyTraductions(basePath, ci) {
     return res;
 }
 /**
- *
  * @param basePath -
  * @param ci -
+ * @returns true if the prettify markdown typedoc files process was successful
  */
 async function prettifyMarkdownTypeDocFiles(basePath, ci) {
     console.log("Prettier - started on markdown");

package/dist/build/build-tsc.js

@@ -8,9 +8,9 @@ const fs_extra_1 = __importDefault(require("fs-extra"));
 const path_1 = __importDefault(require("path"));
 const typescript_1 = __importDefault(require("typescript"));
 /**
- *
  * @param basePath -
  * @param file -
+ * @returns the file content or undefined if the file doesn't exist
  */
 async function readConfig(basePath, file) {
     const tsconfigPath = path_1.default.join(basePath, file);
@@ -21,9 +21,9 @@ async function readConfig(basePath, file) {
     return;
 }
 /**
- *
  * @param basePath -
  * @param type -
+ * @returns the exit code
  */
 async function compile(basePath, type) {
     let options, data;
@@ -124,8 +124,8 @@ async function compile(basePath, type) {
     return exitCode;
 }
 /**
- *
  * @param basePath -
+ * @returns true if the build was successful
  */
 async function buildTS(basePath) {
     console.log("Building TS files");

package/dist/build/build.js

@@ -1,4 +1,3 @@
-#!/usr/bin/env node
 "use strict";
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
@@ -12,6 +11,7 @@ const build_tsc_1 = require("./build-tsc");
 const build_bundle_1 = require("./build-bundle");
 const build_clear_1 = require("./build-clear");
 const fs_extra_1 = __importDefault(require("fs-extra"));
+const build_diststats_1 = require("./build-diststats");
 const build_eslint_1 = require("./build-eslint");
 const path_1 = __importDefault(require("path"));
 const buildCommand = new commander_1.Command("build");
@@ -29,6 +29,7 @@ buildCommand.argument("[path]", `Path to the project root folder, default is "sr
 buildCommand.action(async (argPath) => {
     const opts = buildCommand.opts(), ci = !!opts.ci, all = !!opts.all, doBundle = all || !!opts.bundle, clean = all || !!opts.clean, distfiles = all || !!opts.dist, doLint = all || !!opts.lint, prettier = all || !!opts.prettify, tsc = all || !!opts.tsc;
     const basePath = process.cwd();
+    const oldStats = await (0, build_diststats_1.getDistStats)(path_1.default.join(basePath, "dist"));
     if (clean) {
         await (0, build_clear_1.clearDist)(basePath);
     }
@@ -58,4 +59,13 @@ buildCommand.action(async (argPath) => {
     if (!canContinue) {
         throw new Error("Build failed");
     }
+    const newStats = await (0, build_diststats_1.getDistStats)(path_1.default.join(basePath, "dist")), diffSize = newStats.totalSize - oldStats.totalSize, texts = [
+        `Size changed from ${oldStats.totalSize} to ${newStats.totalSize} (${diffSize}B)`,
+        `Files count changed from ${oldStats.totalFiles} to ${newStats.totalFiles} (${newStats.totalFiles - oldStats.totalFiles})`,
+        `Folders count changed from ${oldStats.totalFolders} to ${newStats.totalFolders} (${newStats.totalFolders - oldStats.totalFolders})`,
+    ], sizeIncreased = diffSize > 0, outputFunc = sizeIncreased ? console.warn : console.info;
+    console.log("Build finished successfully!");
+    for (const text of texts) {
+        outputFunc(text);
+    }
 });

package/dist/create/create.js

@@ -1,4 +1,3 @@
-#!/usr/bin/env node
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createCommand = void 0;

package/dist/create/preset/create-preset.js

@@ -9,51 +9,51 @@ const template_utils_1 = require("../../utils/template-utils");
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const path_1 = __importDefault(require("path"));
 /**
- *
- * @param destPath -
- * @param name -
+ * Updates the bundle file with the correct function name
+ * @param destPath - The path where the project is located
+ * @param name - The name of the project
  */
 async function updateBundleFile(destPath, name) {
     const bundlePath = path_1.default.resolve(destPath, "src", "bundle.ts"), bundle = await fs_extra_1.default.readFile(bundlePath, "utf-8"), capitalizedName = (0, string_utils_1.capitalize)((0, string_utils_1.capitalize)(name, "-"), " "), bundleRegex = /loadTemplatePreset/g, replacedText = bundle.replace(bundleRegex, `load${capitalizedName}Preset`);
     await fs_extra_1.default.writeFile(bundlePath, replacedText);
 }
 /**
- *
- * @param destPath -
- * @param name -
+ * 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, name) {
     const indexPath = path_1.default.resolve(destPath, "src", "index.ts"), index = await fs_extra_1.default.readFile(indexPath, "utf-8"), capitalizedName = (0, string_utils_1.capitalize)((0, string_utils_1.capitalize)(name, "-"), " "), camelizedName = (0, string_utils_1.camelize)(capitalizedName), indexFunctionRegex = /loadTemplatePreset/g, replacedFuncText = index.replace(indexFunctionRegex, `load${capitalizedName}Preset`), indexNameRegex = /"#template#"/g, replacedNameText = replacedFuncText.replace(indexNameRegex, `"${camelizedName}"`);
     await fs_extra_1.default.writeFile(indexPath, replacedNameText);
 }
 /**
- *
- * @param destPath -
- * @param name -
- * @param description -
- * @param repoUrl -
+ * Updates the preset 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 updatePresetPackageFile(destPath, name, description, repoUrl) {
     const camelizedName = (0, string_utils_1.camelize)((0, string_utils_1.camelize)(name, "-"), " "), dashedName = (0, string_utils_1.dash)(camelizedName);
     (0, template_utils_1.updatePackageFile)(destPath, `"tsparticles-preset-${dashedName}"`, description, `"tsparticles.preset.${camelizedName}.min.js"`, repoUrl);
 }
 /**
- *
- * @param destPath -
- * @param name -
- * @param description -
- * @param repoUrl -
+ * Updates the preset 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 updatePresetPackageDistFile(destPath, name, description, repoUrl) {
     const camelizedName = (0, string_utils_1.camelize)((0, string_utils_1.camelize)(name, "-"), " "), dashedName = (0, string_utils_1.dash)(camelizedName);
     (0, template_utils_1.updatePackageDistFile)(destPath, `"tsparticles-preset-${dashedName}"`, description, `"tsparticles.preset.${camelizedName}.min.js"`, repoUrl);
 }
 /**
- *
- * @param destPath -
- * @param name -
- * @param description -
- * @param repoUrl -
+ * Updates the preset 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, name, description, repoUrl) {
     const readmePath = path_1.default.resolve(destPath, "README.md"), readme = await fs_extra_1.default.readFile(readmePath, "utf-8"), capitalizedName = (0, string_utils_1.capitalize)((0, string_utils_1.capitalize)(name, "-"), " "), camelizedName = (0, string_utils_1.camelize)(capitalizedName), dashedName = (0, string_utils_1.dash)(camelizedName), readmeDescriptionRegex = /tsParticles Template Preset/g, replacedDescriptionText = readme.replace(readmeDescriptionRegex, `tsParticles ${description} Preset`), readmePackageNameRegex = /tsparticles-preset-template/g, replacedPackageNameText = replacedDescriptionText.replace(readmePackageNameRegex, `tsparticles-preset-${dashedName}`), readmeFileNameRegex = /tsparticles\.preset\.template(\.bundle)?\.min\.js/g, replacedFileNameText = replacedPackageNameText.replace(readmeFileNameRegex, `tsparticles.preset.${camelizedName}$1.min.js`), readmeFunctionNameRegex = /loadTemplatePreset/g, replacedFunctionNameText = replacedFileNameText.replace(readmeFunctionNameRegex, `load${capitalizedName}Preset`), readmeMiniDescriptionRegex = /\[tsParticles\]\(https:\/\/github.com\/matteobruni\/tsparticles\) preset template\./g, replacedMiniDescriptionText = replacedFunctionNameText.replace(readmeMiniDescriptionRegex, `[tsParticles](https://github.com/matteobruni/tsparticles) preset ${name}.`), readmeUsageRegex = /preset: "template"/g, replacedUsageText = replacedMiniDescriptionText.replace(readmeUsageRegex, `preset: "${camelizedName}`), sampleImageRegex = /!\[demo\]\(https:\/\/raw.githubusercontent.com\/tsparticles\/preset-template\/main\/images\/sample.png\)/g, repoPath = repoUrl.includes("github.com")
@@ -62,20 +62,20 @@ async function updateReadmeFile(destPath, name, description, repoUrl) {
     await fs_extra_1.default.writeFile(readmePath, replacedText);
 }
 /**
- *
- * @param destPath -
- * @param name -
- * @param description -
+ * Updates the preset 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 updatePresetWebpackFile(destPath, name, description) {
     await (0, template_utils_1.updateWebpackFile)(destPath, (0, string_utils_1.camelize)((0, string_utils_1.capitalize)((0, string_utils_1.capitalize)(name, "-"), " ")), `tsParticles ${description} Preset`, "loadParticlesPreset");
 }
 /**
- *
- * @param name -
- * @param description -
- * @param repoUrl -
- * @param destPath -
+ * Creates the preset 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
  */
 async function createPresetTemplate(name, description, repoUrl, destPath) {
     const sourcePath = path_1.default.resolve(__dirname, "..", "..", "..", "files", "create-preset");

package/dist/create/preset/preset.js

@@ -1,4 +1,3 @@
-#!/usr/bin/env node
 "use strict";
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };

package/dist/utils/string-utils.js

@@ -2,40 +2,33 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.dash = exports.camelize = exports.capitalize = void 0;
 /**
- *
- * @param str -
- * @param split -
+ * This function is used to capitalize a string.
+ * @param str - the string to capitalize (e.g. "my-string" -\> "MyString")
+ * @param split - the character used to split the string, if not provided the string will be considered a single word
  * @returns the capitalized string
  */
 function capitalize(str, split) {
-    if (split) {
-        return str
-            .split(split)
-            .map(token => capitalize(token))
-            .join("");
-    }
-    else {
-        return str.replace(/./, c => c.toUpperCase());
-    }
+    const words = split ? str.split(split) : [str];
+    return words.map(w => w.replace(/./, c => c.toUpperCase())).join("");
 }
 exports.capitalize = capitalize;
 /**
- *
- * @param str -
- * @param split -
+ * This function is used to camelcase a string.
+ * @param str - the string to camelcase (e.g. "my-string" -\> "myString")
+ * @param split - the character used to split the string, if not provided the string will be considered a single word
  * @returns the camelized string
  */
 function camelize(str, split) {
-    const capitalized = capitalize(str, split);
-    return capitalized.replace(/./, c => c.toLowerCase());
+    return capitalize(str, split).replace(/./, c => c.toLowerCase());
 }
 exports.camelize = camelize;
 /**
- *
- * @param str -
+ * This function is used to dash a string.
+ * @param str - the string to dash (e.g. "myString" -\> "my-string")
  * @returns the dashed string
  */
 function dash(str) {
-    return str.replace(/[A-Z]/g, c => `-${c.toLowerCase()}`);
+    const dashed = str.replace(/([A-Z])/g, g => `-${g[0].toLowerCase()}`);
+    return dashed.startsWith("-") ? dashed.substring(1) : dashed;
 }
 exports.dash = dash;

package/dist/utils/template-utils.js

@@ -8,12 +8,12 @@ const child_process_1 = require("child_process");
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const path_1 = __importDefault(require("path"));
 /**
- *
- * @param destPath -
- * @param packageName -
- * @param description -
- * @param fileName -
- * @param repoUrl -
+ * 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
  */
 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")}"`);
@@ -21,12 +21,12 @@ async function updatePackageFile(destPath, packageName, description, fileName, r
 }
 exports.updatePackageFile = updatePackageFile;
 /**
- *
- * @param destPath -
- * @param packageName -
- * @param description -
- * @param fileName -
- * @param repoUrl -
+ * 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
  */
 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")}"`);
@@ -34,11 +34,11 @@ async function updatePackageDistFile(destPath, packageName, description, fileNam
 }
 exports.updatePackageDistFile = updatePackageDistFile;
 /**
- *
- * @param destPath -
- * @param name -
- * @param description -
- * @param fnName -
+ * 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
  */
 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);
@@ -46,8 +46,8 @@ async function updateWebpackFile(destPath, name, description, fnName) {
 }
 exports.updateWebpackFile = updateWebpackFile;
 /**
- *
- * @param destPath -
+ * Copies the empty template files to the destination path
+ * @param destPath - The path where the project will be created
  */
 async function copyEmptyTemplateFiles(destPath) {
     const emptyPath = path_1.default.resolve(__dirname, "..", "..", "files", "empty-project");
@@ -58,8 +58,8 @@ async function copyEmptyTemplateFiles(destPath) {
 }
 exports.copyEmptyTemplateFiles = copyEmptyTemplateFiles;
 /**
- *
- * @param src -
+ * Filters the files to copy
+ * @param src - The source file path
  * @returns true if the file should be copied
  */
 function copyFilter(src) {
@@ -70,8 +70,8 @@ function copyFilter(src) {
 }
 exports.copyFilter = copyFilter;
 /**
- *
- * @param destPath -
+ * Runs npm install in the given path
+ * @param destPath - The path where the project will be created
  */
 function runInstall(destPath) {
     (0, child_process_1.execSync)("npm install", {
@@ -80,8 +80,8 @@ function runInstall(destPath) {
 }
 exports.runInstall = runInstall;
 /**
- *
- * @param destPath -
+ * Runs npm run build in the given path
+ * @param destPath - The path where the project will be build
  */
 function runBuild(destPath) {
     (0, child_process_1.execSync)("npm run build", {

package/files/empty-project/package.json

@@ -83,14 +83,14 @@
     "prettier": "@tsparticles/prettier-config",
     "devDependencies": {
         "@babel/core": "^7.21.4",
-        "@tsparticles/cli": "^1.0.0",
-        "@tsparticles/eslint-config": "^1.10.0",
-        "@tsparticles/prettier-config": "^1.8.0",
-        "@tsparticles/tsconfig": "^1.11.0",
-        "@tsparticles/webpack-plugin": "^1.12.0",
+        "@tsparticles/cli": "^1.2.0",
+        "@tsparticles/eslint-config": "^1.11.0",
+        "@tsparticles/prettier-config": "^1.9.0",
+        "@tsparticles/tsconfig": "^1.12.0",
+        "@tsparticles/webpack-plugin": "^1.13.0",
         "@types/webpack-env": "^1.18.0",
-        "@typescript-eslint/eslint-plugin": "^5.58.0",
-        "@typescript-eslint/parser": "^5.58.0",
+        "@typescript-eslint/eslint-plugin": "^5.59.0",
+        "@typescript-eslint/parser": "^5.59.0",
         "babel-loader": "^9.1.2",
         "browserslist": "^4.21.5",
         "copyfiles": "^2.4.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsparticles/cli",
-  "version": "1.1.1",
+  "version": "1.3.0",
   "license": "MIT",
   "bin": {
     "tsparticles-cli": "dist/cli.js"
@@ -10,16 +10,16 @@
   },
   "prettier": "@tsparticles/prettier-config",
   "dependencies": {
-    "@tsparticles/eslint-config": "^1.10.0",
-    "@tsparticles/prettier-config": "^1.8.0",
-    "@tsparticles/tsconfig": "^1.11.0",
-    "@tsparticles/webpack-plugin": "^1.12.0",
-    "@typescript-eslint/eslint-plugin": "^5.58.0",
-    "@typescript-eslint/parser": "^5.58.0",
-    "commander": "^10.0.0",
+    "@tsparticles/eslint-config": "^1.11.0",
+    "@tsparticles/prettier-config": "^1.9.0",
+    "@tsparticles/tsconfig": "^1.12.0",
+    "@tsparticles/webpack-plugin": "^1.13.0",
+    "@typescript-eslint/eslint-plugin": "^5.59.0",
+    "@typescript-eslint/parser": "^5.59.0",
+    "commander": "^10.0.1",
     "eslint": "^8.38.0",
     "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-jsdoc": "^41.1.1",
+    "eslint-plugin-jsdoc": "^44.0.0",
     "eslint-plugin-tsdoc": "^0.2.17",
     "fs-extra": "^11.1.1",
     "klaw": "^4.1.0",

package/src/build/build-bundle.ts

@@ -2,8 +2,8 @@ import path from "path";
 import webpack from "webpack";
 
 /**
- *
  * @param basePath -
+ * @returns true if the bundle was created
  */
 export async function bundle(basePath: string): Promise<boolean> {
     console.log("Bundling started");

package/src/build/build-clear.ts

@@ -2,8 +2,8 @@ import path from "path";
 import { rimraf } from "rimraf";
 
 /**
- *
  * @param basePath -
+ * @returns true if the dist folder was cleared
  */
 export async function clearDist(basePath: string): Promise<boolean> {
     console.log("Clearing dist folder");

package/src/build/build-distfiles.ts

@@ -3,8 +3,8 @@ import klaw from "klaw";
 import path from "path";
 
 /**
- *
  * @param basePath -
+ * @returns true if the dist files process was successful
  */
 export async function buildDistFiles(basePath: string): Promise<boolean> {
     console.log("Build - started on dist files");

package/src/build/build-diststats.ts

@@ -0,0 +1,48 @@
+import fs from "fs-extra";
+import path from "path";
+
+export interface IDistStats {
+    totalFiles: number;
+    totalFolders: number;
+    totalSize: number;
+}
+
+/**
+ * @param folderPath - the path to the folder to get the stats for
+ * @returns the given folder stats;
+ */
+async function getFolderStats(folderPath: string): Promise<IDistStats> {
+    const stats: IDistStats = {
+        totalFiles: 0,
+        totalFolders: 0,
+        totalSize: 0,
+    };
+
+    const dir = await fs.promises.opendir(folderPath);
+
+    for await (const dirent of dir) {
+        if (dirent.isDirectory()) {
+            const subDirStats = await getDistStats(path.join(folderPath, dirent.name));
+
+            stats.totalFolders += subDirStats.totalFolders + 1;
+            stats.totalFiles += subDirStats.totalFiles;
+            stats.totalSize += subDirStats.totalSize;
+        } else {
+            const fileStats = await fs.stat(path.join(folderPath, dirent.name));
+
+            stats.totalFiles++;
+            stats.totalSize += fileStats.size;
+        }
+    }
+
+    return stats;
+}
+
+/**
+ * Gets the stats for the dist folder
+ * @param basePath - the base path to the project
+ * @returns the stats for the dist folder
+ */
+export async function getDistStats(basePath: string): Promise<IDistStats> {
+    return await getFolderStats(path.join(basePath, "dist"));
+}

package/src/build/build-eslint.ts

@@ -1,8 +1,8 @@
 import { ESLint } from "eslint";
 
 /**
- *
  * @param ci -
+ * @returns true if the linting was successful
  */
 export async function lint(ci: boolean): Promise<boolean> {
     console.log("ESLint - started on src");

package/src/build/build-prettier.ts

@@ -4,10 +4,10 @@ import path from "path";
 import prettier from "prettier";
 
 /**
- *
  * @param basePath -
  * @param srcPath -
  * @param ci -
+ * @returns true if the prettify src process was successful
  */
 export async function prettifySrc(basePath: string, srcPath: string, ci: boolean): Promise<boolean> {
     console.log("Prettier - started on src");
@@ -52,9 +52,9 @@ export async function prettifySrc(basePath: string, srcPath: string, ci: boolean
 }
 
 /**
- *
  * @param basePath -
  * @param ci -
+ * @returns true if the prettify readme process was successful
  */
 export async function prettifyReadme(basePath: string, ci: boolean): Promise<boolean> {
     console.log("Prettier - started on README.md");
@@ -92,9 +92,9 @@ export async function prettifyReadme(basePath: string, ci: boolean): Promise<boo
 }
 
 /**
- *
  * @param basePath -
  * @param ci -
+ * @returns true if the prettify traductions process was successful
  */
 async function prettifyTraductions(basePath: string, ci: boolean): Promise<boolean> {
     console.log("Prettier - started on traductions");
@@ -147,9 +147,9 @@ async function prettifyTraductions(basePath: string, ci: boolean): Promise<boole
 }
 
 /**
- *
  * @param basePath -
  * @param ci -
+ * @returns true if the prettify markdown typedoc files process was successful
  */
 async function prettifyMarkdownTypeDocFiles(basePath: string, ci: boolean): Promise<boolean> {
     console.log("Prettier - started on markdown");

package/src/build/build-tsc.ts

@@ -3,9 +3,9 @@ import path from "path";
 import ts from "typescript";
 
 /**
- *
  * @param basePath -
  * @param file -
+ * @returns the file content or undefined if the file doesn't exist
  */
 async function readConfig(basePath: string, file: string): Promise<string | undefined> {
     const tsconfigPath = path.join(basePath, file);
@@ -20,9 +20,9 @@ async function readConfig(basePath: string, file: string): Promise<string | unde
 }
 
 /**
- *
  * @param basePath -
  * @param type -
+ * @returns the exit code
  */
 async function compile(basePath: string, type: "browser" | "cjs" | "esm" | "types" | "umd"): Promise<number> {
     let options: unknown, data: string | undefined;
@@ -150,8 +150,8 @@ async function compile(basePath: string, type: "browser" | "cjs" | "esm" | "type
 }
 
 /**
- *
  * @param basePath -
+ * @returns true if the build was successful
  */
 export async function buildTS(basePath: string): Promise<boolean> {
     console.log("Building TS files");

package/src/build/build.ts

@@ -1,4 +1,3 @@
-#!/usr/bin/env node
 import { prettifyReadme, prettifySrc } from "./build-prettier";
 import { Command } from "commander";
 import { buildDistFiles } from "./build-distfiles";
@@ -6,6 +5,7 @@ import { buildTS } from "./build-tsc";
 import { bundle } from "./build-bundle";
 import { clearDist } from "./build-clear";
 import fs from "fs-extra";
+import { getDistStats } from "./build-diststats";
 import { lint } from "./build-eslint";
 import path from "path";
 
@@ -43,6 +43,8 @@ buildCommand.action(async (argPath: string) => {
 
     const basePath = process.cwd();
 
+    const oldStats = await getDistStats(path.join(basePath, "dist"));
+
     if (clean) {
         await clearDist(basePath);
     }
@@ -82,6 +84,26 @@ buildCommand.action(async (argPath: string) => {
     if (!canContinue) {
         throw new Error("Build failed");
     }
+
+    const newStats = await getDistStats(path.join(basePath, "dist")),
+        diffSize = newStats.totalSize - oldStats.totalSize,
+        texts = [
+            `Size changed from ${oldStats.totalSize} to ${newStats.totalSize} (${diffSize}B)`,
+            `Files count changed from ${oldStats.totalFiles} to ${newStats.totalFiles} (${
+                newStats.totalFiles - oldStats.totalFiles
+            })`,
+            `Folders count changed from ${oldStats.totalFolders} to ${newStats.totalFolders} (${
+                newStats.totalFolders - oldStats.totalFolders
+            })`,
+        ],
+        sizeIncreased = diffSize > 0,
+        outputFunc = sizeIncreased ? console.warn : console.info;
+
+    console.log("Build finished successfully!");
+
+    for (const text of texts) {
+        outputFunc(text);
+    }
 });
 
 export { buildCommand };

package/src/create/create.ts

@@ -1,4 +1,3 @@
-#!/usr/bin/env node
 import { Command } from "commander";
 import { presetCommand } from "./preset/preset";
 

package/src/create/preset/create-preset.ts

@@ -12,9 +12,9 @@ import fs from "fs-extra";
 import path from "path";
 
 /**
- *
- * @param destPath -
- * @param name -
+ * Updates the bundle file with the correct function name
+ * @param destPath - The path where the project is located
+ * @param name - The name of the project
  */
 async function updateBundleFile(destPath: string, name: string): Promise<void> {
     const bundlePath = path.resolve(destPath, "src", "bundle.ts"),
@@ -27,9 +27,9 @@ async function updateBundleFile(destPath: string, name: string): Promise<void> {
 }
 
 /**
- *
- * @param destPath -
- * @param name -
+ * 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"),
@@ -45,11 +45,11 @@ async function updateIndexFile(destPath: string, name: string): Promise<void> {
 }
 
 /**
- *
- * @param destPath -
- * @param name -
- * @param description -
- * @param repoUrl -
+ * Updates the preset 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 updatePresetPackageFile(
     destPath: string,
@@ -70,11 +70,11 @@ async function updatePresetPackageFile(
 }
 
 /**
- *
- * @param destPath -
- * @param name -
- * @param description -
- * @param repoUrl -
+ * Updates the preset 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 updatePresetPackageDistFile(
     destPath: string,
@@ -95,11 +95,11 @@ async function updatePresetPackageDistFile(
 }
 
 /**
- *
- * @param destPath -
- * @param name -
- * @param description -
- * @param repoUrl -
+ * Updates the preset 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"),
@@ -146,10 +146,10 @@ async function updateReadmeFile(destPath: string, name: string, description: str
 }
 
 /**
- *
- * @param destPath -
- * @param name -
- * @param description -
+ * Updates the preset 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 updatePresetWebpackFile(destPath: string, name: string, description: string): Promise<void> {
     await updateWebpackFile(
@@ -161,11 +161,11 @@ async function updatePresetWebpackFile(destPath: string, name: string, descripti
 }
 
 /**
- *
- * @param name -
- * @param description -
- * @param repoUrl -
- * @param destPath -
+ * Creates the preset 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 createPresetTemplate(
     name: string,

package/src/create/preset/preset.ts

@@ -1,4 +1,3 @@
-#!/usr/bin/env node
 import prompts, { type PromptObject } from "prompts";
 import { Command } from "commander";
 import { capitalize } from "../../utils/string-utils";

package/src/utils/string-utils.ts

@@ -1,37 +1,32 @@
 /**
- *
- * @param str -
- * @param split -
+ * This function is used to capitalize a string.
+ * @param str - the string to capitalize (e.g. "my-string" -\> "MyString")
+ * @param split - the character used to split the string, if not provided the string will be considered a single word
  * @returns the capitalized string
  */
 export function capitalize(str: string, split?: string): string {
-    if (split) {
-        return str
-            .split(split)
-            .map(token => capitalize(token))
-            .join("");
-    } else {
-        return str.replace(/./, c => c.toUpperCase());
-    }
+    const words = split ? str.split(split) : [str];
+
+    return words.map(w => w.replace(/./, c => c.toUpperCase())).join("");
 }
 
 /**
- *
- * @param str -
- * @param split -
+ * This function is used to camelcase a string.
+ * @param str - the string to camelcase (e.g. "my-string" -\> "myString")
+ * @param split - the character used to split the string, if not provided the string will be considered a single word
  * @returns the camelized string
  */
 export function camelize(str: string, split?: string): string {
-    const capitalized = capitalize(str, split);
-
-    return capitalized.replace(/./, c => c.toLowerCase());
+    return capitalize(str, split).replace(/./, c => c.toLowerCase());
 }
 
 /**
- *
- * @param str -
+ * This function is used to dash a string.
+ * @param str - the string to dash (e.g. "myString" -\> "my-string")
  * @returns the dashed string
  */
 export function dash(str: string): string {
-    return str.replace(/[A-Z]/g, c => `-${c.toLowerCase()}`);
+    const dashed = str.replace(/([A-Z])/g, g => `-${g[0].toLowerCase()}`);
+
+    return dashed.startsWith("-") ? dashed.substring(1) : dashed;
 }

package/src/utils/template-utils.ts

@@ -3,12 +3,12 @@ import fs from "fs-extra";
 import path from "path";
 
 /**
- *
- * @param destPath -
- * @param packageName -
- * @param description -
- * @param fileName -
- * @param repoUrl -
+ * 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 async function updatePackageFile(
     destPath: string,
@@ -36,12 +36,12 @@ export async function updatePackageFile(
 }
 
 /**
- *
- * @param destPath -
- * @param packageName -
- * @param description -
- * @param fileName -
- * @param repoUrl -
+ * 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 async function updatePackageDistFile(
     destPath: string,
@@ -69,11 +69,11 @@ export async function updatePackageDistFile(
 }
 
 /**
- *
- * @param destPath -
- * @param name -
- * @param description -
- * @param fnName -
+ * 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,
@@ -94,8 +94,8 @@ export async function updateWebpackFile(
 }
 
 /**
- *
- * @param destPath -
+ * Copies the empty template files to the destination path
+ * @param destPath - The path where the project will be created
  */
 export async function copyEmptyTemplateFiles(destPath: string): Promise<void> {
     const emptyPath = path.resolve(__dirname, "..", "..", "files", "empty-project");
@@ -107,8 +107,8 @@ export async function copyEmptyTemplateFiles(destPath: string): Promise<void> {
 }
 
 /**
- *
- * @param src -
+ * Filters the files to copy
+ * @param src - The source file path
  * @returns true if the file should be copied
  */
 export function copyFilter(src: string): boolean {
@@ -120,8 +120,8 @@ export function copyFilter(src: string): boolean {
 }
 
 /**
- *
- * @param destPath -
+ * Runs npm install in the given path
+ * @param destPath - The path where the project will be created
  */
 export function runInstall(destPath: string): void {
     execSync("npm install", {
@@ -130,8 +130,8 @@ export function runInstall(destPath: string): void {
 }
 
 /**
- *
- * @param destPath -
+ * Runs npm run build in the given path
+ * @param destPath - The path where the project will be build
  */
 export function runBuild(destPath: string): void {
     execSync("npm run build", {