@mintlify/link-rot 3.0.4 → 3.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/link-rot",
-  "version": "3.0.4",
+  "version": "3.0.6",
   "description": "Static checking for broken internal links",
   "engines": {
     "node": ">=18.0.0"
@@ -27,6 +27,7 @@
     "registry": "https://registry.npmjs.org/"
   },
   "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "files": [
     "dist"
   ],
@@ -34,10 +35,12 @@
     "prepare": "npm run build",
     "build": "tsc",
     "watch": "tsc --watch",
-    "lint": "eslint . --cache"
+    "lint": "eslint . --cache",
+    "format": "prettier \"./src/**/*.ts\" --write",
+    "format:check": "prettier \"./src/**/*.ts\" --check"
   },
   "dependencies": {
-    "@mintlify/prebuild": "^1.0.0",
+    "@mintlify/prebuild": "1.0.9",
     "chalk": "^5.1.0",
     "fs-extra": "^11.1.0",
     "is-absolute-url": "^4.0.1",
@@ -50,7 +53,9 @@
   "devDependencies": {
     "@mintlify/eslint-config": "1.0.3",
     "@mintlify/eslint-config-typescript": "1.0.7",
+    "@mintlify/prettier-config": "1.0.1",
     "@mintlify/ts-config": "1.0.7",
+    "@trivago/prettier-plugin-sort-imports": "3.x",
     "@tsconfig/recommended": "1.x",
     "@types/fs-extra": "^9.0.13",
     "@types/mdast": "^3.0.10",
@@ -63,5 +68,6 @@
     "mdast-util-mdx-jsx": "^2.1.2",
     "prettier": "2.x",
     "typescript": "^4.8.2"
-  }
+  },
+  "gitHead": "1d442e3c32d9fc7f38dbe40396e3574f10de0f2d"
 }

package/dist/link-renaming/index.d.ts

@@ -1,2 +0,0 @@
-import { renameFileAndUpdateLinksInContent } from "./renameFileAndUpdateLinksInContent.js";
-export default renameFileAndUpdateLinksInContent;

package/dist/link-renaming/index.js

@@ -1,2 +0,0 @@
-import { renameFileAndUpdateLinksInContent } from "./renameFileAndUpdateLinksInContent.js";
-export default renameFileAndUpdateLinksInContent;

package/dist/link-renaming/renameLinks.d.ts

@@ -1,2 +0,0 @@
-declare const renameLinks: (filePath: string, existingLink: string, newLink: string) => Promise<number>;
-export default renameLinks;

package/dist/link-renaming/renameLinks.js

@@ -1,47 +0,0 @@
-/**
- * @typedef {import('remark-mdx')}
- */
-import fs from "fs-extra";
-import { normalize } from "path";
-import { remark } from "remark";
-import remarkFrontmatter from "remark-frontmatter";
-import remarkGfm from "remark-gfm";
-import remarkMdx from "remark-mdx";
-import { visit } from "unist-util-visit";
-const getContentWithRenamedLinks = async (fileContent, existingLink, newLink) => {
-    let numRenamedLinks = 0;
-    const remarkMdxReplaceLinks = () => {
-        return (tree) => {
-            visit(tree, (node) => {
-                // ![]() format
-                if (node.type === "link" &&
-                    node.url &&
-                    normalize(node.url) === existingLink) {
-                    node.url = newLink;
-                    numRenamedLinks++;
-                }
-                return;
-            });
-        };
-    };
-    const file = await remark()
-        .use(remarkMdx)
-        .use(remarkGfm)
-        .use(remarkFrontmatter, ["yaml", "toml"])
-        .use(remarkMdxReplaceLinks)
-        .process(fileContent);
-    return {
-        numRenamedLinks,
-        newContent: String(file),
-    };
-};
-const renameLinks = async (filePath, existingLink, newLink) => {
-    const fileContent = fs.readFileSync(filePath).toString();
-    const { numRenamedLinks, newContent } = await getContentWithRenamedLinks(fileContent, existingLink, newLink);
-    fs.outputFileSync(filePath, newContent, {
-        flag: "w",
-    });
-    return numRenamedLinks;
-};
-console.log(await getContentWithRenamedLinks("[](test)", "[](test)", "test2"));
-export default renameLinks;

package/dist/static-checking/crawlPages.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/static-checking/crawlPages.js

@@ -1 +0,0 @@
-export {};

package/dist/static-checking/getUsedInternalLinks.d.ts

