dependency-cruiser/src/extract/tsc/parse.mjs

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

import { readFileSync } from "node:fs";
import transpile from "../transpile/index.mjs";
import tryImport from "#utl/try-import.mjs";
import meta from "#meta.cjs";
import getExtension from "#utl/get-extension.mjs";

/** @type {import('typescript')} */
const typescript = await tryImport(
	"typescript",
	meta.supportedTranspilers.typescript,
);
/** @type {Map<string, any>} */
const CACHE = new Map();

/**
 * Compiles pTypescriptSource into a (typescript) AST
 *
 * @param {object} pFileRecord Record with source code, an extension and a filename
 * @param {any} [pTranspileOptions] options for the transpiler(s) - a tsconfig or
 *                                a babel config
 * @return {object} - a (typescript) AST
 */
export function getASTFromSource(pFileRecord, pTranspileOptions) {
	let lSource = pFileRecord.source;
	if (pFileRecord.extension === ".vue") {
		lSource = transpile(pFileRecord, pTranspileOptions);
	}

	return typescript.createSourceFile(
		pFileRecord.filename || "$internal-file-name",
		lSource,
		typescript.ScriptTarget.Latest,
		false,
	);
}

/**
 * Compiles the file identified by pFileName into a (typescript)
 * AST and returns it. Subsequent calls for the same file name will
 * return the result from a cache
 *
 * @param {string} pFileName - the name of the file to compile
 * @param {any} [pTranspileOptions] options for the transpiler(s) - a tsconfig or
 *                                a babel config
 * @return {object} - a (typescript) AST
 */
export function getASTCached(pFileName, pTranspileOptions) {
	if (CACHE.has(pFileName)) {
		return CACHE.get(pFileName);
	}
	const lAST = getASTFromSource(
		{
			source: readFileSync(pFileName, "utf8"),
			extension: getExtension(pFileName),
			filename: pFileName,
		},
		pTranspileOptions,
	);
	CACHE.set(pFileName, lAST);
	return lAST;
}

/**
 * @return {boolean} - true if the typescript compiler is available,
 *                     false in all other cases
 */
export const isAvailable = () => typescript !== false;

export function clearCache() {
	CACHE.clear();
}