dependency-cruiser 17.0.0 → 17.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "17.0.0",
+  "version": "17.0.1",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",
@@ -158,7 +158,6 @@
     "rechoir": "^0.8.0",
     "safe-regex": "^2.1.1",
     "semver": "^7.7.2",
-    "teamcity-service-messages": "^0.1.14",
     "tsconfig-paths-webpack-plugin": "^4.2.0",
     "watskeburt": "^4.2.3"
   },

package/src/meta.cjs

@@ -1,7 +1,7 @@
 /* generated - don't edit */
 
 module.exports = {
-  version: "17.0.0",
+  version: "17.0.1",
   engines: {
     node: "^20.12||^22||>=24",
   },

package/src/report/teamcity.mjs

@@ -1,6 +1,100 @@
-import tsm from "teamcity-service-messages";
+import { randomInt } from "node:crypto";
+import memoize, { memoizeClear } from "memoize";
+
 import { formatPercentage, formatViolation } from "./utl/index.mjs";
 
+/**
+ * Escape string for TeamCity output.
+ * @see https://confluence.jetbrains.com/display/TCD65/Build+Script+Interaction+with+TeamCity#BuildScriptInteractionwithTeamCity-servMsgsServiceMessages
+ * Copied from https://github.com/pifantastic/teamcity-service-messages/blob/master/lib/message.js#L72
+ *
+ * @param  {String} pMessageString the string to escape
+ * @return {String}
+ */
+function escape(pMessageString) {
+  if (pMessageString === null) {
+    return "";
+  }
+
+  return (
+    pMessageString
+      .toString()
+      .replace(/\|/g, "||")
+      .replace(/\n/g, "|n")
+      .replace(/\r/g, "|r")
+      .replace(/\[/g, "|[")
+      .replace(/\]/g, "|]")
+      // next line
+      .replace(/\u0085/g, "|x")
+      // line separator
+      .replace(/\u2028/g, "|l")
+      // paragraph separator
+      .replace(/\u2029/g, "|p")
+      .replace(/'/g, "|'")
+  );
+}
+
+/**
+ * Returns a random flowId consisting of 10 numeric digits. TeamCity doesn't
+ * currently seem to have demands on the format (it's just a string as far
+ * as I can tell), but this is what teamcity-service-messages used, so as
+ * per the rule of least surprise, this is what we use.
+ *
+ * @return {string} a random flowId consisting of 10 numeric digits
+ */
+function getRandomFlowIdBare() {
+  const lFlowIdLength = 10;
+  // eslint-disable-next-line no-magic-numbers
+  const lFlowIdMax = 10 ** lFlowIdLength;
+
+  return randomInt(1, lFlowIdMax).toString().padStart(lFlowIdLength, "0");
+}
+
+const getRandomFlowId = memoize(getRandomFlowIdBare);
+
+/**
+ * Returns a timestamp in ISO format without the trailing 'Z'. It used to be
+ * an issue with TeamCity that it didn't use the trailing 'Z' (this is
+ * documented in the teamcity-service-messages source code) - not sure whether
+ * this is still the case, but this is what we do to be on the safe side.
+ *
+ * @returns {string} a timestamp in ISO format without the trailing 'Z'
+ */
+function getTimeStamp() {
+  return new Date().toISOString().slice(0, -1);
+}
+
+function inspectionType(pData) {
+  const lAttributes = [];
+  lAttributes.push(
+    `id='${pData.id}'`,
+    `name='${pData.name}'`,
+    `description='${escape(pData.description)}'`,
+    `category='${pData.category}'`,
+    `flowId='${getRandomFlowId()}'`,
+    `timestamp='${getTimeStamp()}'`,
+  );
+  return `##teamcity[inspectionType ${lAttributes.join(" ")}]`;
+}
+
+function inspection(pData) {
+  const lAttributes = [];
+  lAttributes.push(
+    `typeId='${pData.typeId}'`,
+    `message='${escape(pData.message)}'`,
+  );
+  if (pData.file) {
+    lAttributes.push(`file='${pData.file}'`);
+  }
+  lAttributes.push(
+    `SEVERITY='${pData.SEVERITY}'`,
+    `flowId='${getRandomFlowId()}'`,
+    `timestamp='${getTimeStamp()}'`,
+  );
+
+  return `##teamcity[inspection ${lAttributes.join(" ")}]`;
+}
+
 const CATEGORY = "dependency-cruiser";
 const SEVERITY2TEAMCITY_SEVERITY = new Map([
   ["error", "ERROR"],
@@ -19,7 +113,7 @@ function reportRules(pRules, pViolations) {
       pViolations.some((pViolation) => pRule.name === pViolation.rule.name),
     )
     .map((pRule) =>
-      tsm.inspectionType({
+      inspectionType({
         id: pRule.name,
         name: pRule.name,
         description: pRule.comment || pRule.name,
@@ -35,7 +129,7 @@ function reportAllowedRule(pAllowedRule, pViolations) {
     pAllowedRule.length > 0 &&
     pViolations.some((pViolation) => pViolation.rule.name === "not-in-allowed")
   ) {
-    lReturnValue = tsm.inspectionType({
+    lReturnValue = inspectionType({
       id: "not-in-allowed",
       name: "not-in-allowed",
       description: "dependency is not in the 'allowed' set of rules",
@@ -49,7 +143,7 @@ function reportIgnoredRules(pIgnoredCount) {
   let lReturnValue = [];
 
   if (pIgnoredCount > 0) {
-    lReturnValue = tsm.inspectionType({
+    lReturnValue = inspectionType({
       id: "ignored-known-violations",
       name: "ignored-known-violations",
       description:
@@ -114,7 +208,7 @@ function reportIgnoredViolation(pIgnoredCount) {
   let lReturnValue = [];
 
   if (pIgnoredCount > 0) {
-    lReturnValue = tsm.inspection({
+    lReturnValue = inspection({
       typeId: "ignored-known-violations",
       message: `${pIgnoredCount} known violations ignored. Run with --no-ignore-known to see them.`,
       SEVERITY: "WARNING",
@@ -126,7 +220,7 @@ function reportIgnoredViolation(pIgnoredCount) {
 function reportViolations(pViolations, pIgnoredCount) {
   return pViolations
     .map((pViolation) =>
-      tsm.inspection({
+      inspection({
         typeId: pViolation.rule.name,
         message: bakeViolationMessage(pViolation),
         file: pViolation.from,
@@ -138,21 +232,17 @@ function reportViolations(pViolations, pIgnoredCount) {
 
 /**
  * Returns a bunch of TeamCity service messages:
- * - for each violated rule in the passed results: an `inspectionType` with the name and comment of that rule
- * - for each violation in the passed results: an `inspection` with the violated rule name and the tos and froms
+ * - for each violated rule in the passed results: an `inspectionType` with the
+ *   name and comment of that rule
+ * - for each violation in the passed results: an `inspection` with the
+ *   violated rule name and the tos and froms
  *
  * @param {import("../../types/dependency-cruiser.js").ICruiseResult} pResults
  * @returns {import("../../types/dependency-cruiser.js").IReporterOutput}
  */
 // eslint-disable-next-line complexity
 export default function teamcity(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
-  tsm.stdout = false;
+  memoizeClear(getRandomFlowId);
 
   const lRuleSet = pResults?.summary?.ruleSetUsed ?? [];
   const lViolations = (pResults?.summary?.violations ?? []).filter(

package/types/shared-types.d.mts

@@ -2,10 +2,6 @@
 export type ModuleSystemType = "cjs" | "amd" | "es6" | "tsd";
 
 // cruise options, dependency-cruiser
-/* as we don't care about types beyond code completion, we ignore the
- * eslint warning that the 'string' type is redundant here.
- */
-/* eslint-disable @typescript-eslint/no-redundant-type-constituents */
 export type OutputType =
   | "json"
   | "html"
@@ -29,7 +25,7 @@ export type OutputType =
   | "null"
   // for plugins: string. TODO: research whether it's possible to
   // tie this down to the `^plugin:[^:]+-reporter-plugin.[cm]?js$` regex
-  | string;
+  | (string & {}); // autocompletion hack
 
 export type SeverityType = "error" | "warn" | "info" | "ignore";