@storm-software/workspace-tools 1.27.0 → 1.29.0

package/src/executors/tsup-node/executor.js

@@ -12458,12 +12458,12 @@ var require_install_packages_task = __commonJS({
     var child_process_1 = require("child_process");
     var path_1 = require("path");
     var nx_1 = require_nx();
-    var { detectPackageManager, getPackageManagerCommand, joinPathFragments: joinPathFragments2 } = (0, nx_1.requireNx)();
+    var { detectPackageManager, getPackageManagerCommand, joinPathFragments: joinPathFragments3 } = (0, nx_1.requireNx)();
     function installPackagesTask(tree, alwaysRun = false, cwd = "", packageManager = detectPackageManager(cwd)) {
-      if (!tree.listChanges().find((f) => f.path === joinPathFragments2(cwd, "package.json")) && !alwaysRun) {
+      if (!tree.listChanges().find((f) => f.path === joinPathFragments3(cwd, "package.json")) && !alwaysRun) {
         return;
       }
-      const packageJsonValue = tree.read(joinPathFragments2(cwd, "package.json"), "utf-8");
+      const packageJsonValue = tree.read(joinPathFragments3(cwd, "package.json"), "utf-8");
       let storedPackageJsonValue = global["__packageJsonInstallCache__"];
       if (storedPackageJsonValue != packageJsonValue || alwaysRun) {
         global["__packageJsonInstallCache__"] = packageJsonValue;
@@ -41784,7 +41784,7 @@ var require_project_name_and_root_utils = __commonJS({
     var nx_1 = require_nx();
     var get_workspace_layout_1 = require_get_workspace_layout();
     var names_1 = require_names();
-    var { joinPathFragments: joinPathFragments2, normalizePath, logger, readJson, stripIndents, workspaceRoot } = (0, nx_1.requireNx)();
+    var { joinPathFragments: joinPathFragments3, normalizePath, logger, readJson, stripIndents, workspaceRoot } = (0, nx_1.requireNx)();
     var deprecationWarning = stripIndents`
     In Nx 18, generating projects will no longer derive the name and root.
     Please provide the exact project name and root in the future.`;
@@ -41860,14 +41860,14 @@ var require_project_name_and_root_utils = __commonJS({
         if (directory === relativeCwd || directory.startsWith(`${relativeCwd}/`)) {
           asProvidedProjectDirectory = directory;
         } else {
-          asProvidedProjectDirectory = joinPathFragments2(relativeCwd, directory);
+          asProvidedProjectDirectory = joinPathFragments3(relativeCwd, directory);
         }
       } else if (options.rootProject) {
         asProvidedProjectDirectory = ".";
       } else {
         asProvidedProjectDirectory = relativeCwd;
         if (!relativeCwd.endsWith(asProvidedProjectName) && !relativeCwd.endsWith(options.name)) {
-          asProvidedProjectDirectory = joinPathFragments2(relativeCwd, asProvidedProjectName);
+          asProvidedProjectDirectory = joinPathFragments3(relativeCwd, asProvidedProjectName);
         }
       }
       if (asProvidedProjectName.startsWith("@")) {
@@ -41900,7 +41900,7 @@ var require_project_name_and_root_utils = __commonJS({
       const derivedSimpleProjectName = name;
       let derivedProjectDirectory = derivedProjectDirectoryWithoutLayout;
       if (derivedProjectDirectoryWithoutLayout !== ".") {
-        derivedProjectDirectory = joinPathFragments2(layoutDirectory, derivedProjectDirectory);
+        derivedProjectDirectory = joinPathFragments3(layoutDirectory, derivedProjectDirectory);
       }
       let derivedImportPath;
       if (options.projectType === "library") {
@@ -49563,7 +49563,7 @@ var require_dist2 = __commonJS({
       loadTsConfig: () => loadTsConfig2
     });
     module2.exports = __toCommonJS2(src_exports);
-    var import_path5 = __toESM2(require("path"), 1);
+    var import_path4 = __toESM2(require("path"), 1);
     var import_fs4 = __toESM2(require("fs"), 1);
     var singleComment = Symbol("singleComment");
     var multiComment = Symbol("multiComment");
@@ -49659,10 +49659,10 @@ var require_dist2 = __commonJS({
       }
     }
     var req = false ? createRequire(import_meta.url) : require;
-    var findUp = (name, startDir, stopDir = import_path5.default.parse(startDir).root) => {
+    var findUp = (name, startDir, stopDir = import_path4.default.parse(startDir).root) => {
       let dir = startDir;
       while (dir !== stopDir) {
-        const file = import_path5.default.join(dir, name);
+        const file = import_path4.default.join(dir, name);
         if (import_fs4.default.existsSync(file))
           return file;
         if (!file.endsWith(".json")) {
@@ -49670,17 +49670,17 @@ var require_dist2 = __commonJS({
           if (import_fs4.default.existsSync(fileWithExt))
             return fileWithExt;
         }
-        dir = import_path5.default.dirname(dir);
+        dir = import_path4.default.dirname(dir);
       }
       return null;
     };
     var resolveTsConfigFromFile = (cwd, filename) => {
-      if (import_path5.default.isAbsolute(filename))
+      if (import_path4.default.isAbsolute(filename))
         return import_fs4.default.existsSync(filename) ? filename : null;
       return findUp(filename, cwd);
     };
     var resolveTsConfigFromExtends = (cwd, name) => {
-      if (import_path5.default.isAbsolute(name))
+      if (import_path4.default.isAbsolute(name))
         return import_fs4.default.existsSync(name) ? name : null;
       if (name.startsWith("."))
         return findUp(name, cwd);
@@ -49689,14 +49689,14 @@ var require_dist2 = __commonJS({
     };
     var loadTsConfigInternal = (dir = process.cwd(), name = "tsconfig.json", isExtends = false) => {
       var _a, _b;
-      dir = import_path5.default.resolve(dir);
+      dir = import_path4.default.resolve(dir);
       const id = isExtends ? resolveTsConfigFromExtends(dir, name) : resolveTsConfigFromFile(dir, name);
       if (!id)
         return null;
       const data = jsoncParse(import_fs4.default.readFileSync(id, "utf-8"));
-      const configDir = import_path5.default.dirname(id);
+      const configDir = import_path4.default.dirname(id);
       if ((_a = data.compilerOptions) == null ? void 0 : _a.baseUrl) {
-        data.compilerOptions.baseUrl = import_path5.default.join(
+        data.compilerOptions.baseUrl = import_path4.default.join(
           configDir,
           data.compilerOptions.baseUrl
         );
@@ -49779,11 +49779,11 @@ var require_dist3 = __commonJS({
     var import_esbuild = require("esbuild");
     var import_load_tsconfig = require_dist2();
     var import_fs4 = __toESM2(require("fs"), 1);
-    var import_path5 = __toESM2(require("path"), 1);
+    var import_path4 = __toESM2(require("path"), 1);
     var getPkgType = () => {
       try {
         const pkg = JSON.parse(
-          import_fs4.default.readFileSync(import_path5.default.resolve("package.json"), "utf-8")
+          import_fs4.default.readFileSync(import_path4.default.resolve("package.json"), "utf-8")
         );
         return pkg.type;
       } catch (error) {
@@ -49792,7 +49792,7 @@ var require_dist3 = __commonJS({
     function guessFormat(inputFile) {
       if (!usingDynamicImport)
         return "cjs";
-      const ext2 = import_path5.default.extname(inputFile);
+      const ext2 = import_path4.default.extname(inputFile);
       const type = getPkgType();
       if (ext2 === ".js") {
         return type === "module" ? "esm" : "cjs";
@@ -75530,7 +75530,7 @@ var require_util6 = __commonJS({
     var normalize2 = createSafeHandler((url) => {
     });
     exports.normalize = normalize2;
-    function join4(aRoot, aPath) {
+    function join3(aRoot, aPath) {
       const pathType = getURLType(aPath);
       const rootType = getURLType(aRoot);
       aRoot = ensureDirectory(aRoot);
@@ -75556,7 +75556,7 @@ var require_util6 = __commonJS({
       const newPath = withBase(aPath, withBase(aRoot, base));
       return computeRelativeURL(base, newPath);
     }
-    exports.join = join4;
+    exports.join = join3;
     function relative(rootURL, targetURL) {
       const result = relativeIfPossible(rootURL, targetURL);
       return typeof result === "string" ? result : normalize2(targetURL);
@@ -75586,9 +75586,9 @@ var require_util6 = __commonJS({
       }
       let url = normalize2(sourceURL || "");
       if (sourceRoot)
-        url = join4(sourceRoot, url);
+        url = join3(sourceRoot, url);
       if (sourceMapURL)
-        url = join4(trimFilename(sourceMapURL), url);
+        url = join3(trimFilename(sourceMapURL), url);
       return url;
     }
     exports.computeSourceURL = computeSourceURL;
@@ -77354,7 +77354,7 @@ var require_source_map = __commonJS({
 var require_native = __commonJS({
   "node_modules/.pnpm/rollup@4.5.0/node_modules/rollup/dist/native.js"(exports, module2) {
     var { existsSync: existsSync2 } = require("node:fs");
-    var { join: join4 } = require("node:path");
+    var { join: join3 } = require("node:path");
     var { platform, arch, report } = require("node:process");
     var isMusl = () => !report.getReport().header.glibcVersionRuntime;
     var bindingsByPlatformAndArch = {
@@ -77404,7 +77404,7 @@ If this is important to you, please consider supporting Rollup to make a native
       return imported.base;
     }
     var localName = `./rollup.${packageBase}.node`;
-    var { parse, parseAsync, xxhashBase64Url } = existsSync2(join4(__dirname, localName)) ? require(localName) : require(`@rollup/rollup-${packageBase}`);
+    var { parse, parseAsync, xxhashBase64Url } = existsSync2(join3(__dirname, localName)) ? require(localName) : require(`@rollup/rollup-${packageBase}`);
     module2.exports.parse = parse;
     module2.exports.parseAsync = parseAsync;
     module2.exports.xxhashBase64Url = xxhashBase64Url;
@@ -110771,7 +110771,7 @@ ${commentStart} ----------------------------------------------------------------
 
 // packages/workspace-tools/src/executors/tsup/executor.ts
 var import_esbuild_decorators = __toESM(require_src());
-var import_devkit = __toESM(require_devkit());
+var import_devkit2 = __toESM(require_devkit());
 var import_get_extra_dependencies = __toESM(require_get_extra_dependencies());
 var import_js = __toESM(require_src2());
 var import_normalize_options = __toESM(require_normalize_options());
@@ -117000,7 +117000,7 @@ glob.glob = glob;
 
 // packages/workspace-tools/src/executors/tsup/executor.ts
 var import_fileutils = require("nx/src/utils/fileutils");
-var import_path4 = require("path");
+var import_path3 = require("path");
 var import_prettier = require("prettier");
 var import_tsup2 = __toESM(require_dist6());
 var ts = __toESM(require("typescript"));
@@ -117011,7 +117011,7 @@ var removeExtension = (filePath) => {
 };
 
 // packages/workspace-tools/src/executors/tsup/get-config.ts
-var import_path3 = require("path");
+var import_devkit = __toESM(require_devkit());
 var import_tsup = __toESM(require_dist6());
 function modernConfig({
   entry,
@@ -117036,7 +117036,7 @@ function modernConfig({
   generatePackageJson,
   dtsTsConfig
 }) {
-  let outputPath = (0, import_path3.join)(outDir, "dist", "modern");
+  let outputPath = (0, import_devkit.joinPathFragments)(outDir, "dist", "modern");
   return {
     name: "modern",
     entry,
@@ -117115,7 +117115,7 @@ function legacyConfig({
   generatePackageJson,
   dtsTsConfig
 }) {
-  let outputPath = (0, import_path3.join)(outDir, "dist", "legacy");
+  let outputPath = (0, import_devkit.joinPathFragments)(outDir, "dist", "legacy");
   return {
     name: "legacy",
     entry,
@@ -117181,14 +117181,14 @@ function workerConfig({
   apiReport = true,
   docModel = true,
   tsdocMetadata = true,
-  shims = false,
+  shims = true,
   define: define2,
   env,
   plugins,
   generatePackageJson,
   dtsTsConfig
 }) {
-  let outputPath = (0, import_path3.join)(outDir, "dist");
+  let outputPath = (0, import_devkit.joinPathFragments)(outDir, "dist");
   return {
     name: "worker",
     entry,
@@ -117223,13 +117223,13 @@ function workerConfig({
         }
       }
     },
-    /*minify: debug ? false : "terser",
+    minify: debug ? false : "terser",
     terserOptions: {
       compress: true,
       ecma: 2020,
       keep_classnames: true,
       keep_fnames: true
-    },*/
+    },
     apiReport,
     docModel,
     tsdocMetadata,
@@ -117249,20 +117249,32 @@ function getConfig(workspaceRoot, projectRoot, sourceRoot, {
 }) {
   const entry = globSync(
     [
-      rest.entry ? rest.entry : (0, import_path3.join)(sourceRoot, "**/*.{ts,tsx}"),
+      rest.entry ? rest.entry : (0, import_devkit.joinPathFragments)(
+        sourceRoot.includes(workspaceRoot) ? sourceRoot : (0, import_devkit.joinPathFragments)(workspaceRoot, sourceRoot),
+        "**/*.{ts,tsx}"
+      ),
       ...additionalEntryPoints ?? []
     ],
     {
       withFileTypes: true
     }
   ).reduce((ret, filePath) => {
-    let propertyKey = (0, import_path3.join)(filePath.path, removeExtension(filePath.name)).replaceAll(workspaceRoot, "").replaceAll("\\", "/").replaceAll(sourceRoot, "").replaceAll(projectRoot, "");
+    let propertyKey = (0, import_devkit.joinPathFragments)(
+      filePath.path,
+      removeExtension(filePath.name)
+    ).replaceAll(workspaceRoot, "").replaceAll("\\", "/").replaceAll(sourceRoot, "").replaceAll(projectRoot, "");
     if (propertyKey) {
       while (propertyKey.startsWith("/")) {
         propertyKey = propertyKey.substring(1);
       }
+      console.debug(
+        `Trying to add entry point ${propertyKey} at "${(0, import_devkit.joinPathFragments)(
+          filePath.path,
+          filePath.name
+        )}"`
+      );
       if (!(propertyKey in ret)) {
-        ret[propertyKey] = (0, import_path3.join)(filePath.path, filePath.name);
+        ret[propertyKey] = (0, import_devkit.joinPathFragments)(filePath.path, filePath.name);
       }
     }
     return ret;
@@ -117357,8 +117369,8 @@ ${Object.keys(options).map(
     if (!result.success) {
       throw new Error("The Build process failed trying to copy assets");
     }
-    const workspacePackageJson = (0, import_devkit.readJsonFile)(
-      (0, import_path4.join)(workspaceRoot, "package.json")
+    const workspacePackageJson = (0, import_devkit2.readJsonFile)(
+      (0, import_path3.join)(workspaceRoot, "package.json")
     );
     options.external = options.external || [];
     if (workspacePackageJson?.dependencies) {
@@ -117377,8 +117389,8 @@ ${Object.keys(options).map(
       options.external = implicitDependencies.reduce(
         (ret, key) => {
           if (context.projectsConfigurations.projects[key].root) {
-            const packageJson = (0, import_devkit.readJsonFile)(
-              (0, import_path4.join)(
+            const packageJson = (0, import_devkit2.readJsonFile)(
+              (0, import_path3.join)(
                 context.root,
                 context.projectsConfigurations.projects[key].root,
                 "package.json"
@@ -117444,9 +117456,9 @@ ${externalDependencies.map((dep) => {
       endOfLine: "lf"
     };
     if (options.generatePackageJson !== false) {
-      const projectGraph = (0, import_devkit.readCachedProjectGraph)();
-      const pathToPackageJson = (0, import_path4.join)(context.root, projectRoot, "package.json");
-      const packageJson = (0, import_fileutils.fileExists)(pathToPackageJson) ? (0, import_devkit.readJsonFile)(pathToPackageJson) : { name: context.projectName, version: "0.0.1" };
+      const projectGraph = (0, import_devkit2.readCachedProjectGraph)();
+      const pathToPackageJson = (0, import_path3.join)(context.root, projectRoot, "package.json");
+      const packageJson = (0, import_fileutils.fileExists)(pathToPackageJson) ? (0, import_devkit2.readJsonFile)(pathToPackageJson) : { name: context.projectName, version: "0.0.1" };
       delete packageJson.dependencies;
       externalDependencies.forEach((entry) => {
         const packageConfig = entry.node.data;
@@ -117470,13 +117482,31 @@ ${externalDependencies.map((dep) => {
             types: "./dist/modern/index.d.cts",
             default: "./dist/modern/index.cjs"
           },
+          default: {
+            types: "./dist/modern/**/*.d.ts",
+            default: "./dist/modern/**/*.js"
+          },
+          "./*": {
+            "import": {
+              types: "./dist/modern/**/*.d.ts",
+              default: "./dist/modern/**/*.js"
+            },
+            require: {
+              types: "./dist/modern/**/*.d.cts",
+              default: "./dist/modern/**/*.cjs"
+            },
+            "default": {
+              types: "./dist/modern/**/*.d.ts",
+              default: "./dist/modern/**/*.js"
+            }
+          },
           ...(options.additionalEntryPoints ?? []).map((entryPoint) => ({
             [removeExtension(entryPoint).replace(sourceRoot, "")]: {
-              types: (0, import_path4.join)(
+              types: (0, import_path3.join)(
                 "./dist/modern",
                 `${removeExtension(entryPoint.replace(sourceRoot, ""))}.d.ts`
               ),
-              default: (0, import_path4.join)(
+              default: (0, import_path3.join)(
                 "./dist/modern",
                 `${removeExtension(entryPoint.replace(sourceRoot, ""))}.js`
               )
@@ -117487,6 +117517,10 @@ ${externalDependencies.map((dep) => {
       };
       packageJson.funding ??= workspacePackageJson.funding;
       packageJson.types ??= "dist/legacy/index.d.ts";
+      packageJson.typings ??= "dist/legacy/index.d.ts";
+      packageJson.typescript ??= {
+        definition: "dist/legacy/index.d.ts"
+      };
       packageJson.main ??= "dist/legacy/index.cjs";
       packageJson.module ??= "dist/legacy/index.js";
       options.platform && options.platform !== "node" && (packageJson.browser ??= "dist/modern/index.global.js");
@@ -117495,15 +117529,15 @@ ${externalDependencies.map((dep) => {
         if (distSrc.startsWith("/")) {
           distSrc = distSrc.substring(1);
         }
-        packageJson.source ??= `${(0, import_path4.join)(distSrc, "index.ts").replaceAll(
+        packageJson.source ??= `${(0, import_path3.join)(distSrc, "index.ts").replaceAll(
           "\\",
           "/"
         )}`;
       }
       packageJson.sideEffects ??= false;
-      packageJson.files ??= ["dist"];
+      packageJson.files ??= ["dist/**/*"];
       if (options.includeSrc !== false && !packageJson.files.includes("src")) {
-        packageJson.files.push("src");
+        packageJson.files.push("src/**/*");
       }
       packageJson.publishConfig ??= {
         access: "public"
@@ -117515,8 +117549,8 @@ ${externalDependencies.map((dep) => {
       packageJson.license ??= workspacePackageJson.license;
       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)(
+      packageJson.repository.directory ??= projectRoot ? projectRoot : (0, import_path3.join)("packages", context.projectName);
+      const packageJsonPath = (0, import_path3.join)(
         context.root,
         options.outputPath,
         "package.json"
@@ -117532,10 +117566,10 @@ ${externalDependencies.map((dep) => {
     }
     if (options.includeSrc !== false) {
       const files = globSync([
-        (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")
+        (0, import_devkit2.joinPathFragments)(context.root, options.outputPath, "src/**/*.ts"),
+        (0, import_devkit2.joinPathFragments)(context.root, options.outputPath, "src/**/*.tsx"),
+        (0, import_devkit2.joinPathFragments)(context.root, options.outputPath, "src/**/*.js"),
+        (0, import_devkit2.joinPathFragments)(context.root, options.outputPath, "src/**/*.jsx")
       ]);
       await Promise.allSettled(
         files.map(
@@ -117637,15 +117671,15 @@ function getNormalizedTsConfig(workspaceRoot, outputPath, options) {
         declaration: true,
         declarationMap: true,
         emitDeclarationOnly: true,
-        declarationDir: (0, import_path4.join)(workspaceRoot, "tmp", ".tsup", "declaration")
+        declarationDir: (0, import_path3.join)(workspaceRoot, "tmp", ".tsup", "declaration")
       }
     },
     ts.sys,
-    (0, import_path4.dirname)(options.tsConfig)
+    (0, import_path3.dirname)(options.tsConfig)
   );
   tsConfig.options.pathsBasePath = workspaceRoot;
   if (tsConfig.options.incremental && !tsConfig.options.tsBuildInfoFile) {
-    tsConfig.options.tsBuildInfoFile = (0, import_devkit.joinPathFragments)(
+    tsConfig.options.tsBuildInfoFile = (0, import_devkit2.joinPathFragments)(
       outputPath,
       "tsconfig.tsbuildinfo"
     );
@@ -117680,7 +117714,7 @@ var applyDefaultOptions = (options) => {
   options.additionalEntryPoints ??= [];
   options.assets ??= [];
   options.plugins ??= [];
-  options.includeSrc ??= true;
+  options.includeSrc ??= false;
   options.clean ??= true;
   options.bundle ??= true;
   options.debug ??= false;
@@ -117690,6 +117724,7 @@ var applyDefaultOptions = (options) => {
   options.tsdocMetadata ??= true;
   options.define ??= {};
   options.env ??= {};
+  options.verbose ??= !!process.env.CI;
   return options;
 };
 var executor_default = withRunExecutor(

package/src/generators/browser-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/browser-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/browser-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/browser-library/files/tsconfig.spec.json

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