@storm-software/workspace-tools 1.19.3 → 1.20.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [1.20.0](https://github.com/storm-software/storm-ops/compare/workspace-tools-v1.19.3...workspace-tools-v1.20.0) (2023-12-02)
+
+
+### Features
+
+* **workspace-tools:** Added default options function parameter to workspace tools ([9a5c880](https://github.com/storm-software/storm-ops/commit/9a5c880c24898f5c593c32d1d13e978c5e0b3356))
+
+## [1.19.3](https://github.com/storm-software/storm-ops/compare/workspace-tools-v1.19.2...workspace-tools-v1.19.3) (2023-12-02)
+
+
+### Bug Fixes
+
+* **workspace-tools:** Resolved issue with `esbuildPluginPino` plugin for neutral build ([dba1022](https://github.com/storm-software/storm-ops/commit/dba102278281102a359c1c7cff087b9969b58c7c))
+
 ## [1.19.2](https://github.com/storm-software/storm-ops/compare/workspace-tools-v1.19.1...workspace-tools-v1.19.2) (2023-12-02)
 
 

package/index.js

@@ -104957,6 +104957,9 @@ var require_dist6 = __commonJS({
 var workspace_tools_exports = {};
 __export(workspace_tools_exports, {
   WorkspaceStorage: () => WorkspaceStorage,
+  applyDefault: () => applyDefault,
+  applyWorkspaceExecutorTokens: () => applyWorkspaceExecutorTokens,
+  applyWorkspaceGeneratorTokens: () => applyWorkspaceGeneratorTokens,
   applyWorkspaceTokens: () => applyWorkspaceTokens,
   configSchemaGeneratorFn: () => configSchemaGeneratorFn,
   eslintVersion: () => eslintVersion,
@@ -104984,7 +104987,7 @@ __export(workspace_tools_exports, {
   tsLibVersion: () => tsLibVersion,
   tsNeutralBuildExecutorFn: () => tsNeutralBuildExecutorFn,
   tsNodeBuildExecutorFn: () => tsNodeBuildExecutorFn,
-  tsupExecutor: () => tsupExecutor,
+  tsupExecutorFn: () => tsupExecutorFn,
   tsupVersion: () => tsupVersion,
   typesNodeVersion: () => typesNodeVersion,
   typescriptVersion: () => typescriptVersion,
@@ -105239,26 +105242,39 @@ var getWorkspaceRoot2 = () => {
 };
 
 // packages/workspace-tools/src/utils/apply-workspace-tokens.ts
-var applyWorkspaceTokens = (option, config) => {
+var applyWorkspaceExecutorTokens = (option, tokenizerOptions) => {
+  console.log("applyWorkspaceExecutorTokens", option);
   let result = option;
   if (!result) {
     return result;
   }
-  const workspaceRoot = getWorkspaceRoot2();
   let projectName;
   let projectRoot;
   let sourceRoot;
-  if (config?.projectsConfigurations?.projects && config?.projectName) {
-    const context = config;
+  if (tokenizerOptions?.projectName) {
+    const context = tokenizerOptions;
     projectName = context.projectName;
-    projectRoot = context.projectsConfigurations.projects[projectName].root;
-    sourceRoot = context.projectsConfigurations.projects[projectName].sourceRoot;
+    projectRoot = context.root;
+    sourceRoot = context.sourceRoot;
   } else {
-    const projectConfig = config;
+    const projectConfig = tokenizerOptions;
     projectName = projectConfig.name;
     projectRoot = projectConfig.root;
     sourceRoot = projectConfig.sourceRoot;
   }
+  if (tokenizerOptions.config) {
+    const configKeys = Object.keys(tokenizerOptions.config);
+    if (configKeys.some((configKey) => result.includes(`{${configKey}}`))) {
+      configKeys.forEach((configKey) => {
+        if (result.includes(`{${configKey}}`)) {
+          result = result.replaceAll(
+            `{${configKey}}`,
+            tokenizerOptions.config[configKey]
+          );
+        }
+      });
+    }
+  }
   if (result.includes("{projectName}")) {
     result = result.replaceAll("{projectName}", projectName);
   }
@@ -105269,28 +105285,69 @@ var applyWorkspaceTokens = (option, config) => {
     result = result.replaceAll("{sourceRoot}", sourceRoot);
   }
   if (result.includes("{workspaceRoot}")) {
-    result = result.replaceAll("{workspaceRoot}", workspaceRoot);
+    result = result.replaceAll(
+      "{workspaceRoot}",
+      tokenizerOptions.workspaceRoot ?? getWorkspaceRoot2()
+    );
   }
   return result;
 };
+var applyWorkspaceGeneratorTokens = (option, tokenizerOptions) => {
+  let result = option;
+  if (!result) {
+    return result;
+  }
+  if (result.includes("{workspaceRoot}")) {
+    result = result.replaceAll(
+      "{workspaceRoot}",
+      tokenizerOptions.workspaceRoot ?? tokenizerOptions.config.workspaceRoot ?? getWorkspaceRoot2()
+    );
+  }
+  return result;
+};
+var applyWorkspaceTokens = (options, config, tokenizerFn) => {
+  let result = options;
+  if (!result) {
+    return {};
+  }
+  return Object.keys(options).reduce(
+    (ret, option) => {
+      if (options[option] === void 0 || options[option] === null || typeof options[option] === "number" || typeof options[option] === "boolean" || typeof options[option] === "string") {
+        ret[option] = tokenizerFn(option, config);
+      } else if (Array.isArray(options[option])) {
+        ret[option] = options[option].map(
+          (item) => tokenizerFn(item, config)
+        );
+      } else if (typeof options[option] === "object") {
+        ret[option] = tokenizerFn(options[option], config);
+      }
+      return ret;
+    },
+    {}
+  );
+};
 
 // packages/workspace-tools/src/base/base-executor.ts
-var withRunExecutor = (name, executorFn, executorOptions = { skipReadingConfig: false }) => async (options, context) => {
+var withRunExecutor = (name, executorFn, executorOptions = {
+  skipReadingConfig: false
+}) => async (options, context) => {
   const startTime = Date.now();
   try {
     console.info(`\u26A1 Running the ${name} executor...`);
-    console.debug(`\u2699\uFE0F Executor schema options: 
+    if (executorOptions?.applyDefaultFn) {
+      options = executorOptions.applyDefaultFn(options);
+    }
+    console.debug(`\u2699\uFE0F  Executor schema options: 
 `, options);
-    const tokenized = Object.keys(options).reduce(
-      (ret, key) => {
-        ret[key] = applyWorkspaceTokens(
-          options[key],
-          context
-        );
-        return ret;
-      },
-      options
-    );
+    if (!context.projectsConfigurations?.projects || !context.projectName || !context.projectsConfigurations.projects[context.projectName]) {
+      throw new Error(
+        "The Build process failed because the context is not valid. Please run this command from a workspace."
+      );
+    }
+    const workspaceRoot = getWorkspaceRoot2();
+    const projectRoot = context.projectsConfigurations.projects[context.projectName].root;
+    const sourceRoot = context.projectsConfigurations.projects[context.projectName].sourceRoot;
+    const projectName = context.projectsConfigurations.projects[context.projectName].name;
     let config;
     if (!executorOptions.skipReadingConfig) {
       const configFile = await getConfigFile();
@@ -105301,8 +105358,21 @@ var withRunExecutor = (name, executorFn, executorOptions = { skipReadingConfig:
       });
       setConfigEnv(config);
       console.debug(`Loaded Storm config into env:
-${Object.keys(process.env).map((key) => ` - ${key}=${process.env[key]}`).join("\n")}`);
+  ${Object.keys(process.env).map((key) => ` - ${key}=${process.env[key]}`).join("\n")}`);
     }
+    const tokenized = applyWorkspaceTokens(
+      options,
+      {
+        config,
+        workspaceRoot,
+        projectRoot,
+        sourceRoot,
+        projectName,
+        ...context.projectsConfigurations.projects[context.projectName],
+        ...executorOptions
+      },
+      applyWorkspaceExecutorTokens
+    );
     const result = await Promise.resolve(
       executorFn(tokenized, context, config)
     );
@@ -105327,11 +105397,16 @@ ${Object.keys(process.env).map((key) => ` - ${key}=${process.env[key]}`).join("\
 };
 
 // packages/workspace-tools/src/base/base-generator.ts
-var withRunGenerator = (name, generatorFn, generatorOptions = { skipReadingConfig: false }) => async (tree, options) => {
+var withRunGenerator = (name, generatorFn, generatorOptions = {
+  skipReadingConfig: false
+}) => async (tree, options) => {
   const startTime = Date.now();
   try {
     console.info(`\u26A1 Running the ${name} generator...`);
-    console.debug("\u2699\uFE0F Generator schema options: \n", options);
+    if (generatorOptions?.applyDefaultFn) {
+      options = generatorOptions.applyDefaultFn(options);
+    }
+    console.debug("\u2699\uFE0F  Generator schema options: \n", options);
     let config;
     if (!generatorOptions.skipReadingConfig) {
       const configFile = await getConfigFile();
@@ -105344,7 +105419,14 @@ var withRunGenerator = (name, generatorFn, generatorOptions = { skipReadingConfi
       console.debug(`Loaded Storm config into env:
 ${Object.keys(process.env).map((key) => ` - ${key}=${process.env[key]}`).join("\n")}`);
     }
-    const result = await Promise.resolve(generatorFn(tree, options, config));
+    const tokenized = applyWorkspaceTokens(
+      options,
+      { workspaceRoot: tree.root, config },
+      applyWorkspaceGeneratorTokens
+    );
+    const result = await Promise.resolve(
+      generatorFn(tree, tokenized, config)
+    );
     if (result && (!result.success || result.error && result?.error?.message && typeof result?.error?.message === "string" && result?.error?.name && typeof result?.error?.name === "string")) {
       throw new Error(`The ${name} generator failed to run`, {
         cause: result.error
@@ -111914,28 +111996,9 @@ var outExtension = ({ format: format2 }) => {
 };
 
 // packages/workspace-tools/src/executors/tsup/executor.ts
-async function tsupExecutor(options, context) {
+async function tsupExecutorFn(options, context) {
   try {
     console.log("\u{1F4E6}  Running Storm build executor on the workspace");
-    options.entry ??= "{sourceRoot}/index.ts";
-    options.outputPath ??= "dist/{projectRoot}";
-    options.tsConfig ??= "tsconfig.json";
-    options.platform ??= "neutral";
-    options.verbose ??= false;
-    options.external ??= [];
-    options.additionalEntryPoints ??= [];
-    options.assets ??= [];
-    options.plugins ??= [];
-    options.includeSrc ??= true;
-    options.clean ??= true;
-    options.bundle ??= true;
-    options.debug ??= false;
-    options.watch ??= false;
-    options.apiReport ??= true;
-    options.docModel ??= true;
-    options.tsdocMetadata ??= true;
-    options.define ??= {};
-    options.env ??= {};
     options.verbose && console.log(
       `\u2699\uFE0F  Executor options:
 ${Object.keys(options).map(
@@ -111951,17 +112014,9 @@ ${Object.keys(options).map(
     const workspaceRoot = getWorkspaceRoot2();
     const projectRoot = context.projectsConfigurations.projects[context.projectName].root;
     const sourceRoot = context.projectsConfigurations.projects[context.projectName].sourceRoot;
-    const outputPath = applyWorkspaceTokens(
-      options.outputPath ? options.outputPath : "dist/{projectRoot}",
-      context
-    );
-    options.entry = applyWorkspaceTokens(
-      options.entry ? options.entry : "{sourceRoot}/index.ts",
-      context
-    );
     if (options.clean !== false) {
-      console.log(`\u{1F9F9} Cleaning output path: ${outputPath}`);
-      (0, import_fs_extra.removeSync)(outputPath);
+      console.log(`\u{1F9F9} Cleaning output path: ${options.outputPath}`);
+      (0, import_fs_extra.removeSync)(options.outputPath);
     }
     const assets = Array.from(options.assets);
     assets.push({
@@ -111982,7 +112037,7 @@ ${Object.keys(options).map(
       });
     }
     const result = await (0, import_js.copyAssets)(
-      { assets, watch: options.watch, outputPath },
+      { assets, watch: options.watch, outputPath: options.outputPath },
       context
     );
     if (!result.success) {
@@ -112111,7 +112166,11 @@ ${externalDependencies.map((dep) => {
     packageJson.keywords ??= workspacePackageJson.keywords;
     packageJson.repository ??= workspacePackageJson.repository;
     packageJson.repository.directory ??= projectRoot ? projectRoot : (0, import_path4.join)("packages", context.projectName);
-    const packageJsonPath = (0, import_path4.join)(context.root, outputPath, "package.json");
+    const packageJsonPath = (0, import_path4.join)(
+      context.root,
+      options.outputPath,
+      "package.json"
+    );
     console.log(`\u26A1 Writing package.json file to: ${packageJsonPath}`);
     (0, import_fs3.writeFileSync)(
       packageJsonPath,
@@ -112133,10 +112192,10 @@ ${externalDependencies.map((dep) => {
     );
     if (options.includeSrc !== false) {
       const files = globSync([
-        (0, import_devkit.joinPathFragments)(context.root, outputPath, "src/**/*.ts"),
-        (0, import_devkit.joinPathFragments)(context.root, outputPath, "src/**/*.tsx"),
-        (0, import_devkit.joinPathFragments)(context.root, outputPath, "src/**/*.js"),
-        (0, import_devkit.joinPathFragments)(context.root, outputPath, "src/**/*.jsx")
+        (0, import_devkit.joinPathFragments)(context.root, options.outputPath, "src/**/*.ts"),
+        (0, import_devkit.joinPathFragments)(context.root, options.outputPath, "src/**/*.tsx"),
+        (0, import_devkit.joinPathFragments)(context.root, options.outputPath, "src/**/*.js"),
+        (0, import_devkit.joinPathFragments)(context.root, options.outputPath, "src/**/*.jsx")
       ]);
       await Promise.allSettled(
         files.map(
@@ -112162,7 +112221,7 @@ ${(0, import_fs3.readFileSync)(file, "utf-8")}`,
       ...options,
       dtsTsConfig: getNormalizedTsConfig(
         context.root,
-        outputPath,
+        options.outputPath,
         (0, import_tsc.createTypeScriptCompilationOptions)(
           (0, import_normalize_options.normalizeOptions)(
             {
@@ -112188,7 +112247,7 @@ ${options.banner}
 
 `
       } : void 0,
-      outputPath
+      outputPath: options.outputPath
     });
     if (typeof config === "function") {
       await build(await Promise.resolve(config({})));
@@ -112251,12 +112310,41 @@ var isPrimitive = (value) => {
     return false;
   }
 };
-var executor_default = tsupExecutor;
+var applyDefault = (options) => {
+  options.entry ??= "{sourceRoot}/index.ts";
+  options.outputPath ??= "dist/{projectRoot}";
+  options.tsConfig ??= "tsconfig.json";
+  options.platform ??= "neutral";
+  options.verbose ??= false;
+  options.external ??= [];
+  options.additionalEntryPoints ??= [];
+  options.assets ??= [];
+  options.plugins ??= [];
+  options.includeSrc ??= true;
+  options.clean ??= true;
+  options.bundle ??= true;
+  options.debug ??= false;
+  options.watch ??= false;
+  options.apiReport ??= true;
+  options.docModel ??= true;
+  options.tsdocMetadata ??= true;
+  options.define ??= {};
+  options.env ??= {};
+  return options;
+};
+var executor_default = withRunExecutor(
+  "TypeScript Build using tsup",
+  tsupExecutorFn,
+  {
+    skipReadingConfig: false,
+    applyDefaultFn: applyDefault
+  }
+);
 
 // packages/workspace-tools/src/executors/tsup-neutral/executor.ts
 var tsNeutralBuildExecutorFn = (options, context, config) => {
   options.plugins ??= [];
-  return executor_default(
+  return tsupExecutorFn(
     {
       ...options,
       platform: "neutral",
@@ -112277,9 +112365,18 @@ var tsNeutralBuildExecutorFn = (options, context, config) => {
     context
   );
 };
+var applyDefault2 = (options) => {
+  options = applyDefault({ ...options, platform: "neutral" });
+  options.plugins ??= [];
+  return options;
+};
 var executor_default2 = withRunExecutor(
   "TypeScript Build (Neutral Platform)",
-  tsNeutralBuildExecutorFn
+  tsNeutralBuildExecutorFn,
+  {
+    skipReadingConfig: false,
+    applyDefaultFn: applyDefault2
+  }
 );
 
 // node_modules/.pnpm/esbuild-plugin-pino@2.1.0_esbuild@0.19.5/node_modules/esbuild-plugin-pino/dist/index.mjs
@@ -112414,12 +112511,10 @@ function esbuildPluginPino({
 
 // packages/workspace-tools/src/executors/tsup-node/executor.ts
 var tsNodeBuildExecutorFn = (options, context, config) => {
-  options.plugins ??= [];
-  options.transports ??= ["pino-pretty", "pino-loki"];
   if (options.transports && Array.isArray(options.transports) && options.transports.length > 0) {
     options.plugins.push(esbuildPluginPino({ transports: options.transports }));
   }
-  return executor_default(
+  return tsupExecutorFn(
     {
       ...options,
       platform: "node",
@@ -112440,9 +112535,19 @@ var tsNodeBuildExecutorFn = (options, context, config) => {
     context
   );
 };
+var applyDefault3 = (options) => {
+  options = applyDefault({ ...options, platform: "node" });
+  options.plugins ??= [];
+  options.transports ??= ["pino-pretty", "pino-loki"];
+  return options;
+};
 var executor_default3 = withRunExecutor(
   "TypeScript Build (NodeJs Platform)",
-  tsNodeBuildExecutorFn
+  tsNodeBuildExecutorFn,
+  {
+    skipReadingConfig: false,
+    applyDefaultFn: applyDefault3
+  }
 );
 
 // packages/workspace-tools/src/generators/config-schema/generator.ts
@@ -117100,7 +117205,6 @@ var getProjectConfigurations = () => (0, import_retrieve_workspace_files.retriev
 
 // packages/workspace-tools/src/generators/config-schema/generator.ts
 async function configSchemaGeneratorFn(tree, options) {
-  const schema = {};
   const projectConfigurations = getProjectConfigurations();
   const workspaceRoot = getWorkspaceRoot2();
   const modules = await Promise.all(
@@ -117896,6 +118000,9 @@ var WorkspaceStorage = class {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   WorkspaceStorage,
+  applyDefault,
+  applyWorkspaceExecutorTokens,
+  applyWorkspaceGeneratorTokens,
   applyWorkspaceTokens,
   configSchemaGeneratorFn,
   eslintVersion,
@@ -117923,7 +118030,7 @@ var WorkspaceStorage = class {
   tsLibVersion,
   tsNeutralBuildExecutorFn,
   tsNodeBuildExecutorFn,
-  tsupExecutor,
+  tsupExecutorFn,
   tsupVersion,
   typesNodeVersion,
   typescriptVersion,