@mintlify/link-rot 3.0.1603 → 3.0.1605

package/dist/graph.d.ts

@@ -24,6 +24,7 @@ export declare class MdxPath {
     relativeDir: string;
     filename: string;
     wrapper?: Wrapper | undefined;
+    line?: number | undefined;
     path: ParsedPath | URL;
     pathType: PathType;
     anchorLink?: string;
@@ -34,7 +35,7 @@ export declare class MdxPath {
      * Generate all the computed fields in an MdxPath
      */
     private constructParsedPath;
-    constructor(originalPath: string, relativeDir?: string, filename?: string, wrapper?: Wrapper | undefined);
+    constructor(originalPath: string, relativeDir?: string, filename?: string, wrapper?: Wrapper | undefined, line?: number | undefined);
     toString(): string;
     getResolvedFiles(fileIndex: FileIndex, baseDir: string): string[];
     resolvesTo(node: Node, fileIndex: FileIndex, baseDir: string): boolean;
@@ -56,7 +57,7 @@ export declare class Node {
     constructor(label: string, paths?: MdxPath[]);
     toString(): string;
     equals(other: Node): boolean;
-    addPath(originalPath: string, wrapper?: Wrapper): void;
+    addPath(originalPath: string, wrapper?: Wrapper, line?: number): void;
     addOutgoingEdge(edge: Edge): void;
     getChildNodes(depth?: number): Node[];
 }
@@ -108,6 +109,8 @@ export declare class Graph {
     getBrokenInternalLinks(options?: {
         checkAnchors?: boolean;
     }): MdxPath[];
+    getLinksTo(target: MdxPath): MdxPath[];
+    private getPageRoute;
     private getPageCandidates;
     private isPageRoute;
     private resolvesToValidPath;

package/dist/graph.js

@@ -3,7 +3,7 @@ import { getFileListWithDirectories } from '@mintlify/prebuild';
 import { existsSync } from 'fs';
 import { parse, join, resolve, dirname, basename } from 'path';
 import { sep as WINDOWS_SEPARATOR } from 'path/win32';
-import { getLinkPaths, normalizePath, removeSelectors } from './prebuild.js';
+import { getLinkPaths, isValidPage, normalizePath, removeFileExtension, removeSelectors, } from './prebuild.js';
 export var PathType;
 (function (PathType) {
     PathType["INTERNAL"] = "internal";
@@ -91,11 +91,12 @@ export class MdxPath {
         const queryParams = urlPath.searchParams;
         return { path, pathType, anchorLink, queryParams };
     }
-    constructor(originalPath, relativeDir = '', filename = '', wrapper) {
+    constructor(originalPath, relativeDir = '', filename = '', wrapper, line) {
         this.originalPath = originalPath;
         this.relativeDir = relativeDir;
         this.filename = filename;
         this.wrapper = wrapper;
+        this.line = line;
         this.pagePaths = [];
         this.relativeDir = normalizePath(relativeDir);
         const { path, pathType, anchorLink, queryParams } = this.constructParsedPath();
@@ -185,8 +186,8 @@ export class Node {
     equals(other) {
         return this.label === other.label;
     }
-    addPath(originalPath, wrapper) {
-        const path = new MdxPath(originalPath, this.relativeDir, this.filename, wrapper);
+    addPath(originalPath, wrapper, line) {
+        const path = new MdxPath(originalPath, this.relativeDir, this.filename, wrapper, line);
         this.paths.push(path);
     }
     addOutgoingEdge(edge) {
@@ -458,6 +459,23 @@ export class Graph {
             (path.pagePaths.length === 0 ||
                 path.pagePaths.some((pagePath) => brokenLinks.has(pagePath))));
     }
+    getLinksTo(target) {
+        const targetPage = this.getPageRoute(target.toString());
+        const pointsAtTarget = (path) => path.pathType === PathType.INTERNAL &&
+            !path.originalPath.startsWith('#') &&
+            this.getPageRoute(path.toString()) === targetPage &&
+            (!target.anchorLink || path.anchorLink === target.anchorLink);
+        return Object.values(this.nodes)
+            .flatMap((node) => node.paths)
+            .filter((path) => pointsAtTarget(path) || path.pagePaths.some(pointsAtTarget));
+    }
+    getPageRoute(normalized) {
+        var _a;
+        const file = (_a = [...this.getPageCandidates(normalized), normalized].find((label) => this.nodes[label])) !== null && _a !== void 0 ? _a : normalized;
+        const parsed = parse(file);
+        const route = isValidPage(parsed) ? removeFileExtension(parsed) : file;
+        return basename(route) === 'index' ? dirname(route) : route;
+    }
     getPageCandidates(normalized) {
         // normalizePath('/') yields '.' — resolve lookups against node labels (which use
         // path.join, so `join('.', 'index.mdx') === 'index.mdx'`) rather than naive

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { buildGraph, decorateGraphNodeFromPageContent, getBrokenInternalLinks, } from './static-checking/getBrokenInternalLinks.js';
-export { Node, PathType } from './graph.js';
+export { MdxPath, Node, PathType } from './graph.js';
 export { getBrokenExternalLinks } from './static-checking/getBrokenExternalLinks.js';
 export type { ExternalLinkResult } from './static-checking/getBrokenExternalLinks.js';
 export { getFilesLinksDependOn } from './static-checking/resolveSnippetLinksFromRenderingPages.js';

package/dist/index.js

@@ -1,5 +1,5 @@
 export { buildGraph, decorateGraphNodeFromPageContent, getBrokenInternalLinks, } from './static-checking/getBrokenInternalLinks.js';
-export { Node, PathType } from './graph.js';
+export { MdxPath, Node, PathType } from './graph.js';
 export { getBrokenExternalLinks } from './static-checking/getBrokenExternalLinks.js';
 export { getFilesLinksDependOn } from './static-checking/resolveSnippetLinksFromRenderingPages.js';
 export { getBrokenRedirects } from './static-checking/getBrokenRedirects.js';

package/dist/static-checking/getBrokenInternalLinks.js

@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { cleanHeadingId, COMPONENTS_WITH_CLEANED_ID, COMPONENTS_WITHOUT_ID, coreRemark, generateParamFieldId, isMintIgnored, preprocessCustomHeadingIds, preprocessMdxFragmentCode, remarkComponentIds, remarkExtractTableOfContents, } from '@mintlify/common';
+import { cleanHeadingId, COMPONENTS_WITH_CLEANED_ID, COMPONENTS_WITHOUT_ID, coreRemark, customHeadingIdSourceLines, generateParamFieldId, isMintIgnored, preprocessCustomHeadingIds, preprocessMdxFragmentCode, remarkComponentIds, remarkExtractTableOfContents, } from '@mintlify/common';
 import { getMintIgnore } from '@mintlify/prebuild';
 import fs from 'fs-extra';
 import path from 'path';
@@ -84,30 +84,32 @@ export const decorateGraphNodeFromPageContent = (graphNode, content, options) =>
                     referenced.add(node.identifier);
             });
             visit(tree, (node) => {
-                var _a, _b;
+                var _a, _b, _c;
+                const parsedLine = (_a = node.position) === null || _a === void 0 ? void 0 : _a.start.line;
+                const line = parsedLine === undefined ? undefined : sourceLines[parsedLine - 1];
                 if (node.type === 'link' || node.type === 'image') {
-                    graphNode.addPath(node.url, Wrapper.MD);
+                    graphNode.addPath(node.url, Wrapper.MD, line);
                     return;
                 }
                 if (node.type === 'definition') {
                     if (referenced.delete(node.identifier))
-                        graphNode.addPath(node.url, Wrapper.MD);
+                        graphNode.addPath(node.url, Wrapper.MD, line);
                     return;
                 }
                 const mdxJsxFlowElement = node;
                 if (mdxJsxFlowElement.name === 'img' || mdxJsxFlowElement.name === 'source') {
                     const srcAttrIndex = mdxJsxFlowElement.attributes.findIndex((attr) => attr.type === 'mdxJsxAttribute' && attr.name === 'src');
-                    const nodeUrl = attributeString((_a = mdxJsxFlowElement.attributes[srcAttrIndex]) === null || _a === void 0 ? void 0 : _a.value);
+                    const nodeUrl = attributeString((_b = mdxJsxFlowElement.attributes[srcAttrIndex]) === null || _b === void 0 ? void 0 : _b.value);
                     if (typeof nodeUrl === 'string') {
-                        graphNode.addPath(nodeUrl, Wrapper.SRC);
+                        graphNode.addPath(nodeUrl, Wrapper.SRC, line);
                         return;
                     }
                 }
                 else if (mdxJsxFlowElement.name === 'a' || mdxJsxFlowElement.name === 'Card') {
                     const hrefAttrIndex = mdxJsxFlowElement.attributes.findIndex((attr) => attr.type === 'mdxJsxAttribute' && attr.name === 'href');
-                    const nodeUrl = attributeString((_b = mdxJsxFlowElement.attributes[hrefAttrIndex]) === null || _b === void 0 ? void 0 : _b.value);
+                    const nodeUrl = attributeString((_c = mdxJsxFlowElement.attributes[hrefAttrIndex]) === null || _c === void 0 ? void 0 : _c.value);
                     if (typeof nodeUrl === 'string') {
-                        graphNode.addPath(nodeUrl, Wrapper.HREF);
+                        graphNode.addPath(nodeUrl, Wrapper.HREF, line);
                         return;
                     }
                 }
@@ -117,7 +119,9 @@ export const decorateGraphNodeFromPageContent = (graphNode, content, options) =>
     };
     // Same pre-parse escaping as prebuild, so code fences inside `<MDX>` fragments
     // (`<project-root>`, `{id}`) aren't read as JSX and the page parses like it renders
-    const preprocessed = preprocessCustomHeadingIds(preprocessMdxFragmentCode(content));
+    const fragmentEscaped = preprocessMdxFragmentCode(content);
+    const preprocessed = preprocessCustomHeadingIds(fragmentEscaped);
+    const sourceLines = customHeadingIdSourceLines(fragmentEscaped);
     const processor = coreRemark()
         .use(remarkSmartypants)
         .use(visitLinks)