@tsparticles/cli 3.0.13 → 3.0.15

package/src/utils/file-utils.ts

@@ -4,13 +4,13 @@ import { lookpath } from "lookpath";
 import path from "path";
 
 export interface ReplaceTokensOptions {
-    path: string;
-    tokens: ReplaceTokensData[];
+  path: string;
+  tokens: ReplaceTokensData[];
 }
 
 export interface ReplaceTokensData {
-    from: string | RegExp;
-    to: string;
+  from: string | RegExp;
+  to: string;
 }
 
 /**
@@ -18,19 +18,19 @@ export interface ReplaceTokensData {
  * @param options -
  */
 export async function replaceTokensInFiles(options: ReplaceTokensOptions[]): Promise<void> {
-    for (const item of options) {
-        const filePath = item.path;
+  for (const item of options) {
+    const filePath = item.path;
 
-        let data = await fs.readFile(filePath, "utf-8");
+    let data = await fs.readFile(filePath, "utf-8");
 
-        for (const token of item.tokens) {
-            const regex = new RegExp(token.from, "g");
+    for (const token of item.tokens) {
+      const regex = new RegExp(token.from, "g");
 
-            data = data.replace(regex, token.to);
-        }
-
-        await fs.writeFile(filePath, data);
+      data = data.replace(regex, token.to);
     }
+
+    await fs.writeFile(filePath, data);
+  }
 }
 
 /**
@@ -38,7 +38,7 @@ export async function replaceTokensInFiles(options: ReplaceTokensOptions[]): Pro
  * @param options -
  */
 export async function replaceTokensInFile(options: ReplaceTokensOptions): Promise<void> {
-    await replaceTokensInFiles([options]);
+  await replaceTokensInFiles([options]);
 }
 
 /**
@@ -47,40 +47,40 @@ export async function replaceTokensInFile(options: ReplaceTokensOptions): Promis
  * @returns the destination directory path
  */
 export async function getDestinationDir(destination: string): Promise<string> {
-    const destPath = path.join(process.cwd(), destination),
-        destExists = await fs.pathExists(destPath);
+  const destPath = path.join(process.cwd(), destination),
+    destExists = await fs.pathExists(destPath);
 
-    if (destExists) {
-        const destContents = await fs.readdir(destPath),
-            destContentsNoGit = destContents.filter(t => t !== ".git" && t !== ".gitignore");
+  if (destExists) {
+    const destContents = await fs.readdir(destPath),
+      destContentsNoGit = destContents.filter(t => t !== ".git" && t !== ".gitignore");
 
-        if (destContentsNoGit.length) {
-            throw new Error("Destination folder already exists and is not empty");
-        }
+    if (destContentsNoGit.length) {
+      throw new Error("Destination folder already exists and is not empty");
     }
+  }
 
-    await fs.ensureDir(destPath);
+  await fs.ensureDir(destPath);
 
-    return destPath;
+  return destPath;
 }
 
 /**
  * @returns the repository URL
  */
 export async function getRepositoryUrl(): Promise<string> {
-    if (!(await lookpath("git"))) {
-        return "";
-    }
+  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 new Promise<string>((resolve, reject) => {
+    exec("git config --get remote.origin.url", (error, stdout) => {
+      if (error) {
+        reject(error);
 
-                return;
-            }
+        return;
+      }
 
-            resolve(stdout);
-        });
+      resolve(stdout);
     });
+  });
 }

package/src/utils/string-utils.ts

