dependency-cruiser 13.0.4 → 13.1.0-beta-1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "13.0.4",
+  "version": "13.1.0-beta-1",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",
@@ -154,11 +154,11 @@
     "acorn-loose": "8.3.0",
     "acorn-walk": "8.2.0",
     "ajv": "8.12.0",
-    "chalk": "5.2.0",
+    "chalk": "5.3.0",
     "commander": "11.0.0",
     "enhanced-resolve": "5.15.0",
     "figures": "5.0.0",
-    "glob": "10.2.7",
+    "glob": "10.3.1",
     "handlebars": "4.7.7",
     "ignore": "5.2.4",
     "indent-string": "5.0.0",
@@ -169,8 +169,8 @@
     "prompts": "2.4.2",
     "rechoir": "^0.8.0",
     "safe-regex": "2.1.1",
-    "semver": "^7.5.2",
-    "semver-try-require": "6.2.2",
+    "semver": "^7.5.3",
+    "semver-try-require": "6.2.3",
     "teamcity-service-messages": "0.1.14",
     "tsconfig-paths-webpack-plugin": "4.0.1",
     "watskeburt": "0.11.5",
@@ -180,18 +180,18 @@
     "@babel/core": "7.22.5",
     "@babel/plugin-transform-modules-commonjs": "7.22.5",
     "@babel/preset-typescript": "7.22.5",
-    "@swc/core": "1.3.66",
+    "@swc/core": "1.3.67",
     "@types/lodash": "4.14.195",
-    "@types/node": "20.3.1",
+    "@types/node": "20.3.3",
     "@types/prompts": "2.4.4",
-    "@typescript-eslint/eslint-plugin": "5.60.0",
-    "@typescript-eslint/parser": "5.60.0",
+    "@typescript-eslint/eslint-plugin": "5.60.1",
+    "@typescript-eslint/parser": "5.60.1",
     "@vue/compiler-sfc": "3.3.4",
     "c8": "8.0.0",
     "chai": "4.3.7",
     "chai-json-schema": "1.5.1",
     "coffeescript": "2.7.0",
-    "eslint": "8.43.0",
+    "eslint": "8.44.0",
     "eslint-config-moving-meadow": "4.0.2",
     "eslint-config-prettier": "8.8.0",
     "eslint-plugin-budapestian": "5.0.1",
@@ -203,7 +203,7 @@
     "eslint-plugin-unicorn": "^47.0.0",
     "husky": "8.0.3",
     "intercept-stdout": "0.1.2",
-    "lint-staged": "13.2.2",
+    "lint-staged": "13.2.3",
     "mocha": "10.2.0",
     "normalize-newline": "4.1.0",
     "npm-run-all": "4.1.5",
@@ -212,11 +212,17 @@
     "shx": "0.3.4",
     "svelte": "3.59.1",
     "symlink-dir": "5.1.1",
-    "typescript": "5.1.3",
+    "typescript": "5.1.6",
     "upem": "8.0.0",
     "vue-template-compiler": "2.7.14",
     "yarn": "1.22.19"
   },
+  "overrides": {
+    "semver": "^7.5.3"
+  },
+  "resolutions": {
+    "semver": "^7.5.3"
+  },
   "upem": {
     "policies": [
       {
@@ -228,6 +234,11 @@
         "package": "rechoir",
         "policy": "wanted",
         "because": "we want to keep rechoir ~similar to what webpack-cli uses (which is ^0.8.0 since 2022-11-15). See https://github.com/webpack/webpack-cli/blame/master/packages/webpack-cli/package.json"
+      },
+      {
+        "package": "svelte",
+        "policy": "pin",
+        "because": "upgrading to supporting svelte 4 will require a non-trivial amount of labour (which we are going to invest, but not right now)"
       }
     ]
   },

package/src/main/resolve-options/normalize.mjs

@@ -1,11 +1,10 @@
 import fs from "node:fs";
-import has from "lodash/has.js";
-import omit from "lodash/omit.js";
 import enhancedResolve from "enhanced-resolve";
