dependency-cruiser 17.3.2 → 17.3.3-beta-2

package/types/dependency-cruiser.d.mts

@@ -16,61 +16,61 @@ export type * from "./resolve-options.mjs";
 export const allExtensions: IAvailableExtension[];
 
 export interface IAvailableExtension {
-  /**
-   * File extension (e.g. ".js", ".ts", ".jsx")
-   */
-  extension: string;
-  /**
-   * Whether or not the extension is available as supported in the current environment
-   */
-  available: boolean;
+	/**
+	 * File extension (e.g. ".js", ".ts", ".jsx")
+	 */
+	extension: string;
+	/**
+	 * Whether or not the extension is available as supported in the current environment
+	 */
+	available: boolean;
 }
 
 export interface IAvailableTranspiler {
-  /**
-   * The name of the transpiler (e.g. "typescript", "coffeescript")
-   */
-  name: string;
-  /**
-   * A semver version range (e.g. ">=2.0.0 <3.0.0")
-   */
-  version: string;
-  /**
-   * Whether or not the transpiler is available in the current environment
-   */
-  available: boolean;
+	/**
+	 * The name of the transpiler (e.g. "typescript", "coffeescript")
+	 */
+	name: string;
+	/**
+	 * A semver version range (e.g. ">=2.0.0 <3.0.0")
+	 */
+	version: string;
+	/**
+	 * Whether or not the transpiler is available in the current environment
+	 */
+	available: boolean;
 }
 
 export interface IReporterOutput {
-  /**
-   * The output proper of the reporter. For most reporters this will be
-   * a string.
-   */
-  output: ICruiseResult | string;
-  /**
-   * The exit code - reporters can return a non-zero value when they find
-   * errors here. api consumers (like a cli) can use this to return a
-   * non-zero exit code, so the build breaks when something is wrong
-   *
-   * This is e.g. the default behavior of the `err` and `err-long` reporters.
-   */
-  exitCode: number;
+	/**
+	 * The output proper of the reporter. For most reporters this will be
+	 * a string.
+	 */
+	output: ICruiseResult | string;
+	/**
+	 * The exit code - reporters can return a non-zero value when they find
+	 * errors here. api consumers (like a cli) can use this to return a
+	 * non-zero exit code, so the build breaks when something is wrong
+	 *
+	 * This is e.g. the default behavior of the `err` and `err-long` reporters.
+	 */
+	exitCode: number;
 }
 
 export interface ITranspileOptions {
-  /**
-   * An object with with a typescript config object. Note that the
-   * API will not take any 'extends' keys there into account, so
-   * before calling make sure to flatten them out if you want them
-   * used (e.g. with 'dependency-cruiser/config-utl/extract-ts-config')
-   */
-  tsConfig?: any;
-  /**
-   * An object with with a babel config object. Either pass the options
-   * manually or extract them from a configuration file with e.g. with
-   * 'dependency-cruiser/config-utl/extract-babel-config')
-   */
-  babelConfig?: any;
+	/**
+	 * An object with with a typescript config object. Note that the
+	 * API will not take any 'extends' keys there into account, so
+	 * before calling make sure to flatten them out if you want them
+	 * used (e.g. with 'dependency-cruiser/config-utl/extract-ts-config')
+	 */
+	tsConfig?: any;
+	/**
+	 * An object with with a babel config object. Either pass the options
+	 * manually or extract them from a configuration file with e.g. with
+	 * 'dependency-cruiser/config-utl/extract-babel-config')
+	 */
+	babelConfig?: any;
 }
 
 /**
@@ -88,10 +88,10 @@ export interface ITranspileOptions {
  *                        like TypeScript or Babel
  */
 export function cruise(
-  pFileAndDirectoryArray: string[],
-  pCruiseOptions?: ICruiseOptions,
-  pResolveOptions?: Partial<IResolveOptions>,
-  pTranspileOptions?: ITranspileOptions,
+	pFileAndDirectoryArray: string[],
+	pCruiseOptions?: ICruiseOptions,
+	pResolveOptions?: Partial<IResolveOptions>,
+	pTranspileOptions?: ITranspileOptions,
 ): Promise<IReporterOutput>;
 
 /**
@@ -102,8 +102,8 @@ export function cruise(
  * @param pOutputType Which reporter to use to format the cruise result with
  */
 export function format(
-  pResult: ICruiseResult,
-  pFormatOptions: IFormatOptions,
+	pResult: ICruiseResult,
+	pFormatOptions: IFormatOptions,
 ): Promise<IReporterOutput>;
 
 /**

package/types/filter-types.d.mts

@@ -1,64 +1,64 @@
 import type { DependencyType } from "./shared-types.mjs";
 
 export interface IDoNotFollowType {
-  /**
-   * a regular expression for modules to include, but not follow further
-   */
-  path?: string | string[];
-  /**
-   * an array of dependency types to include, but not follow further
-   */
-  dependencyTypes?: DependencyType[];
+	/**
+	 * a regular expression for modules to include, but not follow further
+	 */
+	path?: string | string[];
+	/**
+	 * an array of dependency types to include, but not follow further
+	 */
+	dependencyTypes?: DependencyType[];
 }
 
 export interface IExcludeType {
-  /**
-   * a regular expression for modules to exclude
-   */
-  path?: string | string[];
-  /**
-   * a boolean indicating whether or not to exclude dynamic dependencies
-   * leave out to match both
-   */
-  dynamic?: boolean;
+	/**
+	 * a regular expression for modules to exclude
+	 */
+	path?: string | string[];
+	/**
+	 * a boolean indicating whether or not to exclude dynamic dependencies
+	 * leave out to match both
+	 */
+	dynamic?: boolean;
 }
 
 export interface IIncludeOnlyType {
-  /**
-   * regular expression describing which dependencies the function
-   * should cruise - anything not matching this will be skipped
-   */
-  path?: string | string[];
+	/**
+	 * regular expression describing which dependencies the function
+	 * should cruise - anything not matching this will be skipped
+	 */
+	path?: string | string[];
 }
 
 export interface IFocusType {
-  /**
-   * dependency-cruiser will include modules matching this regular expression
-   * in its output, as well as their neighbours (direct dependencies and
-   * dependents)
-   */
-  path?: string | string[];
-  /**
-   * by default 'focus' only inlcudes the direct neighbours of the focus'ed module(s).
-   * This property makes dependency-cruiser will also include neighbors of neighbors,
-   * up to the specified depth.
-   */
-  depth?: number;
+	/**
+	 * dependency-cruiser will include modules matching this regular expression
+	 * in its output, as well as their neighbours (direct dependencies and
+	 * dependents)
+	 */
+	path?: string | string[];
+	/**
+	 * by default 'focus' only inlcudes the direct neighbours of the focus'ed module(s).
+	 * This property makes dependency-cruiser will also include neighbors of neighbors,
+	 * up to the specified depth.
+	 */
+	depth?: number;
 }
 
 export interface IReachesType {
-  /**
-   * dependency-cruiser will include modules matching this regular expression
-   * in its output, as well as _any_ module that reaches them - either directly
-   * or via via.
-   */
-  path?: string | string[];
+	/**
+	 * dependency-cruiser will include modules matching this regular expression
+	 * in its output, as well as _any_ module that reaches them - either directly
+	 * or via via.
+	 */
+	path?: string | string[];
 }
 
 export interface IHighlightType {
-  /**
-   * dependency-cruiser will mark modules matching this regular expression
-   * as 'highlighted' in its output
-   */
-  path?: string | string[];
+	/**
+	 * dependency-cruiser will mark modules matching this regular expression
+	 * as 'highlighted' in its output
+	 */
+	path?: string | string[];
 }