@@ -5,16 +5,16 @@
  * @returns the capitalized string
  */
 export function capitalize(str: string, ...splits: string[]): string {
-    let res = str.replace(/./, c => c.toUpperCase());
+  let res = str.replace(/./, c => c.toUpperCase());
 
-    for (const split of splits) {
-        res = res
-            .split(split)
-            .map(w => w.replace(/./, c => c.toUpperCase()))
-            .join("");
-    }
+  for (const split of splits) {
+    res = res
+      .split(split)
+      .map(w => w.replace(/./, c => c.toUpperCase()))
+      .join("");
+  }
 
-    return res;
+  return res;
 }
 
 /**
@@ -24,7 +24,7 @@ export function capitalize(str: string, ...splits: string[]): string {
  * @returns the camelized string
  */
 export function camelize(str: string, ...splits: string[]): string {
-    return capitalize(str, ...splits).replace(/./, c => c.toLowerCase());
+  return capitalize(str, ...splits).replace(/./, c => c.toLowerCase());
 }
 
 /**
@@ -33,9 +33,9 @@ export function camelize(str: string, ...splits: string[]): string {
  * @returns the dashed string
  */
 export function dash(str: string): string {
-    const index = 0,
-        dashed = str.replace(/([A-Z])/g, g => `-${g[index]?.toLowerCase() ?? ""}`),
-        startPos = 1;
+  const index = 0,
+    dashed = str.replace(/([A-Z])/g, g => `-${g[index]?.toLowerCase() ?? ""}`),
+    startPos = 1;
 
-    return dashed.startsWith("-") ? dashed.substring(startPos) : dashed;
+  return dashed.startsWith("-") ? dashed.substring(startPos) : dashed;
 }

package/src/utils/template-utils.ts

