dependency-cruiser 11.2.0 → 11.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "11.2.0",
+  "version": "11.2.1",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",

package/src/cli/format.js

@@ -6,7 +6,6 @@ const io = require("./utl/io");
 
 const KNOWN_FMT_OPTIONS = [
   "collapse",
-  "doNotFollow",
   "exclude",
   "focus",
   "help",

package/src/meta.js

@@ -1,7 +1,7 @@
 /* generated - don't edit */
 
 module.exports = {
-  version: "11.2.0",
+  version: "11.2.1",
   engines: {
     node: "^12.20||^14||>=16",
   },

package/types/dependency-cruiser.d.ts

@@ -1,6 +1,5 @@
 import { ICruiseResult } from "./cruise-result";
-import { ICruiseOptions } from "./options";
-import { OutputType } from "./shared-types";
+import { ICruiseOptions, IFormatOptions } from "./options";
 
 export * from "./rule-set";
 export * from "./options";
@@ -128,7 +127,7 @@ export function futureCruise(
  */
 export function format(
   pResult: ICruiseResult,
-  pOutputType: OutputType
+  pFormatOptions: IFormatOptions
 ): IReporterOutput;
 
 /**

package/types/options.d.ts

@@ -245,3 +245,35 @@ export interface ICruiseOptions {
    */
   metrics?: boolean;
 }
+
+export interface IFormatOptions {
+  /**
+   * regular expression describing which dependencies the function
+   * should not cruise
+   */
+  exclude?: string | string[] | IExcludeType;
+  /**
+   * regular expression describing which dependencies the function
+   * should cruise - anything not matching this will be skipped
+   */
+  includeOnly?: string | string[] | IIncludeOnlyType;
+  /**
+   * dependency-cruiser will include modules matching this regular expression
+   * in its output, as well as their neighbours (direct dependencies and
+   * dependents)
+   */
+  focus?: string | string[] | IFocusType;
+  /**
+   * collapse a to a folder depth by passing a single digit (e.g. 2).
+   * When passed a regex collapse to that pattern
+   *
+   * E.g. ^packages/[^/]+/ would collapse to modules/ folders directly under
+   * your packages folder.
+   */
+  collapse?: string | number;
+  /**
+   * one of "json", "html", "dot", "csv" or "err". When left
+   * out the function will return a javascript object as dependencies
+   */
+  outputType?: OutputType;
+}