@tsparticles/cli 2.0.0-beta.8 → 2.0.0

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

@@ -43,8 +43,8 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pnpm-store-
       - run: pnpm install --no-frozen-lockfile
-      - run: npx pnpm run build:ci
-      - run: npx pnpm test
+      - run: pnpm run build:ci
+      - run: pnpm test
   pr:
     runs-on: ubuntu-latest
     if: ${{ github.event_name == 'pull_request' }}
@@ -81,5 +81,5 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pnpm-store-
       - run: pnpm install --no-frozen-lockfile
-      - run: npx pnpm run build:ci
-      - run: npx pnpm test
+      - run: pnpm run build:ci
+      - run: pnpm test

package/dist/create/plugin/create-plugin.js

@@ -125,7 +125,7 @@ async function createPluginTemplate(name, description, repoUrl, destPath) {
     await updatePluginPackageDistFile(destPath, name, description, repoUrl);
     await updateReadmeFile(destPath, name, description, repoUrl);
     await updatePluginWebpackFile(destPath, name, description);
-    (0, template_utils_1.runInstall)(destPath);
-    (0, template_utils_1.runBuild)(destPath);
+    await (0, template_utils_1.runInstall)(destPath);
+    await (0, template_utils_1.runBuild)(destPath);
 }
 exports.createPluginTemplate = createPluginTemplate;

package/dist/create/plugin/plugin.js