+import omit from "lodash/omit.js";
 import { scannableExtensions } from "../../extract/transpile/meta.mjs";
 import {
-  ruleSetHasLicenseRule,
   ruleSetHasDeprecationRule,
+  ruleSetHasLicenseRule,
 } from "../../graph-utl/rule-set.mjs";
 
 const DEFAULT_CACHE_DURATION = 4000;
@@ -63,10 +62,7 @@ function pushPlugin(pPlugins, pPluginToPush) {
   return (pPlugins || []).concat(pPluginToPush);
 }
 
-function isTsConfigPathsEligible(pTSConfig) {
-  return has(pTSConfig, "options.baseUrl");
-}
-
+// eslint-disable-next-line max-lines-per-function
 async function compileResolveOptions(
   pResolveOptions,
   pTSConfig,
@@ -74,16 +70,12 @@ async function compileResolveOptions(
 ) {
   let lResolveOptions = {};
 
-  // TsConfigPathsPlugin requires a baseUrl to be present in the tsconfig,
-  // otherwise it prints scary messages that it didn't and read the tsConfig
-  // (potentially making users think it's dependency-cruiser disregarding the
-  // tsconfig). Hence: only load TsConfigPathsPlugin when an options.baseUrl exists
-  // Also: there's a performance impact of ~1 ms per resolve even when there
+  // There's a performance impact of ~1 ms per resolve even when there
   // are 0 paths in the tsconfig, so not loading it when not necessary
   // will be a win.
   // Also: requiring the plugin only when it's necessary will save some
   // startup time (especially on a cold require cache)
-  if (pResolveOptions.tsConfig && isTsConfigPathsEligible(pTSConfig)) {
+  if (pResolveOptions.tsConfig) {
     const { default: TsConfigPathsPlugin } = await import(
       "tsconfig-paths-webpack-plugin"
     );
@@ -92,6 +84,29 @@ async function compileResolveOptions(
       // @ts-expect-error TS2351 "TsConfPathsPlugin is not constructable" - is unjustified
       new TsConfigPathsPlugin({
         configFile: pResolveOptions.tsConfig,
+        // TsConfigPathsPlugin requires a baseUrl to be present in the tsconfig,
+        // otherwise it prints scary messages that it didn't and read the tsConfig
+        // (potentially making users think it's dependency-cruiser disregarding the
+        // tsconfig). Hence up till version 13.0.4 dependency-cruiser only loaded
+        // TsConfigPathsPlugin when an options.baseUrl existed. However, this
+        // isn't necessary anymore:
+        // - [tsconfig#baseUrl documentation](https://www.typescriptlang.org/tsconfig#baseUrl)
+        //   UNrecommends the use of the baseUrl for non-AMD projects
+        // - [tsconfig-paths PR #207](https://github.com/dividab/tsconfig-paths/pull/208)
+        //   'tolerates' undefined baseUrls
+        //
+        // Hence, until
+        // [tpwp issue #99](https://github.com/dividab/tsconfig-paths-webpack-plugin/issues/99)
+        // lands:
+        // - pass a default baseUrl to TsConfigPathsPlugin if the baseUrl isn't available
+        // - pass undefined in all other cases; TsConfigPathsPlugin will read
+        //   it from the tsconfig.json in that case. Passing the processed baseUrl
+        //   (pTSConfig?.options?.baseUrl) instead would've been more obvious, but
+        //   doesn't work, as that is an absolute path and tsconfig-paths(-wpp)
+        //   seems to process that again resulting in invalid paths and unresolved
+        //   or erroneous dependencies
+        // eslint-disable-next-line no-undefined
+        baseUrl: pTSConfig?.options?.baseUrl ? undefined : "./",
         // TsConfigPathsPlugin doesn't (can't) read enhanced-resolve's
         // list of extensions, and the default it uses for extensions
         // so we do it ourselves - either with the extensions passed

package/src/meta.js

@@ -1,7 +1,7 @@
 /* generated - don't edit */
 
 module.exports = {
-  version: "13.0.4",
+  version: "13.1.0-beta-1",
   engines: {
     node: "^16.14||>=18",
   },

package/src/report/azure-devops.mjs

@@ -0,0 +1,103 @@
+/*
+Message grouping
+##[group]Beginning of a group
+##[warning]Warning message
+##[error]Error message
+##[section]Start of a section
+##[debug]Debug text
+##[command]Command-line being run
+##[endgroup]
+
+Warnings and errors:
+
+##vso[task.logissue type=warning;sourcepath=consoleapp/main.cs;linenumber=1;columnnumber=1;code=100;]Found something that could be a problem.
+
+Progress
+##vso[task.setprogress]current operation
+
+Complete
+##vso[task.complete]current operation
+*/
+
+import { EOL } from "node:os";
+
+const SEVERITY2VSO_TYPE = new Map([
+  // "error" | "warn" | "info" | "ignore
+  ["error", "error"],
+  ["warn", "warning"],
+  // azure devops doesn't seem to understand 'info'. We still want to
+  // show them, though, hence:
+  ["info", "warning"],
+]);
+
+/**
+ *
+ * @param {import("../../types/shared-types.js").SeverityType} pSeverity
+ */
+function formatSeverity(pSeverity) {
+  return SEVERITY2VSO_TYPE.get(pSeverity) ?? "warning";
+}
+
+/**
+ *
+ * @param {import("../../types/violations.js").IViolation} pViolation
+ */
+function formatViolation(pViolation) {
+  return `##vso[task.logissue type=${formatSeverity(
+    pViolation.rule.severity
+  )};sourcepath=${pViolation.from}]${pViolation.rule.name}`;
+}
+
+/**
+ *
+ * @param {number} pNumberOfErrors
+ * @returns
+ */
+function formatSuccess(pNumberOfErrors) {
+  return pNumberOfErrors === 0 ? "Succeeded" : "Failed";
+}
+
+/**
+ *
+ * @param {import("../../types/cruise-result.js").ISummary} pSummary
+ */
+function formatSummary(pSummary) {
+  return `##vso[task.complete result=${formatSuccess(pSummary.error)};] ${
+    pSummary.totalCruised
+  } modules, ${pSummary.totalDependenciesCruised} dependencies cruised`;
+}
+
+/**
+ * Returns a bunch of Azure DevOps log messages:
+ * - for each violated rule in the passed results: gnork
+ * - for each violation in the passed results: bork
+ *
+ * https://learn.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands?view=azure-devops&tabs=bash#task-commands
+ *
+ * @param {import("../../types/dependency-cruiser.js").ICruiseResult} pResults
+ * @returns {import("../../types/dependency-cruiser.js").IReporterOutput}
+ */
+// eslint-disable-next-line unicorn/prevent-abbreviations
+export default function azureDevOps(pResults) {
+  // this is the documented way to get tsm to emit strings
+  // Alternatively we could've used the 'low level API', which
+  // involves creating new `Message`s and stringifying those.
+  // The abstraction of the 'higher level API' makes this
+  // reporter more easy to implement and maintain, despite
+  // setting this property directly
+
+  const lViolations = (pResults?.summary?.violations ?? []).filter(
+    (pViolation) => pViolation.rule.severity !== "ignore"
+  );
+  const lIgnoredCount = pResults?.summary?.ignore ?? 0;
+
+  return {
+    output: lViolations
+      .map(formatViolation)
+      .join(EOL)
+      .concat(EOL)
+      .concat(formatSummary(pResults.summary))
+      .concat(EOL),
+    exitCode: pResults.summary.error,
+  };
+}

package/src/report/index.mjs

@@ -21,6 +21,7 @@ const TYPE2MODULE = {
   metrics: "./metrics.mjs",
   mermaid: "./mermaid.mjs",
   null: "./null.mjs",
+  "azure-devops": "./azure-devops.mjs",
 };
 
 /**