@storm-software/workspace-tools 1.62.18 → 1.62.20

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

@@ -0,0 +1,48 @@
+import type { EsBuildExecutorOptions } from "@nx/esbuild/src/executors/esbuild/schema.d.ts";
+import type { Options } from "tsup";
+import type { GetConfigParams } from "../../types";
+
+export type Platform = "browser" | "neutral" | "node" | "worker";
+
+export type TsupExecutorSchema = Omit<
+  EsBuildExecutorOptions,
+  | "main"
+  | "outputFileName"
+  | "metafile"
+  | "generatePackageJson"
+  | "sourcemap"
+  | "minify"
+  | "format"
+  | "target"
+  | "thirdParty"
+  | "skipTypeCheck"
+  | "esbuildOptions"
+  | "esbuildConfig"
+  | "platform"
+> & {
+  entry: string;
+  options?: Options;
+  clean?: boolean;
+  debug?: boolean;
+  banner?: string;
+  verbose?: boolean;
+  define?: Record<string, string | undefined | null>;
+  env?: Record<string, string | undefined | null>;
+  apiReport?: boolean;
+  docModel?: boolean;
+  tsdocMetadata?: boolean;
+  includeSrc?: boolean;
+  platform?: Platform;
+  plugins?: any[];
+  shims?: boolean;
+  splitting?: boolean;
+  treeshake?: boolean;
+  generatePackageJson?: boolean;
+  emitOnAll?: boolean;
+  getConfig: (params: GetConfigParams) => Options;
+  format?: string[];
+  metafile?: boolean;
+  minify?: boolean;
+  skipNativeModulesPlugin?: boolean;
+  useJsxModule?: boolean;
+};

package/src/executors/tsup/schema.json

