@tsparticles/cli-create-utils 4.0.0-beta.12 → 4.0.0-beta.16

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [4.0.0-beta.16](https://github.com/tsparticles/tsparticles/compare/v4.0.0-beta.15...v4.0.0-beta.16) (2026-05-09)
+
+**Note:** Version bump only for package @tsparticles/cli-create-utils
+
+# [4.0.0-beta.15](https://github.com/tsparticles/tsparticles/compare/v4.0.0-beta.14...v4.0.0-beta.15) (2026-05-09)
+
+**Note:** Version bump only for package @tsparticles/cli-create-utils

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Matteo Bruni
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,51 +1,52 @@
-[![banner](https://particles.js.org/images/banner2.png)](https://particles.js.org)
+# @tsparticles/cli-create-utils
 
-# tsParticles CLI
+Shared utilities used by `@tsparticles/cli-command-create` and all modular `create-*` command packages.
 
-## Installation
-
-### NPM
-
-```bash
-npm install -g @tsparticles/cli-create
-```
+## What It Provides
 
-### Yarn
+- project scaffold generation (`createProjectTemplate`)
+- interactive prompt helpers (`promptProjectData`)
+- filesystem helpers (`getDestinationDir`, `getRepositoryUrl`, token replacement)
+- template/package update helpers (`updatePackageFile`, `copyEmptyTemplateFiles`, `runInstall`, `runBuild`)
+- string naming helpers (`capitalize`, `camelize`, `dash`)
 
-```bash
-yarn global add @tsparticles/cli-create
-```
-
-### PNPM
+## Installation
 
 ```bash
-pnpm global add @tsparticles/cli-create
+pnpm add @tsparticles/cli-create-utils
 ```
 
-## Usage
+## Exports
 
-### Help
+This package re-exports everything from:
 
-```bash
-npx @tsparticles/cli-create --help
-```
+- `src/create-project.ts`
+- `src/file-utils.ts`
+- `src/prompt-utils.ts`
+- `src/string-utils.ts`
+- `src/template-utils.ts`
 
-or
+## Typical Usage
 
-```bash
-tsparticles-create --help
-```
+```ts
+import { Command } from "commander";
+import { createProjectTemplate, promptProjectData } from "@tsparticles/cli-create-utils";
 
-### Create
+const cmd = new Command("shape");
 
-#### Preset
+cmd.argument("<destination>");
+cmd.action(async destination => {
+  const data = await promptProjectData({
+    destination,
+    nameLabel: "shape",
+  });
 
-```bash
-npx @tsparticles/cli-create preset <folder>
-```
-
-or
-
-```bash
-tsparticles-create preset <folder>
+  await createProjectTemplate({
+    description: data.description,
+    destination: data.destinationPath,
+    kind: "shape",
+    name: data.name,
+    repositoryUrl: data.repositoryUrl,
+  });
+});
 ```

package/dist/create-project.d.ts

@@ -0,0 +1,18 @@
+export type CreateProjectKind = "bundle" | "effect" | "interaction" | "palette" | "path" | "plugin" | "preset" | "shape" | "updater";
+export type InteractionType = "external" | "generic" | "particles";
+export type PluginType = "color-manager" | "easing" | "emitters-shape" | "export" | "generic";
+type SubType = InteractionType | PluginType | undefined;
+export interface ICreateProjectOptions {
+    description: string;
+    destination: string;
+    kind: CreateProjectKind;
+    name: string;
+    repositoryUrl: string;
+    type?: SubType;
+}
+/**
+ *
+ * @param options
+ */
+export declare function createProjectTemplate(options: ICreateProjectOptions): Promise<void>;
+export {};