@storm-software/workspace-tools 1.66.0 → 1.66.2

package/CHANGELOG.md

@@ -1,3 +1,27 @@
+## 1.66.2 (2024-03-28)
+
+
+### 🩹 Fixes
+
+- **workspace-tools:** Update the Nx plugins to provide tags to workspace projects ([980a0203](https://github.com/storm-software/storm-ops/commit/980a0203))
+
+
+### ❤️  Thank You
+
+- Patrick Sullivan
+
+## 1.66.1 (2024-03-25)
+
+
+### 🩹 Fixes
+
+- **workspace-tools:** Resolved issue with applying Storm Nx plugins ([db3de8a6](https://github.com/storm-software/storm-ops/commit/db3de8a6))
+
+
+### ❤️  Thank You
+
+- Patrick Sullivan
+
 ## 1.66.0 (2024-03-25)
 
 

package/config/nx.json

@@ -18,7 +18,6 @@
       }
     }
   },
-  "defaultBase": "main",
   "namedInputs": {
     "globalTesting": [
       "{workspaceRoot}/jest.config.ts",
@@ -205,29 +204,9 @@
         "default",
         "^production"
       ],
-      "outputs": [
-        "{options.outputPath}"
-      ],
       "dependsOn": [
         "^build"
-      ],
-      "options": {
-        "main": "{projectRoot}/src/index.ts",
-        "outputPath": "dist/{projectRoot}",
-        "tsConfig": "{projectRoot}/tsconfig.json",
-        "assets": [
-          {
-            "glob": "*.md",
-            "input": "{projectRoot}",
-            "output": "."
-          },
-          {
-            "glob": "LICENSE",
-            "input": ".",
-            "output": "."
-          }
-        ]
-      }
+      ]
     },
     "docs": {
       "cache": true,
@@ -310,10 +289,9 @@
     }
   },
   "plugins": [
-    "@nx/js",
-    "@nx/jest",
-    "@nx/eslint",
-    "@storm-software/workspace-tools"
+    "@nx/eslint/plugin",
+    "@storm-software/workspace-tools/plugins/rust",
+    "@storm-software/workspace-tools/plugins/typescript"
   ],
   "pluginsConfig": {
     "@nx/js": {
@@ -321,5 +299,6 @@
       "analyzeLockfile": true,
       "analyzePackageJson": true
     }
-  }
+  },
+  "defaultBase": "main"
 }

package/index.ts

@@ -1,4 +1,5 @@
 export * from "./src/base";
+export * from "./src/utils";
 export * from "./src/executors/tsup-neutral/executor";
 export * from "./src/executors/tsup-neutral/schema";
 export * from "./src/executors/tsup-node/executor";
@@ -23,7 +24,3 @@ export * from "./src/generators/preset/generator";
 export * from "./src/generators/preset/schema";
 export * from "./src/generators/release-version/generator";
 export * from "./src/generators/release-version/schema";
