@diplodoc/yfmlint 1.3.4 → 1.4.0

package/README.md

@@ -1,4 +1,9 @@
 [![NPM version](https://img.shields.io/npm/v/@diplodoc/yfmlint.svg?style=flat)](https://www.npmjs.org/package/@diplodoc/yfmlint)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=diplodoc-platform_yfmlint&metric=alert_status)](https://sonarcloud.io/summary/overall?id=diplodoc-platform_yfmlint)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=diplodoc-platform_yfmlint&metric=coverage)](https://sonarcloud.io/summary/overall?id=diplodoc-platform_yfmlint)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=diplodoc-platform_yfmlint&metric=sqale_rating)](https://sonarcloud.io/summary/overall?id=diplodoc-platform_yfmlint)
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=diplodoc-platform_yfmlint&metric=reliability_rating)](https://sonarcloud.io/summary/overall?id=diplodoc-platform_yfmlint)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=diplodoc-platform_yfmlint&metric=security_rating)](https://sonarcloud.io/summary/overall?id=diplodoc-platform_yfmlint)
 
 # YFM syntax linter
 

package/build/index.js

@@ -21483,6 +21483,41 @@ var yfm001 = {
 };
 
 // src/rules/helpers.ts
+function validateLineNumberAndGetFilePath(params2, rawLineNumber) {
+  const linesCount = params2.lines.length;
+  const lineNumber = Math.min(Math.max(1, rawLineNumber || 1), linesCount);
+  const env = params2.parsers.markdownit.env;
+  const filePath = (env == null ? void 0 : env.path) || params2.name;
+  return { lineNumber, filePath };
+}
+function resolveIncludeSource(params2, rawLineNumber, token, parentToken) {
+  var _a, _b, _c, _d;
+  const sourceFile = ((_a = token == null ? void 0 : token.meta) == null ? void 0 : _a.sourceFile) || ((_b = parentToken == null ? void 0 : parentToken.meta) == null ? void 0 : _b.sourceFile);
+  const includeChain = ((_c = token == null ? void 0 : token.meta) == null ? void 0 : _c.includeChain) || ((_d = parentToken == null ? void 0 : parentToken.meta) == null ? void 0 : _d.includeChain);
+  if (!sourceFile || !(includeChain == null ? void 0 : includeChain.length)) {
+    return null;
+  }
+  const mainFileLine = includeChain[0].line;
+  const lineNumber = Math.min(Math.max(1, mainFileLine), params2.lines.length);
+  return {
+    lineNumber,
+    sourceFile,
+    sourceLineNumber: rawLineNumber || 1,
+    includeChain
+  };
+}
+function formatIncludeChain(info, brokenTarget) {
+  const parts = info.includeChain.map((entry) => `${entry.file}:${entry.line}`);
+  parts.push(`${info.sourceFile}:${info.sourceLineNumber}`);
+  return `${parts.join(" \u2192 ")} \u219B ${brokenTarget}`;
+}
+function createContextWithFileInfo(baseContext, filePath, paramsName) {
+  const parts = [baseContext];
+  if (filePath !== paramsName) {
+    parts.push(`File: ${filePath}`);
+  }
+  return parts.filter(Boolean).join("; ");
+}
 function findLinksInInlineTokens(params2, ruleName, onError, handler) {
   params2.parsers.markdownit.tokens.filter((token) => token.type === "inline").forEach((inline) => {
     var _a;
@@ -21492,10 +21527,29 @@ function findLinksInInlineTokens(params2, ruleName, onError, handler) {
         if (handler) {
           handler(linkToken, inline);
         } else {
-          onError({
-            lineNumber: link.lineNumber || inline.lineNumber,
-            context: link.line || inline.line
-          });
+          const rawLineNumber = link.lineNumber || inline.lineNumber;
+          const includeSource = resolveIncludeSource(
+            params2,
+            rawLineNumber,
+            link,
+            inline
+          );
+          if (includeSource) {
+            const href = linkToken.attrGet("href") || "";
+            const context = formatIncludeChain(includeSource, href);
+            onError({ lineNumber: includeSource.lineNumber, context });
+          } else {
+            const { lineNumber, filePath } = validateLineNumberAndGetFilePath(
+              params2,
+              rawLineNumber
+            );
+            const context = createContextWithFileInfo(
+              link.line || inline.line,
+              filePath,
+              params2.name
+            );
+            onError({ lineNumber, context });
+          }
         }
       }
     });
@@ -21510,10 +21564,29 @@ function findImagesInInlineTokens(params2, ruleName, onError, handler) {
         if (handler) {
           handler(imageToken, inline);
         } else {
-          onError({
-            lineNumber: image.lineNumber || inline.lineNumber,
-            context: image.line || inline.line
-          });
+          const rawLineNumber = image.lineNumber || inline.lineNumber;
+          const includeSource = resolveIncludeSource(
+            params2,
+            rawLineNumber,
+            image,
+            inline
+          );
+          if (includeSource) {
+            const src = imageToken.attrGet("src") || "";
+            const context = formatIncludeChain(includeSource, src);
+            onError({ lineNumber: includeSource.lineNumber, context });
+          } else {
+            const { lineNumber, filePath } = validateLineNumberAndGetFilePath(
+              params2,
+              rawLineNumber
+            );
+            const context = createContextWithFileInfo(
+              image.line || inline.line,
+              filePath,
+              params2.name
+            );
+            onError({ lineNumber, context });
+          }
         }
       }
     });
