@joshmossas/nx-cargo 0.6.2

package/src/executors/run/executor.ts

@@ -0,0 +1,19 @@
+import { ExecutorContext } from "@nx/devkit";
+
+import { Target, parseCargoArgs, runCargo } from "../../common";
+import CLIOptions from "./schema";
+
+export default async function (opts: CLIOptions, ctx: ExecutorContext) {
+	try {
+		let [args, env] = parseCargoArgs(Target.Run, opts, ctx);
+
+		await runCargo(args, ctx, env);
+
+		return { success: true };
+	} catch (err) {
+		return {
+			success: false,
+			reason: err?.message,
+		};
+	}
+}

package/src/executors/run/schema.d.ts

@@ -0,0 +1,32 @@
+import {
+	CompilationOptions,
+	DisplayOptions,
+	FeatureSelection,
+	OutputOptions,
+	ManifestOptions,
+	PackageSelection,
+	EnvironmentOptions,
+} from "../../common/schema";
+
+// prettier-ignore
+type Options =
+	& PackageSelection
+	& FeatureSelection
+	& CompilationOptions
+	& OutputOptions
+	& DisplayOptions
+	& ManifestOptions
+	& EnvironmentOptions
+	& { [key: string]: unknown }
+& {
+	/**
+	 * Copy final artifacts to this directory.
+	 *
+	 * This option is unstable and available only on the [nightly channel](https://doc.rust-lang.org/book/appendix-07-nightly-rust.html)
+	 * and requires the `-Z unstable-options` flag to enable. See https://github.com/rust-lang/cargo/issues/6790
+	 * for more information.
+	 */
+	outDir?: string;
+};
+
+export default Options;

package/src/executors/run/schema.json

@@ -0,0 +1,77 @@
+{
+	"version": 2,
+	"outputCapture": "direct-nodejs",
+	"$schema": "http://json-schema.org/schema",
+	"title": "Run executor",
+	"description": "",
+	"type": "object",
+	"properties": {
+		"package": {
+			"type": "string",
+			"description": "Specify the Cargo package, if different from the Nx project name."
+		},
+		"features": {
+			"type": "string",
+			"description": "Space or comma separated list of features to activate, or \"all\"."
+		},
+		"noDefaultFeatures": {
+			"type": "boolean",
+			"description": "Do not activate the `default` feature of the package."
+		},
+		"target": {
+			"type": "string",
+			"description": "Build for the given architecture. The default is the host architecture. The general format of the triple is `<arch><sub>-<vendor>-<sys>-<abi>`. Run `rustc --print target-list` for a list of supported targets.\n\nThis may also be specified with the `build.target` [config value](https://doc.rust-lang.org/cargo/reference/config.html).\n\nNote that specifying this flag makes Cargo run in a different mode where the target artifacts are placed in a separate directory. See the [build cache](https://doc.rust-lang.org/cargo/guide/build-cache.html) documentation for more details."
+		},
+		"release": {
+			"type": "boolean",
+			"description": "Build optimized artifacts with the `release` profile. See the [PROFILES](https://doc.rust-lang.org/cargo/commands/cargo-build.html#profiles) section for details on how this affects profile selection."
+		},
+		"targetDir": {
+			"type": "string",
+			"description": "Directory for all generated artifacts and intermediate files. May also be specified with the `CARGO_TARGET_DIR` environment variable, or the `build.target-dir` [config value](https://doc.rust-lang.org/cargo/reference/config.html). Defaults to `target` in the root of the workspace."
+		},
+		"outDir": {
+			"type": "string",
+			"description": "Copy final artifacts to this directory.\n\nThis option is unstable and available only on the [nightly channel](https://doc.rust-lang.org/book/appendix-07-nightly-rust.html). See https://github.com/rust-lang/cargo/issues/6790 for more information."
+		},
+		"verbose": {
+			"type": "boolean",
+			"description": "Use verbose output. May also be specified with the term.verbose [config value](https://doc.rust-lang.org/cargo/reference/config.html).",
+			"alias": "v"
+		},
+		"veryVerbose": {
+			"type": "boolean",
+			"description": "Include extra output such as dependency warnings and build script output."
+		},
+		"quiet": {
+			"type": "boolean",
+			"description": "No output printed to stdout.",
+			"alias": "q"
+		},
+		"messageFormat": {
+			"type": "string",
+			"description": "The output format for diagnostic messages. Can be specified multiple times and consists of comma-separated values. Valid values:\n  * `human` (default): Display in a human-readable text format. Conflicts with `short` and `json`.\n  * `short`: Emit shorter, human-readable text messages. Conflicts with `human` and `json`.\n  * `json`: Emit JSON messages to stdout. See [the reference](https://doc.rust-lang.org/cargo/reference/external-tools.html#json-messages) for more details. Conflicts with `human` and `short`.\n  * `json-diagnostic-short`: Ensure the `rendered` field of JSON messages contains the \"short\" rendering from rustc. Cannot be used with `human` or `short`.\n  * `json-diagnostic-rendered-ansi`: Ensure the `rendered` field of JSON messages contains embedded ANSI color codes for respecting rustc's default color scheme. Cannot be used with `human` or `short`.\n  * `json-render-diagnostics`: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself should render the JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with `human` or `short`."
+		},
+		"locked": {
+			"type": "boolean",
+			"description": "Requires that the `Cargo.lock` file is up-to-date. If the lock file is missing, or it needs to be updated, Cargo will exit with an error."
+		},
+		"frozen": {
+			"type": "boolean",
+			"description": "Like `locked`, but prevents Cargo from attempting to access the network to determine if `Cargo.lock` is out-of-date."
+		},
+		"offline": {
+			"type": "boolean",
+			"description": "Prevents Cargo from accessing the network for any reason. Without this flag, Cargo will stop with an error if it needs to access the network and the network is not available. With this flag, Cargo will attempt to proceed without the network if possible."
+		},
+		"toolchain": {
+			"type": "string",
+			"description": "See the [rustup documentation](https://rust-lang.github.io/rustup/overrides.html) for more information about how toolchain overrides work."
+		},
+		"env": {
+			"type": "object",
+			"description": "Specify environment variables to set while running the Cargo command."
+		}
+	},
+	"required": []
+}