@@ -1,2 +0,0 @@
-export declare const getUsedInternalLinksInPage: (content: string) => Promise<string[]>;
-export declare const getUsedInternalLinksInSite: (dirName: string) => Promise<Record<string, string[]>>;

package/dist/static-checking/getUsedInternalLinks.js

@@ -1,74 +0,0 @@
-import isAbsoluteUrl from "is-absolute-url";
-import fs from "fs-extra";
-import { remark } from "remark";
-import remarkFrontmatter from "remark-frontmatter";
-import remarkGfm from "remark-gfm";
-import remarkMdx from "remark-mdx";
-import { visit } from "unist-util-visit";
-import { getFullPath, getPagePaths, normalizeFilePaths, removeLeadingSlash, } from "../prebuild.js";
-import path from "path";
-const isDataString = (str) => str.startsWith("data:");
-export const getUsedInternalLinksInPage = async (content) => {
-    const links = [];
-    const visitLinks = () => {
-        return (tree) => {
-            visit(tree, (node) => {
-                if (
-                // ![]() format
-                (node.type === "link" || node.type === "image") &&
-                    node.url &&
-                    !isAbsoluteUrl(node.url) &&
-                    !isDataString(node.url)) {
-                    links.push(node.url);
-                    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 = mdxJsxFlowElement.attributes[srcAttrIndex].value;
-                    if (srcAttrIndex !== -1 &&
-                        typeof nodeUrl === "string" &&
-                        !isAbsoluteUrl(nodeUrl) &&
-                        !isDataString(nodeUrl)) {
-                        links.push(nodeUrl);
-                    }
-                }
-                else if (mdxJsxFlowElement.name === "a") {
-                    const hrefAttrIndex = mdxJsxFlowElement.attributes.findIndex((attr) => attr.type === "mdxJsxAttribute" && attr.name === "href");
-                    const nodeUrl = mdxJsxFlowElement.attributes[hrefAttrIndex].value;
-                    if (hrefAttrIndex !== -1 &&
-                        typeof nodeUrl === "string" &&
-                        !isAbsoluteUrl(nodeUrl) &&
-                        !isDataString(nodeUrl)) {
-                        links.push(nodeUrl);
-                    }
-                }
-            });
-            return tree;
-        };
-    };
-    await remark()
-        .use(remarkMdx)
-        .use(remarkGfm)
-        .use(remarkFrontmatter, ["yaml", "toml"])
-        .use(visitLinks)
-        .process(content);
-    return normalizeFilePaths(links).map(getFullPath).map(removeLeadingSlash);
-};
-export const getUsedInternalLinksInSite = async (dirName) => {
-    const dirChildren = getPagePaths(dirName);
-    const getLinksPromises = [];
-    const usedLinksInSite = {};
-    dirChildren.forEach((filePath) => {
-        getLinksPromises.push((async () => {
-            const fileContent = fs
-                .readFileSync(path.join(dirName, filePath))
-                .toString();
-            const usedLinksInPage = await getUsedInternalLinksInPage(fileContent);
-            usedLinksInSite[filePath] = usedLinksInPage;
-        })());
-    });
-    await Promise.all(getLinksPromises);
-    return usedLinksInSite;
-};

package/dist/static-checking/getValidInternalLinks.d.ts

@@ -1 +0,0 @@
-export declare const getValidInternalLinks: (dirName: string) => Set<string>;

package/dist/static-checking/getValidInternalLinks.js

@@ -1,5 +0,0 @@
-import { getFileList } from "@mintlify/prebuild";
-import { filterLinks, removeFileExtension, removeLeadingSlash, } from "../prebuild.js";
-export const getValidInternalLinks = (dirName) => new Set(filterLinks(getFileList(dirName))
-    .map(removeFileExtension)
-    .map(removeLeadingSlash));

package/dist/static-checking/index.d.ts

@@ -1,4 +0,0 @@
-export { getUsedInternalLinksInPage, getUsedInternalLinksInSite, } from "./getUsedInternalLinks";
-export { getValidInternalLinks } from "./getValidInternalLinks";
-import { getBrokenInternalLinks } from "./getBrokenInternalLinks";
-export default getBrokenInternalLinks;

package/dist/static-checking/index.js

@@ -1,4 +0,0 @@
-export { getUsedInternalLinksInPage, getUsedInternalLinksInSite, } from "./getUsedInternalLinks";
-export { getValidInternalLinks } from "./getValidInternalLinks";
-import { getBrokenInternalLinks } from "./getBrokenInternalLinks";
-export default getBrokenInternalLinks;