dependency-cruiser 17.3.2 → 17.3.3-beta-2

package/bin/depcruise-baseline.mjs

@@ -6,8 +6,8 @@ import cli from "#cli/index.mjs";
 import meta from "#meta.cjs";
 
 function showHelp() {
-  process.stdout
-    .write(`Usage: depcruise-baseline [options] <files-or-directories...>
+	process.stdout
+		.write(`Usage: depcruise-baseline [options] <files-or-directories...>
 
 Writes all known violations of rules in a .dependency-cruiser.js to a file.
 Alias for depcruise -c -T baseline -f .dependency-cruiser-known-violations.json [files-or-directories]
@@ -22,48 +22,48 @@ Options:
 }
 
 try {
-  assertNodeEnvironmentSuitable();
+	assertNodeEnvironmentSuitable();
 
-  const { values: options, positionals } = parseArgs({
-    options: {
-      config: {
-        type: "string",
-        short: "c",
-        default: "",
-      },
-      "output-to": {
-        type: "string",
-        short: "f",
-        default: ".dependency-cruiser-known-violations.json",
-      },
-      version: {
-        type: "boolean",
-        short: "V",
-      },
-      help: {
-        type: "boolean",
-        short: "h",
-      },
-    },
-    allowPositionals: true,
-  });
+	const { values: options, positionals } = parseArgs({
+		options: {
+			config: {
+				type: "string",
+				short: "c",
+				default: "",
+			},
+			"output-to": {
+				type: "string",
+				short: "f",
+				default: ".dependency-cruiser-known-violations.json",
+			},
+			version: {
+				type: "boolean",
+				short: "V",
+			},
+			help: {
+				type: "boolean",
+				short: "h",
+			},
+		},
+		allowPositionals: true,
+	});
 
-  if (options.version) {
-    process.stdout.write(`${meta.version}\n`);
-  } else if (options.help || positionals.length === 0) {
-    showHelp();
-  } else {
-    if (options.config === "") {
-      options.config = true;
-    }
-    process.exitCode = await cli(positionals, {
-      config: options.config,
-      outputTo: options["output-to"],
-      cache: false,
-      outputType: "baseline",
-    });
-  }
+	if (options.version) {
+		process.stdout.write(`${meta.version}\n`);
+	} else if (options.help || positionals.length === 0) {
+		showHelp();
+	} else {
+		if (options.config === "") {
+			options.config = true;
+		}
+		process.exitCode = await cli(positionals, {
+			config: options.config,
+			outputTo: options["output-to"],
+			cache: false,
+			outputType: "baseline",
+		});
+	}
 } catch (pError) {
-  process.stderr.write(pError.message);
-  process.exitCode = 1;
+	process.stderr.write(pError.message);
+	process.exitCode = 1;
 }

package/bin/depcruise-fmt.mjs

@@ -6,7 +6,7 @@ import format from "#cli/format.mjs";
 import meta from "#meta.cjs";
 
 function showHelp() {
-  process.stdout.write(`Usage: depcruise-fmt [options] <dependency-cruiser-json>
+	process.stdout.write(`Usage: depcruise-fmt [options] <dependency-cruiser-json>
 
 Format dependency-cruiser output json.
 Details: https://github.com/sverweij/dependency-cruiser
@@ -36,95 +36,95 @@ Options:
 }
 
 try {
-  assertNodeEnvironmentSuitable();
+	assertNodeEnvironmentSuitable();
 
-  const { values: options, positionals } = parseArgs({
-    options: {
-      "output-to": {
-        type: "string",
-        short: "f",
-        default: "-",
-      },
-      "output-type": {
-        type: "string",
-        short: "T",
-        default: "err",
-      },
-      "include-only": {
-        type: "string",
-        short: "I",
-      },
-      focus: {
-        type: "string",
-        short: "F",
-      },
-      "focus-depth": {
-        type: "string",
-        default: "1",
-      },
-      reaches: {
-        type: "string",
-        short: "R",
-      },
-      highlight: {
-        type: "string",
-        short: "H",
-      },
-      exclude: {
-        type: "string",
-        short: "x",
-      },
-      collapse: {
-        type: "string",
-        short: "S",
-      },
-      prefix: {
-        type: "string",
-        short: "P",
-      },
-      suffix: {
-        type: "string",
-      },
-      "exit-code": {
-        type: "boolean",
-        short: "e",
-      },
-      version: {
-        type: "boolean",
-        short: "V",
-      },
-      help: {
-        type: "boolean",
-        short: "h",
-      },
-    },
-    allowPositionals: true,
-  });
+	const { values: options, positionals } = parseArgs({
+		options: {
+			"output-to": {
+				type: "string",
+				short: "f",
+				default: "-",
+			},
+			"output-type": {
+				type: "string",
+				short: "T",
+				default: "err",
+			},
+			"include-only": {
+				type: "string",
+				short: "I",
+			},
+			focus: {
+				type: "string",
+				short: "F",
+			},
+			"focus-depth": {
+				type: "string",
+				default: "1",
+			},
+			reaches: {
+				type: "string",
+				short: "R",
+			},
+			highlight: {
+				type: "string",
+				short: "H",
+			},
+			exclude: {
+				type: "string",
+				short: "x",
+			},
+			collapse: {
+				type: "string",
+				short: "S",
+			},
+			prefix: {
+				type: "string",
+				short: "P",
+			},
+			suffix: {
+				type: "string",
+			},
+			"exit-code": {
+				type: "boolean",
+				short: "e",
+			},
+			version: {
+				type: "boolean",
+				short: "V",
+			},
+			help: {
+				type: "boolean",
+				short: "h",
+			},
+		},
+		allowPositionals: true,
+	});
 
-  if (options.version) {
-    process.stdout.write(`${meta.version}\n`);
-  } else if (options.help || positionals.length === 0) {
-    showHelp();
-  } else {
-    const lFormatOptions = {
-      ...options,
-      outputTo: options["output-to"],
-      outputType: options["output-type"],
-      includeOnly: options["include-only"],
-      focusDepth: options["focus-depth"],
-      exitCode: options["exit-code"],
-    };
-    delete lFormatOptions["output-to"];
-    delete lFormatOptions["output-type"];
-    delete lFormatOptions["include-only"];
-    delete lFormatOptions["focus-depth"];
-    delete lFormatOptions["exit-code"];
-    const lExitCode = await format(positionals[0], lFormatOptions);
-    if (lFormatOptions.exitCode) {
-      process.exitCode = lExitCode;
-    }
-  }
+	if (options.version) {
+		process.stdout.write(`${meta.version}\n`);
+	} else if (options.help || positionals.length === 0) {
+		showHelp();
+	} else {
+		const lFormatOptions = {
+			...options,
+			outputTo: options["output-to"],
+			outputType: options["output-type"],
+			includeOnly: options["include-only"],
+			focusDepth: options["focus-depth"],
+			exitCode: options["exit-code"],
+		};
+		delete lFormatOptions["output-to"];
+		delete lFormatOptions["output-type"];
+		delete lFormatOptions["include-only"];
+		delete lFormatOptions["focus-depth"];
+		delete lFormatOptions["exit-code"];
+		const lExitCode = await format(positionals[0], lFormatOptions);
+		if (lFormatOptions.exitCode) {
+			process.exitCode = lExitCode;
+		}
+	}
 } catch (pError) {
-  process.stderr.write(pError.message);
-  process.exitCode = 1;
+	process.stderr.write(pError.message);
+	process.exitCode = 1;
 }

package/bin/dependency-cruise.mjs

@@ -6,178 +6,178 @@ import cli from "#cli/index.mjs";
 import meta from "#meta.cjs";
 
 try {
-  assertNodeEnvironmentSuitable();
+	assertNodeEnvironmentSuitable();
 
-  program
-    .description(
-      `Validate and visualize dependencies.${EOL}Details: https://github.com/sverweij/dependency-cruiser`,
-    )
-    .option(
-      "--init [oneshot]",
-      `set up dependency-cruiser for use in your environment (<<< recommended!)${EOL}${EOL}`,
-    )
-    .option(
-      "-c, --config [file]",
-      "read rules and options from [file] (e.g. .dependency-cruiser.js)",
-      true,
-    )
-    .addOption(
-      new Option(
-        "--no-config",
-        "do not use a configuration file. " +
-          "Overrides any --config option set earlier",
-      ).hideHelp(true),
-    )
-    .option(
-      "-T, --output-type <type>",
-      "output type; e.g. err, err-html, dot, ddot, archi, flat, d2, mermaid, text or json",
-      "err",
-    )
-    .option("-m, --metrics", "calculate stability metrics", false)
-    .addOption(new Option("--no-metrics").hideHelp(true))
-    .option(
-      "-f, --output-to <file>",
-      "file to write output to; - for stdout",
-      "-",
-    )
-    .option(
-      "-I, --include-only <regex>",
-      "only include modules matching the regex",
-    )
-    .option(
-      "-F, --focus <regex>",
-      "only include modules matching the regex + their direct neighbours",
-    )
-    .option(
-      "--focus-depth <number>",
-      "the depth to focus on - only applied when --focus is passed too. " +
-        "1= direct neighbors, 2=neighbours of neighbours etc.",
-      1,
-    )
-    .option(
-      "-R, --reaches <regex>",
-      "only include modules matching the regex + all modules that can reach them",
-    )
-    .option(
-      "-A, --affected [revision]",
-      "only include modules changed since the revision + all modules that can reach them (when not specified revision defaults to 'main')",
-    )
-    .option(
-      "-H, --highlight <regex>",
-      "mark modules matching the regex as 'highlighted'",
-    )
-    .option("-x, --exclude <regex>", "exclude all modules matching the regex")
-    .option(
-      "-X, --do-not-follow <regex>",
-      "include modules matching the regex, but don't follow their dependencies",
-    )
-    .option(
-      "--ignore-known [file]",
-      "ignore known violations as saved in [file] (default: .dependency-cruiser-known-violations.json)",
-    )
-    .addOption(new Option("--no-ignore-known").hideHelp(true))
-    .addOption(
-      new Option(
-        "--ts-config [file]",
-        "use a TypeScript configuration (e.g. tsconfig.json) or it's JavaScript counterpart (e.g. jsconfig.json)",
-      ).hideHelp(true),
-    )
-    .addOption(
-      new Option(
-        "--webpack-config [file]",
-        "use a webpack configuration (e.g. webpack.config.js)",
-      ).hideHelp(true),
-    )
-    .addOption(
-      new Option(
-        "--ts-pre-compilation-deps",
-        "detect dependencies that only exist before typescript-to-javascript " +
-          "compilation (off by default)",
-      ).hideHelp(true),
-    )
-    .option(
-      "-S, --collapse <regex>",
-      "collapse a to a folder depth by passing a single digit (e.g. 2). When passed a " +
-        'regex collapses to that pattern. E.g. "^packages/[^/]+/" would collapse to ' +
-        "modules/ folders directly under your packages folder. ",
-    )
-    .addOption(
-      new Option(
-        "-p, --progress [type]",
-        "show progress while dependency-cruiser is busy",
-      ).choices(["cli-feedback", "performance-log", "ndjson", "none"]),
-    )
-    .addOption(
-      new Option("--no-progress", "Alias of --progress none").hideHelp(true),
-    )
-    .addOption(
-      new Option(
-        "-d, --max-depth <n>",
-        "you probably want to use --collapse instead of --max-depth. " +
-          "(max-depth would limit the cruise depth; 0 <= n <= 99 (default: 0 - no limit)).",
-      ).hideHelp(true),
-    )
-    .addOption(
-      new Option(
-        "-M, --module-systems <items>",
-        "list of module systems (default: amd, cjs, es6, tsd)",
-      ).hideHelp(true),
-    )
-    .option(
-      "-P, --prefix <prefix>",
-      `prefix to use for links in the dot and err-html reporters${EOL}${EOL}`,
-    )
-    .option(
-      "--suffix <suffix>",
-      `suffix to use for links in the dot and err-html reporters${EOL}${EOL}`,
-    )
-    .option(
-      "-C, --cache [cache-directory]",
-      "use a cache to speed up execution. " +
-        "The directory defaults to node_modules/.cache/dependency-cruiser",
-    )
-    .addOption(
-      new Option(
-        "--cache-strategy <strategy>",
-        "strategy to use for detecting changed files in the cache.",
-      ).choices(["metadata", "content"]),
-    )
-    .addOption(
-      new Option(
-        "--no-cache",
-        "switch off caching. Overrides the 'cache' key in .dependency-cruiser.js " +
-          "and --cache options set earlier on the command line",
-      ).hideHelp(true),
-    )
-    .addOption(
-      new Option(
-        "--preserve-symlinks",
-        "leave symlinks unchanged (off by default)",
-      ).hideHelp(true),
-    )
-    .addOption(
-      new Option("-v, --validate [file]", `alias for --config`).hideHelp(true),
-    )
-    .option(
-      "-i, --info",
-      "shows what languages and extensions dependency-cruiser supports",
-    )
-    .addHelpText(
-      "after",
-      `${EOL}Other options:` +
-        `${EOL}  see https://github.com/sverweij/dependency-cruiser/blob/main/doc/cli.md${EOL}`,
-    )
-    .version(meta.version)
-    .argument("[files-or-directories...]")
-    .allowExcessArguments()
-    .parse(process.argv);
+	program
+		.description(
+			`Validate and visualize dependencies.${EOL}Details: https://github.com/sverweij/dependency-cruiser`,
+		)
+		.option(
+			"--init [oneshot]",
+			`set up dependency-cruiser for use in your environment (<<< recommended!)${EOL}${EOL}`,
+		)
+		.option(
+			"-c, --config [file]",
+			"read rules and options from [file] (e.g. .dependency-cruiser.js)",
+			true,
+		)
+		.addOption(
+			new Option(
+				"--no-config",
+				"do not use a configuration file. " +
+					"Overrides any --config option set earlier",
+			).hideHelp(true),
+		)
+		.option(
+			"-T, --output-type <type>",
+			"output type; e.g. err, err-html, dot, ddot, archi, flat, d2, mermaid, text or json",
+			"err",
+		)
+		.option("-m, --metrics", "calculate stability metrics", false)
+		.addOption(new Option("--no-metrics").hideHelp(true))
+		.option(
+			"-f, --output-to <file>",
+			"file to write output to; - for stdout",
+			"-",
+		)
+		.option(
+			"-I, --include-only <regex>",
+			"only include modules matching the regex",
+		)
+		.option(
+			"-F, --focus <regex>",
+			"only include modules matching the regex + their direct neighbours",
+		)
+		.option(
+			"--focus-depth <number>",
+			"the depth to focus on - only applied when --focus is passed too. " +
+				"1= direct neighbors, 2=neighbours of neighbours etc.",
+			1,
+		)
+		.option(
+			"-R, --reaches <regex>",
+			"only include modules matching the regex + all modules that can reach them",
+		)
+		.option(
+			"-A, --affected [revision]",
+			"only include modules changed since the revision + all modules that can reach them (when not specified revision defaults to 'main')",
+		)
+		.option(
+			"-H, --highlight <regex>",
+			"mark modules matching the regex as 'highlighted'",
+		)
+		.option("-x, --exclude <regex>", "exclude all modules matching the regex")
+		.option(
+			"-X, --do-not-follow <regex>",
+			"include modules matching the regex, but don't follow their dependencies",
+		)
+		.option(
+			"--ignore-known [file]",
+			"ignore known violations as saved in [file] (default: .dependency-cruiser-known-violations.json)",
+		)
+		.addOption(new Option("--no-ignore-known").hideHelp(true))
+		.addOption(
+			new Option(
+				"--ts-config [file]",
+				"use a TypeScript configuration (e.g. tsconfig.json) or it's JavaScript counterpart (e.g. jsconfig.json)",
+			).hideHelp(true),
+		)
+		.addOption(
+			new Option(
+				"--webpack-config [file]",
+				"use a webpack configuration (e.g. webpack.config.js)",
+			).hideHelp(true),
+		)
+		.addOption(
+			new Option(
+				"--ts-pre-compilation-deps",
+				"detect dependencies that only exist before typescript-to-javascript " +
+					"compilation (off by default)",
+			).hideHelp(true),
+		)
+		.option(
+			"-S, --collapse <regex>",
+			"collapse a to a folder depth by passing a single digit (e.g. 2). When passed a " +
+				'regex collapses to that pattern. E.g. "^packages/[^/]+/" would collapse to ' +
+				"modules/ folders directly under your packages folder. ",
+		)
+		.addOption(
+			new Option(
+				"-p, --progress [type]",
+				"show progress while dependency-cruiser is busy",
+			).choices(["cli-feedback", "performance-log", "ndjson", "none"]),
+		)
+		.addOption(
+			new Option("--no-progress", "Alias of --progress none").hideHelp(true),
+		)
+		.addOption(
+			new Option(
+				"-d, --max-depth <n>",
+				"you probably want to use --collapse instead of --max-depth. " +
+					"(max-depth would limit the cruise depth; 0 <= n <= 99 (default: 0 - no limit)).",
+			).hideHelp(true),
+		)
+		.addOption(
+			new Option(
+				"-M, --module-systems <items>",
+				"list of module systems (default: amd, cjs, es6, tsd)",
+			).hideHelp(true),
+		)
+		.option(
+			"-P, --prefix <prefix>",
+			`prefix to use for links in the dot and err-html reporters${EOL}${EOL}`,
+		)
+		.option(
+			"--suffix <suffix>",
+			`suffix to use for links in the dot and err-html reporters${EOL}${EOL}`,
+		)
+		.option(
+			"-C, --cache [cache-directory]",
+			"use a cache to speed up execution. " +
+				"The directory defaults to node_modules/.cache/dependency-cruiser",
+		)
+		.addOption(
+			new Option(
+				"--cache-strategy <strategy>",
+				"strategy to use for detecting changed files in the cache.",
+			).choices(["metadata", "content"]),
+		)
+		.addOption(
+			new Option(
+				"--no-cache",
+				"switch off caching. Overrides the 'cache' key in .dependency-cruiser.js " +
+					"and --cache options set earlier on the command line",
+			).hideHelp(true),
+		)
+		.addOption(
+			new Option(
+				"--preserve-symlinks",
+				"leave symlinks unchanged (off by default)",
+			).hideHelp(true),
+		)
+		.addOption(
+			new Option("-v, --validate [file]", `alias for --config`).hideHelp(true),
+		)
+		.option(
+			"-i, --info",
+			"shows what languages and extensions dependency-cruiser supports",
+		)
+		.addHelpText(
+			"after",
+			`${EOL}Other options:` +
+				`${EOL}  see https://github.com/sverweij/dependency-cruiser/blob/main/doc/cli.md${EOL}`,
+		)
+		.version(meta.version)
+		.argument("[files-or-directories...]")
+		.allowExcessArguments()
+		.parse(process.argv);
 
-  if (Boolean(program.args[0]) || program.opts().info || program.opts().init) {
-    process.exitCode = await cli(program.args, program.opts());
-  } else {
-    program.help();
-  }
+	if (Boolean(program.args[0]) || program.opts().info || program.opts().init) {
+		process.exitCode = await cli(program.args, program.opts());
+	} else {
+		program.help();
+	}
 } catch (pError) {
-  process.stderr.write(pError.message);
-  process.exitCode = 1;
+	process.stderr.write(pError.message);
+	process.exitCode = 1;
 }