@tsparticles/cli 3.1.7 → 3.2.0

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

@@ -23,7 +23,6 @@ jobs:
         name: Install pnpm
         id: pnpm-install
         with:
-          version: 10
           run_install: false
       - name: Get pnpm version
         id: pnpm-version
@@ -64,7 +63,6 @@ jobs:
         name: Install pnpm
         id: pnpm-install
         with:
-          version: 10
           run_install: false
       - name: Get pnpm version
         id: pnpm-version

package/.planning/PROJECT.md

@@ -0,0 +1,43 @@
+# New Project
+
+## What This Is
+
+An initialized project workspace for planning and execution. This project represents the CLI tooling and templates found in this repository and is intended to be used as the basis for planning feature work or packaging improvements.
+
+## Core Value
+
+Make the CLI and project templates reliable and easy to extend so maintainers and downstream projects can scaffold consistent plugins and shapes quickly.
+
+## Requirements
+
+### Validated
+
+(None yet — this is a planning initialization for future work)
+
+### Active
+
+- [ ] Improve CLI build reliability and developer experience
+- [ ] Create clear scaffolding templates for plugins and shapes
+
+### Out of Scope
+
+- Large runtime application features unrelated to CLI scaffolding
+
+## Context
+
+This repository contains a TypeScript-based CLI (`src/`), template projects under `files/`, and CI workflows under `.github/`. The codebase map will be created to infer existing capabilities.
+
+## Constraints
+
+- **Timeline**: TBD — planning stage
+- **Tech**: TypeScript + Node.js CLI tooling
+
+## Key Decisions
+
+| Decision                      | Rationale                         | Outcome   |
+| ----------------------------- | --------------------------------- | --------- |
+| Initialize planning artifacts | Begin structured project planning | — Pending |
+
+---
+
+_Last updated: [date]_

package/.planning/REQUIREMENTS.md

@@ -0,0 +1,41 @@
+# Requirements: CLI Project
+
+**Defined:** [date]
+**Core Value:** Make the CLI and templates reliable and easy to extend
+
+## v1 Requirements
+
+### CLI
+
+- [ ] **CLI-01**: CLI can scaffold a plugin using `create plugin` command
+- [ ] **CLI-02**: CLI build scripts pass locally (TypeScript compiles)
+- [ ] **CLI-03**: Tests run with `pnpm test` and pass in CI
+
+### Templates
+
+- [ ] **TPL-01**: Plugin template under `files/create-plugin/` generates a working plugin
+- [ ] **TPL-02**: Shape template under `files/create-shape/` generates a working shape
+
+## v2 Requirements
+
+- **DOC-01**: Add CONTRIBUTING.md with dev setup
+
+## Out of Scope
+
+| Feature                    | Reason                         |
+| -------------------------- | ------------------------------ |
+| Large runtime app features | Not related to CLI scaffolding |
+
+## Traceability
+
+| Requirement | Phase   | Status  |
+| ----------- | ------- | ------- |
+| CLI-01      | Phase 1 | Pending |
+| CLI-02      | Phase 1 | Pending |
+| CLI-03      | Phase 1 | Pending |
+| TPL-01      | Phase 1 | Pending |
+| TPL-02      | Phase 1 | Pending |
+
+---
+
+_Requirements defined: [date]_

package/.planning/ROADMAP.md