package/src/executors/test/executor.ts

@@ -0,0 +1,19 @@
+import { ExecutorContext } from "@nx/devkit";
+
+import { parseCargoArgs, runCargo, Target } from "../../common";
+import CLIOptions from "./schema";
+
+export default async function (opts: CLIOptions, ctx: ExecutorContext) {
+	try {
+		let [args, env] = parseCargoArgs(Target.Test, opts, ctx);
+
+		await runCargo(args, ctx, env);
+
+		return { success: true };
+	} catch (err) {
+		return {
+			success: false,
+			reason: err?.message,
+		};
+	}
+}

package/src/executors/test/schema.d.ts

@@ -0,0 +1,22 @@
+import {
+	CompilationOptions,
+	DisplayOptions,
+	EnvironmentOptions,
+	FeatureSelection,
+	ManifestOptions,
+	OutputOptions,
+	PackageSelection,
+} from "../../common/schema";
+
+// prettier-ignore
+type Options =
+	& PackageSelection
+	& FeatureSelection
+	& CompilationOptions
+	& OutputOptions
+	& DisplayOptions
+	& ManifestOptions
+	& EnvironmentOptions
+	& { [key: string]: unknown };
+
+export default Options;

package/src/executors/test/schema.json

@@ -0,0 +1,73 @@
+{
+	"version": 2,
+	"outputCapture": "direct-nodejs",
+	"$schema": "http://json-schema.org/schema",
+	"title": "Test executor",
+	"description": "",
+	"type": "object",
+	"properties": {
+		"package": {
+			"type": "string",
+			"description": "Specify the Cargo package, if different from the Nx project name."
+		},
+		"features": {
+			"type": "string",
+			"description": "Space or comma separated list of features to activate, or \"all\"."
+		},
+		"noDefaultFeatures": {
+			"type": "boolean",
+			"description": "Do not activate the `default` feature of the package."
+		},
+		"target": {
+			"type": "string",
+			"description": "Build for the given architecture. The default is the host architecture. The general format of the triple is `<arch><sub>-<vendor>-<sys>-<abi>`. Run `rustc --print target-list` for a list of supported targets.\n\nThis may also be specified with the `build.target` [config value](https://doc.rust-lang.org/cargo/reference/config.html).\n\nNote that specifying this flag makes Cargo run in a different mode where the target artifacts are placed in a separate directory. See the [build cache](https://doc.rust-lang.org/cargo/guide/build-cache.html) documentation for more details."
+		},
+		"release": {
+			"type": "boolean",
+			"description": "Build optimized artifacts with the `release` profile. See the [PROFILES](https://doc.rust-lang.org/cargo/commands/cargo-build.html#profiles) section for details on how this affects profile selection."
+		},
+		"targetDir": {
+			"type": "string",
+			"description": "Directory for all generated artifacts and intermediate files. May also be specified with the `CARGO_TARGET_DIR` environment variable, or the `build.target-dir` [config value](https://doc.rust-lang.org/cargo/reference/config.html). Defaults to `target` in the root of the workspace."
+		},
+		"verbose": {
+			"type": "boolean",
+			"description": "Use verbose output. May also be specified with the term.verbose [config value](https://doc.rust-lang.org/cargo/reference/config.html).",
+			"alias": "v"
+		},
+		"veryVerbose": {
+			"type": "boolean",
+			"description": "Include extra output such as dependency warnings and build script output."
+		},
+		"quiet": {
+			"type": "boolean",
+			"description": "No output printed to stdout.",
+			"alias": "q"
+		},
+		"messageFormat": {
+			"type": "string",
+			"description": "The output format for diagnostic messages. Can be specified multiple times and consists of comma-separated values. Valid values:\n  * `human` (default): Display in a human-readable text format. Conflicts with `short` and `json`.\n  * `short`: Emit shorter, human-readable text messages. Conflicts with `human` and `json`.\n  * `json`: Emit JSON messages to stdout. See [the reference](https://doc.rust-lang.org/cargo/reference/external-tools.html#json-messages) for more details. Conflicts with `human` and `short`.\n  * `json-diagnostic-short`: Ensure the `rendered` field of JSON messages contains the \"short\" rendering from rustc. Cannot be used with `human` or `short`.\n  * `json-diagnostic-rendered-ansi`: Ensure the `rendered` field of JSON messages contains embedded ANSI color codes for respecting rustc's default color scheme. Cannot be used with `human` or `short`.\n  * `json-render-diagnostics`: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself should render the JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with `human` or `short`."
+		},
+		"locked": {
+			"type": "boolean",
+			"description": "Requires that the `Cargo.lock` file is up-to-date. If the lock file is missing, or it needs to be updated, Cargo will exit with an error."
+		},
+		"frozen": {
+			"type": "boolean",
+			"description": "Like `locked`, but prevents Cargo from attempting to access the network to determine if `Cargo.lock` is out-of-date."
+		},
+		"offline": {
+			"type": "boolean",
+			"description": "Prevents Cargo from accessing the network for any reason. Without this flag, Cargo will stop with an error if it needs to access the network and the network is not available. With this flag, Cargo will attempt to proceed without the network if possible."
+		},
+		"toolchain": {
+			"type": "string",
+			"description": "See the [rustup documentation](https://rust-lang.github.io/rustup/overrides.html) for more information about how toolchain overrides work."
+		},
+		"env": {
+			"type": "object",
+			"description": "Specify environment variables to set while running the Cargo command."
+		}
+	},
+	"required": []
+}

