@storm-software/workspace-tools 1.270.1 → 1.271.0

package/docs/api/executors/typia/schema.md

@@ -0,0 +1,46 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Typia Executor
+
+## `outputPath`
+- **Type**: `string`
+- **Default**: `"{sourceRoot}/__generated__/typia"`
+
+> Output Path
+
+
+The output path for the build
+
+
+## `entry`
+- **Type**: `array`
+- **Default**: `["{sourceRoot}/index.ts"]`
+
+> Entry File(s)
+
+
+The entry file or files to build
+
+
+## `tsconfig`
+- **Type**: `string`
+- **Default**: `"{projectRoot}/tsconfig.json"`
+
+> TSConfig Path
+
+
+The path to the tsconfig file
+
+
+## `clean`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Clean
+
+
+Clean the output directory before building
+
+

package/docs/api/executors/unbuild/schema.md

@@ -0,0 +1,222 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Unbuild Executor
+
+## `outputPath`
+- **Type**: `string`
+
+> Output Path
+
+
+The output path for the build
+
+
+## `entry`
+- **Type**: `array`
+- **Default**: `["{sourceRoot}"]`
+
+> Input Directory
+
+
+The directory to use as input for the build
+
+
+## `tsconfig`
+- **Type**: `string`
+- **Default**: `"{projectRoot}/tsconfig.json"`
+
+> TSConfig Path
+
+
+The path to the tsconfig file
+
+
+## `bundle`
+- **Type**: `boolean`
+
+> Bundle
+
+
+Bundle the output
+
+
+## `minify`
+- **Type**: `boolean`
+
+> Minify
+
+
+Minify the output
+
+
+## `debug`
+- **Type**: `boolean`
+
+> Debug
+
+
+Debug the output
+
+
+## `sourcemap`
+- **Type**: `boolean`
+
+> Sourcemap
+
+
+Generate a sourcemap
+
+
+## `silent`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Silent
+
+
+Should the build run silently - only report errors back to the user
+
+
+## `target`
+- **Type**: `string`
+- **Default**: `"esnext"`
+
+> Target
+
+
+The target to build
+
+
+## `format`
+- **Type**: `array`
+- **Default**: `["cjs","esm"]`
+
+> Format
+
+
+The format to build
+
+
+## `platform`
+- **Type**: `string`
+- **Default**: `"neutral"`
+
+> Platform
+
+
+The platform to build
+
+
+## `external`
+- **Type**: `array`
+- **Default**: `[]`
+
+> External
+
+
+The external dependencies
+
+
+## `define`
+
+## `env`
+
+## `name`
+- **Type**: `string`
+- **Default**: `"{projectName}"`
+
+> Name
+
+
+The name of the project/build
+
+
+## `treeShaking`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Tree Shaking
+
+
+Enable tree shaking
+
+
+## `watch`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Watch
+
+
+Watch for changes
+
+
+## `clean`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Clean
+
+
+Clean the output directory before building
+
+
+## `stub`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Stub
+
+
+Stub the output
+
+
+## `buildOnly`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Build Only
+
+
+Should the build process skip generating a package.json and copying assets
+
+
+## `watchOptions`
+
+## `stubOptions`
+
+## `dependencies`
+- **Type**: `array`
+
+> Dependencies
+
+
+The dependencies to install
+
+
+## `peerDependencies`
+- **Type**: `array`
+
+> Peer Dependencies
+
+
+The peer dependencies to install
+
+
+## `devDependencies`
+- **Type**: `array`
+
+> Dev Dependencies
+
+
+The dev dependencies to install
+
+
+## `alias`
+
+## `replace`
+
+## `rollup`
+

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

@@ -0,0 +1,58 @@
+<!-- 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/browser-library/schema.md

@@ -0,0 +1,129 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Browser 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**: `"browser"`
+
+> 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/config-schema/schema.md

@@ -0,0 +1,25 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Config Schema Generator
+
+## `directory`
+- **Type**: `string`
+
+> Directory
+
+
+The directory to create the library in
+
+
+## `outputFile`
+- **Type**: `string`
+- **Default**: `"{workspaceRoot}/storm-workspace.schema.json"`
+
+> Output File
+
+
+The file to write the schema to
+
+

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

@@ -0,0 +1,15 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Init Generator
+
+## `skipFormat`
+- **Type**: `boolean`
+
+> Skip Format
+
+
+Skip formatting the generated files
+
+

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

@@ -0,0 +1,58 @@
+<!-- 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/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
+
+