dependency-cruiser 17.3.2 → 17.3.3-beta-2

package/src/config-utl/extract-babel-config.mjs

@@ -7,68 +7,68 @@ import tryImport from "#utl/try-import.mjs";
 import meta from "#meta.cjs";
 
 async function getJSConfig(pBabelConfigFileName) {
-  let lReturnValue = {};
+	let lReturnValue = {};
 
-  try {
-    const { default: lModule } = await import(
-      `file://${makeAbsolute(pBabelConfigFileName)}`
-    );
-    lReturnValue = lModule;
-  } catch (pError) {
-    throw new Error(
-      `${
-        `Encountered an error while parsing babel config '${pBabelConfigFileName}':` +
-        `\n\n          ${pError}`
-      }\n\n         At this time dependency-cruiser only supports babel configurations\n         in either commonjs or json5.\n`,
-    );
-  }
+	try {
+		const { default: lModule } = await import(
+			`file://${makeAbsolute(pBabelConfigFileName)}`
+		);
+		lReturnValue = lModule;
+	} catch (pError) {
+		throw new Error(
+			`${
+				`Encountered an error while parsing babel config '${pBabelConfigFileName}':` +
+				`\n\n          ${pError}`
+			}\n\n         At this time dependency-cruiser only supports babel configurations\n         in either commonjs or json5.\n`,
+		);
+	}
 
-  if (typeof lReturnValue === "function") {
-    // Function format configs not supported yet. Will need calling the
-    // function with a bunch of params (lReturnValue = lReturnValue(APIPAPI))
-    throw new TypeError(
-      `The babel config '${pBabelConfigFileName}' returns a function. At this time\n` +
-        `         dependency-cruiser doesn't support that yet.`,
-    );
-  }
-  return lReturnValue;
+	if (typeof lReturnValue === "function") {
+		// Function format configs not supported yet. Will need calling the
+		// function with a bunch of params (lReturnValue = lReturnValue(APIPAPI))
+		throw new TypeError(
+			`The babel config '${pBabelConfigFileName}' returns a function. At this time\n` +
+				`         dependency-cruiser doesn't support that yet.`,
+		);
+	}
+	return lReturnValue;
 }
 
 async function getJSON5Config(pBabelConfigFileName) {
-  let lReturnValue = {};
+	let lReturnValue = {};
 
-  try {
-    lReturnValue = json5.parse(await readFile(pBabelConfigFileName, "utf8"));
-  } catch (pError) {
-    throw new Error(
-      `Encountered an error while parsing the babel config '${pBabelConfigFileName}':` +
-        `\n\n          ${pError}\n`,
-    );
-  }
+	try {
+		lReturnValue = json5.parse(await readFile(pBabelConfigFileName, "utf8"));
+	} catch (pError) {
+		throw new Error(
+			`Encountered an error while parsing the babel config '${pBabelConfigFileName}':` +
+				`\n\n          ${pError}\n`,
+		);
+	}
 
-  if (pBabelConfigFileName.endsWith("package.json")) {
-    lReturnValue = lReturnValue?.babel ?? {};
-  }
-  return lReturnValue;
+	if (pBabelConfigFileName.endsWith("package.json")) {
+		lReturnValue = lReturnValue?.babel ?? {};
+	}
+	return lReturnValue;
 }
 
 async function getConfig(pBabelConfigFileName) {
-  const lExtensionToParseFunction = new Map([
-    [".js", getJSConfig],
-    [".cjs", getJSConfig],
-    [".mjs", getJSConfig],
-    ["", getJSON5Config],
-    [".json", getJSON5Config],
-    [".json5", getJSON5Config],
-  ]);
-  const lExtension = extname(pBabelConfigFileName);
+	const lExtensionToParseFunction = new Map([
+		[".js", getJSConfig],
+		[".cjs", getJSConfig],
+		[".mjs", getJSConfig],
+		["", getJSON5Config],
+		[".json", getJSON5Config],
+		[".json5", getJSON5Config],
+	]);
+	const lExtension = extname(pBabelConfigFileName);
 
-  if (!lExtensionToParseFunction.has(lExtension)) {
-    throw new Error(
-      `${`The babel config '${pBabelConfigFileName}' is in a format ('${lExtension}')\n`}         dependency-cruiser doesn't support yet.\n`,
-    );
-  }
-  return await lExtensionToParseFunction.get(lExtension)(pBabelConfigFileName);
+	if (!lExtensionToParseFunction.has(lExtension)) {
+		throw new Error(
+			`${`The babel config '${pBabelConfigFileName}' is in a format ('${lExtension}')\n`}         dependency-cruiser doesn't support yet.\n`,
+		);
+	}
+	return await lExtensionToParseFunction.get(lExtension)(pBabelConfigFileName);
 }
 
 /**
@@ -84,24 +84,24 @@ async function getConfig(pBabelConfigFileName) {
  *                 when dependency-cruiser can't yet process it
  */
 export default async function extractBabelConfig(pBabelConfigFileName) {
-  let lReturnValue = {};
-  const babel = await tryImport("@babel/core", meta.supportedTranspilers.babel);
+	let lReturnValue = {};
+	const babel = await tryImport("@babel/core", meta.supportedTranspilers.babel);
 
-  if (babel) {
-    const lConfig = {
-      ...(await getConfig(pBabelConfigFileName)),
-      // under some circumstances babel (and/ or its plugins) really likes to
-      // have a filename to go with the config - so we pass it
-      filename: pBabelConfigFileName,
-    };
-    lReturnValue = {
-      ...babel.loadOptions(lConfig),
-      // according to the babel documentation a config parsed & expanded through
-      // loadOptions can be passed to the parser. With some plugins/ presets
-      // this does not seem to be true anymore, though
-      ...(lConfig.presets ? { presets: lConfig.presets } : {}),
-    };
-  }
+	if (babel) {
+		const lConfig = {
+			...(await getConfig(pBabelConfigFileName)),
+			// under some circumstances babel (and/ or its plugins) needs
+			// a filename to go with the config - so we pass it
+			filename: pBabelConfigFileName,
+		};
+		lReturnValue = {
+			...babel.loadOptions(lConfig),
+			// according to the babel documentation a config parsed & expanded through
+			// loadOptions can be passed to the parser. With some plugins/ presets
+			// this does not seem to be true anymore, though
+			...(lConfig.presets ? { presets: lConfig.presets } : {}),
+		};
+	}
 
-  return lReturnValue;
+	return lReturnValue;
 }

