dependency-cruiser/src/cli/init-config/write-run-scripts-to-manifest.mjs

Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.

/* eslint-disable prefer-template */
/* eslint-disable security/detect-object-injection */
import { writeFileSync } from "node:fs";
import { styleText } from "node:util";
import { EOL } from "node:os";
import { PACKAGE_MANIFEST as _PACKAGE_MANIFEST } from "../defaults.mjs";
import { readManifest } from "./environment-helpers.mjs";
import { folderNameArrayToRE } from "./utl.mjs";

const PACKAGE_MANIFEST = `./${_PACKAGE_MANIFEST}`;

const EXPERIMENTAL_SCRIPT_DOC = [
	{
		name: "depcruise",
		headline: "npm run depcruise",
		description:
			"      validates against the rules in .dependency-cruiser.js and writes the" +
			EOL +
			"      outcome to stdout",
	},
	{
		name: "depcruise:html",
		headline: "npm run depcruise:html",
		description:
			"      validates against the rules in .dependency-cruiser.js and writes it to" +
			EOL +
			"      'dependency-violation-report.html' with a friendly layout",
	},
	{
		name: "depcruise:graph",
		headline: "npm run depcruise:graph",
		description:
			"      writes a detailed internal graph of your app to 'dependency-graph.html'",
	},
	{
		name: "depcruise:graph:dev",
		headline: "npm run depcruise:graph:dev",
		description:
			"      opens a detailed internal graph of your app in your default browser" +
			EOL +
			"      (uses the 'browser' command line program)",
	},
	{
		name: "depcruise:graph:archi",
		headline: "depcruise:graph:archi",
		description:
			"      writes a high-level internal graph of your app to" +
			EOL +
			"      'high-level-dependency-graph.html",
	},
	{
		name: "depcruise:focus",
		headline: "npm run depcruise:focus <regex>",
		description:
			"      writes all dependencies to and from modules matching the given <regex>" +
			EOL +
			"      to stdout - in simple text",
	},
];

/**
 * @param {import("./types").IInitConfig} pInitOptions
 * @return {any} an bunch of key value pairs that can be plonked into a `scripts` attribute in a package.json
 */
export function compileRunScripts(pInitOptions) {
	let lReturnValue = {};

	if (pInitOptions && (pInitOptions.sourceLocation || []).length > 0) {
		const lSourceLocations = pInitOptions.sourceLocation.join(" ");
		const lSourceLocationRE = folderNameArrayToRE(pInitOptions.sourceLocation);
		const lTestLocations = (pInitOptions.testLocation || []).join(" ");

		lReturnValue = {
			depcruise: `depcruise ${lSourceLocations} ${lTestLocations}`,
			"depcruise:graph": `depcruise ${lSourceLocations} --include-only '${lSourceLocationRE}' --output-type dot | dot -T svg | depcruise-wrap-stream-in-html > dependency-graph.html`,
			"depcruise:graph:dev": `depcruise ${lSourceLocations} --include-only '${lSourceLocationRE}' --prefix vscode://file/$(pwd)/ --output-type dot | dot -T svg | depcruise-wrap-stream-in-html | browser`,
			"depcruise:graph:archi": `depcruise ${lSourceLocations} --include-only '${lSourceLocationRE}' --output-type archi | dot -T svg | depcruise-wrap-stream-in-html > high-level-dependency-graph.html`,
			"depcruise:html": `depcruise ${lSourceLocations} ${lTestLocations} --progress --output-type err-html --output-to dependency-violation-report.html`,
			"depcruise:text": `depcruise ${lSourceLocations} ${lTestLocations} --progress --output-type text`,
			"depcruise:focus": `depcruise ${lSourceLocations} ${lTestLocations} --progress --output-type text --focus`,
		};
	}

	return lReturnValue;
}

/**
 * Return the scripts in pAdditionalRunScripts that don't yet exist in
 * pExistingRunScripts
 *
 * @param {any} pAdditionalRunScripts
 * @param {any} pExistingRunScripts
 *
 * @return {any} the scripts in pAdditionalRunScripts that don't yet exist in
 * pExistingRunScripts
 */
function filterNewScriptEntries(pExistingRunScripts, pAdditionalRunScripts) {
	return Object.keys(pAdditionalRunScripts || {})
		.filter((pKey) => !pExistingRunScripts[pKey])
		.reduce((pAll, pKey) => {
			pAll[pKey] = pAdditionalRunScripts[pKey];
			return pAll;
		}, {});
}

export function addRunScriptsToManifest(pManifest, pAdditionalRunScripts) {
	const lManifest = { ...(pManifest || {}) };
	const lExistingRunScripts = lManifest.scripts || {};

	// This ensures the new scripts are added _below_ the ones currently in the manifest
	lManifest.scripts = {
		...lExistingRunScripts,
		...filterNewScriptEntries(lExistingRunScripts, pAdditionalRunScripts),
	};

	return lManifest;
}

function getSuccessMessage(pDestinationManifestFileName) {
	return EXPERIMENTAL_SCRIPT_DOC.reduce(
		(pAll, pScript) => {
			return `${pAll}${
				`\n    ${styleText("green", "►")} ${pScript.headline}` +
				`\n${pScript.description}\n\n`
			}`;
		},
		`  ${styleText("green", "✔")} Run scripts added to '${pDestinationManifestFileName}':\n`,
	);
}

/**
 *
 * @param {any} pNormalizedInitOptions
 * @param {{manifest?: string, destinationManifestFileName?: string, outStream?: NodeJS.WritableStream}} pOptions
 */
export function writeRunScriptsToManifest(pNormalizedInitOptions, pOptions) {
	const lOptions = {
		manifest: readManifest(),
		destinationManifestFileName: PACKAGE_MANIFEST,
		outStream: process.stdout,
		...pOptions,
	};
	const lUpdatedManifest = addRunScriptsToManifest(
		lOptions.manifest,
		compileRunScripts(pNormalizedInitOptions),
	);

	writeFileSync(
		lOptions.destinationManifestFileName,
		JSON.stringify(lUpdatedManifest, null, "  "),
		"utf8",
	);

	lOptions.outStream.write(
		getSuccessMessage(lOptions.destinationManifestFileName),
	);
}