@storm-software/workspace-tools 1.270.1 → 1.271.0

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/docs/api/generators/release-version/schema.md

@@ -0,0 +1,160 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Release Version Generator
+
+## `projects`
+- **Type**: `array`
+
+> Projects
+
+
+The projects to release
+
+
+## `releaseGroup`
+
+## `projectGraph`
+
+## `specifier`
+- **Type**: `string`
+
+> Specifier
+
+
+The specifier
+
+
+## `specifierSource`
+- **Type**: `string`
+
+> Specifier Source
+
+
+The specifier source
+
+
+## `preid`
+- **Type**: `string`
+
+> Preid
+
+
+The preid
+
+
+## `packageRoot`
+- **Type**: `string`
+
+> Package Root
+
+
+The package root
+
+
+## `currentVersionResolver`
+- **Type**: `string`
+- **Default**: `"git-tag"`
+
+> Current Version Resolver
+
+
+The current version resolver
+
+
+## `currentVersionResolverMetadata`
+
+## `fallbackCurrentVersionResolver`
+- **Type**: `string`
+- **Default**: `"disk"`
+
+> Fallback Current Version Resolver
+
+
+The fallback current version resolver
+
+
+## `firstRelease`
+- **Type**: `boolean`
+
+> First Release
+
+
+Release the first version
+
+
+## `versionPrefix`
+- **Type**: `string`
+
+> Version Prefix
+
+
+The version prefix
+
+
+## `skipLockFileUpdate`
+- **Type**: `boolean`
+
+> Skip Lock File Update
+
+
+Skip lock file update
+
+
+## `installArgs`
+- **Type**: `string`
+
+> Install Args
+
+
+The install arguments
+
+
+## `installIgnoreScripts`
+- **Type**: `boolean`
+
+> Install Ignore Scripts
+
+
+Ignore scripts
+
+
+## `conventionalCommitsConfig`
+
+## `deleteVersionPlans`
+- **Type**: `boolean`
+
+> Delete Version Plans
+
+
+Delete version plans
+
+
+## `updateDependents`
+- **Type**: `string`
+
+> Update Dependents
+
+
+Update dependents
+
+
+## `logUnchangedProjects`
+- **Type**: `boolean`
+
+> Log Unchanged Projects
+
+
+Log unchanged projects
+
+
+## `preserveLocalDependencyProtocols`
+- **Type**: `boolean`
+
+> Preserve Local Dependency Protocols
+
+
+Preserve local dependency protocols
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storm-software/workspace-tools",
-  "version": "1.270.1",
+  "version": "1.271.0",
   "description": "Tools for managing a Storm workspace, including various Nx generators and executors for common development tasks.",
   "repository": {
     "type": "github",
@@ -34,28 +34,16 @@
         "types": "./dist/index.d.mts",
         "default": "./dist/index.mjs"
       },
-      "require": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      },
-      "default": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      }
+      "require": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
+      "default": { "types": "./dist/index.d.ts", "default": "./dist/index.js" }
     },
     "./index": {
       "import": {
         "types": "./dist/index.d.mts",
         "default": "./dist/index.mjs"
       },
-      "require": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      },
-      "default": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      }
+      "require": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
+      "default": { "types": "./dist/index.d.ts", "default": "./dist/index.js" }
     },
     "./executors": {
       "import": {
@@ -208,15 +196,9 @@
     "prettier": "^3.5.1"
   },
   "peerDependenciesMeta": {
-    "markdownlint-cli2": {
-      "optional": false
-    },
-    "nx": {
-      "optional": false
-    },
-    "prettier": {
-      "optional": false
-    }
+    "markdownlint-cli2": { "optional": false },
+    "nx": { "optional": false },
+    "prettier": { "optional": false }
   },
   "dependencies": {
     "@ltd/j-toml": "1.38.0",
@@ -226,16 +208,14 @@
     "@size-limit/esbuild": "11.1.4",
     "@size-limit/esbuild-why": "11.1.4",
     "@size-limit/file": "11.1.4",
-    "@storm-software/esbuild": "0.38.1",
-    "@storm-software/prettier": "0.48.1",
-    "@storm-software/unbuild": "0.44.1",
-    "columnify": "^1.6.0",
+    "@storm-software/esbuild": "^0.39.1",
+    "@storm-software/prettier": "^0.49.1",
+    "@storm-software/unbuild": "^0.45.1",
     "fs-extra": "11.2.0",
     "glob": "^11.0.1",
     "jiti": "^2.4.2",
     "markdownlint-cli2": "^0.17.2",
     "micromatch": "^4.0.8",
-    "npm-run-path": "^4.0.1",
     "prettier": "^3.5.1",
     "prettier-plugin-pkg": "^0.18.1",
     "read-yaml-file": "2.1.0",
@@ -256,9 +236,7 @@
     "tsup": "8.4.0",
     "typescript": "^5.8.3"
   },
-  "publishConfig": {
-    "access": "public"
-  },
+  "publishConfig": { "access": "public" },
   "executors": "./executors.json",
   "generators": "./generators.json"
-}
+}