@storm-software/workspace-tools 1.159.0 → 1.159.1

package/src/executors/cargo-format/schema.d.ts

@@ -0,0 +1,3 @@
+import { CargoBaseExecutorSchema } from "../../../declarations";
+
+export type CargoFormatExecutorSchema = CargoBaseExecutorSchema;

package/src/executors/cargo-format/schema.json

@@ -0,0 +1,134 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "cargo-format",
+  "outputCapture": "direct-nodejs",
+  "version": 2,
+  "title": "Cargo Format",
+  "description": "Format a Rust project with Cargo",
+  "type": "object",
+  "properties": {
+    "release": {
+      "type": "boolean",
+      "description": "Run the Cargo command for the project in release mode",
+      "default": false
+    },
+    "profile": {
+      "type": "string",
+      "description": "Build artifacts with the specified profile"
+    },
+    "toolchain": {
+      "type": "string",
+      "description": "The Rust toolchain to use",
+      "enum": ["stable", "beta", "nightly"],
+      "default": "stable"
+    },
+    "features": {
+      "oneOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      ],
+      "description": "Features of workspace members may be enabled with package-name/feature-name syntax. Array of names is supported"
+    },
+    "allFeatures": {
+      "type": "boolean",
+      "default": false,
+      "description": "Build all binary targets",
+      "alias": "all-features"
+    },
+    "lib": {
+      "type": "boolean",
+      "description": "Build the package's library",
+      "default": false
+    },
+    "bin": {
+      "oneOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      ],
+      "description": "Build the specified binary. Array of names or common Unix glob patterns is supported"
+    },
+    "bins": {
+      "type": "boolean",
+      "default": false,
+      "description": "Build all binary targets"
+    },
+    "example": {
+      "oneOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      ],
+      "description": "Build the specified example. Array of names or common Unix glob patterns is supported"
+    },
+    "examples": {
+      "type": "boolean",
+      "default": false,
+      "description": "Build all example targets"
+    },
+    "test": {
+      "oneOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      ],
+      "description": "Build the specified test. Array of names or common Unix glob patterns is supported"
+    },
+    "tests": {
+      "type": "boolean",
+      "default": false,
+      "description": "Build all test targets"
+    },
+    "bench": {
+      "oneOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      ],
+      "description": "Build the specified bench. Array of names or common Unix glob patterns is supported"
+    },
+    "benches": {
+      "type": "boolean",
+      "default": false,
+      "description": "Build all targets in benchmark mode that have the bench = true manifest flag set. By default this includes the library and binaries built as benchmarks, and bench targets. Be aware that this will also build any required dependencies, so the lib target may be built twice (once as a benchmark, and once as a dependency for binaries, benchmarks, etc.). Targets may be enabled or disabled by setting the bench flag in the manifest settings for the target."
+    },
+    "allTargets": {
+      "type": "boolean",
+      "default": false,
+      "description": "Build all test targets",
+      "alias": "all-targets"
+    }
+  },
+  "required": []
+}

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

@@ -1,8 +1,19 @@
 import { type CreateDependencies, type CreateNodes } from "@nx/devkit";
 export declare const name = "storm-software/rust/cargo-toml";
+export declare const description = "Plugin for parsing Cargo.toml files";
+export type CargoPluginProfileMap = Record<string, string> & {
+    development?: string;
+    production?: string;
+};
+export declare const DefaultCargoPluginProfileMap: {
+    development: string;
+    production: string;
+};
 export interface CargoPluginOptions {
     includeApps?: boolean;
     skipDocs?: boolean;
+    toolchain?: "stable" | "beta" | "nightly";
+    profiles?: CargoPluginProfileMap;
 }
 export declare const createNodes: CreateNodes<CargoPluginOptions>;
 export declare const createDependencies: CreateDependencies;

package/src/plugins/rust/index.js