package/src/config-utl/extract-depcruise-config/index.mjs

@@ -6,30 +6,30 @@ import { resolve } from "#extract/resolve/resolve.mjs";
 
 /* eslint no-use-before-define: 0 */
 async function processExtends(pReturnValue, pAlreadyVisited, pBaseDirectory) {
-  let lReturnValue = structuredClone(pReturnValue);
+	let lReturnValue = structuredClone(pReturnValue);
 
-  if (typeof lReturnValue.extends === "string") {
-    lReturnValue = mergeConfigs(
-      lReturnValue,
-      await extractDepcruiseConfig(
-        lReturnValue.extends,
-        pAlreadyVisited,
-        pBaseDirectory,
-      ),
-    );
-  }
+	if (typeof lReturnValue.extends === "string") {
+		lReturnValue = mergeConfigs(
+			lReturnValue,
+			await extractDepcruiseConfig(
+				lReturnValue.extends,
+				pAlreadyVisited,
+				pBaseDirectory,
+			),
+		);
+	}
 
-  if (Array.isArray(lReturnValue.extends)) {
-    for (let lExtends of lReturnValue.extends) {
-      lReturnValue = mergeConfigs(
-        lReturnValue,
-        // eslint-disable-next-line no-await-in-loop
-        await extractDepcruiseConfig(lExtends, pAlreadyVisited, pBaseDirectory),
-      );
-    }
-  }
-  Reflect.deleteProperty(lReturnValue, "extends");
-  return lReturnValue;
+	if (Array.isArray(lReturnValue.extends)) {
+		for (const lExtends of lReturnValue.extends) {
+			lReturnValue = mergeConfigs(
+				lReturnValue,
+				// eslint-disable-next-line no-await-in-loop
+				await extractDepcruiseConfig(lExtends, pAlreadyVisited, pBaseDirectory),
+			);
+		}
+	}
+	Reflect.deleteProperty(lReturnValue, "extends");
+	return lReturnValue;
 }
 
 /**
@@ -51,41 +51,41 @@ async function processExtends(pReturnValue, pAlreadyVisited, pBaseDirectory) {
  * @throws {Error} when the config is not valid (/ does not exist/ isn't readable)
  */
 export default async function extractDepcruiseConfig(
-  pConfigFileName,
-  pAlreadyVisited = new Set(),
-  pBaseDirectory = process.cwd(),
+	pConfigFileName,
+	pAlreadyVisited = new Set(),
+	pBaseDirectory = process.cwd(),
 ) {
-  const lResolvedFileName = resolve(
-    pConfigFileName,
-    pBaseDirectory,
-    await normalizeResolveOptions(
-      {
-        extensions: [".js", ".json", ".cjs", ".mjs"],
-      },
-      {},
-    ),
-    "cli",
-  );
-  const lBaseDirectory = dirname(lResolvedFileName);
+	const lResolvedFileName = resolve(
+		pConfigFileName,
+		pBaseDirectory,
+		await normalizeResolveOptions(
+			{
+				extensions: [".js", ".json", ".cjs", ".mjs"],
+			},
+			{},
+		),
+		"cli",
+	);
+	const lBaseDirectory = dirname(lResolvedFileName);
 
-  if (pAlreadyVisited.has(lResolvedFileName)) {
-    throw new Error(
-      `config is circular - ${[...pAlreadyVisited].join(
-        " -> ",
-      )} -> ${lResolvedFileName}.\n`,
-    );
-  }
-  pAlreadyVisited.add(lResolvedFileName);
+	if (pAlreadyVisited.has(lResolvedFileName)) {
+		throw new Error(
+			`config is circular - ${[...pAlreadyVisited].join(
+				" -> ",
+			)} -> ${lResolvedFileName}.\n`,
+		);
+	}
+	pAlreadyVisited.add(lResolvedFileName);
 
-  let lReturnValue = await readConfig(lResolvedFileName);
+	let lReturnValue = await readConfig(lResolvedFileName);
 
-  if (lReturnValue?.extends) {
-    lReturnValue = await processExtends(
-      lReturnValue,
-      pAlreadyVisited,
-      lBaseDirectory,
-    );
-  }
+	if (lReturnValue?.extends) {
+		lReturnValue = await processExtends(
+			lReturnValue,
+			pAlreadyVisited,
+			lBaseDirectory,
+		);
+	}
 
-  return lReturnValue;
+	return lReturnValue;
 }