@@ -13,41 +13,41 @@ import { replaceTokensInFile } from "./file-utils.js";
  * @param repoUrl - The repository URL
  */
 export async function updatePackageFile(
-    destPath: string,
-    packageName: string,
-    description: string,
-    fileName: string,
-    repoUrl: string,
+  destPath: string,
+  packageName: string,
+  description: string,
+  fileName: string,
+  repoUrl: string,
 ): Promise<void> {
-    await replaceTokensInFile({
-        path: path.join(destPath, "package.json"),
-        tokens: [
-            {
-                from: /"tsParticles empty template"/g,
-                to: `"${description}"`,
-            },
-            {
-                from: /"tsparticles.empty.template.min.js"/g,
-                to: `"${fileName}"`,
-            },
-            {
-                from: /\s{4}"private": true,\r?\n?/g,
-                to: "",
-            },
-            {
-                from: /"@tsparticles\/empty-template"/g,
-                to: `"${packageName}"`,
-            },
-            {
-                from: /"url": "git\+https:\/\/github\.com\/tsparticles\/empty-template\.git"/g,
-                to: `"url": "git+${repoUrl}"`,
-            },
-            {
-                from: /"url": "https:\/\/github\.com\/tsparticles\/empty-template\/issues"/g,
-                to: `"url": "${repoUrl.replace(".git", "/issues")}"`,
-            },
-        ],
-    });
+  await replaceTokensInFile({
+    path: path.join(destPath, "package.json"),
+    tokens: [
+      {
+        from: /"tsParticles empty template"/g,
+        to: `"${description}"`,
+      },
+      {
+        from: /"tsparticles.empty.template.min.js"/g,
+        to: `"${fileName}"`,
+      },
+      {
+        from: /\s{4}"private": true,\r?\n?/g,
+        to: "",
+      },
+      {
+        from: /"@tsparticles\/empty-template"/g,
+        to: `"${packageName}"`,
+      },
+      {
+        from: /"url": "git\+https:\/\/github\.com\/tsparticles\/empty-template\.git"/g,
+        to: `"url": "git+${repoUrl}"`,
+      },
+      {
+        from: /"url": "https:\/\/github\.com\/tsparticles\/empty-template\/issues"/g,
+        to: `"url": "${repoUrl.replace(".git", "/issues")}"`,
+      },
+    ],
+  });
 }
 
 /**
@@ -59,41 +59,41 @@ export async function updatePackageFile(
  * @param repoUrl - The url of the repository
  */
 export async function updatePackageDistFile(
-    destPath: string,
-    packageName: string,
-    description: string,
-    fileName: string,
-    repoUrl: string,
+  destPath: string,
+  packageName: string,
+  description: string,
+  fileName: string,
+  repoUrl: string,
 ): Promise<void> {
-    await replaceTokensInFile({
-        path: path.join(destPath, "package.dist.json"),
-        tokens: [
-            {
-                from: /"tsParticles empty template"/g,
-                to: `"${description}"`,
-            },
-            {
-                from: /"tsparticles.empty.template.min.js"/g,
-                to: `"${fileName}"`,
-            },
-            {
-                from: /\s{4}"private": true,\r?\n?/g,
-                to: "",
-            },
-            {
-                from: /"@tsparticles\/empty-template"/g,
-                to: `"${packageName}"`,
-            },
-            {
-                from: /"url": "git\+https:\/\/github\.com\/tsparticles\/empty-template\.git"/g,
-                to: `"url": "git+${repoUrl}"`,
-            },
-            {
-                from: /"url": "https:\/\/github\.com\/tsparticles\/empty-template\/issues"/g,
-                to: `"url": "${repoUrl.replace(".git", "/issues")}"`,
-            },
-        ],
-    });
+  await replaceTokensInFile({
+    path: path.join(destPath, "package.dist.json"),
+    tokens: [
+      {
+        from: /"tsParticles empty template"/g,
+        to: `"${description}"`,
+      },
+      {
+        from: /"tsparticles.empty.template.min.js"/g,
+        to: `"${fileName}"`,
+      },
+      {
+        from: /\s{4}"private": true,\r?\n?/g,
+        to: "",
+      },
+      {
+        from: /"@tsparticles\/empty-template"/g,
+        to: `"${packageName}"`,
+      },
+      {
+        from: /"url": "git\+https:\/\/github\.com\/tsparticles\/empty-template\.git"/g,
+        to: `"url": "git+${repoUrl}"`,
+      },
+      {
+        from: /"url": "https:\/\/github\.com\/tsparticles\/empty-template\/issues"/g,
+        to: `"url": "${repoUrl.replace(".git", "/issues")}"`,
+      },
+    ],
+  });
 }
 
 /**
@@ -104,28 +104,28 @@ export async function updatePackageDistFile(
  * @param fnName - The name of the function to load the template
  */
 export async function updateWebpackFile(
-    destPath: string,
-    name: string,
-    description: string,
-    fnName: string,
+  destPath: string,
+  name: string,
+  description: string,
+  fnName: string,
 ): Promise<void> {
-    await replaceTokensInFile({
-        path: path.join(destPath, "webpack.config.js"),
-        tokens: [
-            {
-                from: /"Empty"/g,
-                to: `"${description}"`,
-            },
-            {
-                from: /"empty"/g,
-                to: `"${name}"`,
-            },
-            {
-                from: /loadParticlesTemplate/g,
-                to: fnName,
-            },
-        ],
-    });
+  await replaceTokensInFile({
+    path: path.join(destPath, "webpack.config.js"),
+    tokens: [
+      {
+        from: /"Empty"/g,
+        to: `"${description}"`,
+      },
+      {
+        from: /"empty"/g,
+        to: `"${name}"`,
+      },
+      {
+        from: /loadParticlesTemplate/g,
+        to: fnName,
+      },
+    ],
+  });
 }
 
 /**
@@ -133,10 +133,10 @@ export async function updateWebpackFile(
  * @param destPath - The path where the project will be created
  */
 export async function copyEmptyTemplateFiles(destPath: string): Promise<void> {
-    await fs.copy(path.join(__dirname, "..", "..", "files", "empty-project"), destPath, {
-        overwrite: true,
-        filter: copyFilter,
-    });
+  await fs.copy(path.join(__dirname, "..", "..", "files", "empty-project"), destPath, {
+    overwrite: true,
+    filter: copyFilter,
+  });
 }
 
 /**
@@ -145,7 +145,7 @@ export async function copyEmptyTemplateFiles(destPath: string): Promise<void> {
  * @returns true if the file should be copied
  */
 export function copyFilter(src: string): boolean {
-    return !(src.endsWith("node_modules") || src.endsWith("dist"));
+  return !(src.endsWith("node_modules") || src.endsWith("dist"));
 }
 
 /**
@@ -153,27 +153,27 @@ export function copyFilter(src: string): boolean {
  * @param destPath - The path where the project will be created
  */
 export async function runInstall(destPath: string): Promise<void> {
-    if (!(await lookpath("npm"))) {
-        return;
-    }
+  if (!(await lookpath("npm"))) {
+    return;
+  }
 
-    return new Promise((resolve, reject) => {
-        exec(
-            "npm install",
-            {
-                cwd: destPath,
-            },
-            error => {
-                if (error) {
-                    reject(error);
+  return new Promise((resolve, reject) => {
+    exec(
+      "npm install",
+      {
+        cwd: destPath,
+      },
+      error => {
+        if (error) {
+          reject(error);
 
-                    return;
-                }
+          return;
+        }
 
-                resolve();
-            },
-        );
-    });
+        resolve();
+      },
+    );
+  });
 }
 
 /**
@@ -181,25 +181,25 @@ export async function runInstall(destPath: string): Promise<void> {
  * @param destPath - The path where the project will be build
  */
 export async function runBuild(destPath: string): Promise<void> {
-    if (!(await lookpath("npm"))) {
-        return;
-    }
+  if (!(await lookpath("npm"))) {
+    return;
+  }
 
-    return new Promise((resolve, reject) => {
-        exec(
-            "npm run build",
-            {
-                cwd: destPath,
-            },
-            error => {
-                if (error) {
-                    reject(error);
+  return new Promise((resolve, reject) => {
+    exec(
+      "npm run build",
+      {
+        cwd: destPath,
+      },
+      error => {
+        if (error) {
+          reject(error);
 
-                    return;
-                }
+          return;
+        }
 
-                resolve();
-            },
-        );
-    });
+        resolve();
+      },
+    );
+  });
 }