package/src/generators/binary/files/Cargo.toml__template__

@@ -0,0 +1,8 @@
+[package]
+name = "<%= projectName %>"
+version = "0.1.0"
+edition = "<%= edition %>"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]

package/src/generators/binary/files/src/main.rs__template__

@@ -0,0 +1,3 @@
+fn main() {
+    println!("Hello, world!");
+}

package/src/generators/binary/generator.spec.ts

@@ -0,0 +1,75 @@
+import { Tree } from "@nx/devkit";
+import { createTreeWithEmptyWorkspace } from "@nx/devkit/testing";
+import runGenerator from "./generator";
+
+describe("binary generator", () => {
+	let appTree: Tree;
+
+	beforeAll(async () => {
+		appTree = createTreeWithEmptyWorkspace({ layout: "apps-libs" });
+	});
+
+	describe("with kebab-case project name", () => {
+		beforeAll(async () => {
+			await runGenerator(appTree, { name: "my-app" });
+		});
+
+		it("should create the correct file structure", () => {
+			let changes = appTree.listChanges();
+			let cargoToml = changes.find(c => c.path === "apps/my-app/Cargo.toml");
+			let libRs = changes.find(c => c.path === "apps/my-app/src/main.rs");
+
+			expect(cargoToml).toBeTruthy();
+			expect(libRs).toBeTruthy();
+		});
+
+		it("should populate project files with the correct content", () => {
+			let changes = appTree.listChanges();
+			let cargoContent = changes
+				.find(c => c.path === "apps/my-app/Cargo.toml")!
+				.content!.toString();
+
+			expect(cargoContent).toContain(`name = "my-app"`);
+			expect(cargoContent).toContain(`edition = "2021"`);
+		});
+
+		it("should add project to workspace members", () => {
+			let changes = appTree.listChanges();
+			let members = changes.find(c => c.path === "Cargo.toml")!.content!.toString();
+
+			expect(members).toContain(`"apps/my-app"`);
+		});
+	});
+
+	describe("with snake_case project name", () => {
+		beforeAll(async () => {
+			await runGenerator(appTree, { name: "my_app" });
+		});
+
+		it("should create the correct file structure", () => {
+			let changes = appTree.listChanges();
+			let cargoToml = changes.find(c => c.path === "apps/my_app/Cargo.toml");
+			let libRs = changes.find(c => c.path === "apps/my_app/src/main.rs");
+
+			expect(cargoToml).toBeTruthy();
+			expect(libRs).toBeTruthy();
+		});
+
+		it("should populate project files with the correct content", () => {
+			let changes = appTree.listChanges();
+			let cargoContent = changes
+				.find(c => c.path === "apps/my_app/Cargo.toml")!
+				.content!.toString();
+
+			expect(cargoContent).toContain(`name = "my_app"`);
+			expect(cargoContent).toContain(`edition = "2021"`);
+		});
+
+		it("should add project to workspace members", () => {
+			let changes = appTree.listChanges();
+			let members = changes.find(c => c.path === "Cargo.toml")!.content!.toString();
+
+			expect(members).toContain(`"apps/my_app"`);
+		});
+	});
+});