package/src/config-utl/extract-depcruise-config/merge-configs.mjs

@@ -2,15 +2,15 @@ import { isDeepStrictEqual } from "node:util";
 import { uniqBy, uniqWith } from "#utl/array-util.mjs";
 
 function extendNamedRule(pExtendedRule, pForbiddenArrayBase) {
-  return pForbiddenArrayBase
-    .filter(({ name }) => name === pExtendedRule.name)
-    .reduce(
-      (pAll, pBaseRule) => ({
-        ...pBaseRule,
-        ...pAll,
-      }),
-      pExtendedRule,
-    );
+	return pForbiddenArrayBase
+		.filter(({ name }) => name === pExtendedRule.name)
+		.reduce(
+			(pAll, pBaseRule) => ({
+				...pBaseRule,
+				...pAll,
+			}),
+			pExtendedRule,
+		);
 }
 
 /**
@@ -28,29 +28,29 @@ function extendNamedRule(pExtendedRule, pForbiddenArrayBase) {
  * @return {Array} - the merged array
  */
 function mergeRules(pRuleArrayExtended, pRuleArrayBase) {
-  // merge anonymous on 100% equality
-  let lAnonymousRules = uniqWith(
-    pRuleArrayExtended.concat(pRuleArrayBase).filter(({ name }) => !name),
-    isDeepStrictEqual,
-  );
+	// merge anonymous on 100% equality
+	let lAnonymousRules = uniqWith(
+		pRuleArrayExtended.concat(pRuleArrayBase).filter(({ name }) => !name),
+		isDeepStrictEqual,
+	);
 
-  let lNamedRules = pRuleArrayExtended
-    .filter(({ name }) => name)
-    .map((pNamedRule) => extendNamedRule(pNamedRule, pRuleArrayBase));
+	let lNamedRules = pRuleArrayExtended
+		.filter(({ name }) => name)
+		.map((pNamedRule) => extendNamedRule(pNamedRule, pRuleArrayBase));
 
-  // merge named rules based on unique name
-  lNamedRules = uniqBy(
-    // ordered extended => base because the uniqBy picks the
-    // first it encounters and we want the ones from the
-    // extended in case of a conflict
+	// merge named rules based on unique name
+	lNamedRules = uniqBy(
+		// ordered extended => base because the uniqBy picks the
+		// first it encounters and we want the ones from the
+		// extended in case of a conflict
 
-    // the other concats (anonymous, allowed) don't need it
-    // but have it to be consistent with this
-    lNamedRules.concat(pRuleArrayBase).filter(({ name }) => name),
-    ({ name }) => name,
-  );
+		// the other concats (anonymous, allowed) don't need it
+		// but have it to be consistent with this
+		lNamedRules.concat(pRuleArrayBase).filter(({ name }) => name),
+		({ name }) => name,
+	);
 
-  return lNamedRules.concat(lAnonymousRules);
+	return lNamedRules.concat(lAnonymousRules);
 }
 
 /**
@@ -64,15 +64,15 @@ function mergeRules(pRuleArrayExtended, pRuleArrayBase) {
  * @return {Array} - the merged array
  */
 function mergeAllowedRules(pAllowedArrayExtended, pAllowedArrayBase) {
-  return uniqWith(
-    pAllowedArrayExtended.concat(pAllowedArrayBase),
-    isDeepStrictEqual,
-  );
+	return uniqWith(
+		pAllowedArrayExtended.concat(pAllowedArrayBase),
+		isDeepStrictEqual,
+	);
 }
 
 function mergeOptions(pOptionsExtended, pOptionsBase) {
-  // TODO: make implementation less naive (?)
-  return { ...pOptionsBase, ...pOptionsExtended };
+	// TODO: make implementation less naive (?)
+	return { ...pOptionsBase, ...pOptionsExtended };
 }
 
 /**
@@ -85,9 +85,9 @@ function mergeOptions(pOptionsExtended, pOptionsBase) {
  * @returns {string} - a string from the SeverityType value set
  */
 function mergeAllowedSeverities(pConfigExtended, pConfigBase) {
-  return (
-    pConfigExtended?.allowedSeverity ?? pConfigBase?.allowedSeverity ?? "warn"
-  );
+	return (
+		pConfigExtended?.allowedSeverity ?? pConfigBase?.allowedSeverity ?? "warn"
+	);
 }
 
 /**
@@ -106,31 +106,31 @@ function mergeAllowedSeverities(pConfigExtended, pConfigBase) {
  */
 // eslint-disable-next-line complexity
 export default (pConfigExtended, pConfigBase) => {
-  const lForbidden = mergeRules(
-    pConfigExtended?.forbidden ?? [],
-    pConfigBase?.forbidden ?? [],
-  );
-  const lRequired = mergeRules(
-    pConfigExtended?.required ?? [],
-    pConfigBase?.required ?? [],
-  );
-  const lAllowed = mergeAllowedRules(
-    pConfigExtended?.allowed ?? [],
-    pConfigBase?.allowed ?? [],
-  );
+	const lForbidden = mergeRules(
+		pConfigExtended?.forbidden ?? [],
+		pConfigBase?.forbidden ?? [],
+	);
+	const lRequired = mergeRules(
+		pConfigExtended?.required ?? [],
+		pConfigBase?.required ?? [],
+	);
+	const lAllowed = mergeAllowedRules(
+		pConfigExtended?.allowed ?? [],
+		pConfigBase?.allowed ?? [],
+	);
 
-  return {
-    ...(lForbidden.length > 0 ? { forbidden: lForbidden } : {}),
-    ...(lRequired.length > 0 ? { required: lRequired } : {}),
-    ...(lAllowed.length > 0
-      ? {
-          allowed: lAllowed,
-          allowedSeverity: mergeAllowedSeverities(pConfigExtended, pConfigBase),
-        }
-      : {}),
-    options: mergeOptions(
-      pConfigExtended?.options ?? {},
-      pConfigBase?.options ?? {},
-    ),
-  };
+	return {
+		...(lForbidden.length > 0 ? { forbidden: lForbidden } : {}),
+		...(lRequired.length > 0 ? { required: lRequired } : {}),
+		...(lAllowed.length > 0
+			? {
+					allowed: lAllowed,
+					allowedSeverity: mergeAllowedSeverities(pConfigExtended, pConfigBase),
+				}
+			: {}),
+		options: mergeOptions(
+			pConfigExtended?.options ?? {},
+			pConfigBase?.options ?? {},
+		),
+	};
 };