-export * from "./src/plugins/rust/cargo-toml";
-export * from "./src/plugins/typescript/package-lock-file";
-export * from "./src/plugins/typescript/project-config";
-export * from "./src/utils";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storm-software/workspace-tools",
-  "version": "1.66.0",
+  "version": "1.66.2",
   "private": false,
   "description": "⚡ A Nx plugin package that contains various executors and generators used in a Storm workspaces.",
   "keywords": [
@@ -33,6 +33,18 @@
   "typings": "./declarations.d.ts",
   "executors": "./executors.json",
   "generators": "./generators.json",
+  "exports": {
+    ".": "./index.js",
+    "./package.json": "./package.json",
+    "./migrations.json": "./migrations.json",
+    "./generators.json": "./generators.json",
+    "./generators/*/schema.json": "./src/generators/*/schema.json",
+    "./executors.json": "./executors.json",
+    "./executors/*/schema.json": "./src/executors/*/schema.json",
+    "./plugins/rust": "./src/plugins/rust/index.js",
+    "./plugins/typescript": "./src/plugins/typescript/index.js",
+    "./preset": "./src/generators/preset/preset.js"
+  },
   "dependencies": {
     "@anatine/esbuild-decorators": "0.2.19",
     "@ltd/j-toml": "^1.38.0",

package/project.json

@@ -6,7 +6,9 @@
   "targets": {
     "build": {
       "executor": "@nx/esbuild:esbuild",
-      "outputs": ["{options.outputPath}"],
+      "outputs": [
+        "{options.outputPath}"
+      ],
       "options": {
         "outputPath": "dist/packages/workspace-tools",
         "tsConfig": "packages/workspace-tools/tsconfig.lib.json",
@@ -27,9 +29,8 @@
           "packages/workspace-tools/src/generators/release-version/generator.ts",
           "packages/workspace-tools/src/generators/preset/generator.ts",
           "packages/workspace-tools/src/generators/config-schema/generator.ts",
-          "packages/workspace-tools/src/plugins/rust/cargo-toml.ts",
-          "packages/workspace-tools/src/plugins/typescript/package-lock-file.ts",
-          "packages/workspace-tools/src/plugins/typescript/project-config.ts",
+          "packages/workspace-tools/src/plugins/rust/index.ts",
+          "packages/workspace-tools/src/plugins/typescript/index.ts",
           "packages/workspace-tools/src/utils/index.ts",
           "packages/workspace-tools/src/base/index.ts"
         ],
@@ -40,8 +41,18 @@
         "skipTypeCheck": false,
         "metafile": true,
         "minify": false,
-        "format": ["cjs", "esm"],
-        "external": ["nx", "@storm-software/*"],
+        "format": [
+          "cjs"
+        ],
+        "esbuildOptions": {
+          "outExtension": {
+            ".js": ".js"
+          }
+        },
+        "external": [
+          "nx",
+          "@storm-software/*"
+        ],
         "assets": [
           {
             "input": "packages/workspace-tools",
@@ -56,13 +67,19 @@
           {
             "input": "packages/workspace-tools",
             "glob": "**/*.json",
-            "ignore": ["**/tsconfig*.json", "project.json", ".eslintrc.json"],
+            "ignore": [
+              "**/tsconfig*.json",
+              "project.json",
+              ".eslintrc.json"
+            ],
             "output": "."
           },
           {
             "input": "packages/workspace-tools",
             "glob": "**/*.js",
-            "ignore": ["**/jest.config.js"],
+            "ignore": [
+              "**/jest.config.js"
+            ],
             "output": "."
           },
           {
@@ -94,5 +111,8 @@
       }
     }
   },
-  "tags": ["type:util", "scope:tools"]
-}
+  "tags": [
+    "type:util",
+    "scope:tools"
+  ]
+}

package/src/generators/release-version/generator.ts

@@ -440,7 +440,8 @@ To fix this you will either need to add a package.json or Cargo.toml file at tha
     } else if (tree.exists(cargoTomlPath)) {
       const cargoToml = parseCargoToml(tree.read(cargoTomlPath)?.toString("utf-8"));
 
-      cargoToml.version = newVersion;
+      cargoToml.package ??= {};
+      cargoToml.package.version = newVersion;
       tree.write(cargoTomlPath, stringifyCargoToml(cargoToml));
     }
 

package/src/plugins/rust/cargo-toml.ts

@@ -1,155 +1,161 @@
 import {
   type ProjectConfiguration,
   type RawProjectGraphDependency,
-  normalizePath,
   workspaceRoot,
-  type NxPluginV2
+  type CreateNodes,
+  type CreateDependencies
 } from "@nx/devkit";
 import { DependencyType, type ProjectGraphExternalNode } from "nx/src/config/project-graph";
-import { dirname, relative } from "node:path";
+import { dirname } from "node:path";
 import type { Package } from "../../utils/toml";
 import { cargoMetadata, isExternal } from "../../utils/cargo";
 
-export const cargoTomlPlugin: NxPluginV2 = {
-  name: "storm-software/rust/cargo-toml",
-  createNodes: [
-    "*/**/Cargo.toml",
-    (_projectFile, _opts, ctx) => {
-      const metadata = cargoMetadata();
-      if (!metadata) {
-        return {};
-      }
+export const name = "storm-software/rust/cargo-toml";
+
+export const createNodes: CreateNodes = [
+  "*/**/Cargo.toml",
+  (cargoFile, _opts, ctx) => {
+    const metadata = cargoMetadata();
+    if (!metadata) {
+      return {};
+    }
 
-      const { packages: cargoPackages } = metadata;
+    const { packages: cargoPackages } = metadata;
 
-      const externalNodes: Record<string, ProjectGraphExternalNode> = {};
-      const projects: Record<string, ProjectConfiguration> = {};
+    const externalNodes: Record<string, ProjectGraphExternalNode> = {};
+    const projects: Record<string, ProjectConfiguration> = {};
 
-      const cargoPackageMap = cargoPackages.reduce((acc, p) => {
-        if (!acc.has(p.name)) {
-          acc.set(p.name, p);
-        }
-        return acc;
-      }, new Map<string, Package>());
-
-      for (const pkg of cargoPackages) {
-        if (!isExternal(pkg, ctx.workspaceRoot)) {
-          const root = normalizePath(dirname(relative(ctx.workspaceRoot, pkg.manifest_path)));
-
-          const targets: ProjectConfiguration["targets"] = {
-            lint: {
-              cache: true,
-              inputs: ["default", "^production"],
-              dependsOn: ["^lint"],
-              executor: "@monodon/rust:lint",
-              outputs: ["{options.target-dir}"],
-              options: {
-                "target-dir": `dist/target/${pkg.name}`
-              }
-            },
-            build: {
-              cache: true,
-              inputs: ["default", "^production"],
-              dependsOn: ["lint", "^build"],
-              executor: "@monodon/rust:check",
-              outputs: ["{options.target-dir}"],
-              options: {
-                "target-dir": `dist/target/${pkg.name}`
-              }
+    const cargoPackageMap = cargoPackages.reduce((acc, p) => {
+      if (!acc.has(p.name)) {
+        acc.set(p.name, p);
+      }
+      return acc;
+    }, new Map<string, Package>());
+
+    for (const pkg of cargoPackages) {
+      if (!isExternal(pkg, ctx.workspaceRoot)) {
+        // const root = normalizePath(dirname(relative(ctx.workspaceRoot, pkg.manifest_path)));
+        const root = dirname(cargoFile);
+
+        const targets: ProjectConfiguration["targets"] = {
+          lint: {
+            cache: true,
+            inputs: ["default", "^production"],
+            dependsOn: ["^lint"],
+            executor: "@monodon/rust:lint",
+            outputs: ["{options.target-dir}"],
+            options: {
+              "target-dir": `dist/target/${pkg.name}`
+            }
+          },
+          build: {
+            cache: true,
+            inputs: ["default", "^production"],
+            dependsOn: ["lint", "^build"],
+            executor: "@monodon/rust:check",
+            outputs: ["{options.target-dir}"],
+            options: {
+              "target-dir": `dist/target/${pkg.name}`
+            }
+          },
+          test: {
+            cache: true,
+            inputs: ["defaultTesting", "^production"],
+            dependsOn: ["test", "^build"],
+            executor: "@monodon/rust:test",
+            outputs: ["{options.target-dir}"],
+            options: {
+              "target-dir": `dist/target/${pkg.name}`
             },
-            test: {
-              cache: true,
-              inputs: ["defaultTesting", "^production"],
-              dependsOn: ["test", "^build"],
-              executor: "@monodon/rust:test",
-              outputs: ["{options.target-dir}"],
-              options: {
-                "target-dir": `dist/target/${pkg.name}`
-              },
-              configurations: {
-                production: {
-                  release: true
-                }
+            configurations: {
+              production: {
+                release: true
               }
             }
-          };
-
-          // Apply nx-release-publish target for non-private projects
-          const isPrivate = pkg.publish?.length === 0;
-          if (!isPrivate) {
-            targets["nx-release-publish"] = {
-              cache: false,
-              inputs: ["default", "^production"],
-              dependsOn: ["test", "^nx-release-publish"],
-              executor: "@storm-software/workspace-tools:cargo-publish",
-              options: {
-                packageRoot: root
-              }
-            };
           }
+        };
 
-          projects[root] = {
-            root,
-            name: pkg.name,
-            targets,
-            release: {
-              version: {
-                generator: "@storm-software/workspace-tools:release-version"
-              }
+        // Apply nx-release-publish target for non-private projects
+        const isPrivate = pkg.publish?.length === 0;
+        if (!isPrivate) {
+          targets["nx-release-publish"] = {
+            cache: false,
+            inputs: ["default", "^production"],
+            dependsOn: ["test", "^nx-release-publish"],
+            executor: "@storm-software/workspace-tools:cargo-publish",
+            options: {
+              packageRoot: root
             }
           };
         }
-        for (const dep of pkg.dependencies) {
-          if (isExternal(dep, ctx.workspaceRoot)) {
-            const externalDepName = `cargo:${dep.name}`;
-            if (!externalNodes?.[externalDepName]) {
-              externalNodes[externalDepName] = {
-                type: "cargo" as any,
-                name: externalDepName as any,
-                data: {
-                  packageName: dep.name,
-                  version: cargoPackageMap.get(dep.name)?.version ?? "0.0.0"
-                }
-              };
+
+        projects[root] = {
+          root,
+          name: pkg.name,
+          targets,
+          release: {
+            version: {
+              generator: "@storm-software/workspace-tools:release-version"
             }
+          },
+          tags: ["rust", "cargo"]
+        };
+      }
+      for (const dep of pkg.dependencies) {
+        if (isExternal(dep, ctx.workspaceRoot)) {
+          const externalDepName = `cargo:${dep.name}`;
+          if (!externalNodes?.[externalDepName]) {
+            externalNodes[externalDepName] = {
+              type: "cargo" as any,
+              name: externalDepName as any,
+              data: {
+                packageName: dep.name,
+                version: cargoPackageMap.get(dep.name)?.version ?? "0.0.0"
+              }
+            };
           }
         }
       }
-
-      return {
-        projects,
-        externalNodes
-      };
-    }
-  ],
-  createDependencies: (_, { projects, externalNodes }) => {
-    const metadata = cargoMetadata();
-    if (!metadata) {
-      return [];
     }
 
-    const { packages: cargoPackages } = metadata;
+    return {
+      projects,
+      externalNodes
+    };
+  }
+];
 
-    const dependencies: RawProjectGraphDependency[] = [];
+export const createDependencies: CreateDependencies = (_, { projects, externalNodes }) => {
+  const metadata = cargoMetadata();
+  if (!metadata) {
+    return [];
+  }
 
-    for (const pkg of cargoPackages) {
-      if (projects[pkg.name]) {
-        for (const deps of pkg.dependencies) {
-          // if the dependency is listed in nx projects, it's not an external dependency
-          if (projects[deps.name]) {
-            dependencies.push(createDependency(pkg, deps.name, DependencyType.static));
-          } else {
-            const externalDepName = `cargo:${deps.name}`;
-            if (externalDepName in (externalNodes ?? {})) {
-              dependencies.push(createDependency(pkg, externalDepName, DependencyType.static));
-            }
+  const { packages: cargoPackages } = metadata;
+
+  const dependencies: RawProjectGraphDependency[] = [];
+
+  for (const pkg of cargoPackages) {
+    if (projects[pkg.name]) {
+      for (const deps of pkg.dependencies) {
+        if (!cargoPackages.find((p) => p.name === deps.name)) {
+          continue;
+        }
+
+        // if the dependency is listed in nx projects, it's not an external dependency
+        if (projects[deps.name]) {
+          dependencies.push(createDependency(pkg, deps.name, DependencyType.static));
+        } else {
+          const externalDepName = `cargo:${deps.name}`;
+          if (externalDepName in (externalNodes ?? {})) {
+            dependencies.push(createDependency(pkg, externalDepName, DependencyType.static));
           }
         }
       }
     }
-
-    return dependencies;
   }
+
+  return dependencies;
 };
 
 function createDependency(

package/src/plugins/rust/index.ts

@@ -0,0 +1 @@
+export * from "./cargo-toml";

package/src/plugins/typescript/index.ts

@@ -0,0 +1,2 @@
+// export * from "./package-lock-file";
+export * from "./project-config";

package/src/plugins/typescript/project-config.ts

@@ -2,94 +2,97 @@ import { dirname, join } from "node:path";
 import { existsSync } from "node:fs";
 import type { ProjectConfiguration } from "nx/src/config/workspace-json-project-json";
 import { readJsonFile } from "nx/src/utils/fileutils";
-import type { NxPluginV2 } from "nx/src/utils/nx-plugin";
 import { type PackageJson, readTargetsFromPackageJson } from "nx/src/utils/package-json";
 
-export const ProjectJsonProjectsPlugin: NxPluginV2 = {
-  name: "storm-software/typescript/-config",
-  createNodes: [
-    "{project.json,**/project.json}",
-    (file, _, ctx) => {
-      const packageJson = createPackageJson(file, ctx.workspaceRoot);
-      if (!packageJson) {
-        return {};
-      }
+export const name = "storm-software/typescript/project-config";
+export const createNodes = [
+  "{project.json,**/project.json}",
+  (file, _, ctx) => {
+    const packageJson = createPackageJson(file, ctx.workspaceRoot);
+    if (!packageJson) {
+      return {};
+    }
 
-      const project = createProjectFromPackageJsonNextToProjectJson(file, packageJson);
-      const targets: ProjectConfiguration["targets"] = readTargetsFromPackageJson(packageJson);
+    const project = createProjectFromPackageJsonNextToProjectJson(file, packageJson);
+    const targets: ProjectConfiguration["targets"] = readTargetsFromPackageJson(packageJson);
 
-      if (!targets.lint) {
-        targets.lint = {
+    if (!targets.lint) {
+      targets.lint = {
+        cache: true,
+        inputs: ["default"],
+        dependsOn: ["^lint"],
+        executor: "@nx/eslint:lint",
+        outputs: ["{options.outputFile}"],
+        options: {
+          format: "stylish",
+          fix: true,
           cache: true,
-          inputs: ["default"],
-          dependsOn: ["^lint"],
-          executor: "@nx/eslint:lint",
-          outputs: ["{options.outputFile}"],
-          options: {
-            format: "stylish",
-            fix: true,
-            cache: true,
-            errorOnUnmatchedPattern: false,
-            printConfig: true
-          }
-        };
-      }
+          errorOnUnmatchedPattern: false,
+          printConfig: true
+        }
+      };
+    }
 
-      if (!targets.test) {
-        targets.test = {
-          cache: true,
-          inputs: ["default", "^production"],
-          dependsOn: ["build", "^test"],
-          executor: "@nx/jest:jest",
-          outputs: ["{workspaceRoot}/coverage/{projectRoot}"],
-          options: {
-            jestConfig: "{projectRoot}/jest.config.ts",
-            passWithNoTests: true
+    if (!targets.test) {
+      targets.test = {
+        cache: true,
+        inputs: ["default", "^production"],
+        dependsOn: ["build", "^test"],
+        executor: "@nx/jest:jest",
+        outputs: ["{workspaceRoot}/coverage/{projectRoot}"],
+        defaultConfiguration: "local",
+        options: {
+          jestConfig: "{projectRoot}/jest.config.ts",
+          passWithNoTests: true
+        },
+        configurations: {
+          local: {
+            ci: false,
+            codeCoverage: true
           },
-          configurations: {
-            ci: {
-              ci: true,
-              codeCoverage: true
-            }
+          ci: {
+            ci: true,
+            codeCoverage: true
           }
-        };
-      }
+        }
+      };
+    }
 
-      // Apply nx-release-publish target for non-private projects
-      const isPrivate = packageJson.private ?? false;
-      if (!isPrivate) {
-        targets["nx-release-publish"] = {
-          cache: false,
-          inputs: ["default", "^production"],
-          dependsOn: ["build", "^nx-release-publish"],
-          executor: "@storm-software/workspace-tools:cargo-publish",
-          options: {
-            packageRoot: `dist/${project.root}`,
-            registry: "https://registry.npmjs.org/"
-          }
-        };
-      }
+    // Apply nx-release-publish target for non-private projects
+    const isPrivate = packageJson.private ?? false;
+    if (!isPrivate) {
+      targets["nx-release-publish"] = {
+        cache: false,
+        inputs: ["default", "^production"],
+        dependsOn: ["build", "^nx-release-publish"],
+        executor: "@storm-software/workspace-tools:npm-publish",
+        options: {
+          packageRoot: `dist/${project.root}`,
+          registry: "https://registry.npmjs.org/"
+        }
+      };
+    }
 
-      return project?.name
-        ? {
-            projects: {
-              [project.name]: {
-                ...project,
-                targets,
-                release: {
-                  ...project?.release,
-                  version: {
-                    ...project?.release?.version,
-                    generator: "@storm-software/workspace-tools:release-version"
-                  }
+    return project?.name
+      ? {
+          projects: {
+            [project.name]: {
+              tags: ["typescript", "npm"],
+              ...project,
+              targets,
+              release: {
+                ...project?.release,
+                version: {
+                  ...project?.release?.version,
+                  generator: "@storm-software/workspace-tools:release-version"
                 }
               }
             }
           }
-        : {};
-    }
-  ]
-};
+        }
+      : {};
+  }
+];
 
 function createProjectFromPackageJsonNextToProjectJson(
   projectJsonPath: string,

package/tsconfig.lib.json

@@ -3,13 +3,19 @@
   "compilerOptions": {
     "outDir": "../../dist/out-tsc",
     "declaration": true,
-    "types": ["node"]
+    "types": [
+      "node"
+    ]
   },
-  "include": ["**/*.ts", "**/*.json", "declarations.d.ts"],
+  "include": [
+    "**/*.ts",
+    "**/*.json",
+    "declarations.d.ts"
+  ],
   "exclude": [
     "jest.config.ts",
     "src/generators/**/files/**/*",
     "src/**/*.spec.ts",
     "src/**/*.test.ts"
   ]
-}
+}