@@ -19,8 +19,10 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // packages/workspace-tools/src/plugins/rust/index.ts
 var rust_exports = {};
 __export(rust_exports, {
+  DefaultCargoPluginProfileMap: () => DefaultCargoPluginProfileMap,
   createDependencies: () => createDependencies,
   createNodes: () => createNodes,
+  description: () => description,
   name: () => name
 });
 module.exports = __toCommonJS(rust_exports);
@@ -137,9 +139,18 @@ var setDefaultProjectTags = (project) => {
 
 // packages/workspace-tools/src/plugins/rust/cargo-toml.ts
 var name = "storm-software/rust/cargo-toml";
+var description = "Plugin for parsing Cargo.toml files";
+var DefaultCargoPluginProfileMap = {
+  development: "dev",
+  production: "prod"
+};
 var createNodes = [
   "*/**/Cargo.toml",
-  (cargoFile, opts = { includeApps: true, skipDocs: false }, ctx) => {
+  (cargoFile, opts = {
+    includeApps: true,
+    skipDocs: false,
+    profiles: {}
+  }, ctx) => {
     const metadata = cargoMetadata();
     if (!metadata) {
       return {};
@@ -147,6 +158,16 @@ var createNodes = [
     const { packages: cargoPackages } = metadata;
     const externalNodes = {};
     const projects = {};
+    const profiles = {
+      ...DefaultCargoPluginProfileMap,
+      ...opts.profiles
+    };
+    const configurations = Object.keys(profiles).reduce((ret, key) => {
+      ret[key] = {
+        profile: profiles[key]
+      };
+      return ret;
+    }, {});
     const cargoPackageMap = cargoPackages.reduce((acc, p) => {
       if (!acc.has(p.name)) {
         acc.set(p.name, p);
@@ -188,11 +209,25 @@ var createNodes = [
           lint: {
             cache: true,
             inputs: ["linting", "rust", "^production"],
-            dependsOn: ["lint-ls", "^lint"],
-            executor: "@monodon/rust:lint",
+            dependsOn: ["^lint"],
+            executor: "@storm-software/workspace-tools:cargo-clippy",
             options: {
-              "target-dir": `{workspaceRoot}/dist/target/${cargoPackage.name}`
-            }
+              toolchain: opts.toolchain,
+              fix: false
+            },
+            defaultConfiguration: "development",
+            configurations
+          },
+          check: {
+            cache: true,
+            inputs: ["linting", "rust", "^production"],
+            dependsOn: ["lint", "^check"],
+            executor: "@storm-software/workspace-tools:cargo-check",
+            options: {
+              toolchain: opts.toolchain
+            },
+            defaultConfiguration: "development",
+            configurations
           },
           "format-readme": {
             cache: true,
@@ -204,23 +239,42 @@ var createNodes = [
             inputs: ["linting", "rust", "^production"],
             dependsOn: ["^format-toml"]
           },
+          "format-clippy": {
+            cache: true,
+            inputs: ["linting", "rust", "^production"],
+            dependsOn: ["^format-clippy"],
+            executor: "@storm-software/workspace-tools:cargo-clippy",
+            options: {
+              toolchain: opts.toolchain,
+              fix: true
+            },
+            defaultConfiguration: "development",
+            configurations
+          },
           format: {
             cache: true,
             inputs: ["linting", "documentation", "rust", "^production"],
-            dependsOn: ["format-readme", "format-toml", "^format"],
-            executor: "nx:run-commands",
+            dependsOn: [
+              "format-readme",
+              "format-clippy",
+              "format-toml",
+              "^format"
+            ],
+            executor: "@storm-software/workspace-tools:cargo-format",
             options: {
-              command: `cargo fmt -p ${project.name}`,
-              color: true
-            }
+              toolchain: opts.toolchain,
+              fix: true
+            },
+            defaultConfiguration: "development",
+            configurations
           },
           clean: {
             cache: true,
             inputs: ["rust", "^production"],
-            outputs: [`{workspaceRoot}/dist/target/${cargoPackage.name}`],
+            outputs: [`{workspaceRoot}/dist/target/{projectRoot}`],
             executor: "nx:run-commands",
             options: {
-              command: `pnpm exec rimraf dist/target/${cargoPackage.name}`,
+              command: `pnpm exec rimraf dist/target/crates/${cargoPackage.name}`,
               color: true,
               cwd: "{workspaceRoot}"
             }
@@ -229,21 +283,25 @@ var createNodes = [
             cache: true,
             inputs: ["rust", "^production"],
             dependsOn: ["build-base", "^build"],
-            executor: "@monodon/rust:check",
-            outputs: ["{options.target-dir}"],
+            executor: "@storm-software/workspace-tools:cargo-build",
+            outputs: [`{workspaceRoot}/dist/target/{projectRoot}`],
             options: {
-              "target-dir": `{workspaceRoot}/dist/target/${cargoPackage.name}`
-            }
+              toolchain: opts.toolchain
+            },
+            defaultConfiguration: "development",
+            configurations
           },
           rebuild: {
             cache: false,
             inputs: ["rust", "^production"],
             dependsOn: ["clean", "^build"],
-            executor: "@monodon/rust:check",
-            outputs: ["{options.target-dir}"],
+            executor: "@storm-software/workspace-tools:cargo-build",
+            outputs: [`{workspaceRoot}/dist/target/{projectRoot}`],
             options: {
-              "target-dir": `{workspaceRoot}/dist/target/${cargoPackage.name}`
-            }
+              toolchain: opts.toolchain
+            },
+            defaultConfiguration: "development",
+            configurations
           },
           test: {
             cache: true,
@@ -252,26 +310,24 @@ var createNodes = [
             executor: "@monodon/rust:test",
             outputs: ["{options.target-dir}"],
             options: {
-              "target-dir": `{workspaceRoot}/dist/target/${cargoPackage.name}`
+              "target-dir": `{workspaceRoot}/dist/target/{projectRoot}`
             },
-            configurations: {
-              production: {
-                release: true
-              }
-            }
+            defaultConfiguration: "development",
+            configurations
           }
         };
         if (opts.skipDocs != true) {
           project.targets.docs = {
             cache: true,
             inputs: ["linting", "documentation", "default", "^production"],
-            dependsOn: ["build", "lint-docs", "^docs"],
-            outputs: [`{workspaceRoot}/dist/docs/${cargoPackage.name}`],
-            executor: "nx:run-commands",
+            dependsOn: ["build", "format-readme", "lint-docs", "^docs"],
+            outputs: [`{workspaceRoot}/dist/docs/{projectRoot}`],
+            executor: "@storm-software/workspace-tools:cargo-doc",
             options: {
-              command: `cargo doc -p ${project.name} --target-dir dist/docs/${cargoPackage.name}`,
-              color: true
-            }
+              toolchain: opts.toolchain
+            },
+            defaultConfiguration: "development",
+            configurations
           };
         }
         if (cargoPackage.publish === null || cargoPackage.publish === void 0 || cargoPackage.publish === true || Array.isArray(cargoPackage.publish) && cargoPackage.publish.length > 0) {
@@ -284,10 +340,13 @@ var createNodes = [
               "rust",
               "^production"
             ],
+            dependsOn: ["build", "^nx-release-publish"],
             executor: "@storm-software/workspace-tools:cargo-publish",
             options: {
               packageRoot: root
-            }
+            },
+            defaultConfiguration: "development",
+            configurations
           };
         }
         addProjectTag(
@@ -372,7 +431,9 @@ function createDependency(pkg, depName, type) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  DefaultCargoPluginProfileMap,
   createDependencies,
   createNodes,
+  description,
   name
 });

package/src/utils/cargo.d.ts

@@ -1,4 +1,6 @@
+import { ExecutorContext } from "@nx/devkit";
 import { type ChildProcess, type StdioOptions } from "node:child_process";
+import { CargoBaseExecutorSchema } from "../../declarations.d";
 import type { CargoMetadata, Dependency, Package } from "./toml";
 interface CargoRun {
     success: boolean;
@@ -8,7 +10,9 @@ interface RunCargoOptions {
     stdio: StdioOptions;
     env: NodeJS.ProcessEnv | undefined;
 }
+export declare const INVALID_CARGO_ARGS: string[];
 export declare let childProcess: ChildProcess | null;
+export declare const buildCargoCommand: (baseCommand: string, options: CargoBaseExecutorSchema, context: ExecutorContext) => string[];
 export declare function cargoCommand(...args: string[]): Promise<{
     success: boolean;
 }>;

package/src/utils/index.js

@@ -298964,6 +298964,7 @@ var require_transform = __commonJS({
 // packages/workspace-tools/src/utils/index.ts
 var utils_exports = {};
 __export(utils_exports, {
+  INVALID_CARGO_ARGS: () => INVALID_CARGO_ARGS,
   LOCK_FILES: () => LOCK_FILES,
   NPM_LOCK_FILE: () => NPM_LOCK_FILE,
   NPM_LOCK_PATH: () => NPM_LOCK_PATH,
@@ -298974,6 +298975,7 @@ __export(utils_exports, {
   YARN_LOCK_PATH: () => YARN_LOCK_PATH,
   addProjectTag: () => addProjectTag,
   applyWorkspaceExecutorTokens: () => applyWorkspaceExecutorTokens,
+  buildCargoCommand: () => buildCargoCommand,
   cargoCommand: () => cargoCommand,
   cargoCommandSync: () => cargoCommandSync,
   cargoMetadata: () => cargoMetadata,
@@ -299080,7 +299082,53 @@ var applyWorkspaceExecutorTokens = async (option, tokenizerOptions) => {
 var import_devkit = require("@nx/devkit");
 var import_node_child_process6 = require("node:child_process");
 var import_node_path8 = require("node:path");
+var INVALID_CARGO_ARGS = [
+  "allFeatures",
+  "allTargets",
+  "main",
+  "outputPath",
+  "tsConfig"
+];
 var childProcess2;
+var buildCargoCommand = (baseCommand, options, context) => {
+  const args = [];
+  if (options.toolchain && options.toolchain !== "stable") {
+    args.push(`+${options.toolchain}`);
+  }
+  args.push(baseCommand);
+  for (const [key, value2] of Object.entries(options)) {
+    if (key === "toolchain" || key === "release" || INVALID_CARGO_ARGS.includes(key)) {
+      continue;
+    }
+    if (typeof value2 === "boolean") {
+      if (value2) {
+        args.push(`--${key}`);
+      }
+    } else if (Array.isArray(value2)) {
+      for (const item of value2) {
+        args.push(`--${key}`, item);
+      }
+    } else {
+      args.push(`--${key}`, value2);
+    }
+  }
+  if (options.allFeatures && !args.includes("--all-features")) {
+    args.push("--all-features");
+  }
+  if (options.allTargets && !args.includes("--all-targets")) {
+    args.push("--all-targets");
+  }
+  if (options.release && !args.includes("--profile")) {
+    args.push("--release");
+  }
+  if (context.projectName && !args.includes("--package")) {
+    args.push("-p", context.projectName);
+  }
+  if (options.outputPath && !args.includes("--target-dir")) {
+    args.push("--target-dir", options.outputPath);
+  }
+  return args;
+};
 async function cargoCommand(...args) {
   console.log(`> cargo ${args.join(" ")}`);
   args.push("--color", "always");
@@ -302317,6 +302365,7 @@ var nodeVersion = "20.11.0";
 var pnpmVersion = "8.10.2";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  INVALID_CARGO_ARGS,
   LOCK_FILES,
   NPM_LOCK_FILE,
   NPM_LOCK_PATH,
@@ -302327,6 +302376,7 @@ var pnpmVersion = "8.10.2";
   YARN_LOCK_PATH,
   addProjectTag,
   applyWorkspaceExecutorTokens,
+  buildCargoCommand,
   cargoCommand,
   cargoCommandSync,
   cargoMetadata,