@@ -0,0 +1,41 @@
+# ROADMAP
+
+## Overview
+
+Phases derived from v1 requirements. All v1 requirements are covered across the phases below.
+
+| #   | Phase                | Goal                                          | Requirements                   |
+| --- | -------------------- | --------------------------------------------- | ------------------------------ |
+| 1   | Core CLI & Templates | Ensure CLI scaffolding and build are reliable | CLI-01, CLI-02, TPL-01, TPL-02 |
+| 2   | Tests & CI           | Ensure tests run and CI is healthy            | CLI-03                         |
+| 3   | Docs & Developer UX  | Improve contributor onboarding and docs       | DOC-01                         |
+
+## Phase Details
+
+### Phase 1: Core CLI & Templates
+
+Goal: Users can scaffold plugins and shapes and build the codebase locally.
+Requirements: CLI-01, CLI-02, TPL-01, TPL-02
+Success criteria:
+
+1. `create plugin` generates a working plugin scaffold
+2. TypeScript build completes without errors
+3. Templates include README and basic tests
+
+### Phase 2: Tests & CI
+
+Goal: Ensure tests run locally and in CI, coverage tracked.
+Requirements: CLI-03
+Success criteria:
+
+1. Vitest runs and reports passing tests locally
+2. CI workflow runs tests and reports status
+
+### Phase 3: Docs & Developer UX
+
+Goal: Improve onboarding and developer docs
+Requirements: DOC-01
+Success criteria:
+
+1. CONTRIBUTING.md created with setup steps
+2. Quickstart added to README

package/.planning/STATE.md

@@ -0,0 +1,6 @@
+## Project Reference
+
+See: .planning/PROJECT.md (initialized)
+
+**Core value:** Make the CLI and templates reliable and easy to extend
+**Current focus:** Phase 1 — Core CLI & Templates

package/.planning/codebase/ARCHITECTURE.md

@@ -0,0 +1,3 @@
+Architecture Overview
+- CLI entrypoint: src/cli.ts
+- Feature modules: src/create, src/build

package/.planning/codebase/CONCERNS.md

@@ -0,0 +1,3 @@
+Concerns
+- Some build scripts may lack tests
+- CI secrets should be reviewed

package/.planning/codebase/CONVENTIONS.md

@@ -0,0 +1,3 @@
+Conventions
+- TypeScript + Prettier + ESLint
+- Organize by feature

package/.planning/codebase/INTEGRATIONS.md

@@ -0,0 +1,3 @@
+External Integrations
+- GitHub Actions for CI
+- npm registry for publishing

package/.planning/codebase/STACK.md

@@ -0,0 +1,11 @@
+Project Technology Stack
+
+Languages & Runtimes
+- TypeScript (src/)
+- Node.js for CLI
+
+Tools
+- Vitest, tsc, pnpm
+
+Config locations
+- package.json, tsconfig.json

package/.planning/codebase/STRUCTURE.md

@@ -0,0 +1,3 @@
+Structure
+- src/, files/, .github/
+- templates in files/

package/.planning/codebase/TESTING.md

@@ -0,0 +1,3 @@
+Testing
+- Vitest configuration present
+- Run with pnpm test

package/.planning/config.json

@@ -0,0 +1 @@
+{"mode":"interactive","depth":"standard","parallelization":true,"commit_docs":true,"model_profile":"balanced","workflow":{"research":true,"plan_check":true,"verifier":true}}

package/.planning/research/ARCHITECTURE.md

@@ -0,0 +1 @@
+ARCH research placeholder

package/.planning/research/FEATURES.md

@@ -0,0 +1 @@
+FEATURES research placeholder

package/.planning/research/PITFALLS.md

@@ -0,0 +1 @@
+PITFALLS research placeholder

package/.planning/research/STACK.md

@@ -0,0 +1 @@
+STACK research placeholder

package/.planning/research/SUMMARY.md

@@ -0,0 +1,9 @@
+# Research Summary
+
+Key Findings (placeholder)
+
+- Stack: TypeScript, Node.js, Vitest
+- Table stakes: Reliable CLI, scaffolding templates
+- Watch out: CI secrets, build script test coverage
+
+This summary synthesizes the research outputs and will inform requirements and roadmap.

package/dist/build/build-bundle.d.ts

@@ -1,5 +1,6 @@
 /**
  * @param basePath -
+ * @param silent -
  * @returns true if the bundle was created
  */
-export declare function bundle(basePath: string): Promise<boolean>;
+export declare function bundle(basePath: string, silent: boolean): Promise<boolean>;

