dependency-cruiser/src/cli/init-config/build-config.mjs

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

// @ts-check
import { folderNameArrayToRE } from "./utl.mjs";
import configTemplate from "./config-template.mjs";

/**
 * @import { IInitConfig } from "./types.js";
 */

/**
 * @param {string} pString
 * @returns {string}
 */
function quote(pString) {
	return `"${pString}"`;
}

/**
 * @param {string[]=} pExtensions
 * @returns {string}
 */
function extensionsToString(pExtensions) {
	if (pExtensions) {
		return `[${pExtensions.map(quote).join(", ")}]`;
	}
	return "";
}

/**
 * @param {IInitConfig} pInitOptions
 * @returns {string}
 */
function buildNotToTestRule(pInitOptions) {
	const lNotToTestRule = `{
      name: 'not-to-test',
      comment:
        "This module depends on code within a folder that should only contain tests. As tests don't " +
        "implement functionality this is odd. Either you're writing a test outside the test folder " +
        "or there's something in the test folder that isn't a test.",
      severity: 'error',
      from: {
        pathNot: '{{testLocationRE}}'
      },
      to: {
        path: '{{testLocationRE}}'
      }
    },`;
	return pInitOptions.hasTestsOutsideSource
		? lNotToTestRule.replaceAll(
				"{{testLocationRE}}",
				folderNameArrayToRE(pInitOptions?.testLocation ?? []),
			)
		: "";
}

/**
 * @param {IInitConfig} pInitOptions
 * @returns {string}
 */
function buildTsPreCompilationDepsAttribute(pInitOptions) {
	return pInitOptions.tsPreCompilationDeps
		? "tsPreCompilationDeps: true,"
		: "// tsPreCompilationDeps: false,";
}

/**
 *
 * @param {IInitConfig} pInitOptions
 * @returns {string}
 */
function buildDetectJSDocumentImportsAttribute(pInitOptions) {
	return pInitOptions.detectJSDocImports
		? "detectJSDocImports: true,"
		: "// detectJSDocImports: true,";
}

/**
 *
 * @param {IInitConfig} pInitOptions
 * @returns {string}
 */
function buildDetectProcessBuiltinModuleCalls(pInitOptions) {
	return pInitOptions.detectProcessBuiltinModuleCalls
		? "detectProcessBuiltinModuleCalls: true,"
		: "// detectProcessBuiltinModuleCalls: true,";
}

/**
 * @param {IInitConfig} pInitOptions
 * @returns {string}
 */
function buildCombinedDependenciesAttribute(pInitOptions) {
	return pInitOptions.combinedDependencies
		? "combinedDependencies: true,"
		: "// combinedDependencies: false,";
}

/**
 * @param {IInitConfig} pInitOptions
 * @returns {string}
 */
function buildTsOrJsConfigAttribute(pInitOptions) {
	if (pInitOptions.useTsConfig) {
		return `tsConfig: {
      fileName: '${pInitOptions.tsConfig}'
    },`;
	}
	if (pInitOptions.useJsConfig) {
		return `tsConfig: {
      fileName: '${pInitOptions.jsConfig}'
    },`;
	}
	return `// tsConfig: {
    //   fileName: 'tsconfig.json'
    // },`;
}

/**
 * @param {IInitConfig} pInitOptions
 * @returns {string}
 */
function buildWebpackConfigAttribute(pInitOptions) {
	return pInitOptions.webpackConfig
		? `webpackConfig: {
      fileName: '${pInitOptions.webpackConfig}',
      // env: {},
      // arguments: {}
    },`
		: `// webpackConfig: {
    //  fileName: 'webpack.config.js',
    //  env: {},
    //  arguments: {}
    // },`;
}

/**
 * @param {IInitConfig} pInitOptions
 * @returns {string}
 */