package/src/config-utl/extract-depcruise-config/read-config.mjs

@@ -8,13 +8,13 @@ import json5 from "json5";
  * @returns {Promise<import('../../../types/configuration.mjs').IConfiguration>}
  */
 export default async function readConfig(pAbsolutePathToConfigFile) {
-  if (
-    [".js", ".cjs", ".mjs", ""].includes(extname(pAbsolutePathToConfigFile))
-  ) {
-    const { default: config } = await import(
-      `file://${pAbsolutePathToConfigFile}`
-    );
-    return config;
-  }
-  return json5.parse(await readFile(pAbsolutePathToConfigFile, "utf8"));
+	if (
+		[".js", ".cjs", ".mjs", ""].includes(extname(pAbsolutePathToConfigFile))
+	) {
+		const { default: config } = await import(
+			`file://${pAbsolutePathToConfigFile}`
+		);
+		return config;
+	}
+	return json5.parse(await readFile(pAbsolutePathToConfigFile, "utf8"));
 }

package/src/config-utl/extract-depcruise-options.mjs

@@ -10,15 +10,15 @@ import extractDepcruiseConfig from "./extract-depcruise-config/index.mjs";
  * @returns {ICruiseOptions}
  */
 function configuration2options(pConfiguration) {
-  /* c8 ignore next 1 */
-  const lConfiguration = structuredClone(pConfiguration || {});
-  const lReturnValue = structuredClone(lConfiguration?.options ?? {});
+	/* c8 ignore next 1 */
+	const lConfiguration = structuredClone(pConfiguration || {});
+	const lReturnValue = structuredClone(lConfiguration?.options ?? {});
 
-  delete lConfiguration.options;
-  lReturnValue.ruleSet = structuredClone(lConfiguration);
-  lReturnValue.validate = Object.keys(lReturnValue.ruleSet).length > 0;
+	delete lConfiguration.options;
+	lReturnValue.ruleSet = structuredClone(lConfiguration);
+	lReturnValue.validate = Object.keys(lReturnValue.ruleSet).length > 0;
 
-  return lReturnValue;
+	return lReturnValue;
 }
 
 /**
@@ -27,6 +27,6 @@ function configuration2options(pConfiguration) {
  * @returns {Promise<ICruiseOptions>}
  */
 export default async function extractDepcruiseOptions(pConfigFileName) {
-  const lReturnValue = await extractDepcruiseConfig(pConfigFileName);
-  return configuration2options(lReturnValue);
+	const lReturnValue = await extractDepcruiseConfig(pConfigFileName);
+	return configuration2options(lReturnValue);
 }

