dependency-cruiser
Version:
Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.
19 lines (17 loc) • 586 B
text/typescript
import type { ICruiseOptions } from "../options.mjs";
/**
* Reads the file with name `pConfigFileName` returns the parsed cruise
* options you can use as
*
* ```javascript
* const depcruiseOptions = await extractDepcruiseOptions("./.dependency-cruiser.js")
* const cruiseResult = await cruise(["./src"], depcruiseOptions);
* ```
*
* @param pConfigFileName
* @return dependency-cruiser options
* @throws when the config is not valid (/ does not exist/ isn't readable)
*/
export default function extractDepcruiseOptions(
pConfigFileName: string,
): Promise<ICruiseOptions>;