package/src/generators/binary/generator.ts

@@ -0,0 +1,76 @@
+import { Tree, addProjectConfiguration, formatFiles, generateFiles } from "@nx/devkit";
+import * as path from "path";
+
+import {
+	GeneratorOptions,
+	normalizeGeneratorOptions,
+	updateWorkspaceMembers,
+} from "../../common";
+import cargoInit from "../init/generator";
+import CLIOptions from "./schema";
+
+// prettier-ignore
+type Options = CLIOptions & GeneratorOptions;
+
+export default async function (host: Tree, opts: CLIOptions) {
+	let options = normalizeGeneratorOptions("application", host, opts);
+
+	addProjectConfiguration(host, options.projectName, {
+		root: options.projectRoot,
+		projectType: "application",
+		sourceRoot: `${options.projectRoot}/src`,
+		targets: {
+			build: {
+				executor: "@nxrs/cargo:build",
+				options: {
+					profile: "dev",
+				},
+				configurations: {
+					production: {
+						profile: "release",
+					},
+				},
+			},
+			dev: {
+				executor: "@nxrs/cargo:run",
+				options: {},
+			},
+			test: {
+				executor: "@nxrs/cargo:test",
+				options: {},
+			},
+			lint: {
+				executor: "@nxrs/cargo:clippy",
+				options: {
+					fix: false,
+					failOnWarnings: true,
+					noDeps: true,
+				},
+			},
+		},
+		tags: options.parsedTags,
+	});
+
+	await addFiles(host, options);
+	updateWorkspaceMembers(host, options);
+	await formatFiles(host);
+}
+
+async function addFiles(host: Tree, opts: Options) {
+	if (!host.exists("Cargo.toml")) {
+		await cargoInit(host, {});
+	}
+
+	let substitutions = {
+		projectName: opts.projectName,
+		edition: opts.edition,
+		template: "",
+	};
+
+	generateFiles(
+		host,
+		path.join(__dirname, "files"),
+		opts.projectRoot,
+		substitutions
+	);
+}

package/src/generators/binary/schema.d.ts

@@ -0,0 +1,6 @@
+export default interface Options {
+	name: string;
+	edition?: number;
+	directory?: string;
+	tags?: string;
+}

package/src/generators/binary/schema.json

@@ -0,0 +1,35 @@
+{
+	"$schema": "http://json-schema.org/schema",
+	"id": "Binary",
+	"title": "",
+	"type": "object",
+	"properties": {
+		"name": {
+			"type": "string",
+			"description": "",
+			"$default": {
+				"$source": "argv",
+				"index": 0
+			},
+			"x-prompt": "What name would you like to use?"
+		},
+		"edition": {
+			"type": "number",
+			"description": "What Rust edition to use",
+			"default": 2021
+		},
+		"tags": {
+			"type": "string",
+			"description": "Add tags to the project (used for linting)",
+			"alias": "t"
+		},
+		"directory": {
+			"type": "string",
+			"description": "A directory where the project is placed",
+			"alias": "d"
+		}
+	},
+	"required": [
+		"name"
+	]
+}

package/src/generators/init/files/Cargo.toml

@@ -0,0 +1,2 @@
+[workspace]
+members = []

package/src/generators/init/files/rust-toolchain.toml__template__

@@ -0,0 +1,2 @@
+[toolchain]
+channel = "<%= toolchain %>"

package/src/generators/init/generator.spec.ts