package/src/config-utl/extract-known-violations.mjs

@@ -20,58 +20,58 @@ import makeAbsolute from "./make-absolute.mjs";
  * @returns {IViolation}
  */
 function makeForwardCompatible(pKnownViolation) {
-  let lReturnValue = pKnownViolation;
-  if (pKnownViolation.cycle) {
-    lReturnValue = {
-      ...pKnownViolation,
-      cycle: pKnownViolation.cycle.map((pModule) => {
-        if (pModule.name) {
-          return pModule;
-        }
-        return {
-          name: pModule,
-          dependencyTypes: [],
-        };
-      }),
-    };
-  }
-  if (pKnownViolation.via) {
-    lReturnValue = {
-      ...pKnownViolation,
-      via: pKnownViolation.via.map((pModule) => {
-        if (pModule.name) {
-          return pModule;
-        }
-        return {
-          name: pModule,
-          dependencyTypes: [],
-        };
-      }),
-    };
-  }
-  return lReturnValue;
+	let lReturnValue = pKnownViolation;
+	if (pKnownViolation.cycle) {
+		lReturnValue = {
+			...pKnownViolation,
+			cycle: pKnownViolation.cycle.map((pModule) => {
+				if (pModule.name) {
+					return pModule;
+				}
+				return {
+					name: pModule,
+					dependencyTypes: [],
+				};
+			}),
+		};
+	}
+	if (pKnownViolation.via) {
+		lReturnValue = {
+			...pKnownViolation,
+			via: pKnownViolation.via.map((pModule) => {
+				if (pModule.name) {
+					return pModule;
+				}
+				return {
+					name: pModule,
+					dependencyTypes: [],
+				};
+			}),
+		};
+	}
+	return lReturnValue;
 }
 
 export default async function extractKnownViolations(pKnownViolationsFileName) {
-  try {
-    const lFileContents = await readFile(
-      makeAbsolute(pKnownViolationsFileName),
-      "utf8",
-    );
-    const lKnownViolations = json5.parse(lFileContents);
-    const lForwardCompatible = lKnownViolations.map(makeForwardCompatible);
+	try {
+		const lFileContents = await readFile(
+			makeAbsolute(pKnownViolationsFileName),
+			"utf8",
+		);
+		const lKnownViolations = json5.parse(lFileContents);
+		const lForwardCompatible = lKnownViolations.map(makeForwardCompatible);
 
-    return lForwardCompatible;
-  } catch (pError) {
-    if (pError instanceof SyntaxError) {
-      throw new SyntaxError(
-        `'${pKnownViolationsFileName}' should be valid json\n          ${pError}`,
-      );
-    }
-    throw pError;
-  }
+		return lForwardCompatible;
+	} catch (pError) {
+		if (pError instanceof SyntaxError) {
+			throw new SyntaxError(
+				`'${pKnownViolationsFileName}' should be valid json\n          ${pError}`,
+			);
+		}
+		throw pError;
+	}
 
-  // TODO: validate the json against the schema? (might be more clear to do it here,
-  // even if (in context of the cli) it's done again when validating the whole
-  // config
+	// TODO: validate the json against the schema? (might be more clear to do it here,
+	// even if (in context of the cli) it's done again when validating the whole
+	// config
 }