@joshmossas/nx-cargo 0.6.2

package/src/common/index.ts

@@ -0,0 +1,358 @@
+import {
+	ExecutorContext,
+	Tree,
+	getWorkspaceLayout,
+	names as nxNames,
+} from "@nx/devkit";
+import * as chalk from "chalk";
+import * as cp from "child_process";
+import { kebabCase } from "lodash";
+
+import {
+	CompilationOptions,
+	DisplayOptions,
+	EnvironmentOptions,
+	FeatureSelection,
+	ManifestOptions,
+	OutputOptions,
+} from "./schema";
+
+import ClippyCliOptions from "../executors/clippy/schema";
+
+export interface GeneratorOptions {
+	projectName: string;
+	moduleName: string;
+	projectRoot: string;
+	projectDirectory: string;
+	parsedTags: string[];
+	edition: number;
+}
+
+// prettier-ignore
+export type CargoOptions = Partial<
+	& FeatureSelection
+	& CompilationOptions
+	& OutputOptions
+	& DisplayOptions
+	& ManifestOptions
+	& EnvironmentOptions
+	& { [key: string]: unknown }
+>;
+
+interface GeneratorCLIOptions {
+	name: string;
+	directory?: string;
+	tags?: string;
+	edition?: number;
+}
+
+interface Names {
+	name: string;
+	className: string;
+	propertyName: string;
+	constantName: string;
+	fileName: string;
+	snakeName: string;
+}
+
+export enum Target {
+	Build,
+	Run,
+	Test,
+	Clippy,
+}
+
+export function cargoNames(name: string): Names {
+	let result = nxNames(name) as Names;
+	result.snakeName = result.constantName.toLowerCase();
+
+	return result;
+}
+
+export function normalizeGeneratorOptions<T extends GeneratorCLIOptions>(
+	projectType: "application" | "library",
+	host: Tree,
+	opts: T
+): T & GeneratorOptions {
+	let layout = getWorkspaceLayout(host);
+	let names = cargoNames(opts.name);
+	let moduleName = names.snakeName;
+
+	// Only convert project/file name casing if it's invalid
+	let projectName = /^[-_a-zA-Z0-9]+$/.test(opts.name)
+		? opts.name
+		: names.snakeName;
+
+	let fileName = /^[-_a-zA-Z0-9]+$/.test(opts.name)
+		? opts.name
+		: names.fileName;
+
+	let rootDir = {
+		application: layout.appsDir,
+		library: layout.libsDir,
+	}[projectType];
+
+	let projectDirectory = opts.directory
+		? `${nxNames(opts.directory).fileName}/${fileName}`
+		: fileName;
+
+	let projectRoot = `${rootDir}/${projectDirectory}`;
+	let parsedTags = opts.tags?.split(",").map(s => s.trim()) ?? [];
+	let edition = opts.edition ?? 2021;
+
+	return {
+		...opts,
+		projectName,
+		moduleName,
+		projectRoot,
+		projectDirectory,
+		parsedTags,
+		edition,
+	};
+}
+
+export function updateWorkspaceMembers(host: Tree, opts: GeneratorOptions) {
+	let updated = host
+		.read("Cargo.toml")!
+		.toString()
+		.split("\n")
+		.reduce((accum, line) => {
+			let trimmed = line.trim();
+			let match: RegExpMatchArray | null;
+
+			if ((match = trimmed.match(/^members\s*=\s*\[(.*)\]$/))) {
+				let members = match[1]
+					.split(",")
+					.map(m => m.trim())
+					.filter(Boolean);
+
+				members.push(`"${opts.projectRoot}"`);
+				accum.push(`members = [`, ...members.map(m => "    " + m), `]`);
+			} else if ((match = trimmed.match(/^members\s*=\s*\[$/))) {
+				accum.push(line, `    "${opts.projectRoot}",`);
+			} else {
+				accum.push(line);
+			}
+
+			return accum;
+		}, [] as string[])
+		.join("\n");
+
+	host.write("Cargo.toml", updated);
+}
+
+/**
+ * @returns a tuple of `[args, env?]`
+ */
+export function parseCargoArgs<T extends CargoOptions>(
+	target: Target,
+	options: T,
+	ctx: ExecutorContext,
+): [string[], Record<string, string|undefined>?] {
+	let opts = { ...options };
+	let args = [] as string[];
+
+	let env = extractEnv(opts);
+
+	if (opts.toolchain)
+		processArg(args, opts, "toolchain", `+${opts.toolchain}`);
+
+	// prettier-ignore
+	switch (target) {
+		case Target.Build: args.push("build"); break;
+		case Target.Test:  args.push("test");  break;
+		case Target.Run: args.push("run"); break;
+		case Target.Clippy: args.push("clippy"); break;
+	}
+
+	if (!ctx.projectName) {
+		throw new Error("Expected project name to be non-null");
+	}
+
+	let passThroughArgs = target === Target.Clippy
+		? parseClippyArgs(opts)
+		: null;
+
+	let packageName = (opts["package"] as undefined | string) ?? ctx.projectName;
+	if ("package" in opts)
+		delete opts["package"];
+
+	let projects = ctx.projectsConfigurations?.projects ?? ctx.workspace?.projects;
+	if (!projects) {
+		throw new Error("Failed to find projects map from executor context");
+	}
+
+	if (opts.bin) {
+		processArg(
+			args, opts, "bin",
+			"-p", packageName,
+			"--bin", opts.bin,
+		);
+	} else if (
+		target === Target.Build
+		&& projects[ctx.projectName].projectType === "application"
+	) {
+		args.push("--bin", packageName);
+	} else {
+		args.push("-p", packageName);
+	}
+
+	if (opts.features) {
+		let argsToAdd = opts.features === "all"
+			? ["--all-features"]
+			: ["--features", opts.features];
+
+		processArg(args, opts, "features", ...argsToAdd);
+	}
+
+	if (opts.noDefaultFeatures)
+		processArg(args, opts, "noDefaultFeatures", "--no-default-features");
+
+	if (opts.target)
+		processArg(args, opts, "target", "--target", opts.target);
+
+	if (opts.release != null) {
+		if (opts.release) {
+			args.push("--profile", "release");
+
+			if (opts["profile"]) {
+				let label = chalk.bold.yellowBright.inverse(" WARNING ");
+				console.log(
+					`${label} Conflicting options found: "release" and "profile" `
+						+ `-- "profile" will be overridden`
+				);
+				delete opts["profile"];
+			}
+		}
+		delete opts.release;
+	}
+
+	if (opts.targetDir)
+		processArg(args, opts, "targetDir", "--target-dir", opts.targetDir);
+
+	if ("outDir" in opts && !!(opts as any)["outDir"]) {
+		if (args[0] !== "+nightly") {
+			if (args[0].startsWith("+")) {
+				let label = chalk.bold.yellowBright.inverse(" WARNING ");
+				let original = args[0].replace(/^\+/, "");
+				let message =
+					`'outDir' option can only be used with 'nightly' toolchain, ` +
+					`but toolchain '${original}' was already specified. ` +
+					`Overriding '${original}' => 'nightly'.`;
+
+				console.log(`${label} ${message}`);
+
+				args[0] = "+nightly";
+			} else {
+				args.unshift("+nightly");
+			}
+		}
+		args.push("-Z", "unstable-options", "--out-dir", (opts as any)["outDir"]);
+		delete (opts as any)["outDir"];
+	}
+
+	if (opts.verbose)
+		processArg(args, opts, "verbose", "-v");
+
+	if (opts.veryVerbose)
+		processArg(args, opts, "veryVerbose", "-vv");
+
+	if (opts.quiet)
+		processArg(args, opts, "quiet", "-q");
+
+	if (opts.messageFormat)
+		processArg(args, opts, "messageFormat", "--message-format", opts.messageFormat);
+
+	if (opts.locked)
+		processArg(args, opts, "locked", "--locked");
+
+	if (opts.frozen)
+		processArg(args, opts, "frozen", "--frozen");
+
+	if (opts.offline)
+		processArg(args, opts, "offline", "--offline");
+
+	// For the sake of future-proofing in the absence of updates to this plugin,
+	// pass any remaining options straight through to `cargo`
+	for (let [key, value] of Object.entries(opts)) {
+		if (value !== false) {
+			args.push(`--${kebabCase(key)}`);
+
+			if (value !== true)
+				args.push(String(value));
+		}
+	}
+
+	if (passThroughArgs) {
+		args.push("--", ...passThroughArgs);
+	}
+
+	return [args, env];
+}
+
+function parseClippyArgs(opts: ClippyCliOptions): string[] {
+	let args = [];
+
+	if (opts.failOnWarnings || opts.failOnWarnings == null) {
+		delete opts.failOnWarnings;
+		args.push("-D", "warnings");
+	}
+	if (opts.noDeps || opts.noDeps == null) {
+		delete opts.noDeps;
+		args.push("--no-deps");
+	}
+	if (opts.fix) {
+		delete opts.fix;
+		args.push("--fix");
+	}
+
+	return args;
+}
+
+function extractEnv(opts: CargoOptions): Record<string, string|undefined> | undefined {
+	if ("env" in opts && opts.env != null) {
+		let env = {
+			...process.env,
+			...opts.env,
+		};
+
+		delete opts.env;
+
+		return env;
+	}
+}
+
+function processArg(
+	args: string[],
+	opts: CargoOptions,
+	key: keyof CargoOptions,
+	...argsToAdd: string[]
+) {
+	args.push(...argsToAdd);
+	delete opts[key];
+}
+
+export function runCargo(
+	args: string[],
+	ctx: ExecutorContext,
+	env?: Record<string, string|undefined>,
+) {
+	console.log(chalk.dim`> cargo ${
+		args.map(arg => / /.test(arg) ? `"${arg}"` : arg)
+			.join(" ")
+	}`);
+
+	return new Promise<void>((resolve, reject) => {
+		cp.spawn("cargo", args, {
+			cwd: ctx.root,
+			shell: true,
+			stdio: "inherit",
+			env,
+		})
+			.on("error", reject)
+			.on("close", code => {
+				if (code) reject(new Error(`Cargo failed with exit code ${code}`));
+				else resolve();
+			});
+	});
+}

package/src/common/schema.d.ts

@@ -0,0 +1,111 @@
+export interface PackageSelection {
+	/** Specify the Cargo package, if different from the Nx project name. */
+	package?: string;
+}
+
+export interface FeatureSelection {
+	/** Space or comma separated list of features to activate, or "all". */
+	features?: string;
+	/** Do not activate the `default` feature of the package. */
+	noDefaultFeatures?: boolean;
+}
+
+export interface CompilationOptions {
+	/**
+	 * 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.
+	 *
+	 * This may also be specified with the `build.target` [config value](https://doc.rust-lang.org/cargo/reference/config.html).
+	 *
+	 * Note 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.
+	 */
+	target?: string;
+	/**
+	 * Specify a custom `[[bin]]` binary target. Uses the project name if this is
+	 * not specified and the Nx `projectType` is "application".
+	 */
+	bin?: string;
+	/**
+	 * 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.
+	 */
+	release?: boolean;
+	/**
+	 * See the [rustup documentation](https://rust-lang.github.io/rustup/overrides.html)
+	 * for more information about how toolchain overrides work.
+	 */
+	toolchain?: string;
+}
+
+export interface OutputOptions {
+	/**
+	 * 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.
+	 */
+	targetDir?: string;
+}
+
+export interface DisplayOptions {
+	/**
+	 * Use verbose output. May also be specified with the term.verbose [config
+	 * value](https://doc.rust-lang.org/cargo/reference/config.html).
+	 */
+	verbose?: boolean;
+	/** Include extra output such as dependency warnings and build script output. */
+	veryVerbose?: boolean;
+	/** No output printed to stdout. */
+	quiet?: boolean;
+	/**
+	 * The output format for diagnostic messages. Can be specified multiple times and
+	 * consists of comma-separated values. Valid values:
+	 *
+	 *   * `human` (default): Display in a human-readable text format. Conflicts with
+	 *     `short` and `json`.
+	 *   * `short`: Emit shorter, human-readable text messages. Conflicts with `human` and
+	 *     `json`.
+	 *   * `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`.
+	 *   * `json-diagnostic-short`: Ensure the `rendered` field of JSON messages contains
+	 *     the "short" rendering from rustc. Cannot be used with `human` or `short`.
+	 *   * `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`.
+	 *   * `json-render-diagnostics`: Instruct Cargo to not include rustc diagnostics in 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`.
+	 */
+	messageFormat?: string;
+}
+
+export interface ManifestOptions {
+	/**
+	 * 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.
+	 */
+	locked?: boolean;
+	/**
+	 * Like `locked`, but prevents Cargo from attempting to access the network to determine
+	 * if `Cargo.lock` is out-of-date.
+	 */
+	frozen?: boolean;
+	/**
+	 * 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.
+	 */
+	offline?: boolean;
+}
+
+export interface EnvironmentOptions {
+	/**
+	 * Specify environment variables to set while running the Cargo command.
+	 */
+	env?: Record<string, string>;
+}

package/src/executors/build/executor.ts

@@ -0,0 +1,21 @@
+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] = opts.run
+			? parseCargoArgs(Target.Run, opts, ctx)
+			: parseCargoArgs(Target.Build, opts, ctx);
+
+		await runCargo(args, ctx, env);
+
+		return { success: true };
+	} catch (err) {
+		return {
+			success: false,
+			reason: err?.message,
+		};
+	}
+}

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

