@storm-software/workspace-tools 1.41.0 → 1.42.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [1.41.1](https://github.com/storm-software/storm-ops/compare/workspace-tools-v1.41.0...workspace-tools-v1.41.1) (2024-01-14)
+
+
+### Bug Fixes
+
+* **workspace-tools:** Cleaned up dependanies and option defaulting in tsup ([0ae0dd3](https://github.com/storm-software/storm-ops/commit/0ae0dd327ed646e6dbcd1c33b44aef820403cd77))
+
+# [1.41.0](https://github.com/storm-software/storm-ops/compare/workspace-tools-v1.40.1...workspace-tools-v1.41.0) (2024-01-14)
+
+
+### Features
+
+* **git-tools:** Improved all CLI tools and git hooks to use the `zx` package ([a905c21](https://github.com/storm-software/storm-ops/commit/a905c213d710d995cc114b32a90bf4d042c550d6))
+
 ## [1.40.1](https://github.com/storm-software/storm-ops/compare/workspace-tools-v1.40.0...workspace-tools-v1.40.1) (2024-01-14)
 
 

package/README.md

@@ -16,7 +16,7 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
 
 <h3 align="center">💻 Visit <a href="https://stormsoftware.org" target="_blank">stormsoftware.org</a> to stay up to date with this developer</h3><br />
 
-[![Version](https://img.shields.io/badge/version-1.39.0-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;
+[![Version](https://img.shields.io/badge/version-1.41.1-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;
 [![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with docusaurus](https://img.shields.io/badge/documented_with-docusaurus-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://docusaurus.io/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
 
 <h3 align="center" bold="true">⚠️ <b>Attention</b> ⚠️ This repository, and the apps, libraries, and tools contained within, is still in it's initial development phase. As a result, bugs and issues are expected with it's usage. When the main development phase completes, a proper release will be performed, the packages will be availible through NPM (and other distributions), and this message will be removed. However, in the meantime, please feel free to report any issues you may come across.</h3><br />

package/config/nx.json

@@ -4,9 +4,6 @@
   "affected": {
     "defaultBase": "main"
   },
-  "workspaceLayout": {
-    "projectNameAndRootFormat": "as-provided"
-  },
   "tasksRunnerOptions": {
     "default": {
       "runner": "nx/tasks-runners/default",
@@ -26,9 +23,12 @@
   "namedInputs": {
     "globalBuildAffectingConfig": [
       "{workspaceRoot}/tsconfig.base.json",
-      "{workspaceRoot}/package.json"
+      "{workspaceRoot}/package.json",
+      "{workspaceRoot}/storm.json"
     ],
     "globalNonBuildAffectingConfig": [
+      "{workspaceRoot}/**/biome.json",
+      "{workspaceRoot}/**/lefthook.json",
       "{workspaceRoot}/.log4brains.yml",
       "{workspaceRoot}/.eslintrc.json",
       "{workspaceRoot}/.all-contributorsrc",
@@ -81,20 +81,15 @@
     },
     "lint": {
       "cache": true,
-      "executor": "@nx/eslint:lint",
+      "executor": "nx:run-commands",
       "outputs": ["{options.outputFile}"],
       "options": {
-        "lintFilePatterns": [
-          "{projectRoot}/**/*.ts",
-          "{projectRoot}/package.json"
-        ]
+        "commands": [
+          "npx biome lint --apply --no-errors-on-unmatched --files-ignore-unknown=true {projectRoot}"
+        ],
+        "color": true
       },
-      "inputs": [
-        "default",
-        "{workspaceRoot}/.eslintrc.json",
-        "{workspaceRoot}/.eslintignore",
-        "{workspaceRoot}/eslint.config.js"
-      ]
+      "inputs": ["default", "{workspaceRoot}/**/biome.json"]
     },
     "test": {
       "cache": true,

package/index.js

@@ -127893,7 +127893,9 @@ var getConfigFile = async (filePath) => {
     return void 0;
   }
   const config = cosmiconfigResult.config ?? {};
-  cosmiconfigResult.filepath && (config.configFile = cosmiconfigResult.filepath);
+  if (cosmiconfigResult.filepath) {
+    config.configFile = cosmiconfigResult.filepath;
+  }
   config.runtimeVersion = "0.0.1";
   _static_cache = config;
   return config;
@@ -131997,14 +131999,13 @@ var applyWorkspaceTokens = (options, config, tokenizerFn) => {
 var withRunExecutor = (name, executorFn, executorOptions = {
   skipReadingConfig: false,
   hooks: {}
-}) => async (options, context) => {
+}) => async (_options, context) => {
   const startTime = Date.now();
+  let options = _options;
   try {
-    console.info(
-      chalk.bold.hex("#1fb2a6")(`\u26A1 Running the ${name} executor...
+    console.info(chalk.bold.hex("#1fb2a6")(`\u26A1 Running the ${name} executor...
 
-`)
-    );
+`));
     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."
@@ -132029,19 +132030,11 @@ ${Object.keys(process.env).map((key) => ` - ${key}=${process.env[key]}`).join("\
       );
     }
     if (executorOptions?.hooks?.applyDefaultOptions) {
-      getLogLevel(config?.logLevel) >= LogLevel.TRACE && console.debug(chalk.dim(`Running the applyDefaultOptions hook...`));
-      options = await Promise.resolve(
-        executorOptions.hooks.applyDefaultOptions(options, config)
-      );
-      getLogLevel(config?.logLevel) >= LogLevel.TRACE && console.debug(chalk.dim(`Completed the applyDefaultOptions hook...`));
+      getLogLevel(config?.logLevel) >= LogLevel.TRACE && console.debug(chalk.dim("Running the applyDefaultOptions hook..."));
+      options = await Promise.resolve(executorOptions.hooks.applyDefaultOptions(options, config));
+      getLogLevel(config?.logLevel) >= LogLevel.TRACE && console.debug(chalk.dim("Completed the applyDefaultOptions hook..."));
     }
-    getLogLevel(config.logLevel) >= LogLevel.INFO && console.info(
-      chalk.hex("#0ea5e9").italic(`
-
- \u2699\uFE0F  Executor schema options: 
-`),
-      options
-    );
+    getLogLevel(config.logLevel) >= LogLevel.INFO && console.info(chalk.hex("#0ea5e9").italic("\n\n \u2699\uFE0F  Executor schema options: \n"), options);
     const tokenized = applyWorkspaceTokens(
       options,
       {
@@ -132056,44 +132049,34 @@ ${Object.keys(process.env).map((key) => ` - ${key}=${process.env[key]}`).join("\
       applyWorkspaceExecutorTokens
     );
     if (executorOptions?.hooks?.preProcess) {
-      getLogLevel(config?.logLevel) >= LogLevel.TRACE && console.debug(chalk.dim(`Running the preProcess hook...`));
-      await Promise.resolve(
-        executorOptions.hooks.preProcess(tokenized, config)
-      );
-      getLogLevel(config?.logLevel) >= LogLevel.TRACE && console.debug(chalk.dim(`Completed the preProcess hook...`));
+      getLogLevel(config?.logLevel) >= LogLevel.TRACE && console.debug(chalk.dim("Running the preProcess hook..."));
+      await Promise.resolve(executorOptions.hooks.preProcess(tokenized, config));
+      getLogLevel(config?.logLevel) >= LogLevel.TRACE && console.debug(chalk.dim("Completed the preProcess hook..."));
     }
-    const result = await Promise.resolve(
-      executorFn(tokenized, context, config)
-    );
+    const result = await Promise.resolve(executorFn(tokenized, context, 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} executor failed to run`, {
-        cause: result.error
+        cause: result?.error
       });
     }
     if (executorOptions?.hooks?.postProcess) {
-      getLogLevel(config?.logLevel) >= LogLevel.TRACE && console.debug(chalk.dim(`Running the postProcess hook...`));
+      getLogLevel(config?.logLevel) >= LogLevel.TRACE && console.debug(chalk.dim("Running the postProcess hook..."));
       await Promise.resolve(executorOptions.hooks.postProcess(config));
-      getLogLevel(config?.logLevel) >= LogLevel.TRACE && console.debug(chalk.dim(`Completed the postProcess hook...`));
+      getLogLevel(config?.logLevel) >= LogLevel.TRACE && console.debug(chalk.dim("Completed the postProcess hook..."));
     }
     console.info(
-      chalk.bold.hex("#087f5b")(
-        `
+      chalk.bold.hex("#087f5b")(`
 
 \u{1F389} Successfully completed running the ${name} executor!
 
-`
-      )
+`)
     );
     return {
       success: true
     };
   } catch (error) {
     console.error(
-      chalk.bold.hex("#7d1a1a")(
-        `\u274C  An error occurred while running the executor
-
-`
-      ),
+      chalk.bold.hex("#7d1a1a")("\u274C  An error occurred while running the executor\n\n"),
       error
     );
     return {
@@ -139003,10 +138986,10 @@ var import_transform = __toESM(require_transform());
 var getTypiaTransform = (program, diagnostics) => (0, import_transform.default)(program, {}, { addDiagnostic: (input) => diagnostics.push(input) });
 
 // packages/workspace-tools/src/executors/tsup/executor.ts
-async function tsupExecutorFn(options, context) {
+async function tsupExecutorFn(options, context, config) {
   try {
     console.log("\u{1F4E6}  Running Storm build executor on the workspace");
-    options.verbose && console.log(
+    getLogLevel(config?.logLevel) >= LogLevel.TRACE && console.log(
       `\u2699\uFE0F  Executor options:
 ${Object.keys(options).map(
         (key) => `${key}: ${!options[key] || _isPrimitive(options[key]) ? options[key] : JSON.stringify(options[key])}`
@@ -139022,7 +139005,9 @@ ${Object.keys(options).map(
     const projectRoot = context.projectsConfigurations.projects[context.projectName].root;
     const sourceRoot = context.projectsConfigurations.projects[context.projectName].sourceRoot;
     if (options.clean !== false) {
-      console.log(`\u{1F9F9} Cleaning output path: ${options.outputPath}`);
+      if (getLogLevel(config?.logLevel) >= LogLevel.DEBUG) {
+        console.log(`\u{1F9F9} Cleaning output path: ${options.outputPath}`);
+      }
       (0, import_fs_extra.removeSync)(options.outputPath);
     }
     const assets = Array.from(options.assets);
@@ -139091,11 +139076,15 @@ ${Object.keys(options).map(
     const implicitDependencies = context.projectsConfigurations.projects[context.projectName].implicitDependencies;
     const internalDependencies = [];
     const projectConfigs = await Promise.resolve(getProjectConfigurations());
-    console.log("Project Configs:");
-    console.log(projectConfigs);
+    if (getLogLevel(config?.logLevel) >= LogLevel.TRACE) {
+      console.log("Project Configs:");
+      console.log(projectConfigs);
+    }
     if (implicitDependencies && implicitDependencies.length > 0) {
       options.external = implicitDependencies.reduce((ret, key) => {
-        console.log(`\u26A1 Adding implicit dependency: ${key}`);
+        if (getLogLevel(config?.logLevel) >= LogLevel.DEBUG) {
+          console.log(`\u26A1 Adding implicit dependency: ${key}`);
+        }
         const projectConfig = projectConfigs[key];
         if (projectConfig?.targets?.build) {
           const projectPackageJson = (0, import_devkit3.readJsonFile)(projectConfig.targets?.build.options.project);
@@ -139121,10 +139110,12 @@ ${Object.keys(options).map(
         }
       }
     }
-    console.log(`Building with the following dependencies marked as external:
+    if (getLogLevel(config?.logLevel) >= LogLevel.TRACE) {
+      console.log(`Building with the following dependencies marked as external:
 ${externalDependencies.map((dep) => {
-      return `name: ${dep.name}, node: ${dep.node}, outputs: ${dep.outputs}`;
-    }).join("\n")}`);
+        return `name: ${dep.name}, node: ${dep.node}, outputs: ${dep.outputs}`;
+      }).join("\n")}`);
+    }
     const prettierOptions = {
       plugins: ["prettier-plugin-packagejson"],
       trailingComma: "none",
@@ -139161,12 +139152,14 @@ ${externalDependencies.map((dep) => {
         while (propertyKey.startsWith("/")) {
           propertyKey = propertyKey.substring(1);
         }
-        console.debug(
-          `Trying to add entry point ${propertyKey} at "${(0, import_devkit3.joinPathFragments)(
-            filePath.path,
-            filePath.name
-          )}"`
-        );
+        if (getLogLevel(config?.logLevel) >= LogLevel.DEBUG) {
+          console.debug(
+            `Trying to add entry point ${propertyKey} at "${(0, import_devkit3.joinPathFragments)(
+              filePath.path,
+              filePath.name
+            )}"`
+          );
+        }
         if (!(propertyKey in ret)) {
           ret[propertyKey] = (0, import_devkit3.joinPathFragments)(filePath.path, filePath.name);
         }
@@ -139282,7 +139275,9 @@ ${externalDependencies.map((dep) => {
       packageJson.repository ??= workspacePackageJson.repository;
       packageJson.repository.directory ??= projectRoot ? projectRoot : (0, import_path4.join)("packages", context.projectName);
       const packageJsonPath = (0, import_path4.join)(context.root, options.outputPath, "package.json");
-      console.log(`\u26A1 Writing package.json file to: ${packageJsonPath}`);
+      if (getLogLevel(config?.logLevel) >= LogLevel.DEBUG) {
+        console.debug(`\u26A1 Writing package.json file to: ${packageJsonPath}`);
+      }
       (0, import_fs4.writeFileSync)(
         packageJsonPath,
         await (0, import_prettier.format)(JSON.stringify(packageJson), {
@@ -139345,7 +139340,7 @@ ${(0, import_fs4.readFileSync)(file, "utf-8")}`,
               ...options,
               watch: false,
               main: options.entry,
-              transformers: ["typia/lib/transform"]
+              transformers: options.skipTypia ? [] : ["typia/lib/transform"]
             },
             context.root,
             sourceRoot,
@@ -139369,21 +139364,26 @@ ${options.banner}
       getTransform: options.skipTypia ? void 0 : getTypiaTransform
     };
     if (options.getConfig) {
+      if (getLogLevel(config?.logLevel) >= LogLevel.INFO) {
+        console.log("\u26A1 Running the Build process");
+      }
       const getConfigFns = _isFunction(options.getConfig) ? [options.getConfig] : Object.keys(options.getConfig).map((key) => options.getConfig[key]);
-      const config = (0, import_tsup.defineConfig)(
+      const tsupConfig = (0, import_tsup.defineConfig)(
         getConfigFns.map(
           (getConfigFn) => getConfig(context.root, projectRoot, getConfigFn, getConfigOptions)
         )
       );
-      if (_isFunction(config)) {
-        await build(await Promise.resolve(config({})));
+      if (_isFunction(tsupConfig)) {
+        await build(await Promise.resolve(tsupConfig({})), config);
       } else {
-        await build(config);
+        await build(tsupConfig, config);
       }
-    } else {
-      console.log("The Build process did not run because no `getConfig` parameter was provided");
+    } else if (getLogLevel(config?.logLevel) >= LogLevel.WARN) {
+      console.warn("The Build process did not run because no `getConfig` parameter was provided");
+    }
+    if (getLogLevel(config?.logLevel) >= LogLevel.INFO) {
+      console.log("\u26A1 The Build process has completed successfully");
     }
-    console.log("\u26A1 The Build process has completed successfully");
     return {
       success: true
     };
@@ -139409,6 +139409,7 @@ function getNormalizedTsConfig(workspaceRoot, outputPath, options) {
         esModuleInterop: true,
         downlevelIteration: true,
         forceConsistentCasingInFileNames: true,
+        emitDeclarationOnly: true,
         declaration: true,
         declarationMap: true,
         declarationDir: (0, import_path4.join)(workspaceRoot, "tmp", ".tsup", "declaration")
@@ -139423,12 +139424,19 @@ function getNormalizedTsConfig(workspaceRoot, outputPath, options) {
   }
   return tsConfig;
 }
-var build = async (options) => {
-  Array.isArray(options) ? options.length > 0 ? options[0].silent : false : options.silent && console.log("\u2699\uFE0F  Tsup build config: \n", options, "\n");
-  if (Array.isArray(options)) {
-    await Promise.all(options.map((buildOptions) => (0, import_tsup.build)(buildOptions)));
-  } else {
-    await (0, import_tsup.build)(options);
+var build = async (options, config) => {
+  try {
+    if (Array.isArray(options)) {
+      await Promise.all(options.map((buildOptions) => build(buildOptions, config)));
+    } else {
+      if (getLogLevel(config?.logLevel) >= LogLevel.TRACE && !options.silent) {
+        console.log("\u2699\uFE0F  Tsup build config: \n", options, "\n");
+      }
+      await (0, import_tsup.build)(options);
+    }
+  } catch (e) {
+    console.error("\u26A0\uFE0F  A failure occured during the Tsup Build executor");
+    console.error(e);
   }
 };
 var applyDefaultOptions = (options) => {
@@ -139458,7 +139466,6 @@ var applyDefaultOptions = (options) => {
   options.skipTypia ??= false;
   options.define ??= {};
   options.env ??= {};
-  options.verbose ??= !!process.env.CI;
   options.getConfig ??= { dist: defaultConfig };
   return options;
 };
@@ -139502,6 +139509,9 @@ function neutralConfig({
   metafile = false,
   define: define2,
   env: env2,
+  apiReport = true,
+  docModel = true,
+  tsdocMetadata = true,
   plugins,
   generatePackageJson,
   dtsTsConfig,
@@ -139542,9 +139552,9 @@ function neutralConfig({
         }
       }
     },
-    apiReport: false,
-    docModel: false,
-    tsdocMetadata: false,
+    apiReport,
+    docModel,
+    tsdocMetadata,
     sourcemap: debug,
     clean: false,
     tsconfigDecoratorMetadata: true,
@@ -139570,13 +139580,11 @@ var tsupNeutralBuildExecutorFn = (options, context, config) => {
     {
       ...options,
       getConfig: {
-        "dist": neutralConfig
+        dist: neutralConfig
       },
       platform: "neutral",
       banner: getFileBanner(
-        context.projectName ? context.projectName.split(/(?=[A-Z])|[\.\-\s_]/).map((s) => s.trim()).filter((s) => !!s).map(
-          (s) => s ? s.toUpperCase()[0] + s.toLowerCase().slice(1) : ""
-        ).join(" ") : "TypeScript (Neutral Platform)"
+        context.projectName ? context.projectName.split(/(?=[A-Z])|[\.\-\s_]/).map((s) => s.trim()).filter((s) => !!s).map((s) => s ? s.toUpperCase()[0] + s.toLowerCase().slice(1) : "").join(" ") : "TypeScript (Neutral Platform)"
       ),
       define: {
         ...options.define
@@ -139698,12 +139706,10 @@ var tsupNodeBuildExecutorFn = (options, context, config) => {
   return tsupExecutorFn(
     {
       ...options,
-      getConfig: { "dist": nodeConfig },
+      getConfig: { dist: nodeConfig },
       platform: "node",
       banner: getFileBanner(
-        context.projectName ? context.projectName.split(/(?=[A-Z])|[\.\-\s_]/).map((s) => s.trim()).filter((s) => !!s).map(
-          (s) => s ? s.toUpperCase()[0] + s.toLowerCase().slice(1) : ""
-        ).join(" ") : "TypeScript (NodeJs Platform)"
+        context.projectName ? context.projectName.split(/(?=[A-Z])|[\.\-\s_]/).map((s) => s.trim()).filter((s) => !!s).map((s) => s ? s.toUpperCase()[0] + s.toLowerCase().slice(1) : "").join(" ") : "TypeScript (NodeJs Platform)"
       ),
       define: {
         ...options.define
@@ -139712,7 +139718,8 @@ var tsupNodeBuildExecutorFn = (options, context, config) => {
         ...process.env
       }
     },
-    context
+    context,
+    config
   );
 };
 var applyDefaultOptions3 = (options) => {