@tsparticles/cli 3.1.7 → 3.2.0

package/src/build/build-bundle.ts

@@ -3,10 +3,13 @@ import webpack from "webpack";
 
 /**
  * @param basePath -
+ * @param silent -
  * @returns true if the bundle was created
  */
-export async function bundle(basePath: string): Promise<boolean> {
-  console.log("Bundling started");
+export async function bundle(basePath: string, silent: boolean): Promise<boolean> {
+  if (!silent) {
+    console.log("Bundling started");
+  }
 
   let res = false;
 
@@ -54,7 +57,9 @@ export async function bundle(basePath: string): Promise<boolean> {
     res = false;
   }
 
-  console.log("Bundling done");
+  if (!silent) {
+    console.log("Bundling done");
+  }
 
   return res;
 }

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

@@ -7,9 +7,10 @@ const ZERO_VIOLATIONS = 0;
 /**
  * Checks for circular dependencies using dependency-cruiser
  * @param basePath - The project root path
+ * @param silent - If true, reduces the amount of output during the check
  * @returns true if no circular dependencies are found, false otherwise
  */
-export async function buildCircularDeps(basePath: string): Promise<boolean> {
+export async function buildCircularDeps(basePath: string, silent: boolean): Promise<boolean> {
   const srcPath = path.join(basePath, "src"),
     cruiseOptions = await loadDependencyCruiserConfig(basePath);
 
@@ -35,7 +36,9 @@ export async function buildCircularDeps(basePath: string): Promise<boolean> {
       return false;
     }
 
-    console.log("✅ No circular dependencies found.");
+    if (!silent) {
+      console.log("✅ No circular dependencies found.");
+    }
 
     return true;
   } catch (e) {
@@ -43,6 +46,8 @@ export async function buildCircularDeps(basePath: string): Promise<boolean> {
 
     return false;
   } finally {
-    console.log("Finished checking circular dependencies.");
+    if (!silent) {
+      console.log("Finished checking circular dependencies.");
+    }
   }
 }

package/src/build/build-clear.ts

@@ -3,10 +3,13 @@ import { rimraf } from "rimraf";
 
 /**
  * @param basePath -
+ * @param silent -
  * @returns true if the dist folder was cleared
  */
-export async function clearDist(basePath: string): Promise<boolean> {
-  console.log("Clearing dist folder");
+export async function clearDist(basePath: string, silent: boolean): Promise<boolean> {
+  if (!silent) {
+    console.log("Clearing dist folder");
+  }
 
   let res = false;
 
@@ -20,7 +23,9 @@ export async function clearDist(basePath: string): Promise<boolean> {
     res = false;
   }
 
-  console.log("Clearing dist folder done");
+  if (!silent) {
+    console.log("Clearing dist folder done");
+  }
 
   return res;
 }

package/src/build/build-distfiles.ts

@@ -4,10 +4,13 @@ import path from "node:path";
 
 /**
  * @param basePath -
+ * @param silent -
  * @returns true if the dist files process was successful
  */
-export async function buildDistFiles(basePath: string): Promise<boolean> {
-  console.log("Build - started on dist files");
+export async function buildDistFiles(basePath: string, silent: boolean): Promise<boolean> {
+  if (!silent) {
+    console.log("Build - started on dist files");
+  }
 
   let res: boolean;
 
@@ -36,7 +39,9 @@ export async function buildDistFiles(basePath: string): Promise<boolean> {
 
     await fs.writeFile(libPackage, `${JSON.stringify(libObj, undefined, jsonIndent)}\n`, "utf8");
 
-    console.log(`package.dist.json updated successfully to version ${pkgInfo.version}`);
+    if (!silent) {
+      console.log(`package.dist.json updated successfully to version ${pkgInfo.version}`);
+    }
 
     const rootFilesToCopy = [
       "LICENSE",
@@ -96,7 +101,9 @@ export async function buildDistFiles(basePath: string): Promise<boolean> {
     res = false;
   }
 
-  console.log("Build - done on dist files");
+  if (!silent) {
+    console.log("Build - done on dist files");
+  }
 
   return res;
 }

package/src/build/build-eslint.ts

@@ -2,10 +2,13 @@ import { ESLint } from "eslint";
 
 /**
  * @param ci -
+ * @param silent -
  * @returns true if the linting was successful
  */
-export async function lint(ci: boolean): Promise<boolean> {
-  console.log("ESLint - started on src");
+export async function lint(ci: boolean, silent: boolean): Promise<boolean> {
+  if (!silent) {
+    console.log("ESLint - started on src");
+  }
 
   let res: boolean;
 
@@ -39,7 +42,9 @@ export async function lint(ci: boolean): Promise<boolean> {
     res = false;
   }
 
-  console.log("ESLint - done on src");
+  if (!silent) {
+    console.log("ESLint - done on src");
+  }
 
   return res;
 }

package/src/build/build-prettier.ts

@@ -7,10 +7,13 @@ import prettier from "prettier";
  * @param basePath -
  * @param srcPath -
  * @param ci -
+ * @param silent -
  * @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");
+export async function prettifySrc(basePath: string, srcPath: string, ci: boolean, silent: boolean): Promise<boolean> {
+  if (!silent) {
+    console.log("Prettier - started on src");
+  }
 
   let res: boolean;
 
@@ -47,7 +50,9 @@ export async function prettifySrc(basePath: string, srcPath: string, ci: boolean
     res = false;
   }
 
-  console.log("Prettier - done on src");
+  if (!silent) {
+    console.log("Prettier - done on src");
+  }
 
   return res;
 }
@@ -55,10 +60,13 @@ export async function prettifySrc(basePath: string, srcPath: string, ci: boolean
 /**
  * @param basePath -
  * @param ci -
+ * @param silent -
  * @returns true if the prettify package.json process was successful
  */
-export async function prettifyPackageJson(basePath: string, ci: boolean): Promise<boolean> {
-  console.log("Prettier - started on package.json");
+export async function prettifyPackageJson(basePath: string, ci: boolean, silent: boolean): Promise<boolean> {
+  if (!silent) {
+    console.log("Prettier - started on package.json");
+  }
 
   let res: boolean;
 
@@ -88,7 +96,9 @@ export async function prettifyPackageJson(basePath: string, ci: boolean): Promis
     res = false;
   }
 
-  console.log("Prettier - done on package.json");
+  if (!silent) {
+    console.log("Prettier - done on package.json");
+  }
 
   return res;
 }
@@ -96,10 +106,13 @@ export async function prettifyPackageJson(basePath: string, ci: boolean): Promis
 /**
  * @param basePath -
  * @param _ci -
+ * @param silent -
  * @returns true if the prettify package.dist.json process was successful
  */
-export async function prettifyPackageDistJson(basePath: string, _ci: boolean): Promise<boolean> {
-  console.log("Prettier - started on package.dist.json");
+export async function prettifyPackageDistJson(basePath: string, _ci: boolean, silent: boolean): Promise<boolean> {
+  if (!silent) {
+    console.log("Prettier - started on package.dist.json");
+  }
 
   let res: boolean;
 
@@ -131,7 +144,9 @@ export async function prettifyPackageDistJson(basePath: string, _ci: boolean): P
     res = false;
   }
 
-  console.log("Prettier - done on package.dist.json");
+  if (!silent) {
+    console.log("Prettier - done on package.dist.json");
+  }
 
   return res;
 }
@@ -139,10 +154,13 @@ export async function prettifyPackageDistJson(basePath: string, _ci: boolean): P
 /**
  * @param basePath -
  * @param ci -
+ * @param silent -
  * @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");
+export async function prettifyReadme(basePath: string, ci: boolean, silent: boolean): Promise<boolean> {
+  if (!silent) {
+    console.log("Prettier - started on README.md");
+  }
 
   let res: boolean;
 
@@ -164,14 +182,17 @@ export async function prettifyReadme(basePath: string, ci: boolean): Promise<boo
       await fs.writeFile("README.md", formatted, "utf8");
     }
 
-    res = (await prettifyTraductions(basePath, ci)) && (await prettifyMarkdownTypeDocFiles(basePath, ci));
+    res =
+      (await prettifyTraductions(basePath, ci, silent)) && (await prettifyMarkdownTypeDocFiles(basePath, ci, silent));
   } catch (e) {
     console.error(e);
 
     res = false;
   }
 
-  console.log("Prettier - done on README.md");
+  if (!silent) {
+    console.log("Prettier - done on README.md");
+  }
 
   return res;
 }
@@ -179,10 +200,13 @@ export async function prettifyReadme(basePath: string, ci: boolean): Promise<boo
 /**
  * @param basePath -
  * @param ci -
+ * @param silent -
  * @returns true if the prettify traductions process was successful
  */
-async function prettifyTraductions(basePath: string, ci: boolean): Promise<boolean> {
-  console.log("Prettier - started on traductions");
+async function prettifyTraductions(basePath: string, ci: boolean, silent: boolean): Promise<boolean> {
+  if (!silent) {
+    console.log("Prettier - started on traductions");
+  }
 
   let res = false;
 
@@ -226,7 +250,9 @@ async function prettifyTraductions(basePath: string, ci: boolean): Promise<boole
     res = false;
   }
 
-  console.log("Prettier - done on traductions");
+  if (!silent) {
+    console.log("Prettier - done on traductions");
+  }
 
   return res;
 }
@@ -234,10 +260,13 @@ async function prettifyTraductions(basePath: string, ci: boolean): Promise<boole
 /**
  * @param basePath -
  * @param ci -
+ * @param silent -
  * @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");
+async function prettifyMarkdownTypeDocFiles(basePath: string, ci: boolean, silent: boolean): Promise<boolean> {
+  if (!silent) {
+    console.log("Prettier - started on markdown");
+  }
 
   let res = false;
 
@@ -281,7 +310,9 @@ async function prettifyMarkdownTypeDocFiles(basePath: string, ci: boolean): Prom
     res = false;
   }
 
-  console.log("Prettier - done on markdown");
+  if (!silent) {
+    console.log("Prettier - done on markdown");
+  }
 
   return res;
 }

package/src/build/build-tsc.ts

@@ -29,9 +29,14 @@ async function readConfig(basePath: string, file: string): Promise<string | unde
 /**
  * @param basePath -
  * @param type -
+ * @param silent -
  * @returns the exit code
  */
-async function compile(basePath: string, type: "browser" | "cjs" | "esm" | "types" | "umd"): Promise<number> {
+async function compile(
+  basePath: string,
+  type: "browser" | "cjs" | "esm" | "types" | "umd",
+  silent: boolean,
+): Promise<number> {
   let options: unknown, data: string | undefined;
 
   switch (type) {
@@ -156,26 +161,33 @@ async function compile(basePath: string, type: "browser" | "cjs" | "esm" | "type
 
   const exitCode = emitResult.emitSkipped || failed ? ExitCodes.EmitErrors : ExitCodes.OK;
 
-  console.log(`TSC for ${type} done with exit code: '${exitCode.toLocaleString()}'.`);
+  if (!silent || exitCode) {
+    console.log(`TSC for ${type} done with exit code: '${exitCode.toLocaleString()}'.`);
+  }
 
   return exitCode;
 }
 
 /**
  * @param basePath -
+ * @param silent -
  * @returns true if the build was successful
  */
-export async function buildTS(basePath: string): Promise<boolean> {
-  console.log("Building TS files");
+export async function buildTS(basePath: string, silent: boolean): Promise<boolean> {
+  if (!silent) {
+    console.log("Building TS files");
+  }
 
   let res = true;
 
   const types: ("browser" | "cjs" | "esm" | "types" | "umd")[] = ["browser", "cjs", "esm", "types", "umd"];
 
   for (const type of types) {
-    console.log(`Building TS files for ${type} configuration`);
+    if (!silent) {
+      console.log(`Building TS files for ${type} configuration`);
+    }
 
-    const exitCode = await compile(basePath, type);
+    const exitCode = await compile(basePath, type, silent);
 
     if (exitCode) {
       res = false;
@@ -184,7 +196,9 @@ export async function buildTS(basePath: string): Promise<boolean> {
     }
   }
 
-  console.log("Building TS files done");
+  if (!silent) {
+    console.log("Building TS files done");
+  }
 
   return res;
 }

package/src/build/build.ts

@@ -12,13 +12,18 @@ buildCommand.option("-b, --bundle", "Bundle the library using Webpack", false);
 buildCommand.option("-c, --clean", "Clean the dist folder", false);
 buildCommand.option(
   "--ci",
-  "Do all build steps for CI, no fixing files, only checking if they are formatted correctly",
+  "Do all build steps for CI, no fixing files, only checking if they are formatted correctly, sets silent to true by default",
   false,
 );
 buildCommand.option("-r, --circular-deps", "Check for circular dependencies", false);
 buildCommand.option("-d, --dist", "Build the dist files", false);
 buildCommand.option("-l, --lint", "Lint the source files", false);
 buildCommand.option("-p, --prettify", "Prettify the source files", false);
+buildCommand.option(
+  "-s, --silent <boolean>",
+  "Reduce the amount of output during the build, defaults to false, except when --ci is set",
+  false,
+);
 buildCommand.option("-t, --tsc", "Build the library using TypeScript", false);
 
 buildCommand.argument("[path]", `Path to the project root folder, default is "src"`, "src");
@@ -35,6 +40,7 @@ buildCommand.action(async (argPath: string) => {
     doLint = all || !!opts["lint"],
     prettier = all || !!opts["prettify"],
     tsc = all || !!opts["tsc"],
+    silent = !!opts["silent"] || ci,
     basePath = process.cwd(),
     { getDistStats } = await import("./build-diststats.js"),
     oldStats = await getDistStats(basePath);
@@ -42,7 +48,7 @@ buildCommand.action(async (argPath: string) => {
   if (clean) {
     const { clearDist } = await import("./build-clear.js");
 
-    await clearDist(basePath);
+    await clearDist(basePath, silent);
   }
 
   const path = await import("path"),
@@ -58,60 +64,66 @@ buildCommand.action(async (argPath: string) => {
   if (prettier) {
     const { prettifySrc } = await import("./build-prettier.js");
 
-    canContinue = await prettifySrc(basePath, srcPath, ci);
+    canContinue = await prettifySrc(basePath, srcPath, ci, silent);
   }
 
   if (canContinue && doLint) {
     const { lint } = await import("./build-eslint.js");
 
-    canContinue = await lint(ci);
+    canContinue = await lint(ci, silent);
   }
 
   if (canContinue && tsc) {
     const { buildTS } = await import("./build-tsc.js");
 
-    canContinue = await buildTS(basePath);
+    canContinue = await buildTS(basePath, silent);
   }
 
   if (canContinue && circularDeps) {
     const { buildCircularDeps } = await import("./build-circular-deps.js");
 
-    canContinue = await buildCircularDeps(basePath);
+    canContinue = await buildCircularDeps(basePath, silent);
   }
 
   if (canContinue && doBundle) {
     const { bundle } = await import("./build-bundle.js");
 
-    canContinue = await bundle(basePath);
+    canContinue = await bundle(basePath, silent);
   }
 
   if (canContinue && prettier) {
     const { prettifyReadme, prettifyPackageJson, prettifyPackageDistJson } = await import("./build-prettier.js");
 
     canContinue =
-      (await prettifyReadme(basePath, ci)) &&
-      (await prettifyPackageJson(basePath, ci)) &&
-      (await prettifyPackageDistJson(basePath, ci));
+      (await prettifyReadme(basePath, ci, silent)) &&
+      (await prettifyPackageJson(basePath, ci, silent)) &&
+      (await prettifyPackageDistJson(basePath, ci, silent));
   }
 
   if (canContinue && distfiles) {
     const { buildDistFiles } = await import("./build-distfiles.js");
 
-    canContinue = await buildDistFiles(basePath);
+    canContinue = await buildDistFiles(basePath, silent);
   }
 
   if (!canContinue) {
     throw new Error("Build failed");
   }
 
-  const newStats = await getDistStats(basePath),
-    diffSize = newStats.totalSize - oldStats.totalSize,
-    bundleDiffSize = newStats.bundleSize - oldStats.bundleSize,
-    minSize = 0,
-    bundleSizeIncreased = bundleDiffSize > minSize,
-    outputFunc = bundleSizeIncreased ? console.warn : console.info,
-    bundleSizeIncreasedText = bundleSizeIncreased ? "increased" : "decreased",
-    diffSizeIncreasedText = diffSize > minSize ? "increased" : "decreased",
+  let texts: string[] = [],
+    outputFunc = console.info;
+
+  if (!silent) {
+    const newStats = await getDistStats(basePath),
+      diffSize = newStats.totalSize - oldStats.totalSize,
+      bundleDiffSize = newStats.bundleSize - oldStats.bundleSize,
+      minSize = 0,
+      bundleSizeIncreased = bundleDiffSize > minSize,
+      bundleSizeIncreasedText = bundleSizeIncreased ? "increased" : "decreased",
+      diffSizeIncreasedText = diffSize > minSize ? "increased" : "decreased";
+
+    outputFunc = bundleSizeIncreased ? console.warn : console.info;
+
     texts = [
       !bundleDiffSize
         ? "Bundle size unchanged"
@@ -126,11 +138,14 @@ buildCommand.action(async (argPath: string) => {
         newStats.totalFolders - oldStats.totalFolders
       ).toString()})`,
     ];
+  }
 
   console.log("Build finished successfully!");
 
-  for (const text of texts) {
-    outputFunc(text);
+  if (!silent) {
+    for (const text of texts) {
+      outputFunc(text);
+    }
   }
 });