@@ -15,7 +15,7 @@ exports.pluginCommand = pluginCommand;
 pluginCommand.description("Create a new tsParticles plugin");
 pluginCommand.argument("<destination>", "Destination folder");
 pluginCommand.action(async (destination) => {
-    const destPath = await (0, file_utils_1.getDestinationDir)(destination), repoUrl = (0, file_utils_1.getRepositoryUrl)();
+    const destPath = await (0, file_utils_1.getDestinationDir)(destination), repoUrl = await (0, file_utils_1.getRepositoryUrl)();
     const initialName = destPath.split(path_1.default.sep).pop(), questions = [
         {
             type: "text",

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

@@ -143,7 +143,7 @@ async function createPresetTemplate(name, description, repoUrl, destPath) {
     await updatePresetPackageDistFile(destPath, name, description, repoUrl);
     await updateReadmeFile(destPath, name, description, repoUrl);
     await updatePresetWebpackFile(destPath, name, description);
-    (0, template_utils_1.runInstall)(destPath);
-    (0, template_utils_1.runBuild)(destPath);
+    await (0, template_utils_1.runInstall)(destPath);
+    await (0, template_utils_1.runBuild)(destPath);
 }
 exports.createPresetTemplate = createPresetTemplate;

package/dist/create/preset/preset.js

@@ -15,7 +15,7 @@ exports.presetCommand = presetCommand;
 presetCommand.description("Create a new tsParticles preset");
 presetCommand.argument("<destination>", "Destination folder");
 presetCommand.action(async (destination) => {
-    const destPath = await (0, file_utils_1.getDestinationDir)(destination), repoUrl = (0, file_utils_1.getRepositoryUrl)();
+    const destPath = await (0, file_utils_1.getDestinationDir)(destination), repoUrl = await (0, file_utils_1.getRepositoryUrl)();
     const initialName = destPath.split(path_1.default.sep).pop(), questions = [
         {
             type: "text",

package/dist/create/shape/create-shape.js

@@ -125,7 +125,7 @@ async function createShapeTemplate(name, description, repoUrl, destPath) {
     await updateShapePackageDistFile(destPath, name, description, repoUrl);
     await updateReadmeFile(destPath, name, description, repoUrl);
     await updateShapeWebpackFile(destPath, name, description);
-    (0, template_utils_1.runInstall)(destPath);
-    (0, template_utils_1.runBuild)(destPath);
+    await (0, template_utils_1.runInstall)(destPath);
+    await (0, template_utils_1.runBuild)(destPath);
 }
 exports.createShapeTemplate = createShapeTemplate;

package/dist/create/shape/shape.js

@@ -15,7 +15,7 @@ exports.shapeCommand = shapeCommand;
 shapeCommand.description("Create a new tsParticles shape");
 shapeCommand.argument("<destination>", "Destination folder");
 shapeCommand.action(async (destination) => {
-    const destPath = await (0, file_utils_1.getDestinationDir)(destination), repoUrl = (0, file_utils_1.getRepositoryUrl)();
+    const destPath = await (0, file_utils_1.getDestinationDir)(destination), repoUrl = await (0, file_utils_1.getRepositoryUrl)();
     const initialName = destPath.split(path_1.default.sep).pop(), questions = [
         {
             type: "text",

package/dist/utils/file-utils.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRepositoryUrl = exports.getDestinationDir = exports.replaceTokensInFile = exports.replaceTokensInFiles = void 0;
 const child_process_1 = require("child_process");
 const fs_extra_1 = __importDefault(require("fs-extra"));
+const lookpath_1 = require("lookpath");
 const path_1 = __importDefault(require("path"));
 /**
  *
@@ -51,12 +52,18 @@ exports.getDestinationDir = getDestinationDir;
 /**
  * @returns the repository URL
  */
-function getRepositoryUrl() {
-    try {
-        return (0, child_process_1.execSync)("git config --get remote.origin.url").toString();
-    }
-    catch {
+async function getRepositoryUrl() {
+    if (!(await (0, lookpath_1.lookpath)("git"))) {
         return "";
     }
+    return new Promise((resolve, reject) => {
+        (0, child_process_1.exec)("git config --get remote.origin.url", (error, stdout) => {
+            if (error) {
+                reject(error);
+                return;
+            }
+            resolve(stdout.toString());
+        });
+    });
 }
 exports.getRepositoryUrl = getRepositoryUrl;

package/dist/utils/template-utils.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.runBuild = exports.runInstall = exports.copyFilter = exports.copyEmptyTemplateFiles = exports.updateWebpackFile = exports.updatePackageDistFile = exports.updatePackageFile = void 0;
 const child_process_1 = require("child_process");
 const fs_extra_1 = __importDefault(require("fs-extra"));
+const lookpath_1 = require("lookpath");
 const path_1 = __importDefault(require("path"));
 const file_utils_1 = require("./file-utils");
 /**
@@ -139,9 +140,20 @@ exports.copyFilter = copyFilter;
  * 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", {
-        cwd: destPath,
+async function runInstall(destPath) {
+    if (!(await (0, lookpath_1.lookpath)("npm"))) {
+        return;
+    }
+    return new Promise((resolve, reject) => {
+        (0, child_process_1.exec)("npm install", {
+            cwd: destPath,
+        }, error => {
+            if (error) {
+                reject(error);
+                return;
+            }
+            resolve();
+        });
     });
 }
 exports.runInstall = runInstall;
@@ -149,9 +161,20 @@ exports.runInstall = runInstall;
  * 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", {
-        cwd: destPath,
+async function runBuild(destPath) {
+    if (!(await (0, lookpath_1.lookpath)("npm"))) {
+        return;
+    }
+    return new Promise((resolve, reject) => {
+        (0, child_process_1.exec)("npm run build", {
+            cwd: destPath,
+        }, error => {
+            if (error) {
+                reject(error);
+                return;
+            }
+            resolve();
+        });
     });
 }
 exports.runBuild = runBuild;

package/files/create-plugin/README.md

@@ -54,7 +54,7 @@ $ yarn add tsparticles-plugin-template
 Then you need to import it in the app, like this:
 
 ```javascript
-const { tsParticles } = require("tsparticles-engine");
+const { tsParticles } = require("@tsparticles/engine");
 const { loadTemplatePlugin } = require("tsparticles-plugin-template");
 
 (async () => {
@@ -65,7 +65,7 @@ const { loadTemplatePlugin } = require("tsparticles-plugin-template");
 or
 
 ```javascript
-import { tsParticles } from "tsparticles-engine";
+import { tsParticles } from "@tsparticles/engine";
 import { loadTemplatePlugin } from "tsparticles-plugin-template";
 
 (async () => {

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

@@ -1,4 +1,4 @@
-import { type Container, type Engine, type IContainerPlugin } from "tsparticles-engine";
+import { type Container, type Engine, type IContainerPlugin } from "@tsparticles/engine";
 
 export class PluginInstance implements IContainerPlugin {
     private readonly _container;

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

@@ -1,4 +1,4 @@
-import type { Container, Engine, IPlugin, ISourceOptions, Options } from "tsparticles-engine";
+import type { Container, Engine, IPlugin, ISourceOptions, Options } from "@tsparticles/engine";
 import { PluginInstance } from "./PluginInstance";
 
 /**

package/files/create-preset/README.md

@@ -21,7 +21,7 @@ Once installed you need one more script to be included in your page (or you can
 from [jsDelivr](https://www.jsdelivr.com/package/npm/tsparticles-preset-template):
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/tsparticles-engine@2/tsparticles.engine.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@tsparticles/engine@2/tsparticles.engine.min.js"></script>
 <script src="https://cdn.jsdelivr.net/npm/tsparticles-preset-template/tsparticles.preset.template.min.js"></script>
 ```
 
@@ -75,7 +75,7 @@ This sample uses the class component syntax, but you can use hooks as well (if t
 
 ```javascript
 import Particles from "react-particles";
-import { Engine } from "tsparticles-engine";
+import { Engine } from "@tsparticles/engine";
 import { loadTemplatePreset } from "tsparticles-preset-template";
 
 export class ParticlesContainer extends React.PureComponent<IProps> {

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

@@ -1,5 +1,5 @@
 import { loadTemplatePreset } from ".";
-import { tsParticles } from "tsparticles-engine";
+import { tsParticles } from "@tsparticles/engine";
 
 loadTemplatePreset(tsParticles);
 

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

@@ -1,4 +1,4 @@
-import type { Engine } from "tsparticles-engine";
+import type { Engine } from "@tsparticles/engine";
 import { options } from "./options";
 
 /**

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

@@ -1,4 +1,4 @@
-import type { ISourceOptions } from "tsparticles-engine";
+import type { ISourceOptions } from "@tsparticles/engine";
 
 // The options used by the preset
 export const options: ISourceOptions = {

package/files/create-shape/README.md

@@ -55,7 +55,7 @@ $ yarn add tsparticles-shape-template
 Then you need to import it in the app, like this:
 
 ```javascript
-const { tsParticles } = require("tsparticles-engine");
+const { tsParticles } = require("@tsparticles/engine");
 const { loadTemplateShape } = require("tsparticles-shape-template");
 
 (async () => {
@@ -66,7 +66,7 @@ const { loadTemplateShape } = require("tsparticles-shape-template");
 or
 
 ```javascript
-import { tsParticles } from "tsparticles-engine";
+import { tsParticles } from "@tsparticles/engine";
 import { loadTemplateShape } from "tsparticles-shape-template";
 
 (async () => {

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

@@ -1,15 +1,10 @@
-import type { IDelta, IShapeDrawer, Particle } from "tsparticles-engine";
+import type { IShapeDrawData, IShapeDrawer } from "@tsparticles/engine";
 
 export class ShapeDrawer implements IShapeDrawer {
-    draw(_context: CanvasRenderingContext2D,
-         _particle: Particle,
-         _radius: number,
-         _opacity: number,
-         _delta: IDelta,
-         _pixelRatio: number): void {
+    draw(_data: IShapeDrawData): void {
         // draw the particle using the context
         // which is already centered in the particle position
-        // colors are already handles, just draw the shape
+        // colors are already handled, just draw the shape
         // the bounds are -radius to radius
         // delta is the frame time difference between the last frame and this one, in ms, use it for animated shapes
         // pixelRatio is the canvas ratio used by the tsParticles instance, you may need it for density-independent shapes

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

@@ -1,4 +1,4 @@
-import type { Engine } from "tsparticles-engine";
+import type { Engine } from "@tsparticles/engine";
 import { ShapeDrawer } from "./ShapeDrawer";
 
 /**

package/files/empty-project/package.dist.json

@@ -72,6 +72,6 @@
   "module": "index.js",
   "types": "index.d.ts",
   "dependencies": {
-    "tsparticles-engine": "^2.12.0"
+    "@tsparticles/engine": "^3.0.0-beta.3"
   }
 }

package/files/empty-project/package.json

@@ -82,29 +82,29 @@
   "types": "dist/types/index.d.ts",
   "prettier": "@tsparticles/prettier-config",
   "devDependencies": {
-    "@babel/core": "^7.22.9",
-    "@tsparticles/cli": "^2.0.0-beta.8",
-    "@tsparticles/eslint-config": "^1.19.0",
-    "@tsparticles/prettier-config": "^1.12.0",
-    "@tsparticles/tsconfig": "^1.14.0",
-    "@tsparticles/webpack-plugin": "^1.23.0",
-    "@types/webpack-env": "^1.18.1",
-    "@typescript-eslint/eslint-plugin": "^6.2.1",
-    "@typescript-eslint/parser": "^6.2.1",
+    "@babel/core": "^7.23.3",
+    "@tsparticles/cli": "^2.0.0",
+    "@tsparticles/eslint-config": "^2.0.0-beta.7",
+    "@tsparticles/prettier-config": "^2.0.0-beta.4",
+    "@tsparticles/tsconfig": "^2.0.0-beta.1",
+    "@tsparticles/webpack-plugin": "^2.0.0-beta.11",
+    "@types/webpack-env": "^1.18.4",
+    "@typescript-eslint/eslint-plugin": "^6.11.0",
+    "@typescript-eslint/parser": "^6.11.0",
     "babel-loader": "^9.1.3",
-    "browserslist": "^4.21.10",
+    "browserslist": "^4.22.1",
     "copyfiles": "^2.4.1",
-    "eslint": "^8.46.0",
+    "eslint": "^8.53.0",
     "eslint-config-prettier": "^9.0.0",
-    "prettier": "^3.0.1",
-    "rimraf": "^5.0.1",
+    "prettier": "^3.1.0",
+    "rimraf": "^5.0.5",
     "terser-webpack-plugin": "^5.3.9",
-    "typescript": "^5.1.6",
-    "webpack": "^5.88.2",
-    "webpack-bundle-analyzer": "^4.9.0",
+    "typescript": "^5.2.2",
+    "webpack": "^5.89.0",
+    "webpack-bundle-analyzer": "^4.10.0",
     "webpack-cli": "^5.1.4"
   },
   "dependencies": {
-    "tsparticles-engine": "^2.12.0"
+    "@tsparticles/engine": "^3.0.0-beta.3"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsparticles/cli",
-  "version": "2.0.0-beta.8",
+  "version": "2.0.0",
   "license": "MIT",
   "bin": {
     "tsparticles-cli": "dist/cli.js"
@@ -10,34 +10,36 @@
   },
   "prettier": "@tsparticles/prettier-config",
   "dependencies": {
-    "@tsparticles/eslint-config": "^2.0.0-beta.1",
-    "@tsparticles/prettier-config": "^2.0.0-beta.1",
-    "@tsparticles/tsconfig": "^2.0.0-beta.1",
-    "@tsparticles/webpack-plugin": "^2.0.0-beta.1",
-    "@typescript-eslint/eslint-plugin": "^6.4.1",
-    "@typescript-eslint/parser": "^6.4.1",
-    "commander": "^11.0.0",
-    "eslint": "^8.48.0",
+    "@tsparticles/eslint-config": "^2.0.0",
+    "@tsparticles/prettier-config": "^2.0.0",
+    "@tsparticles/tsconfig": "^2.0.0",
+    "@tsparticles/webpack-plugin": "^2.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.12.0",
+    "@typescript-eslint/parser": "^6.12.0",
+    "commander": "^11.1.0",
+    "eslint": "^8.54.0",
     "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-jsdoc": "^46.5.0",
+    "eslint-plugin-jsdoc": "^46.9.0",
     "eslint-plugin-tsdoc": "^0.2.17",
     "fs-extra": "^11.1.1",
     "klaw": "^4.1.0",
+    "lookpath": "^1.2.2",
     "path-scurry": "^1.10.1",
-    "prettier": "^3.0.2",
+    "prettier": "^3.1.0",
+    "prettier-plugin-multiline-arrays": "^3.0.1",
     "prompts": "^2.4.2",
-    "rimraf": "^5.0.1",
-    "typescript": "^5.2.2",
-    "webpack": "^5.88.2"
+    "rimraf": "^5.0.5",
+    "typescript": "^5.3.2",
+    "webpack": "^5.89.0"
   },
   "devDependencies": {
-    "@types/chai": "^4.3.5",
-    "@types/fs-extra": "^11.0.1",
-    "@types/klaw": "^3.0.3",
-    "@types/mocha": "^10.0.1",
-    "@types/node": "^20.5.6",
-    "@types/prompts": "^2.4.4",
-    "chai": "^4.3.8",
+    "@types/chai": "^4.3.11",
+    "@types/fs-extra": "^11.0.4",
+    "@types/klaw": "^3.0.6",
+    "@types/mocha": "^10.0.5",
+    "@types/node": "^20.9.3",
+    "@types/prompts": "^2.4.9",
+    "chai": "^4.3.10",
     "cross-env": "^7.0.3",
     "mocha": "^10.2.0",
     "nyc": "^15.1.0",

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

@@ -175,6 +175,6 @@ export async function createPluginTemplate(
     await updateReadmeFile(destPath, name, description, repoUrl);
     await updatePluginWebpackFile(destPath, name, description);
 
-    runInstall(destPath);
-    runBuild(destPath);
+    await runInstall(destPath);
+    await runBuild(destPath);
 }

package/src/create/plugin/plugin.ts

@@ -11,7 +11,7 @@ pluginCommand.description("Create a new tsParticles plugin");
 pluginCommand.argument("<destination>", "Destination folder");
 pluginCommand.action(async (destination: string) => {
     const destPath = await getDestinationDir(destination),
-        repoUrl = getRepositoryUrl();
+        repoUrl = await getRepositoryUrl();
 
     const initialName = destPath.split(path.sep).pop(),
         questions: PromptObject[] = [

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

@@ -194,6 +194,6 @@ export async function createPresetTemplate(
     await updateReadmeFile(destPath, name, description, repoUrl);
     await updatePresetWebpackFile(destPath, name, description);
 
-    runInstall(destPath);
-    runBuild(destPath);
+    await runInstall(destPath);
+    await runBuild(destPath);
 }

package/src/create/preset/preset.ts

@@ -11,7 +11,7 @@ presetCommand.description("Create a new tsParticles preset");
 presetCommand.argument("<destination>", "Destination folder");
 presetCommand.action(async (destination: string) => {
     const destPath = await getDestinationDir(destination),
-        repoUrl = getRepositoryUrl();
+        repoUrl = await getRepositoryUrl();
 
     const initialName = destPath.split(path.sep).pop(),
         questions: PromptObject[] = [

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

@@ -174,6 +174,6 @@ export async function createShapeTemplate(
     await updateReadmeFile(destPath, name, description, repoUrl);
     await updateShapeWebpackFile(destPath, name, description);
 
-    runInstall(destPath);
-    runBuild(destPath);
+    await runInstall(destPath);
+    await runBuild(destPath);
 }

package/src/create/shape/shape.ts

@@ -11,7 +11,7 @@ shapeCommand.description("Create a new tsParticles shape");
 shapeCommand.argument("<destination>", "Destination folder");
 shapeCommand.action(async (destination: string) => {
     const destPath = await getDestinationDir(destination),
-        repoUrl = getRepositoryUrl();
+        repoUrl = await getRepositoryUrl();
 
     const initialName = destPath.split(path.sep).pop(),
         questions: PromptObject[] = [

package/src/utils/file-utils.ts

@@ -1,5 +1,6 @@
-import { execSync } from "child_process";
+import { exec } from "child_process";
 import fs from "fs-extra";
+import { lookpath } from "lookpath";
 import path from "path";
 
 export type ReplaceTokensOptions = {
@@ -66,10 +67,20 @@ export async function getDestinationDir(destination: string): Promise<string> {
 /**
  * @returns the repository URL
  */
-export function getRepositoryUrl(): string {
-    try {
-        return execSync("git config --get remote.origin.url").toString();
-    } catch {
+export async function getRepositoryUrl(): Promise<string> {
+    if (!(await lookpath("git"))) {
         return "";
     }
+
+    return new Promise<string>((resolve, reject) => {
+        exec("git config --get remote.origin.url", (error, stdout) => {
+            if (error) {
+                reject(error);
+
+                return;
+            }
+
+            resolve(stdout.toString());
+        });
+    });
 }

package/src/utils/template-utils.ts

@@ -1,5 +1,6 @@
-import { execSync } from "child_process";
+import { exec } from "child_process";
 import fs from "fs-extra";
+import { lookpath } from "lookpath";
 import path from "path";
 import { replaceTokensInFile } from "./file-utils";
 
@@ -151,9 +152,27 @@ export function copyFilter(src: string): boolean {
  * 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", {
-        cwd: destPath,
+export async function runInstall(destPath: string): Promise<void> {
+    if (!(await lookpath("npm"))) {
+        return;
+    }
+
+    return new Promise((resolve, reject) => {
+        exec(
+            "npm install",
+            {
+                cwd: destPath,
+            },
+            error => {
+                if (error) {
+                    reject(error);
+
+                    return;
+                }
+
+                resolve();
+            },
+        );
     });
 }
 
@@ -161,8 +180,26 @@ export function runInstall(destPath: string): void {
  * 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", {
-        cwd: destPath,
+export async function runBuild(destPath: string): Promise<void> {
+    if (!(await lookpath("npm"))) {
+        return;
+    }
+
+    return new Promise((resolve, reject) => {
+        exec(
+            "npm run build",
+            {
+                cwd: destPath,
+            },
+            error => {
+                if (error) {
+                    reject(error);
+
+                    return;
+                }
+
+                resolve();
+            },
+        );
     });
 }

package/tests/file-utils.test.ts

@@ -90,8 +90,8 @@ describe("file-utils", async () => {
     });
 
     describe("get repository url", () => {
-        it("should return the repository url", () => {
-            expect(getRepositoryUrl()).to.be.not.equal("");
+        it("should return the repository url", async () => {
+            expect(await getRepositoryUrl()).to.be.not.equal("");
         });
     });