@tsparticles/cli 3.2.2 → 3.3.1

package/.planning/codebase/TESTING.md

@@ -1,3 +1,138 @@
-Testing
-- Vitest configuration present
-- Run with pnpm test
+# Testing Patterns
+
+**Analysis Date:** 2026-03-08
+
+## Test Framework
+
+**Runner:**
+
+- Vitest (`vitest`) - configured in `vitest.config.ts` with `environment: "node"` and `include: ["tests/**/*.test.ts"]`.
+
+Config: `vitest.config.ts`
+
+Run Commands:
+
+```bash
+pnpm test              # Run all tests (runs `vitest run` as defined in package.json)
+pnpm test --watch      # Run in watch mode (Vitest supports --watch)
+pnpm test --coverage   # Coverage if configured via vitest options (not explicitly configured here)
+```
+
+## Test File Organization
+
+Location:
+
+- Tests live under `tests/` at the repo root: `tests/*.test.ts` (e.g., `tests/create-shape.test.ts`, `tests/file-utils.test.ts`).
+
+Naming:
+
+- Test files use the pattern `<feature>.test.ts` (Vitest `include` config picks `tests/**/*.test.ts`).
+
+Structure:
+
+```
+tests/
+├── create-shape.test.ts
+├── create-preset.test.ts
+├── create-plugin.test.ts
+├── file-utils.test.ts
+└── string-utils.test.ts
+```
+
+## Test Structure
+
+Suite Organization (example from `tests/create-shape.test.ts`):
+
+```ts
+import { describe, it, expect } from "vitest";
+import { createShapeTemplate } from "../src/create/shape/create-shape.js";
+
+describe("create-shape", () => {
+  it("should have created the shape project", async () => {
+    // arrange: compute destDir
+    // act: call createShapeTemplate
+    // assert: read package.json and assert properties using fs-extra
+  });
+});
+```
+
+Patterns:
+
+- Tests create temporary directories under `tests/tmp-files` and remove them after assertions (`fs-extra` used to clean up).
+- Tests use actual file system operations to verify template creation (integration-style unit tests).
+
+Setup/Teardown:
+
+- Tests manually create and remove directories within each test case (no global setup file detected).
+
+## Mocking
+
+Framework: Vitest built-in mocking utilities are available but not heavily used in current tests.
+
+Patterns:
+
+- Tests primarily exercise filesystem operations without mocking `fs-extra` or child processes. When external commands are invoked, the code checks for the presence of `npm` using `lookpath` before running `exec` which avoids executing if not present.
+
+What to Mock:
+
+- When adding unit tests for functions that call `exec` or modify the environment, mock `child_process.exec` or `lookpath` to avoid running external processes.
+
+What NOT to Mock:
+
+- For integration-style tests that verify file scaffolding, prefer real `fs` operations in a temporary directory to validate end-to-end behavior.
+
+## Fixtures and Factories
+
+Test Data:
+
+- Tests programmatically generate temporary directories under `tests/tmp-files` and use template functions to create artifacts. No centralized fixtures directory is present.
+
+Location:
+
+- Temporary test artifacts are created in `tests/tmp-files` during tests and cleaned up by tests (see `tests/create-shape.test.ts`).
+
+## Coverage
+
+Requirements: None enforced in repo. CI runs `pnpm test` but coverage thresholds are not configured.
+
+View Coverage:
+
+```bash
+
+```
+
+## Test Types
+
+Unit Tests:
+
+- Small utilities tested (e.g., `tests/file-utils.test.ts`, `tests/string-utils.test.ts`).
+
+Integration Tests:
+
+- Template creation tests behave like integration tests, performing file operations and validating outputs (`tests/create-*.test.ts`).
+
+E2E Tests:
+
+- Not used.
+
+## Common Patterns
+
+Async Testing:
+
+```ts
+it("does async work", async () => {
+  await expect(someAsyncFn()).resolves.toBeTruthy();
+});
+```
+
+Error Testing:
+
+```ts
+it("throws on bad input", async () => {
+  await expect(badAsync()).rejects.toThrow();
+});
+```
+
+---
+
+_Testing analysis: 2026-03-08_

package/dist/build/build-bundle.js

@@ -9,7 +9,7 @@ export async function bundle(basePath, silent) {
     if (!silent) {
         console.log("Bundling started");
     }
-    let res = false;
+    let res;
     try {
         const options = (await import(path.join(basePath, "webpack.config.js")));
         res = await new Promise((resolve, reject) => {

package/dist/build/build-clear.js

@@ -9,7 +9,7 @@ export async function clearDist(basePath, silent) {
     if (!silent) {
         console.log("Clearing dist folder");
     }
-    let res = false;
+    let res;
     try {
         await rimraf(path.join(basePath, "dist"));
         res = true;

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

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

package/dist/build/build-prettier.js

@@ -85,11 +85,11 @@ export async function prettifyPackageJson(basePath, ci, silent) {
 }
 /**
  * @param basePath -
- * @param _ci -
+ * @param ci -
  * @param silent -
  * @returns true if the prettify package.dist.json process was successful
  */
-export async function prettifyPackageDistJson(basePath, _ci, silent) {
+export async function prettifyPackageDistJson(basePath, ci, silent) {
     if (!silent) {
         console.log("Prettier - started on package.dist.json");
     }
@@ -100,15 +100,15 @@ export async function prettifyPackageDistJson(basePath, _ci, silent) {
         options.printWidth = 120;
         options.endOfLine = "lf";
         options.parser = "json";
-        // TODO: disabled this check until "prettier-plugin-multiline-arrays" package is compatible with Prettier 3.0.0
-        /* if (ci) {
-                if (!(await prettier.check(contents, options))) {
-                    throw new Error(`package.dist.json is not formatted correctly`);
-                }
-            } else { */
-        const formatted = await prettier.format(contents, options);
-        await fs.writeFile("package.dist.json", formatted, "utf8");
-        // }
+        if (ci) {
+            if (!(await prettier.check(contents, options))) {
+                throw new Error(`package.dist.json is not formatted correctly`);
+            }
+        }
+        else {
+            const formatted = await prettier.format(contents, options);
+            await fs.writeFile("package.dist.json", formatted, "utf8");
+        }
         res = true;
     }
     catch (e) {