@@ -0,0 +1,39 @@
+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;
+	/**
+	 * Run `cargo run ...` instead of `cargo build ...`.
+	 *
+	 * @deprecated
+	 * Remove this property and use the `@nxrs/cargo:run` executor instead of `@nxrs/cargo:build`.
+	 */
+	run?: boolean;
+};
+
+export default Options;

package/src/executors/build/schema.json

@@ -0,0 +1,77 @@
+{
+	"version": 2,
+	"outputCapture": "direct-nodejs",
+	"$schema": "http://json-schema.org/schema",
+	"title": "Build 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/clippy/executor.ts

@@ -0,0 +1,18 @@
+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.Clippy, opts, ctx);
+
+		await runCargo(args, ctx, env);
+
+		return { success: true };
+	} catch (err) {
+		return {
+			success: false,
+			reason: err?.message,
+		};
+	}
+}

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

@@ -0,0 +1,34 @@
+import {
+	CompilationOptions,
+	DisplayOptions,
+	EnvironmentOptions,
+	FeatureSelection,
+	ManifestOptions,
+	PackageSelection,
+} from "../../common/schema";
+
+type Options =
+	& PackageSelection
+	& FeatureSelection
+	& CompilationOptions
+	& DisplayOptions
+	& ManifestOptions
+	& EnvironmentOptions
+	& { [key: string]: unknown }
+& {
+	/** Automatically fix code where possible. */
+	fix?: boolean;
+	/**
+	 * Return with a non-zero exit code when lint warnings are encountered.
+	 * @default true
+	 */
+	failOnWarnings?: boolean;
+	/**
+	 * By default, Clippy will run on the selected project **and** any dependencies that
+	 * are members of the workspace. To run Clippy **only** on this project, use this flag.
+	 * @default true
+	 */
+	noDeps?: boolean;
+};
+
+export default Options;

package/src/executors/clippy/schema.json

@@ -0,0 +1,29 @@
+{
+	"version": 2,
+	"outputCapture": "direct-nodejs",
+	"$schema": "http://json-schema.org/schema",
+	"title": "Clippy executor",
+	"description": "",
+	"type": "object",
+	"properties": {
+		"fix": {
+			"type": "boolean",
+			"description": "Automatically fix code where possible."
+		},
+		"failOnWarnings": {
+			"type": "boolean",
+			"description": "Return with a non-zero exit code when lint warnings are encountered.",
+			"default": true
+		},
+		"noDeps": {
+			"type": "boolean",
+			"description": "By default, Clippy will run on the selected project **and** any dependencies that are members of the workspace. To run Clippy **only** on this project, use this flag.",
+			"default": true
+		},
+		"env": {
+			"type": "object",
+			"description": "Specify environment variables to set while running the Cargo command."
+		}
+	},
+	"required": []
+}