@tsparticles/cli 2.0.5 → 2.2.0

package/.github/workflows/node.js-ci.yml

@@ -35,7 +35,7 @@ jobs:
         run: |
           echo "::set-output name=pnpm_cache_dir::$(pnpm store path)"
 
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         name: Setup pnpm cache
         with:
           path: ${{ steps.pnpm-cache.outputs.pnpm_cache_dir }}
@@ -73,7 +73,7 @@ jobs:
         run: |
           echo "::set-output name=pnpm_cache_dir::$(pnpm store path)"
 
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         name: Setup pnpm cache
         with:
           path: ${{ steps.pnpm-cache.outputs.pnpm_cache_dir }}

package/dist/build/build-circular-deps.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildCircularDeps = void 0;
+const madge_1 = __importDefault(require("madge"));
+const path_1 = __importDefault(require("path"));
+/**
+ *
+ * @param basePath -
+ * @returns true if no circular dependencies are found, false otherwise
+ */
+async function buildCircularDeps(basePath) {
+    let res = false;
+    try {
+        const madgeRes = await (0, madge_1.default)(path_1.default.join(basePath, "src"), {
+            fileExtensions: ["ts"],
+            detectiveOptions: {
+                skipTypeImports: true,
+            },
+        }), circularDeps = madgeRes.circular();
+        if (circularDeps.length) {
+            throw new Error(`Circular dependencies found: ${circularDeps.join(", ")}`);
+        }
+        res = true;
+    }
+    catch (e) {
+        console.error(e);
+    }
+    console.log("Finished checking circular dependencies.");
+    return res;
+}
+exports.buildCircularDeps = buildCircularDeps;

package/dist/build/build.js