@@ -0,0 +1,223 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "tsup",
+  "version": 2,
+  "title": "Tsup Builder",
+  "description": "Run a build on the project using ESBuild with a patched tsup configuration",
+  "type": "object",
+  "properties": {
+    "entry": {
+      "type": "string",
+      "description": "The path to the entry file, relative to project.",
+      "alias": "main",
+      "default": "{sourceRoot}/index.ts"
+    },
+    "outputPath": {
+      "type": "string",
+      "description": "The output path of the generated files.",
+      "x-completion-type": "directory",
+      "x-priority": "important",
+      "default": "dist/{projectRoot}"
+    },
+    "tsConfig": {
+      "type": "string",
+      "description": "The path to the `tsconfig.json` file.",
+      "x-completion-type": "file",
+      "x-completion-glob": "tsconfig*.json",
+      "x-priority": "important",
+      "default": "{projectRoot}/tsconfig.json"
+    },
+    "additionalEntryPoints": {
+      "type": "array",
+      "description": "List of additional entry points.",
+      "items": {
+        "type": "string"
+      },
+      "default": []
+    },
+    "external": {
+      "type": "array",
+      "description": "Mark one or more module as external. Can use * wildcards, such as *.png.",
+      "items": {
+        "type": "string"
+      }
+    },
+    "bundle": {
+      "type": "boolean",
+      "description": "Whether to bundle the main entry point and additional entry points. Set to false to keep individual output files.",
+      "default": true
+    },
+    "watch": {
+      "type": "boolean",
+      "description": "Enable re-building when files change.",
+      "default": false
+    },
+    "assets": {
+      "type": "array",
+      "description": "List of static assets.",
+      "default": [],
+      "items": {
+        "$ref": "#/definitions/assetPattern"
+      }
+    },
+    "clean": {
+      "type": "boolean",
+      "description": "Remove previous output before build.",
+      "alias": "deleteOutputPath",
+      "default": true
+    },
+    "includeSrc": {
+      "type": "boolean",
+      "description": "Should the source files be added to the distribution folder in an `src` directory.",
+      "default": false
+    },
+    "metafile": {
+      "type": "boolean",
+      "description": "Should a meta file be created for the build package",
+      "default": true
+    },
+    "emitOnAll": {
+      "type": "boolean",
+      "description": "Should each file contained in the package be emitted individually.",
+      "default": false
+    },
+    "generatePackageJson": {
+      "type": "boolean",
+      "description": "Should a package.json file be generated in the output folder or should the existing one be copied in.",
+      "default": true
+    },
+    "splitting": {
+      "type": "boolean",
+      "description": "Should the build process preform *code-splitting*?",
+      "default": true
+    },
+    "treeshake": {
+      "type": "boolean",
+      "description": "Should the build process *tree-shake* to remove unused code?",
+      "default": true
+    },
+    "format": {
+      "type": "array",
+      "description": "The output format for the generated JavaScript files. There are currently three possible values that can be configured: iife, cjs, and esm.",
+      "default": ["cjs", "esm"],
+      "items": {
+        "type": "string"
+      }
+    },
+    "debug": {
+      "type": "boolean",
+      "description": "Should output be unminified with source mappings.",
+      "default": false
+    },
+    "platform": {
+      "type": "string",
+      "description": "Platform target for outputs.",
+      "enum": ["browser", "neutral", "node", "worker"],
+      "default": "neutral"
+    },
+    "banner": {
+      "type": "string",
+      "description": "A short heading added to the top of each typescript file added in the output folder's `src` directory.",
+      "default": "This code was developed by Storm Software (<https://stormsoftware.org>) and is licensed under the Apache License 2.0."
+    },
+    "minify": {
+      "type": "boolean",
+      "description": "Should the build process minify the output files?",
+      "default": false
+    },
+    "verbose": {
+      "type": "boolean",
+      "description": "Should write extra log outputs with details from the executor.",
+      "default": false
+    },
+    "skipNativeModulesPlugin": {
+      "type": "boolean",
+      "description": "Should we skip adding the Native Node Modules ESBuild plugin.",
+      "default": false
+    },
+    "useJsxModule": {
+      "type": "boolean",
+      "description": "Should the build process use the `jsx` module for JSX support?",
+      "default": false
+    },
+    "shims": {
+      "type": "boolean",
+      "description": "Should the build process add shims for node.js modules that are not available in the browser?"
+    },
+    "define": {
+      "type": "object",
+      "description": "Define global constants that can be used in the source code. The value will be converted into a stringified JSON.",
+      "additionalProperties": true
+    },
+    "env": {
+      "type": "object",
+      "description": "Define environment variables that can be used in the source code. The value will be converted into a stringified JSON.",
+      "additionalProperties": true
+    },
+    "apiReport": {
+      "type": "boolean",
+      "description": "Should API Extractor generate an API Report file.",
+      "default": true
+    },
+    "docModel": {
+      "type": "boolean",
+      "description": "Should API Extractor generate an Doc Model markdown file.",
+      "default": true
+    },
+    "tsdocMetadata": {
+      "type": "boolean",
+      "description": "Should API Extractor generate an TSDoc Metadata file.",
+      "default": true
+    },
+    "options": {
+      "type": "object",
+      "description": "Additional options to pass to tsup. See <https://paka.dev/npm/tsup@7.2.0/api#d35d54aca71eb26e>.",
+      "additionalProperties": true,
+      "x-priority": "important"
+    },
+    "plugins": {
+      "type": "array",
+      "description": "List of ESBuild plugins to use during processing",
+      "default": [],
+      "items": {
+        "type": "object"
+      }
+    }
+  },
+  "required": ["tsConfig", "platform", "banner"],
+  "definitions": {
+    "assetPattern": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "glob": {
+              "type": "string",
+              "description": "The pattern to match."
+            },
+            "input": {
+              "type": "string",
+              "description": "The input directory path in which to apply `glob`. Defaults to the project root."
+            },
+            "output": {
+              "type": "string",
+              "description": "Relative path within the output folder."
+            },
+            "ignore": {
+              "description": "An array of globs to ignore.",
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          },
+          "additionalProperties": false,
+          "required": ["glob", "input", "output"]
+        },
+        {
+          "type": "string"
+        }
+      ]
+    }
+  }
+}