@storm-software/workspace-tools 1.295.85 → 1.295.87

package/docs/api/generators/neutral-library/schema.md

@@ -0,0 +1,129 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Neutral Library Generator
+
+## `directory`
+- **Type**: `string`
+
+> Directory
+
+
+The directory to create the library in
+
+
+## `name`
+- **Type**: `string`
+
+> Name
+
+
+The name of the library
+
+
+## `description`
+- **Type**: `string`
+
+> Description
+
+
+The description of the library
+
+
+## `buildExecutor`
+- **Type**: `string`
+- **Default**: `"@storm-software/workspace-tools:unbuild"`
+
+> Build Executor
+
+
+The executor to use for building the library
+
+
+## `platform`
+- **Type**: `string`
+- **Default**: `"neutral"`
+
+> Platform
+
+
+The platform to target with the library
+
+
+## `importPath`
+- **Type**: `string`
+
+> Import Path
+
+
+The import path for the library
+
+
+## `tags`
+- **Type**: `string`
+
+> Tags
+
+
+The tags for the library
+
+
+## `unitTestRunner`
+- **Type**: `string`
+
+> Unit Test Runner
+
+
+The unit test runner to use
+
+
+## `testEnvironment`
+- **Type**: `string`
+
+> Test Environment
+
+
+The test environment to use
+
+
+## `pascalCaseFiles`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Pascal Case Files
+
+
+Use PascalCase for file names
+
+
+## `strict`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Strict
+
+
+Enable strict mode
+
+
+## `publishable`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Publishable
+
+
+Make the library publishable
+
+
+## `buildable`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Buildable
+
+
+Make the library buildable
+
+

package/docs/api/generators/node-library/files/README.md