package/tests/create-plugin.test.ts

@@ -8,7 +8,11 @@ describe("create-plugin", () => {
         const destDir = path.join(__dirname, "tmp-files", "foo-plugin"),
             pkgPath = path.join(destDir, "package.json");
 
-        await createPluginTemplate("foo", "Foo", "", destDir);
+        try {
+            await createPluginTemplate("foo", "Foo", "", destDir);
+        } catch (e) {
+            console.error(e);
+        }
 
         const pkgInfo = await fs.readJSON(pkgPath);
 
@@ -18,9 +22,13 @@ describe("create-plugin", () => {
     });
 
     it("should have created the plugin project, w/ repo", async () => {
-        const destDir = path.join(__dirname,"tmp-files", "bar-plugin");
+        const destDir = path.join(__dirname, "tmp-files", "bar-plugin");
 
-        await createPluginTemplate("bar", "Bar", "https://github.com/matteobruni/tsparticles", destDir);
+        try {
+            await createPluginTemplate("bar", "Bar", "https://github.com/matteobruni/tsparticles", destDir);
+        } catch (e) {
+            console.error(e);
+        }
 
         const pkgPath = path.join(destDir, "package.json"),
             pkgInfo = await fs.readJSON(pkgPath);

package/tests/create-preset.test.ts

@@ -7,7 +7,11 @@ describe("create-preset", () => {
     it("should have created the preset project", async () => {
         const destDir = path.join(__dirname, "tmp-files", "foo-preset");
 
-        await createPresetTemplate("foo", "Foo", "", destDir);
+        try {
+            await createPresetTemplate("foo", "Foo", "", destDir);
+        } catch (e) {
+            console.error(e);
+        }
 
         const pkgPath = path.join(destDir, "package.json"),
             pkgInfo = await fs.readJSON(pkgPath);
@@ -20,7 +24,11 @@ describe("create-preset", () => {
     it("should have created the preset project, w/ repo", async () => {
         const destDir = path.join(__dirname, "tmp-files", "bar-preset");
 
-        await createPresetTemplate("bar", "Bar", "https://github.com/matteobruni/tsparticles", destDir);
+        try {
+            await createPresetTemplate("bar", "Bar", "https://github.com/matteobruni/tsparticles", destDir);
+        } catch (e) {
+            console.error(e);
+        }
 
         const pkgPath = path.join(destDir, "package.json"),
             pkgInfo = await fs.readJSON(pkgPath);

package/tests/create-shape.test.ts

@@ -7,7 +7,11 @@ describe("create-shape", () => {
     it("should have created the shape project", async () => {
         const destDir = path.join(__dirname, "tmp-files", "foo-shape");
 
-        await createShapeTemplate("foo", "Foo", "", destDir);
+        try {
+            await createShapeTemplate("foo", "Foo", "", destDir);
+        } catch (e) {
+            console.error(e);
+        }
 
         const pkgPath = path.join(destDir, "package.json"),
             pkgInfo = await fs.readJSON(pkgPath);
@@ -20,7 +24,11 @@ describe("create-shape", () => {
     it("should have created the shape project, w/ repo", async () => {
         const destDir = path.join(__dirname, "tmp-files", "bar-shape");
 
-        await createShapeTemplate("bar", "Bar", "https://github.com/matteobruni/tsparticles", destDir);
+        try {
+            await createShapeTemplate("bar", "Bar", "https://github.com/matteobruni/tsparticles", destDir);
+        } catch (e) {
+            console.error(e);
+        }
 
         const pkgPath = path.join(destDir, "package.json"),
             pkgInfo = await fs.readJSON(pkgPath);

package/tests/tsconfig.json

@@ -1,24 +1,12 @@
 {
+    "extends": "../tsconfig.json",
     "compilerOptions": {
+        "rootDir": ".",
         "target": "ES2021",
-        "module": "NodeNext",
-        "lib": ["ESNext", "ES2024", "ES2023", "ES2022", "ES2021", "ES2020", "ES2019", "ES2018", "ES2017", "ES2016", "ES2015", "DOM"],
-        "types": ["jsdom", "vitest", "node"],
         "allowJs": true,
-        "rootDir": ".",
         "declaration": false,
         "removeComments": true,
-        "importHelpers": false,
-        "strict": true,
-        "noImplicitAny": true,
-        "strictNullChecks": true,
-        "alwaysStrict": true,
-        "noFallthroughCasesInSwitch": true,
-        "moduleResolution": "NodeNext",
-        "allowSyntheticDefaultImports": true,
-        "esModuleInterop": true,
-        "experimentalDecorators": true,
-        "forceConsistentCasingInFileNames": true
+        "importHelpers": false
     },
     "references": [{ "path": "../src" }],
     "include": ["**/*.ts"]

package/tsconfig.json

@@ -1,23 +1,56 @@
 {
-  "compilerOptions": {
-    "rootDir": ".",
-    "outDir": ".",
-    "resolveJsonModule": true,
-    "composite": true,
-    "types": [
-      "node",
-      "chai",
-      "mocha",
-      "fs-extra",
-      "klaw",
-      "madge",
-      "prompts",
-      "eslint"
+    "compilerOptions": {
+        "rootDir": ".",
+        "outDir": ".",
+        "resolveJsonModule": true,
+        "composite": true,
+        "target": "ESNext",
+        "module": "NodeNext",
+        "moduleResolution": "NodeNext",
+        "lib": [
+            "ESNext",
+            "ES2024",
+            "ES2023",
+            "ES2022",
+            "ES2021",
+            "ES2020",
+            "ES2019",
+            "ES2018",
+            "ES2017",
+            "ES2016",
+            "ES2015"
+        ],
+        "types": [
+            "node",
+            "fs-extra",
+            "klaw",
+            "madge",
+            "prompts",
+            "eslint",
+            "vitest"
+        ],
+        "strict": true,
+        "noImplicitAny": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "strictBindCallApply": true,
+        "strictPropertyInitialization": true,
+        "noImplicitThis": true,
+        "useUnknownInCatchVariables": true,
+        "alwaysStrict": true,
+        "noUnusedLocals": true,
+        "noUnusedParameters": true,
+        "exactOptionalPropertyTypes": true,
+        "noImplicitReturns": true,
+        "noFallthroughCasesInSwitch": true,
+        "noUncheckedIndexedAccess": true,
+        "noImplicitOverride": true,
+        "noPropertyAccessFromIndexSignature": true,
+        "esModuleInterop": true,
+        "forceConsistentCasingInFileNames": true,
+        "allowSyntheticDefaultImports": true
+    },
+    "include": [
+        "src/**/*"
     ]
-  },
-  "include": [
-    "src/**/*",
-    "tests/**/*",
-    "files/**/*"
-  ]
 }