function buildBabelConfigAttribute(pInitOptions) {
	return pInitOptions.babelConfig
		? `babelConfig: {
      fileName: '${pInitOptions.babelConfig}'
    },`
		: `// babelConfig: {
    //   fileName: '.babelrc',
    // },`;
}

/**
 * @param {IInitConfig} pInitOptions
 * @returns {string}
 */
function buildExtensionsAttribute(pInitOptions) {
	return pInitOptions.specifyResolutionExtensions
		? `extensions: ${extensionsToString(pInitOptions.resolutionExtensions)},`
		: `// extensions: [".js", ".jsx", ".ts", ".tsx", ".d.ts"],`;
}

/**
 * @param {IInitConfig} pInitOptions
 * @returns {string}
 */
function buildMainFieldsAttribute(pInitOptions) {
	if (pInitOptions.isTypeModule) {
		return `mainFields: ["module", "main", "types", "typings"],`;
	}
	return `
      // if you migrate to ESM (or are in an ESM environment already) you will want to
      // have "module" in the list of mainFields, like so:
      // mainFields: ["module", "main", "types", "typings"],
      mainFields: ["main", "types", "typings"],`;
}

/**
 * @param {IInitConfig} pInitOptions
 * @returns {string}
 */
function buildBuiltInModulesAttribute(pInitOptions) {
	if (pInitOptions.usesBun) {
		return `
    /* List of built-in modules to use on top of the ones node declares.

       See https://github.com/sverweij/dependency-cruiser/blob/main/doc/options-reference.md#builtinmodules-influencing-what-to-consider-built-in--core-modules
       for details
    */
    builtInModules: { 
      add: [
        "bun",
        "bun:ffi",
        "bun:jsc",
        "bun:sqlite",
        "bun:test",
        "bun:wrap",
        "detect-libc",
        "undici",
        "ws"
      ]
    },
`;
	}
	return "";
}

/**
 * Creates a .dependency-cruiser config with a set of basic validations
 * to the current directory.
 *
 * @param {IInitConfig} pInitOptions ('Normalized') options that influence the shape of
 *                  the configuration
 * @returns {string} the configuration as a string
 */
export default function buildConfig(pInitOptions) {
	return configTemplate
		.replaceAll(
			"{{sourceLocationRE}}",
			folderNameArrayToRE(pInitOptions.sourceLocation),
		)
		.replaceAll(
			"{{resolutionExtensionsAsString}}",
			extensionsToString(pInitOptions.resolutionExtensions),
		)
		.replace("{{notToTestRule}}", buildNotToTestRule(pInitOptions))
		.replace(
			"{{detectJSDocImportsAttribute}}",
			buildDetectJSDocumentImportsAttribute(pInitOptions),
		)
		.replace(
			"{{detectProcessBuiltinModuleCalls}}",
			buildDetectProcessBuiltinModuleCalls(pInitOptions),
		)
		.replace(
			"{{tsPreCompilationDepsAttribute}}",
			buildTsPreCompilationDepsAttribute(pInitOptions),
		)
		.replace(
			"{{combinedDependenciesAttribute}}",
			buildCombinedDependenciesAttribute(pInitOptions),
		)
		.replace(
			"{{tsOrJsConfigAttribute}}",
			buildTsOrJsConfigAttribute(pInitOptions),
		)
		.replace(
			"{{webpackConfigAttribute}}",
			buildWebpackConfigAttribute(pInitOptions),
		)
		.replace(
			"{{babelConfigAttribute}}",
			buildBabelConfigAttribute(pInitOptions),
		)
		.replace(
			"{{builtInModulesAttribute}}",
			buildBuiltInModulesAttribute(pInitOptions),
		)
		.replace("{{extensionsAttribute}}", buildExtensionsAttribute(pInitOptions))
		.replace("{{mainFieldsAttribute}}", buildMainFieldsAttribute(pInitOptions))
		.replace("{{version}}", pInitOptions.version)
		.replace("{{date}}", pInitOptions.date);
}