@storm-software/workspace-tools 1.28.0 → 1.30.0

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

@@ -0,0 +1,9 @@
+import { TsupNeutralExecutorSchema } from "../tsup-neutral/schema";
+import { Platform } from "../tsup/schema";
+
+export type TsupBrowserExecutorSchema = Omit<
+  TsupNeutralExecutorSchema,
+  "platform"
+> & {
+  platform?: Platform;
+};

package/src/executors/tsup-browser/schema.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "tsup-browser",
+  "extends": "../tsup-browser/schema.json",
+  "version": 2,
+  "title": "Browser TypeScript Builder",
+  "description": "Runs a browser platform TypeScript build",
+  "type": "object",
+  "properties": {},
+  "required": []
+}

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

@@ -117247,22 +117247,23 @@ function getConfig(workspaceRoot, projectRoot, sourceRoot, {
   platform,
   ...rest
 }) {
-  const entry = globSync(
-    [
-      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) => {
+  const entryPoints = [];
+  if (rest.entry) {
+    entryPoints.push(rest.entry);
+  }
+  if (rest.packageAll !== false) {
+    entryPoints.push((0, import_devkit.joinPathFragments)(sourceRoot, "**/*.{ts,tsx}"));
+  }
+  if (additionalEntryPoints) {
+    entryPoints.push(...additionalEntryPoints);
+  }
+  const entry = globSync(entryPoints, {
+    withFileTypes: true
+  }).reduce((ret, filePath) => {
     let propertyKey = (0, import_devkit.joinPathFragments)(
       filePath.path,
       removeExtension(filePath.name)
-    ).replaceAll(workspaceRoot, "").replaceAll("\\", "/").replaceAll(sourceRoot, "").replaceAll(projectRoot, "");
+    ).replaceAll("/", "\\").replaceAll(workspaceRoot, "").replaceAll("\\", "/").replaceAll(sourceRoot, "").replaceAll(projectRoot, "");
     if (propertyKey) {
       while (propertyKey.startsWith("/")) {
         propertyKey = propertyKey.substring(1);
@@ -117405,7 +117406,7 @@ ${Object.keys(options).map(
         options.external
       );
     }
-    const externalDependencies = options.external.reduce((acc, name) => {
+    let externalDependencies = options.external.reduce((acc, name) => {
       const externalNode = context.projectGraph.externalNodes[`npm:${name}`];
       if (externalNode) {
         acc.push({
@@ -117413,22 +117414,20 @@ ${Object.keys(options).map(
           outputs: [],
           node: externalNode
         });
-      } else {
-        const workspaceNode = context.projectGraph.nodes[name];
-        if (workspaceNode) {
-          acc.push({
-            name,
-            outputs: [],
-            node: workspaceNode
-          });
-        }
       }
       return acc;
     }, []);
-    options.verbose && console.log(`Added the following external dependencies:
-${externalDependencies.map((dep) => {
-      return `name: ${dep.name}, node: ${dep.node}, outputs: ${dep.outputs}`;
-    }).join("\n")}`);
+    externalDependencies = implicitDependencies.reduce((acc, name) => {
+      const internalNode = context.projectGraph.nodes[name];
+      if (internalNode) {
+        acc.push({
+          name,
+          outputs: [],
+          node: internalNode
+        });
+      }
+      return acc;
+    }, externalDependencies);
     if (options.bundle === false) {
       for (const thirdPartyDependency of (0, import_get_extra_dependencies.getExtraDependencies)(
         context.projectName,
@@ -117441,6 +117440,10 @@ ${externalDependencies.map((dep) => {
         }
       }
     }
+    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")}`);
     const prettierOptions = {
       plugins: ["prettier-plugin-packagejson"],
       trailingComma: "none",
@@ -117722,6 +117725,7 @@ var applyDefaultOptions = (options) => {
   options.apiReport ??= true;
   options.docModel ??= true;
   options.tsdocMetadata ??= true;
+  options.packageAll ??= true;
   options.define ??= {};
   options.env ??= {};
   options.verbose ??= !!process.env.CI;

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

@@ -117247,22 +117247,23 @@ function getConfig(workspaceRoot, projectRoot, sourceRoot, {
   platform,
   ...rest
 }) {
-  const entry = globSync(
-    [
-      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) => {
+  const entryPoints = [];
+  if (rest.entry) {
+    entryPoints.push(rest.entry);
+  }
+  if (rest.packageAll !== false) {
+    entryPoints.push((0, import_devkit.joinPathFragments)(sourceRoot, "**/*.{ts,tsx}"));
+  }
+  if (additionalEntryPoints) {
+    entryPoints.push(...additionalEntryPoints);
+  }
+  const entry = globSync(entryPoints, {
+    withFileTypes: true
+  }).reduce((ret, filePath) => {
     let propertyKey = (0, import_devkit.joinPathFragments)(
       filePath.path,
       removeExtension(filePath.name)
-    ).replaceAll(workspaceRoot, "").replaceAll("\\", "/").replaceAll(sourceRoot, "").replaceAll(projectRoot, "");
+    ).replaceAll("/", "\\").replaceAll(workspaceRoot, "").replaceAll("\\", "/").replaceAll(sourceRoot, "").replaceAll(projectRoot, "");
     if (propertyKey) {
       while (propertyKey.startsWith("/")) {
         propertyKey = propertyKey.substring(1);
@@ -117405,7 +117406,7 @@ ${Object.keys(options).map(
         options.external
       );
     }
-    const externalDependencies = options.external.reduce((acc, name) => {
+    let externalDependencies = options.external.reduce((acc, name) => {
       const externalNode = context.projectGraph.externalNodes[`npm:${name}`];
       if (externalNode) {
         acc.push({
@@ -117413,22 +117414,20 @@ ${Object.keys(options).map(
           outputs: [],
           node: externalNode
         });
-      } else {
-        const workspaceNode = context.projectGraph.nodes[name];
-        if (workspaceNode) {
-          acc.push({
-            name,
-            outputs: [],
-            node: workspaceNode
-          });
-        }
       }
       return acc;
     }, []);
-    options.verbose && console.log(`Added the following external dependencies:
-${externalDependencies.map((dep) => {
-      return `name: ${dep.name}, node: ${dep.node}, outputs: ${dep.outputs}`;
-    }).join("\n")}`);
+    externalDependencies = implicitDependencies.reduce((acc, name) => {
+      const internalNode = context.projectGraph.nodes[name];
+      if (internalNode) {
+        acc.push({
+          name,
+          outputs: [],
+          node: internalNode
+        });
+      }
+      return acc;
+    }, externalDependencies);
     if (options.bundle === false) {
       for (const thirdPartyDependency of (0, import_get_extra_dependencies.getExtraDependencies)(
         context.projectName,
@@ -117441,6 +117440,10 @@ ${externalDependencies.map((dep) => {
         }
       }
     }
+    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")}`);
     const prettierOptions = {
       plugins: ["prettier-plugin-packagejson"],
       trailingComma: "none",
@@ -117722,6 +117725,7 @@ var applyDefaultOptions = (options) => {
   options.apiReport ??= true;
   options.docModel ??= true;
   options.tsdocMetadata ??= true;
+  options.packageAll ??= true;
   options.define ??= {};
   options.env ??= {};
   options.verbose ??= !!process.env.CI;

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"
+  ]
+}