@@ -32,13 +32,14 @@ buildCommand.option("-a, --all", "Do all build steps (default if no flags are sp
 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", false);
+buildCommand.option("-cd, --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("-t, --tsc", "Build the library using TypeScript", false);
 buildCommand.argument("[path]", `Path to the project root folder, default is "src"`, "src");
 buildCommand.action(async (argPath) => {
-    const opts = buildCommand.opts(), ci = !!opts.ci, all = !!opts.all || (!opts.bundle && !opts.clean && !opts.dist && !opts.lint && !opts.prettify && !opts.tsc), 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 opts = buildCommand.opts(), ci = !!opts.ci, all = !!opts.all || (!opts.bundle && !opts.clean && !opts.dist && !opts.lint && !opts.prettify && !opts.tsc), doBundle = all || !!opts.bundle, circularDeps = all || !!opts.circularDeps, clean = all || !!opts.clean, distfiles = all || !!opts.dist, doLint = all || !!opts.lint, prettier = all || !!opts.prettify, tsc = all || !!opts.tsc;
     const basePath = process.cwd(), { getDistStats } = await Promise.resolve().then(() => __importStar(require("./build-diststats.js"))), oldStats = await getDistStats(basePath);
     if (clean) {
         const { clearDist } = await Promise.resolve().then(() => __importStar(require("./build-clear.js")));
@@ -61,6 +62,10 @@ buildCommand.action(async (argPath) => {
         const { buildTS } = await Promise.resolve().then(() => __importStar(require("./build-tsc.js")));
         canContinue = await buildTS(basePath);
     }
+    if (canContinue && circularDeps) {
+        const { buildCircularDeps } = await Promise.resolve().then(() => __importStar(require("./build-circular-deps.js")));
+        canContinue = await buildCircularDeps(basePath);
+    }
     if (canContinue && doBundle) {
         const { bundle } = await Promise.resolve().then(() => __importStar(require("./build-bundle.js")));
         canContinue = await bundle(basePath);

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

@@ -1,41 +1,10 @@
-import type { Container, Engine, IPlugin, ISourceOptions, Options } from "@tsparticles/engine";
-import { PluginInstance } from "./PluginInstance";
-
-/**
- */
-class Plugin implements IPlugin {
-    readonly id;
-
-    private readonly _engine;
-
-    constructor(engine: Engine) {
-        this.id = "#template#";
-
-        this._engine = engine;
-    }
-
-    getPlugin(container: Container): PluginInstance {
-        return new PluginInstance(container, this._engine);
-    }
-
-    loadOptions(_options: Options, _source?: ISourceOptions): void {
-        if (!this.needsPlugin()) {
-            // ignore plugin options when not needed
-
-            return;
-        }
-
-        // Load your options here
-    }
-
-    needsPlugin(_options?: ISourceOptions): boolean {
-        return true; // add your condition here, replace true with condition if needed
-    }
-}
+import type { Engine } from "@tsparticles/engine";
 
 /**
  * @param engine - The engine instance
  */
 export async function loadTemplatePlugin(engine: Engine): Promise<void> {
+    const { Plugin } = await import("./plugin.js");
+
     await engine.addPlugin(new Plugin(engine));
 }

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

@@ -0,0 +1,36 @@
+import { type Container, type Engine, type IPlugin, type ISourceOptions, type Options } from "@tsparticles/engine";
+import type { PluginInstance } from "./PluginInstance.js";
+
+/**
+ */
+export class Plugin implements IPlugin {
+    readonly id;
+
+    private readonly _engine;
+
+    constructor(engine: Engine) {
+        this.id = "#template#";
+
+        this._engine = engine;
+    }
+
+    async getPlugin(container: Container): Promise<PluginInstance> {
+        const { PluginInstance } = await import("./PluginInstance.js");
+
+        return new PluginInstance(container, this._engine);
+    }
+
+    loadOptions(_options: Options, _source?: ISourceOptions): void {
+        if (!this.needsPlugin()) {
+            // ignore plugin options when not needed
+
+            return;
+        }
+
+        // Load your options here
+    }
+
+    needsPlugin(_options?: ISourceOptions): boolean {
+        return true; // add your condition here, replace true with condition if needed
+    }
+}

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

@@ -1,11 +1,12 @@
 import type { Engine } from "@tsparticles/engine";
-import { options } from "./options";
 
 /**
  *
  * @param engine - the engine instance to load the preset into
  */
 export async function loadTemplatePreset(engine: Engine): Promise<void> {
+    const { options } = await import("./options");
+
     // TODO: additional modules must be loaded here
 
     // Adds the preset to the engine, with the given options

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

@@ -1,7 +1,7 @@
 import type { IShapeDrawData, IShapeDrawer } from "@tsparticles/engine";
 
 export class ShapeDrawer implements IShapeDrawer {
-    draw(_data: IShapeDrawData): void {
+    async draw(_data: IShapeDrawData): Promise<void> {
         // draw the particle using the context
         // which is already centered in the particle position
         // colors are already handled, just draw the shape
@@ -10,5 +10,8 @@ export class ShapeDrawer implements IShapeDrawer {
         // pixelRatio is the canvas ratio used by the tsParticles instance, you may need it for density-independent shapes
         // the parameters have an underscore prefix because they're not used in this example
         // the underscore prefix can be removed for used parameters, the unused ones can be removed too
+
+        // remove this if there's already an await call
+        await Promise.resolve();
     }
 }

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

@@ -1,9 +1,10 @@
 import type { Engine } from "@tsparticles/engine";
-import { ShapeDrawer } from "./ShapeDrawer";
 
 /**
  * @param engine - the engine instance to load the shape into
  */
 export async function loadTemplateShape(engine: Engine): Promise<void> {
+    const { ShapeDrawer } = await import("./ShapeDrawer");
+
     await engine.addShape("#template#", new ShapeDrawer());
 }

package/files/empty-project/package.json

@@ -83,14 +83,14 @@
   "prettier": "@tsparticles/prettier-config",
   "devDependencies": {
     "@babel/core": "^7.23.9",
-    "@tsparticles/cli": "^2.0.5",
-    "@tsparticles/eslint-config": "^2.1.0",
+    "@tsparticles/cli": "^2.2.0",
+    "@tsparticles/eslint-config": "^2.1.4",
     "@tsparticles/prettier-config": "^2.1.0",
     "@tsparticles/tsconfig": "^2.0.1",
-    "@tsparticles/webpack-plugin": "^2.1.0",
+    "@tsparticles/webpack-plugin": "^2.1.4",
     "@types/webpack-env": "^1.18.4",
-    "@typescript-eslint/eslint-plugin": "^6.19.1",
-    "@typescript-eslint/parser": "^6.19.1",
+    "@typescript-eslint/eslint-plugin": "^6.20.0",
+    "@typescript-eslint/parser": "^6.20.0",
     "babel-loader": "^9.1.3",
     "browserslist": "^4.22.3",
     "copyfiles": "^2.4.1",
@@ -105,6 +105,6 @@
     "webpack-cli": "^5.1.4"
   },
   "dependencies": {
-    "@tsparticles/engine": "^3.0.3"
+    "@tsparticles/engine": "^3.2.0"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsparticles/cli",
-  "version": "2.0.5",
+  "version": "2.2.0",
   "license": "MIT",
   "bin": {
     "tsparticles-cli": "dist/cli.js"
@@ -10,12 +10,12 @@
   },
   "prettier": "@tsparticles/prettier-config",
   "dependencies": {
-    "@tsparticles/eslint-config": "^2.1.0",
+    "@tsparticles/eslint-config": "^2.1.4",
     "@tsparticles/prettier-config": "^2.1.0",
     "@tsparticles/tsconfig": "^2.0.1",
-    "@tsparticles/webpack-plugin": "^2.1.0",
-    "@typescript-eslint/eslint-plugin": "^6.19.1",
-    "@typescript-eslint/parser": "^6.19.1",
+    "@tsparticles/webpack-plugin": "^2.1.4",
+    "@typescript-eslint/eslint-plugin": "^6.20.0",
+    "@typescript-eslint/parser": "^6.20.0",
     "commander": "^11.1.0",
     "eslint": "^8.56.0",
     "eslint-config-prettier": "^9.1.0",
@@ -24,6 +24,7 @@
     "fs-extra": "^11.2.0",
     "klaw": "^4.1.0",
     "lookpath": "^1.2.2",
+    "madge": "^6.1.0",
     "path-scurry": "^1.10.1",
     "prettier": "^3.2.4",
     "prettier-plugin-multiline-arrays": "^3.0.1",
@@ -36,8 +37,9 @@
     "@types/chai": "^4.3.11",
     "@types/fs-extra": "^11.0.4",
     "@types/klaw": "^3.0.6",
+    "@types/madge": "^5.0.3",
     "@types/mocha": "^10.0.6",
-    "@types/node": "^20.11.9",
+    "@types/node": "^20.11.13",
     "@types/prompts": "^2.4.9",
     "chai": "^4.4.0",
     "cross-env": "^7.0.3",
@@ -55,12 +57,13 @@
     "prettify:readme": "prettier --write ./README.md",
     "lint": "eslint src --ext .js,.jsx,.ts,.tsx --fix",
     "lint:ci": "eslint src --ext .js,.jsx,.ts,.tsx",
+    "circular-deps": "madge --circular --extensions ts src",
     "compile": "pnpm run build:ts",
     "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": "pnpm run clear:dist && pnpm run prettify:src && pnpm run lint && pnpm run compile && pnpm run circular-deps && 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",
     "version": "node scripts/postversion.js && git add files/empty-project/package.json"

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

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

package/src/build/build.ts

@@ -15,6 +15,7 @@ buildCommand.option(
     "Do all build steps for CI, no fixing files, only checking if they are formatted correctly",
     false,
 );
+buildCommand.option("-cd, --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);
@@ -26,6 +27,7 @@ buildCommand.action(async (argPath: string) => {
         ci = !!opts.ci,
         all = !!opts.all || (!opts.bundle && !opts.clean && !opts.dist && !opts.lint && !opts.prettify && !opts.tsc),
         doBundle = all || !!opts.bundle,
+        circularDeps = all || !!opts.circularDeps,
         clean = all || !!opts.clean,
         distfiles = all || !!opts.dist,
         doLint = all || !!opts.lint,
@@ -70,6 +72,12 @@ buildCommand.action(async (argPath: string) => {
         canContinue = await buildTS(basePath);
     }
 
+    if (canContinue && circularDeps) {
+        const { buildCircularDeps } = await import("./build-circular-deps.js");
+
+        canContinue = await buildCircularDeps(basePath);
+    }
+
     if (canContinue && doBundle) {
         const { bundle } = await import("./build-bundle.js");