@storm-software/workspace-tools 1.62.18 → 1.62.20

package/CHANGELOG.md

@@ -1,3 +1,27 @@
+## 1.62.20 (2024-03-01)
+
+
+### 🩹 Fixes
+
+- **workspace-tools:** Resolved issue with missing asset files ([7be5832f](https://github.com/storm-software/storm-ops/commit/7be5832f))
+
+
+### ❤️  Thank You
+
+- Patrick Sullivan
+
+## 1.62.19 (2024-03-01)
+
+
+### 🩹 Fixes
+
+- **workspace-tools:** Added back additional entry points ([790e9029](https://github.com/storm-software/storm-ops/commit/790e9029))
+
+
+### ❤️  Thank You
+
+- Patrick Sullivan
+
 ## 1.62.18 (2024-03-01)
 
 

package/declarations.d.ts

@@ -0,0 +1,129 @@
+import type { StormConfig } from "@storm-software/config";
+import type { TsupExecutorSchema } from "./src/executors/tsup/schema";
+import type { ExecutorContext } from "@nx/devkit";
+import type { Tree } from "@nx/devkit";
+import type { Options } from "tsup";
+import type { TsupGetConfigOptions } from "./src/types";
+import type {
+  Program,
+  Diagnostic,
+  TransformerFactory,
+  SourceFile,
+  ParsedCommandLine
+} from "typescript";
+
+export interface TsupContext {
+  projectRoot: string;
+  sourceRoot: string;
+  projectName: string;
+  main: string;
+}
+
+export type BuildOptions = Options;
+export type Entry = string | string[] | Record<string, string>;
+export type GetConfigParams = Omit<
+  TsupGetConfigOptions,
+  "entry" | "assets" | "clean" | "outputPath" | "tsConfig" | "main"
+> & {
+  entry: Entry;
+  outDir: string;
+  projectRoot: string;
+  workspaceRoot: string;
+  tsconfig: string;
+  shims?: boolean;
+  apiReport?: boolean;
+  docModel?: boolean;
+  tsdocMetadata?: boolean;
+  dtsTsConfig: ParsedCommandLine;
+  getTransform?: (program: Program, diagnostics: Diagnostic[]) => TransformerFactory<SourceFile>;
+};
+
+declare function outExtension({ format }: { format?: string }): { js: string; dts: string };
+export { outExtension };
+
+declare function applyDefaultOptions(options: TsupExecutorSchema): TsupExecutorSchema;
+export { applyDefaultOptions };
+
+declare function runTsupBuild(
+  context: TsupContext,
+  config: Partial<StormConfig>,
+  options: TsupExecutorSchema
+): Promise<void>;
+export { runTsupBuild };
+
+declare function tsupExecutorFn(
+  options: TsupExecutorSchema,
+  context: ExecutorContext,
+  config?: StormConfig
+): Promise<{
+  success: boolean;
+}>;
+export { tsupExecutorFn };
+
+export interface BaseExecutorSchema extends Record<string, any> {
+  main?: string;
+  outputPath?: string;
+  tsConfig?: string;
+}
+
+export interface WorkspaceToolHooks<TSchema = any> {
+  applyDefaultOptions?: (
+    options: Partial<TSchema>,
+    config?: StormConfig
+  ) => Promise<TSchema> | TSchema;
+  preProcess?: (options: TSchema, config?: StormConfig) => Promise<void> | void;
+  postProcess?: (config?: StormConfig) => Promise<void> | void;
+}
+
+export interface BaseWorkspaceToolOptions<TSchema = any> {
+  skipReadingConfig?: boolean;
+  hooks?: WorkspaceToolHooks<TSchema>;
+}
+
+export interface BaseExecutorOptions<
+  TExecutorSchema extends BaseExecutorSchema = BaseExecutorSchema
+> extends BaseWorkspaceToolOptions<TExecutorSchema> {}
+
+export interface BaseExecutorResult {
+  error?: Error;
+  success?: boolean;
+}
+
+declare function withRunExecutor<TExecutorSchema extends BaseExecutorSchema = BaseExecutorSchema>(
+  name: string,
+  executorFn: (
+    options: TExecutorSchema,
+    context: ExecutorContext,
+    config?: StormConfig
+  ) => Promise<BaseExecutorResult | null | undefined> | BaseExecutorResult | null | undefined,
+  executorOptions: BaseExecutorOptions<TExecutorSchema>
+): (_options: TExecutorSchema, context: ExecutorContext) => Promise<{ success: boolean }>;
+export { withRunExecutor };
+
+export interface BaseGeneratorSchema extends Record<string, any> {
+  main?: string;
+  outputPath?: string;
+  tsConfig?: string;
+}
+
+export interface BaseGeneratorOptions<
+  TGeneratorSchema extends BaseGeneratorSchema = BaseGeneratorSchema
+> extends BaseWorkspaceToolOptions<TGeneratorSchema> {}
+
+export interface BaseGeneratorResult {
+  error?: Error;
+  success?: boolean;
+}
+
+declare function withRunGenerator<TGeneratorSchema = any>(
+  name: string,
+  generatorFn: (
+    tree: Tree,
+    options: TGeneratorSchema,
+    config?: StormConfig
+  ) => Promise<BaseGeneratorResult | null | undefined> | BaseGeneratorResult | null | undefined,
+  generatorOptions: BaseGeneratorOptions<TGeneratorSchema> = {
+    skipReadingConfig: false
+  }
+): (tree: Tree, _options: TGeneratorSchema) => Promise<{ success: boolean }>;
+export { withRunGenerator };

package/executors.json

@@ -0,0 +1,35 @@
+{
+  "executors": {
+    "tsup": {
+      "implementation": "./src/executors/tsup/executor",
+      "schema": "./src/executors/tsup/schema.json",
+      "description": "Run a build on the project using tsup configuration",
+      "internal": true
+    },
+    "tsup-neutral": {
+      "implementation": "./src/executors/tsup-neutral/executor",
+      "schema": "./src/executors/tsup-neutral/schema.json",
+      "description": "Runs a neutral platform TypeScript build"
+    },
+    "tsup-node": {
+      "implementation": "./src/executors/tsup-node/executor",
+      "schema": "./src/executors/tsup-node/schema.json",
+      "description": "Runs a node platform TypeScript build"
+    },
+    "tsup-browser": {
+      "implementation": "./src/executors/tsup-browser/executor",
+      "schema": "./src/executors/tsup-browser/schema.json",
+      "description": "Runs a browser platform TypeScript build"
+    },
+    "typia": {
+      "implementation": "./src/executors/typia/executor",
+      "schema": "./src/executors/typia/schema.json",
+      "description": "Run the Typia generator to create runtime type validators"
+    },
+    "npm-publish": {
+      "implementation": "./src/executors/npm-publish/executor",
+      "schema": "./src/executors/npm-publish/schema.json",
+      "description": "Publish a package to the NPM registry"
+    }
+  }
+}

package/generators.json

@@ -0,0 +1,53 @@
+{
+  "generators": {
+    "init": {
+      "factory": "./src/generators/init/init#stormInitGenerator",
+      "schema": "./src/generators/init/schema.json",
+      "description": "Initialize the `@storm-software/workspace-tools` plugin.",
+      "aliases": [
+        "ng-add"
+      ],
+      "internal": true
+    },
+    "preset": {
+      "factory": "./src/generators/preset/generator",
+      "schema": "./src/generators/preset/schema.json",
+      "description": "Storm workspace preset generator",
+      "x-use-standalone-layout": true
+    },
+    "node-library": {
+      "factory": "./src/generators/node-library/generator",
+      "schema": "./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": "./src/generators/config-schema/generator",
+      "schema": "./src/generators/config-schema/schema.json",
+      "description": "Create a Storm JSON schema based on the workspaces project configurations"
+    },
+    "neutral-library": {
+      "factory": "./src/generators/neutral-library/generator",
+      "schema": "./src/generators/neutral-library/schema.json",
+      "description": "Create a new Neutral TypeScript library package in the Storm workspace"
+    },
+    "browser-library": {
+      "factory": "./src/generators/browser-library/generator",
+      "schema": "./src/generators/browser-library/schema.json",
+      "description": "Create a new browser TypeScript library package in the Storm workspace"
+    },
+    "design-tokens": {
+      "factory": "./src/generators/design-tokens/generator",
+      "schema": "./src/generators/design-tokens/schema.json",
+      "description": "Generate design tokens code using a Token Studio export"
+    },
+    "release-version": {
+      "factory": "./src/generators/release-version/generator",
+      "schema": "./src/generators/release-version/schema.json",
+      "description": "The release version generator used in Storm Workspaces"
+    }
+  }
+}