package/dist/build/build-bundle.js

@@ -2,10 +2,13 @@ import path from "node:path";
 import webpack from "webpack";
 /**
  * @param basePath -
+ * @param silent -
  * @returns true if the bundle was created
  */
-export async function bundle(basePath) {
-    console.log("Bundling started");
+export async function bundle(basePath, silent) {
+    if (!silent) {
+        console.log("Bundling started");
+    }
     let res = false;
     try {
         const options = (await import(path.join(basePath, "webpack.config.js")));
@@ -38,6 +41,8 @@ export async function bundle(basePath) {
         console.error(e);
         res = false;
     }
-    console.log("Bundling done");
+    if (!silent) {
+        console.log("Bundling done");
+    }
     return res;
 }

package/dist/build/build-circular-deps.d.ts

@@ -1,6 +1,7 @@
 /**
  * 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 declare function buildCircularDeps(basePath: string): Promise<boolean>;
+export declare function buildCircularDeps(basePath: string, silent: boolean): Promise<boolean>;

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

@@ -5,9 +5,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) {
+export async function buildCircularDeps(basePath, silent) {
     const srcPath = path.join(basePath, "src"), cruiseOptions = await loadDependencyCruiserConfig(basePath);
     try {
         const result = await cruise([srcPath], {
@@ -24,7 +25,9 @@ export async function buildCircularDeps(basePath) {
             }
             return false;
         }
-        console.log("✅ No circular dependencies found.");
+        if (!silent) {
+            console.log("✅ No circular dependencies found.");
+        }
         return true;
     }
     catch (e) {
@@ -32,6 +35,8 @@ export async function buildCircularDeps(basePath) {
         return false;
     }
     finally {
-        console.log("Finished checking circular dependencies.");
+        if (!silent) {
+            console.log("Finished checking circular dependencies.");
+        }
     }
 }

package/dist/build/build-clear.d.ts

@@ -1,5 +1,6 @@
 /**
  * @param basePath -
+ * @param silent -
  * @returns true if the dist folder was cleared
  */
-export declare function clearDist(basePath: string): Promise<boolean>;
+export declare function clearDist(basePath: string, silent: boolean): Promise<boolean>;

package/dist/build/build-clear.js

@@ -2,10 +2,13 @@ import path from "node:path";
 import { rimraf } from "rimraf";
 /**
  * @param basePath -
+ * @param silent -
  * @returns true if the dist folder was cleared
  */
-export async function clearDist(basePath) {
-    console.log("Clearing dist folder");
+export async function clearDist(basePath, silent) {
+    if (!silent) {
+        console.log("Clearing dist folder");
+    }
     let res = false;
     try {
         await rimraf(path.join(basePath, "dist"));
@@ -15,6 +18,8 @@ export async function clearDist(basePath) {
         console.error(e);
         res = false;
     }
-    console.log("Clearing dist folder done");
+    if (!silent) {
+        console.log("Clearing dist folder done");
+    }
     return res;
 }

package/dist/build/build-distfiles.d.ts

@@ -1,5 +1,6 @@
 /**
  * @param basePath -
+ * @param silent -
  * @returns true if the dist files process was successful
  */
-export declare function buildDistFiles(basePath: string): Promise<boolean>;
+export declare function buildDistFiles(basePath: string, silent: boolean): Promise<boolean>;

package/dist/build/build-distfiles.js

@@ -3,10 +3,13 @@ import klaw from "klaw";
 import path from "node:path";
 /**
  * @param basePath -
+ * @param silent -
  * @returns true if the dist files process was successful
  */
-export async function buildDistFiles(basePath) {
-    console.log("Build - started on dist files");
+export async function buildDistFiles(basePath, silent) {
+    if (!silent) {
+        console.log("Build - started on dist files");
+    }
     let res;
     try {
         const pkgInfo = JSON.parse((await fs.readFile(path.join(basePath, "package.json"))).toString()), 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);
@@ -19,7 +22,9 @@ export async function buildDistFiles(basePath) {
         }
         const jsonIndent = 2;
         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",
             "README.md",
@@ -63,6 +68,8 @@ export async function buildDistFiles(basePath) {
         console.error(e);
         res = false;
     }
-    console.log("Build - done on dist files");
+    if (!silent) {
+        console.log("Build - done on dist files");
+    }
     return res;
 }

package/dist/build/build-eslint.d.ts

@@ -1,5 +1,6 @@
 /**
  * @param ci -
+ * @param silent -
  * @returns true if the linting was successful
  */
-export declare function lint(ci: boolean): Promise<boolean>;
+export declare function lint(ci: boolean, silent: boolean): Promise<boolean>;

package/dist/build/build-eslint.js

@@ -1,10 +1,13 @@
 import { ESLint } from "eslint";
 /**
  * @param ci -
+ * @param silent -
  * @returns true if the linting was successful
  */
-export async function lint(ci) {
-    console.log("ESLint - started on src");
+export async function lint(ci, silent) {
+    if (!silent) {
+        console.log("ESLint - started on src");
+    }
     let res;
     try {
         const eslint = new ESLint({
@@ -23,6 +26,8 @@ export async function lint(ci) {
         console.error(e);
         res = false;
     }
-    console.log("ESLint - done on src");
+    if (!silent) {
+        console.log("ESLint - done on src");
+    }
     return res;
 }

package/dist/build/build-prettier.d.ts

@@ -2,24 +2,28 @@
  * @param basePath -
  * @param srcPath -
  * @param ci -
+ * @param silent -
  * @returns true if the prettify src process was successful
  */
-export declare function prettifySrc(basePath: string, srcPath: string, ci: boolean): Promise<boolean>;
+export declare function prettifySrc(basePath: string, srcPath: string, ci: boolean, silent: boolean): Promise<boolean>;
 /**
  * @param basePath -
  * @param ci -
+ * @param silent -
  * @returns true if the prettify package.json process was successful
  */
-export declare function prettifyPackageJson(basePath: string, ci: boolean): Promise<boolean>;
+export declare function prettifyPackageJson(basePath: string, ci: boolean, silent: boolean): Promise<boolean>;
 /**
  * @param basePath -
  * @param _ci -
+ * @param silent -
  * @returns true if the prettify package.dist.json process was successful
  */
-export declare function prettifyPackageDistJson(basePath: string, _ci: boolean): Promise<boolean>;
+export declare function prettifyPackageDistJson(basePath: string, _ci: boolean, silent: boolean): Promise<boolean>;
 /**
  * @param basePath -
  * @param ci -
+ * @param silent -
  * @returns true if the prettify readme process was successful
  */
-export declare function prettifyReadme(basePath: string, ci: boolean): Promise<boolean>;
+export declare function prettifyReadme(basePath: string, ci: boolean, silent: boolean): Promise<boolean>;

package/dist/build/build-prettier.js

@@ -6,10 +6,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, srcPath, ci) {
-    console.log("Prettier - started on src");
+export async function prettifySrc(basePath, srcPath, ci, silent) {
+    if (!silent) {
+        console.log("Prettier - started on src");
+    }
     let res;
     try {
         for await (const file of klaw(srcPath)) {
@@ -38,16 +41,21 @@ export async function prettifySrc(basePath, srcPath, ci) {
         console.error(e);
         res = false;
     }
-    console.log("Prettier - done on src");
+    if (!silent) {
+        console.log("Prettier - done on src");
+    }
     return res;
 }
 /**
  * @param basePath -
  * @param ci -
+ * @param silent -
  * @returns true if the prettify package.json process was successful
  */
-export async function prettifyPackageJson(basePath, ci) {
-    console.log("Prettier - started on package.json");
+export async function prettifyPackageJson(basePath, ci, silent) {
+    if (!silent) {
+        console.log("Prettier - started on package.json");
+    }
     let res;
     try {
         const contents = await fs.readFile("package.json", "utf8"), options = (await prettier.resolveConfig(basePath)) ?? {};
@@ -70,16 +78,21 @@ export async function prettifyPackageJson(basePath, ci) {
         console.error(e);
         res = false;
     }
-    console.log("Prettier - done on package.json");
+    if (!silent) {
+        console.log("Prettier - done on package.json");
+    }
     return res;
 }
 /**
  * @param basePath -
  * @param _ci -
+ * @param silent -
  * @returns true if the prettify package.dist.json process was successful
  */
-export async function prettifyPackageDistJson(basePath, _ci) {
-    console.log("Prettier - started on package.dist.json");
+export async function prettifyPackageDistJson(basePath, _ci, silent) {
+    if (!silent) {
+        console.log("Prettier - started on package.dist.json");
+    }
     let res;
     try {
         const contents = await fs.readFile("package.dist.json", "utf8"), options = (await prettier.resolveConfig(basePath)) ?? {};
@@ -102,16 +115,21 @@ export async function prettifyPackageDistJson(basePath, _ci) {
         console.error(e);
         res = false;
     }
-    console.log("Prettier - done on package.dist.json");
+    if (!silent) {
+        console.log("Prettier - done on package.dist.json");
+    }
     return res;
 }
 /**
  * @param basePath -
  * @param ci -
+ * @param silent -
  * @returns true if the prettify readme process was successful
  */
-export async function prettifyReadme(basePath, ci) {
-    console.log("Prettier - started on README.md");
+export async function prettifyReadme(basePath, ci, silent) {
+    if (!silent) {
+        console.log("Prettier - started on README.md");
+    }
     let res;
     try {
         const contents = await fs.readFile("README.md", "utf8"), options = (await prettier.resolveConfig(basePath)) ?? {};
@@ -127,22 +145,28 @@ export async function prettifyReadme(basePath, ci) {
             const formatted = await prettier.format(contents, options);
             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;
 }
 /**
  * @param basePath -
  * @param ci -
+ * @param silent -
  * @returns true if the prettify traductions process was successful
  */
-async function prettifyTraductions(basePath, ci) {
-    console.log("Prettier - started on traductions");
+async function prettifyTraductions(basePath, ci, silent) {
+    if (!silent) {
+        console.log("Prettier - started on traductions");
+    }
     let res = false;
     try {
         const folder = "traduction", folderPath = path.join(basePath, folder);
@@ -175,16 +199,21 @@ async function prettifyTraductions(basePath, ci) {
         console.error(e);
         res = false;
     }
-    console.log("Prettier - done on traductions");
+    if (!silent) {
+        console.log("Prettier - done on traductions");
+    }
     return res;
 }
 /**
  * @param basePath -
  * @param ci -
+ * @param silent -
  * @returns true if the prettify markdown typedoc files process was successful
  */
-async function prettifyMarkdownTypeDocFiles(basePath, ci) {
-    console.log("Prettier - started on markdown");
+async function prettifyMarkdownTypeDocFiles(basePath, ci, silent) {
+    if (!silent) {
+        console.log("Prettier - started on markdown");
+    }
     let res = false;
     try {
         const folder = "markdown", folderPath = path.join(basePath, folder);
@@ -217,6 +246,8 @@ async function prettifyMarkdownTypeDocFiles(basePath, ci) {
         console.error(e);
         res = false;
     }
-    console.log("Prettier - done on markdown");
+    if (!silent) {
+        console.log("Prettier - done on markdown");
+    }
     return res;
 }

package/dist/build/build-tsc.d.ts

@@ -1,5 +1,6 @@
 /**
  * @param basePath -
+ * @param silent -
  * @returns true if the build was successful
  */
-export declare function buildTS(basePath: string): Promise<boolean>;
+export declare function buildTS(basePath: string, silent: boolean): Promise<boolean>;