@storm-software/workspace-tools 1.21.19 → 1.22.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storm-software/workspace-tools",
-  "version": "1.21.19",
+  "version": "1.22.1",
   "private": false,
   "description": "⚡ A Nx plugin package that contains various executors and generators used in a Storm workspaces.",
   "keywords": [

package/src/executors/tsup/schema.d.ts

@@ -20,17 +20,17 @@ export type TsupExecutorSchema = Omit<
   | "platform"
 > & {
   entry: string;
-  options: Options;
-  clean: boolean;
-  debug: boolean;
+  options?: Options;
+  clean?: boolean;
+  debug?: boolean;
   banner?: string;
-  verbose: boolean;
+  verbose?: boolean;
   define?: Record<string, string>;
   env?: Record<string, string>;
   apiReport?: boolean;
   docModel?: boolean;
   tsdocMetadata?: boolean;
   includeSrc?: boolean;
-  platform: Platform;
-  plugins: any[];
+  platform?: Platform;
+  plugins?: any[];
 };

package/src/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/src/generators/neutral-library/files/jest.config.ts

@@ -0,0 +1,3 @@
+import { getJestConfig } from "@storm-software/testing-tools";
+
+export default getJestConfig("<%= directory %>", true, "<%= name %>");

package/src/generators/neutral-library/files/src/index.ts.template

@@ -0,0 +1,10 @@
+/**
+ * The <%= name %> library used by Storm Software for building TypeScript applications.
+ *
+ * @remarks
+ * <%= description %>
+ *
+ * @packageDocumentation
+ */
+
+const variable = "<%= name %>";

package/src/generators/neutral-library/files/tsconfig.spec.json

@@ -0,0 +1,13 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "<%= offsetFromRoot %>dist/out-tsc",
+    "types": ["jest", "node"]
+  },
+  "include": [
+    "jest.config.ts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.d.ts"
+  ]
+}

package/src/generators/neutral-library/schema.d.ts

@@ -0,0 +1,6 @@
+import { TypeScriptLibraryGeneratorSchema } from "../../base/typescript-library-generator";
+
+export type NeutralLibraryGeneratorSchema = Omit<
+  TypeScriptLibraryGeneratorSchema,
+  "platform"
+>;

package/src/generators/neutral-library/schema.json

@@ -0,0 +1,82 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "neutral-library",
+  "title": "Add Neutral Library",
+  "description": "Create a new Neutral TypeScript library package in the Storm workspaces",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "A name for the library.",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "What name would you like to use for the library?",
+      "pattern": "(?:^@[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*\\/[a-zA-Z0-9-~][a-zA-Z0-9-._~]*|^[a-zA-Z][^:]*)$"
+    },
+    "description": {
+      "type": "string",
+      "description": "The library used by Storm Software for building TypeScript applications.",
+      "$default": {
+        "$source": "argv",
+        "index": 2
+      },
+      "x-prompt": "Provide description to use as a summary of the library?"
+    },
+    "directory": {
+      "type": "string",
+      "description": "A directory where the lib is placed.",
+      "x-priority": "important"
+    },
+    "projectNameAndRootFormat": {
+      "description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
+      "type": "string",
+      "enum": ["as-provided", "derived"]
+    },
+    "tags": {
+      "type": "string",
+      "description": "Add tags to the library (used for linting)."
+    },
+    "strict": {
+      "type": "boolean",
+      "description": "Whether to enable tsconfig strict mode or not.",
+      "default": true
+    },
+    "publishable": {
+      "type": "boolean",
+      "default": false,
+      "description": "Generate a publishable library.",
+      "x-priority": "important"
+    },
+    "importPath": {
+      "type": "string",
+      "description": "The library name used to import it, like @storm-software/my-awesome-lib. Required for publishable library.",
+      "x-priority": "important"
+    },
+    "buildable": {
+      "type": "boolean",
+      "default": true,
+      "description": "Generate a buildable library.",
+      "x-deprecated": "Use the `bundler` option for greater control (swc, tsc, rollup, vite, esbuild, none)."
+    },
+    "setParserOptionsProject": {
+      "type": "boolean",
+      "description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
+      "default": false
+    },
+    "rootProject": {
+      "type": "boolean",
+      "default": false,
+      "description": "Is the current project the root project in the workspace."
+    }
+  },
+  "required": [
+    "name",
+    "directory",
+    "projectNameAndRootFormat",
+    "publishable",
+    "importPath",
+    "buildable"
+  ]
+}

package/src/generators/node-library/files/README.md

@@ -13,14 +13,14 @@
 Using [pnpm](http://pnpm.io):
 
 ```bash
-pnpm add -D @<%= namespace %>/<%= name %>
+pnpm add -D <%= namespace %>/<%= name %>
 ```
 
 <details>
   <summary>Using npm</summary>
 
 ```bash
-npm install -D @<%= namespace %>/<%= name %>
+npm install -D <%= namespace %>/<%= name %>
 ```
 
 </details>
@@ -29,7 +29,7 @@ npm install -D @<%= namespace %>/<%= name %>
   <summary>Using yarn</summary>
 
 ```bash
-yarn add -D @<%= namespace %>/<%= name %>
+yarn add -D <%= namespace %>/<%= name %>
 ```
 
 </details>