@@ -0,0 +1,49 @@
+import { createTreeWithEmptyWorkspace } from "@nx/devkit/testing";
+import { Tree } from "@nx/devkit";
+
+import runGenerator from "./generator";
+
+describe("init generator", () => {
+	let appTree: Tree;
+
+	beforeEach(() => {
+		appTree = createTreeWithEmptyWorkspace();
+	});
+
+	it("should run successfully", async () => {
+		await runGenerator(appTree, {});
+		let changes = appTree.listChanges();
+
+		let cargoToml = changes.find(c => c.path === "Cargo.toml");
+		let toolchainToml = changes.find(c => c.path === "rust-toolchain.toml");
+		let rustfmtToml = changes.find(c => c.path === "rustfmt.toml");
+
+		expect(cargoToml).toBeTruthy();
+		expect(toolchainToml).toBeTruthy();
+		expect(rustfmtToml).toBeTruthy();
+
+		let content = toolchainToml?.content!.toString();
+		expect(content).toContain(`channel = "stable"`);
+	});
+
+	it("should respect the 'toolchain' CLI option", async () => {
+		await runGenerator(appTree, { toolchain: "nightly" });
+		let toolchainToml = appTree
+			.listChanges()
+			.find(c => c.path === "rust-toolchain.toml")!
+			.content!.toString();
+
+		expect(toolchainToml).toContain(`channel = "nightly"`);
+	});
+
+	it("should add the graph plugin to nx.json plugins", async () => {
+		await runGenerator(appTree, {});
+		let changes = appTree.listChanges();
+
+		let nxJson = changes.find(c => c.path === "nx.json");
+		expect(nxJson).toBeTruthy();
+
+		let json = JSON.parse(nxJson!.content!.toString());
+		expect(json.plugins).toContain("@nxrs/cargo");
+	});
+});

package/src/generators/init/generator.ts

@@ -0,0 +1,55 @@
+import {
+	Tree,
+	formatFiles,
+	generateFiles,
+	readNxJson,
+	updateNxJson,
+} from "@nx/devkit";
+import * as path from "path";
+
+import CLIOptions from "./schema";
+
+// TODO: Add `buildable` option to `library` generator
+// TODO: Add `format` executor via rustfmt
+// TODO: Add `benchmark` generator/executor via Criterion
+
+interface Options extends CLIOptions {
+	toolchain: string;
+}
+
+export default async function (host: Tree, opts: CLIOptions) {
+	let options = normalizeOptions(host, opts);
+	addFiles(host, options);
+	addPlugin(host, options);
+
+	await formatFiles(host);
+}
+
+function normalizeOptions(_: Tree, options: CLIOptions): Options {
+	let toolchain = options.toolchain ?? "stable";
+
+	return { toolchain };
+}
+
+function addFiles(host: Tree, options: Options) {
+	let templateOptions = {
+		toolchain: options.toolchain,
+		template: "",
+	};
+
+	generateFiles(host, path.join(__dirname, "files"), ".", templateOptions);
+
+	let gitignore = host.read(".gitignore")?.toString() ?? "";
+	gitignore += "/target";
+
+	host.write(".gitignore", gitignore);
+}
+
+function addPlugin(host: Tree, _: Options) {
+	let config = readNxJson(host) ?? {};
+	let plugins = config.plugins
+		? config.plugins.concat("@nxrs/cargo")
+		: ["@nxrs/cargo"];
+
+	updateNxJson(host, { ...config, plugins });
+}

package/src/generators/init/schema.d.ts

@@ -0,0 +1,7 @@
+export default interface Options {
+	/**
+	 * The rustup toolchain channel for projects in this workspace
+	 * @default "stable"
+	 */
+	toolchain?: string;
+}

package/src/generators/init/schema.json

@@ -0,0 +1,14 @@
+{
+	"$schema": "http://json-schema.org/schema",
+	"id": "Cargo",
+	"title": "",
+	"type": "object",
+	"properties": {
+		"toolchain": {
+			"type": "string",
+			"description": "The rustup toolchain channel for projects in this workspace",
+			"$default": "stable"
+		}
+	},
+	"required": []
+}

package/src/generators/library/files/Cargo.toml__template__

@@ -0,0 +1,8 @@
+[package]
+name = "<%= projectName %>"
+version = "0.1.0"
+edition = "<%= edition %>"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]

package/src/generators/library/files/src/lib.rs__template__

@@ -0,0 +1,13 @@
+pub fn <%= moduleName %>() -> String {
+    "<%= projectName %>".into()
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn it_works() {
+        assert_eq!(<%= moduleName %>(), "<%= projectName %>".to_string());
+    }
+}