@@ -0,0 +1,63 @@
+<!-- START header -->
+<!-- END header -->
+
+# <%= name %>
+
+<%= description %>
+
+<!-- START doctoc -->
+<!-- END doctoc -->
+
+## Installing
+
+Using [pnpm](http://pnpm.io):
+
+```bash
+pnpm add -D <%= namespace %>/<%= name %>
+```
+
+<details>
+  <summary>Using npm</summary>
+
+```bash
+npm install -D <%= namespace %>/<%= name %>
+```
+
+</details>
+
+<details>
+  <summary>Using yarn</summary>
+
+```bash
+yarn add -D <%= namespace %>/<%= name %>
+```
+
+</details>
+
+## Reduced Package Size
+
+This project uses [tsup](https://tsup.egoist.dev/) to package the source code
+due to its ability to remove unused code and ship smaller javascript files
+thanks to code splitting. This helps to greatly reduce the size of the package
+and to make it easier to use in other projects.
+
+## Development
+
+This project is built using [Nx](https://nx.dev). As a result, many of the usual
+commands are available to assist in development.
+
+### Building
+
+Run `nx build <%= name %>` to build the library.
+
+### Running unit tests
+
+Run `nx test <%= name %>` to execute the unit tests via
+[Jest](https://jestjs.io).
+
+### Linting
+
+Run `nx lint <%= name %>` to run [ESLint](https://eslint.org/) on the package.
+
+<!-- START footer -->
+<!-- END footer -->

package/docs/api/generators/node-library/schema.md

@@ -0,0 +1,129 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Node Library Generator
+
+## `directory`
+- **Type**: `string`
+
+> Directory
+
+
+The directory to create the library in
+
+
+## `name`
+- **Type**: `string`
+
+> Name
+
+
+The name of the library
+
+
+## `description`
+- **Type**: `string`
+
+> Description
+
+
+The description of the library
+
+
+## `buildExecutor`
+- **Type**: `string`
+- **Default**: `"@storm-software/workspace-tools:unbuild"`
+
+> Build Executor
+
+
+The executor to use for building the library
+
+
+## `platform`
+- **Type**: `string`
+- **Default**: `"node"`
+
+> Platform
+
+
+The platform to target with the library
+
+
+## `importPath`
+- **Type**: `string`
+
+> Import Path
+
+
+The import path for the library
+
+
+## `tags`
+- **Type**: `string`
+
+> Tags
+
+
+The tags for the library
+
+
+## `unitTestRunner`
+- **Type**: `string`
+
+> Unit Test Runner
+
+
+The unit test runner to use
+
+
+## `testEnvironment`
+- **Type**: `string`
+
+> Test Environment
+
+
+The test environment to use
+
+
+## `pascalCaseFiles`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Pascal Case Files
+
+
+Use PascalCase for file names
+
+
+## `strict`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Strict
+
+
+Enable strict mode
+
+
+## `publishable`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Publishable
+
+
+Make the library publishable
+
+
+## `buildable`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Buildable
+
+
+Make the library buildable
+
+

package/docs/api/generators/preset/schema.md

@@ -0,0 +1,110 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Preset Generator
+
+## `directory`
+- **Type**: `string`
+
+> Directory
+
+
+The directory to create the library in
+
+
+## `name`
+- **Type**: `string`
+
+> Name
+
+
+The name of the workspace
+
+
+## `organization`
+- **Type**: `string`
+- **Default**: `"storm-software"`
+
+> Organization
+
+
+The organization of the workspace
+
+
+## `includeApps`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Include Apps
+
+
+Include apps in the workspace
+
+
+## `includeRust`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Include Rust
+
+
+Include Rust support in the workspace
+
+
+## `namespace`
+- **Type**: `string`
+- **Default**: `"storm-software"`
+
+> Namespace
+
+
+The namespace of the workspace
+
+
+## `description`
+- **Type**: `string`
+
+> Description
+
+
+The description of the workspace
+
+
+## `repositoryUrl`
+- **Type**: `string`
+
+> Repository URL
+
+
+The URL of the repository
+
+
+## `nxCloud`
+- **Type**: `string`
+
+> Nx Cloud
+
+
+Nx Cloud configuration
+
+
+## `mode`
+- **Type**: `string`
+
+> Mode
+
+
+The mode of the Nx client
+
+
+## `packageManager`
+- **Type**: `string`
+- **Default**: `"pnpm"`
+
+> Package Manager
+
+
+The package manager to use
+
+

package/executors.json

@@ -0,0 +1,69 @@
+{
+  "executors": {
+    "typia": {
+      "implementation": "./dist/src/executors/typia/executor",
+      "schema": "./dist/src/executors/typia/schema.json",
+      "description": "Run the `typia` generator to create runtime type validators"
+    },
+    "esbuild": {
+      "implementation": "./dist/src/executors/esbuild/executor",
+      "schema": "./dist/src/executors/esbuild/schema.json",
+      "description": "Run the `esbuild` build process on a selected project"
+    },
+    "unbuild": {
+      "implementation": "./dist/src/executors/unbuild/executor",
+      "schema": "./dist/src/executors/unbuild/schema.json",
+      "description": "Run the `unbuild` build process on a selected project"
+    },
+    "clean-package": {
+      "implementation": "./dist/src/executors/clean-package/executor",
+      "schema": "./dist/src/executors/clean-package/schema.json",
+      "description": "Remove configuration files, fields, and scripts for development before publishing package. The executor will remove these unnecessary files and fields to make the distributable package as light as possible (for scenarios like edge computing, limited memory environments, etc.)"
+    },
+    "size-limit": {
+      "implementation": "./dist/src/executors/size-limit/executor",
+      "schema": "./dist/src/executors/size-limit/schema.json",
+      "description": "Run a size-limit performance test on the project"
+    },
+    "npm-publish": {
+      "implementation": "./dist/src/executors/npm-publish/executor",
+      "schema": "./dist/src/executors/npm-publish/schema.json",
+      "description": "Publish a package to the NPM registry"
+    },
+    "cargo-publish": {
+      "implementation": "./dist/src/executors/cargo-publish/executor",
+      "schema": "./dist/src/executors/cargo-publish/schema.json",
+      "description": "Publish a Rust crate to the crates.io registry"
+    },
+    "cargo-build": {
+      "implementation": "./dist/src/executors/cargo-build/executor",
+      "schema": "./dist/src/executors/cargo-build/schema.json",
+      "description": "Build a Rust project with Cargo Build"
+    },
+    "cargo-check": {
+      "implementation": "./dist/src/executors/cargo-check/executor",
+      "schema": "./dist/src/executors/cargo-check/schema.json",
+      "description": "Check a Rust project with Cargo Check"
+    },
+    "cargo-format": {
+      "implementation": "./dist/src/executors/cargo-format/executor",
+      "schema": "./dist/src/executors/cargo-format/schema.json",
+      "description": "Format a Rust project with Cargo Fmt"
+    },
+    "cargo-clippy": {
+      "implementation": "./dist/src/executors/cargo-clippy/executor",
+      "schema": "./dist/src/executors/cargo-clippy/schema.json",
+      "description": "Lint a Rust project with Cargo Clippy"
+    },
+    "cargo-doc": {
+      "implementation": "./dist/src/executors/cargo-doc/executor",
+      "schema": "./dist/src/executors/cargo-doc/schema.json",
+      "description": "Create docs for a Rust project with Cargo Doc"
+    },
+    "napi": {
+      "implementation": "./dist/src/executors/napi/executor",
+      "schema": "./dist/src/executors/napi/schema.json",
+      "description": "Build Node.js native addons using N-API and Rust via the NAPI-RS framework"
+    }
+  }
+}

package/generators.json

@@ -0,0 +1,51 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "name": "storm-workspace",
+  "version": "0.0.1",
+  "generators": {
+    "init": {
+      "factory": "./dist/src/generators/init/init#initGenerator",
+      "schema": "./dist/src/generators/init/schema.json",
+      "description": "Initialize the `@storm-software/workspace-tools` plugin.",
+      "aliases": ["ng-add"],
+      "internal": true
+    },
+    "preset": {
+      "factory": "./dist/src/generators/preset/generator",
+      "schema": "./dist/src/generators/preset/schema.json",
+      "description": "Storm workspace preset generator",
+      "x-use-standalone-layout": true
+    },
+    "node-library": {
+      "factory": "./dist/src/generators/node-library/generator",
+      "schema": "./dist/src/generators/node-library/schema.json",
+      "aliases": ["node-lib"],
+      "x-type": "library",
+      "description": "Create a new NodeJs TypeScript library package in the Storm workspace"
+    },
+    "config-schema": {
+      "factory": "./dist/src/generators/config-schema/generator",
+      "schema": "./dist/src/generators/config-schema/schema.json",
+      "description": "Create a Storm JSON schema based on the workspaces project configurations"
+    },
+    "neutral-library": {
+      "factory": "./dist/src/generators/neutral-library/generator",
+      "schema": "./dist/src/generators/neutral-library/schema.json",
+      "aliases": ["neutral-lib"],
+      "x-type": "library",
+      "description": "Create a new Neutral TypeScript library package in the Storm workspace"
+    },
+    "browser-library": {
+      "factory": "./dist/src/generators/browser-library/generator",
+      "schema": "./dist/src/generators/browser-library/schema.json",
+      "aliases": ["browser-lib"],
+      "x-type": "library",
+      "description": "Create a new browser TypeScript library package in the Storm workspace"
+    },
+    "release-version": {
+      "factory": "./dist/src/generators/release-version/generator",
+      "schema": "./dist/src/generators/release-version/schema.json",
+      "description": "The release version generator used in Storm Workspaces"
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storm-software/workspace-tools",
-  "version": "1.295.85",
+  "version": "1.295.87",
   "description": "Tools for managing a Storm workspace, including various Nx generators and executors for common development tasks.",
   "keywords": [
     "monorepo",
@@ -237,13 +237,13 @@
     "@size-limit/esbuild": "^11.2.0",
     "@size-limit/esbuild-why": "^11.2.0",
     "@size-limit/file": "^11.2.0",
-    "@storm-software/config-tools": "1.190.25",
-    "@storm-software/esbuild": "0.53.186",
-    "@storm-software/npm-tools": "0.6.142",
-    "@storm-software/pnpm-tools": "0.7.35",
-    "@storm-software/prettier": "0.59.77",
-    "@storm-software/tsdown": "0.45.186",
-    "@storm-software/unbuild": "0.57.186",
+    "@storm-software/config-tools": "^1.190.25",
+    "@storm-software/esbuild": "^0.53.186",
+    "@storm-software/npm-tools": "^0.6.142",
+    "@storm-software/pnpm-tools": "^0.7.35",
+    "@storm-software/prettier": "^0.59.77",
+    "@storm-software/tsdown": "^0.45.186",
+    "@storm-software/unbuild": "^0.57.186",
     "fs-extra": "11.2.0",
     "glob": "^11.1.0",
     "jiti": "2.4.2",
@@ -257,7 +257,7 @@
   },
   "devDependencies": {
     "@napi-rs/cli": "^3.6.2",
-    "@storm-software/package-constants": "0.1.38",
+    "@storm-software/package-constants": "^0.1.38",
     "@types/micromatch": "^4.0.10",
     "@types/node": "^25.9.1",
     "@types/semver": "^7.7.1",
@@ -282,5 +282,5 @@
   "publishConfig": { "access": "public" },
   "executors": "./executors.json",
   "generators": "./generators.json",
-  "gitHead": "612ced4c4fb0ca6359356cecc9a163042286f577"
+  "gitHead": "b430e8c833499dbf379ae4797f81d1b9b4846556"
 }