@@ -21570,15 +21643,27 @@ var yfm003 = {
       const reason = linkToken.attrGet("YFM003");
       if (reason) {
         const reasonDescription = typeof reason === "string" && REASON_DESCRIPTION[reason] ? `Reason: ${REASON_DESCRIPTION[reason]}` : "";
-        const context = [
-          `Unreachable link: "${linkToken.attrGet("href")}"`,
-          reasonDescription,
-          `Line: ${linkToken.lineNumber || inline.lineNumber}`
-        ].filter(Boolean).join("; ");
-        onError({
-          lineNumber: linkToken.lineNumber || inline.lineNumber,
-          context
-        });
+        const rawLineNumber = linkToken.lineNumber || inline.lineNumber;
+        const href = linkToken.attrGet("href") || "";
+        const includeSource = resolveIncludeSource(
+          params2,
+          rawLineNumber,
+          linkToken,
+          inline
+        );
+        if (includeSource) {
+          const chain = formatIncludeChain(includeSource, href);
+          const context = [chain, reasonDescription].filter(Boolean).join("; ");
+          onError({ lineNumber: includeSource.lineNumber, context });
+        } else {
+          const { lineNumber } = validateLineNumberAndGetFilePath(params2, rawLineNumber);
+          const context = [
+            `Unreachable link: "${href}"`,
+            reasonDescription,
+            `Line: ${rawLineNumber}`
+          ].filter(Boolean).join("; ");
+          onError({ lineNumber, context });
+        }
       }
     });
   }
@@ -21739,12 +21824,23 @@ var yfm010 = {
     if (!config) {
       return;
     }
-    findLinksInInlineTokens(params2, "YFM010", onError, (linkToken) => {
-      const autotitleAnchorError = `[Unreachable autotitle anchor: "${linkToken.attrGet("href")}"]`;
-      onError({
-        lineNumber: linkToken.lineNumber,
-        context: autotitleAnchorError + " " + (linkToken.line || "")
-      });
+    findLinksInInlineTokens(params2, "YFM010", onError, (linkToken, inline) => {
+      const href = linkToken.attrGet("href") || "";
+      const rawLineNumber = linkToken.lineNumber || inline.lineNumber;
+      const includeSource = resolveIncludeSource(
+        params2,
+        rawLineNumber,
+        linkToken,
+        inline
+      );
+      if (includeSource) {
+        const context = formatIncludeChain(includeSource, href);
+        onError({ lineNumber: includeSource.lineNumber, context });
+      } else {
+        const { lineNumber } = validateLineNumberAndGetFilePath(params2, rawLineNumber);
+        const context = `Unreachable autotitle anchor: "${href}"; Line: ${rawLineNumber}`;
+        onError({ lineNumber, context });
+      }
     });
   }
 };