dependency-cruiser/src/extract/extract-stats.mjs

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

import {
	getStats as tscStats,
	shouldUse as tscShouldUse,
} from "./tsc/extract.mjs";
import { getStats as acornStats } from "./acorn/extract.mjs";

/**
 * @import { IStrictCruiseOptions, ITranspileOptions } from "../../types/dependency-cruiser.mjs";
 * @import { IDependency } from "../../types/cruise-result.mjs";
 */

/**
 * @param {IStrictCruiseOptions} pCruiseOptions
 * @param {string} pFileName
 * @returns {(IStrictCruiseOptions, string, any) => IDependency[]}
 */
function determineExtractionFunction(pCruiseOptions, pFileName) {
	let lExtractionFunction = acornStats;

	if (tscShouldUse(pCruiseOptions, pFileName)) {
		lExtractionFunction = tscStats;
	}

	return lExtractionFunction;
}

/**
 * Returns some stats for the module in pFileName
 *
 * @param  {string} pFileName path to the file
 * @param  {IStrictCruiseOptions} pCruiseOptions cruise options
 * @param  {ITranspileOptions} pTranspileOptions       an object with tsconfig ('typescript project') options
 *                               ('flattened' so there's no need for file access on any
 *                               'extends' option in there)
 * @return {IDependency[]} an array of dependency objects (see above)
 */
export default function extractStats(
	pFileName,
	pCruiseOptions,
	pTranspileOptions,
) {
	try {
		return determineExtractionFunction(pCruiseOptions, pFileName)(
			pCruiseOptions,
			pFileName,
			pTranspileOptions,
		);
	} catch (pError) {
		throw new Error(
			`Extracting stats ran afoul of...\n\n  ${pError.message}\n... in ${pFileName}\n\n`,
		);
	}
}