dependency-cruiser 12.12.0 → 12.12.2

package/README.md

@@ -1,10 +1,10 @@
-# Dependency cruiser ![Dependency cruiser](https://raw.githubusercontent.com/sverweij/dependency-cruiser/master/doc/assets/ZKH-Dependency-recolored-160.png)
+# Dependency cruiser ![Dependency cruiser](https://raw.githubusercontent.com/sverweij/dependency-cruiser/v12/doc/assets/ZKH-Dependency-recolored-160.png)
 
 _Validate and visualise dependencies. With your rules._ JavaScript. TypeScript. CoffeeScript. ES6, CommonJS, AMD.
 
 ## What's this do?
 
-![Snazzy dot output to whet your appetite](https://raw.githubusercontent.com/sverweij/dependency-cruiser/master/doc/assets/sample-dot-output.png)
+![Snazzy dot output to whet your appetite](https://raw.githubusercontent.com/sverweij/dependency-cruiser/v12/doc/assets/sample-dot-output.png)
 
 This runs through the dependencies in any JavaScript, TypeScript, LiveScript or CoffeeScript project and ...
 
@@ -112,7 +112,7 @@ npx depcruise --config .dependency-cruiser.js src
 
 This will validate against your rules and shows any violations in an eslint-like format:
 
-![sample err output](https://raw.githubusercontent.com/sverweij/dependency-cruiser/master/doc/assets/sample-err-output.png)
+![sample err output](https://raw.githubusercontent.com/sverweij/dependency-cruiser/v12/doc/assets/sample-err-output.png)
 
 There's more ways to report validations; in a graph (like the one on top of this
 readme) or in an self-containing `html` file.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "12.12.0",
+  "version": "12.12.2",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",
@@ -87,8 +87,8 @@
     "depcruise:graph:doc:samples": "sh tools/generate-samples.sh",
     "depcruise:graph:mermaid": "node ./bin/dependency-cruise.js bin src --include-only ^src/ --config --collapse 2 --output-type mermaid",
     "depcruise:graph:mermaid:diff": "node ./bin/dependency-cruise.js bin src test types tools --config configs/.dependency-cruiser-unlimited.json --output-type mermaid --reaches \"$(watskeburt $SHA)\"",
-    "depcruise:graph:view": "node ./bin/dependency-cruise.js bin src --prefix vscode://file/$(pwd)/ --config configs/.dependency-cruiser-show-metrics-config.json --output-type dot --progress cli-feedback --highlight \"$(watskeburt develop)\" | dot -T svg | node ./bin/wrap-stream-in-html.js | browser",
-    "depcruise:graph:view:diff": "node ./bin/dependency-cruise.js bin src test --prefix vscode://file/$(pwd)/ --config configs/.dependency-cruiser-unlimited.json --output-type dot --progress cli-feedback --reaches \"$(watskeburt develop)\" | dot -T svg | node ./bin/wrap-stream-in-html.js | browser",
+    "depcruise:graph:view": "node ./bin/dependency-cruise.js bin src --prefix vscode://file/$(pwd)/ --config configs/.dependency-cruiser-show-metrics-config.json --output-type dot --progress cli-feedback --highlight \"$(watskeburt v12)\" | dot -T svg | node ./bin/wrap-stream-in-html.js | browser",
+    "depcruise:graph:view:diff": "node ./bin/dependency-cruise.js bin src test --prefix vscode://file/$(pwd)/ --config configs/.dependency-cruiser-unlimited.json --output-type dot --progress cli-feedback --reaches \"$(watskeburt v12)\" | dot -T svg | node ./bin/wrap-stream-in-html.js | browser",
     "depcruise:report": "node ./bin/dependency-cruise.js src bin test configs types --output-type err-html --config configs/.dependency-cruiser-show-metrics-config.json --output-to dependency-violations.html",
     "depcruise:report:view": "node ./bin/dependency-cruise.js src bin test configs types --output-type err-html --config configs/.dependency-cruiser-show-metrics-config.json --output-to - | browser",
     "depcruise:focus": "node ./bin/dependency-cruise.js src bin test configs types tools --progress --config --output-type text --focus",
@@ -149,7 +149,7 @@
     "ajv": "8.12.0",
     "chalk": "^4.1.2",
     "commander": "10.0.1",
-    "enhanced-resolve": "5.13.0",
+    "enhanced-resolve": "5.14.0",
     "figures": "^3.2.0",
     "get-stream": "^6.0.1",
     "glob": "7.2.0",
@@ -171,21 +171,21 @@
     "wrap-ansi": "^7.0.0"
   },
   "devDependencies": {
-    "@babel/core": "7.21.5",
+    "@babel/core": "7.21.8",
     "@babel/plugin-transform-modules-commonjs": "7.21.5",
     "@babel/preset-typescript": "7.21.5",
-    "@swc/core": "1.3.56",
+    "@swc/core": "1.3.57",
     "@types/lodash": "4.14.194",
-    "@types/node": "18.16.3",
+    "@types/node": "20.1.3",
     "@types/prompts": "2.4.4",
-    "@typescript-eslint/eslint-plugin": "5.59.1",
-    "@typescript-eslint/parser": "5.59.1",
-    "@vue/compiler-sfc": "3.2.47",
+    "@typescript-eslint/eslint-plugin": "5.59.5",
+    "@typescript-eslint/parser": "5.59.5",
+    "@vue/compiler-sfc": "3.3.2",
     "c8": "7.13.0",
     "chai": "4.3.7",
     "chai-json-schema": "1.5.1",
     "coffeescript": "2.7.0",
-    "eslint": "8.39.0",
+    "eslint": "8.40.0",
     "eslint-config-moving-meadow": "4.0.2",
     "eslint-config-prettier": "8.8.0",
     "eslint-plugin-budapestian": "5.0.1",
@@ -194,7 +194,7 @@
     "eslint-plugin-mocha": "10.1.0",
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-security": "1.7.1",
-    "eslint-plugin-unicorn": "^46.0.0",
+    "eslint-plugin-unicorn": "^47.0.0",
     "husky": "8.0.3",
     "intercept-stdout": "0.1.2",
     "lint-staged": "13.2.2",
@@ -204,7 +204,7 @@
     "prettier": "2.8.8",
     "proxyquire": "2.1.3",
     "shx": "0.3.4",
-    "svelte": "3.58.0",
+    "svelte": "3.59.1",
     "symlink-dir": "5.1.1",
     "typescript": "5.0.4",
     "upem": "7.3.2",

package/src/enrich/summarize/summarize-options.js

@@ -26,10 +26,10 @@ const SHAREABLE_OPTIONS = [
   "reaches",
   "reporterOptions",
   "rulesFile",
+  "tsConfig",
   "tsPreCompilationDeps",
   "webpackConfig",
   // "progress", TODO: could be enabled
-  // "tsConfig", TODO: should be enabled
 ];
 
 function makeOptionsPresentable(pOptions) {

package/src/meta.js

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

package/src/report/null.js

@@ -1,5 +1,5 @@
 /**
- * Returns the results of a cruise in JSON
+ *  Returns the results of a cruise _only_ in an exitCode
  *
  * @param {import("../../types/cruise-result").ICruiseResult} pResults
  * @returns {import("../../types/dependency-cruiser").IReporterOutput}

package/types/cruise-result.d.ts

@@ -358,51 +358,8 @@ export interface IOptions extends ICruiseOptions {
    * The rules file used to validate the dependencies (if any)
    */
   rulesFile?: string;
-  /**
-   * The TypeScript configuration file used (if any)
-   */
-  tsConfig?: ITsConfig;
-  /**
-   * The webpack configuration options used for the cruise
-   */
-  webpackConfig?: IWebpackConfig;
-  /**
-   * The Babel configuration file used (if any)
-   */
-  babelConfig?: IBabelConfig;
 }
 
-export interface ITsConfig {
-  fileName?: string;
-}
-
-export interface IBabelConfig {
-  fileName?: string;
-}
-
-/**
- * The webpack configuration options used for the cruise
- */
-export interface IWebpackConfig {
-  /**
-   * The arguments used
-   */
-  arguments?: { [key: string]: any };
-  /**
-   * The 'env' parameters passed
-   */
-  env?: WebpackEnvType;
-  /**
-   * The name of the webpack configuration file used
-   */
-  fileName?: string;
-}
-
-/**
- * The 'env' parameters passed
- */
-export type WebpackEnvType = { [key: string]: any } | string;
-
 export interface IFolderDependency {
   /**
    * the (resolved) name of the dependency

package/types/dependency-cruiser.d.ts

@@ -124,7 +124,7 @@ export function futureCruise(
  * Given a cruise result, formats it with the given reporter (pOutputType)
  *
  * @param pResult     A javascript object that contains the result of a cruise. Must adhere
- *                    to the [dependency-cruiser results schema](https://github.com/sverweij/dependency-cruiser/blob/develop/src/schema/cruise-result.json)
+ *                    to the [dependency-cruiser results schema](https://github.com/sverweij/dependency-cruiser/blob/v12/src/schema/cruise-result.json)
  * @param pOutputType Which reporter to use to format the cruise result with
  */
 export function format(

package/types/options.d.ts

@@ -19,6 +19,37 @@ export type ProgressType =
   | "ndjson"
   | "none";
 
+export interface ITsConfig {
+  fileName?: string;
+}
+
+export interface IBabelConfig {
+  fileName?: string;
+}
+
+/**
+ * The 'env' parameters passed to webpack, if any
+ */
+export type WebpackEnvType = { [key: string]: any } | string;
+
+/**
+ * The webpack configuration options used for the cruise
+ */
+export interface IWebpackConfig {
+  /**
+   * The arguments used
+   */
+  arguments?: { [key: string]: any };
+  /**
+   * The 'env' parameters passed
+   */
+  env?: WebpackEnvType;
+  /**
+   * The name of the webpack configuration file used
+   */
+  fileName?: string;
+}
+
 export interface ICruiseOptions {
   /**
    * if true, will attempt to validate with the rules in ruleSet.
@@ -175,7 +206,7 @@ export interface ICruiseOptions {
   /*
    * List of strings you have in use in addition to cjs/ es6 requires
    * & imports to declare module dependencies. Use this e.g. if you've
-   * redeclared require (`const want = require`), use a require-wrapper
+   * re-declared require (`const want = require`), use a require-wrapper
    * (like semver-try-require) or use window.require as a hack
    *
    * Defaults to `[]`
@@ -186,6 +217,31 @@ export interface ICruiseOptions {
    */
   reporterOptions?: IReporterOptions;
 
+  /**
+   * TypeScript project file ('tsconfig.json') to use for (1) compilation
+   * and (2) resolution (e.g. with the paths property)",
+   */
+  tsConfig?: ITsConfig;
+
+  /**
+   * Webpack configuration to use to get resolve options from
+   */
+  webpackConfig?: IWebpackConfig;
+
+  /**
+   * Babel configuration (e.g. '.babelrc.json') to use.
+   */
+  babelConfig?: IBabelConfig;
+
+  /**
+   * Overrides the parser dependency-cruiser will use - EXPERIMENTAL
+   *
+   * Note that you'll _very_ likely not need this - dependency-cruiser will
+   * typically sort out what the best parser for the job is out of the ones
+   * available
+   */
+  parser?: "acorn" | "tsc" | "swc";
+
   /**
    * Options used in module resolution that for dependency-cruiser's
    * use cannot go in a webpack config.
@@ -218,6 +274,18 @@ export interface ICruiseOptions {
      * tsconfig contains paths/ aliases.
      */
     extensions?: string[];
+    /**
+     * A list of main fields in manifests (package.json s). Typically you'd want
+     * to keep leave this this on its default (['main']) , but if you e.g. use
+     * external packages that only expose types, and you still want references
+     * to these types to be resolved you could expand this to ['main', 'types']
+     */
+    mainFields?: string[];
+    /**
+     * A list of files to consider 'main' files, defaults to ['index']. Only set
+     * this when you have really special needs that warrant it.
+     */
+    mainFiles?: string[];
     /**
      * Options to pass to the resolver (webpack's 'enhanced resolve') regarding
      * caching.
@@ -240,6 +308,7 @@ export interface ICruiseOptions {
       cacheDuration: number;
     };
   };
+
   /**
    * Whether or not to show progress feedback when the command line
    * app is running.
@@ -259,11 +328,13 @@ export interface ICruiseOptions {
      */
     maximumLevel?: -1 | 40 | 50 | 60 | 70 | 80 | 99;
   };
+
   /**
    * When this flag is set to true, dependency-cruiser will calculate (stability) metrics
    * for all modules and folders. Defaults to false.
    */
   metrics?: boolean;
+
   /**
    * - false: don't use caching.
    * - true or empty object: use caching with the default settings

package/types/reporter-options.d.ts

@@ -60,7 +60,7 @@ export interface IAnonReporterOptions {
    * patterned after the original file name in stead. The list is empty
    * by default.
    *
-   * Read more in https://github.com/sverweij/dependency-cruiser/blob/develop/doc/cli.md#anon---obfuscated-json",
+   * Read more in https://github.com/sverweij/dependency-cruiser/blob/v12/doc/cli.md#anon---obfuscated-json",
    */
   wordlist?: string[];
 }