import { blue, red, yellow } from "../fmt/colors.ts";import { walk } from "../fs/walk.ts";import { createSourceFile, ImportDeclaration, ScriptTarget, StringLiteral, SyntaxKind,} from "https://esm.sh/typescript@4.8.4";
const EXTENSIONS = [".mjs", ".js", ".ts", ".md"];const EXCLUDED_PATHS = [ ".git", ".github", "_tools", "node",];
const ROOT = new URL("../", import.meta.url);const ROOT_LENGTH = ROOT.pathname.slice(0, -1).length;const FAIL_FAST = Deno.args.includes("--fail-fast");const TEST_MODE = Deno.args.includes("--test-mode");
const RX_JSDOC_COMMENT = /\*\*[^*]*\*+(?:[^/*][^*]*\*+)*/mg;const RX_JSDOC_REMOVE_LEADING_ASTERISK = /^\s*\* ?/gm;const RX_CODE_BLOCK = /`{3}([\w]*)\n([\S\s]+?)\n`{3}/gm;
const root = TEST_MODE ? new URL("./_tools/testdata", ROOT) : ROOT;
let shouldFail = false;let countChecked = 0;
function checkImportStatements( codeBlock: string, filePath: string, lineNumber: number,): void { const sourceFile = createSourceFile( "doc-imports-checker$", codeBlock, ScriptTarget.Latest, ); const importDeclarations = sourceFile.statements.filter((s) => s.kind === SyntaxKind.ImportDeclaration ) as ImportDeclaration[];
for (const importDeclaration of importDeclarations) { const { moduleSpecifier } = importDeclaration; const importPath = (moduleSpecifier as StringLiteral).text; const isRelative = importPath.startsWith("."); const isInternal = importPath.startsWith( "https://deno.land/std@$STD_VERSION/", ); const { line } = sourceFile.getLineAndCharacterOfPosition( moduleSpecifier.pos, );
if (isRelative || !isInternal) { console.log( yellow("Warn ") + (isRelative ? "relative import path" : "external or incorrectly versioned dependency") + ": " + red(`"${importPath}"`) + " at " + blue( filePath.substring(ROOT_LENGTH + 1), ) + yellow(":" + (lineNumber + line)), );
if (FAIL_FAST) { Deno.exit(1); } shouldFail = true; } }}
function checkCodeBlocks( content: string, filePath: string, lineNumber = 1,): void { for (const codeBlockMatch of content.matchAll(RX_CODE_BLOCK)) { const [, language, codeBlock] = codeBlockMatch; const shortFilePath = filePath.substring(ROOT_LENGTH + 1); const codeBlockLineNumber = content.slice(0, codeBlockMatch.index).split("\n").length;
switch (language.toLowerCase()) { case "ts": case "js": case "typescript": case "javascript": case "": if (language === "") { console.log( yellow("Warn") + " codeblock with no language specified at " + blue(shortFilePath) + yellow(":" + codeBlockLineNumber), ); }
checkImportStatements( codeBlock, filePath, lineNumber + codeBlockLineNumber, ); break;
default: console.log( yellow("Warn") + " skipping code block with language " + blue(language) + " at " + blue(shortFilePath) + yellow(":" + codeBlockLineNumber), ); break; } }}
for await ( const { path } of walk(root, { exts: EXTENSIONS, includeDirs: false, skip: EXCLUDED_PATHS.map((p) => new RegExp(p + "$")), })) { const content = await Deno.readTextFile(path); countChecked++;
if (path.endsWith(".md")) { checkCodeBlocks(content, path); } else { for (const jsdocMatch of content.matchAll(RX_JSDOC_COMMENT)) { const comment = jsdocMatch[0].replaceAll( RX_JSDOC_REMOVE_LEADING_ASTERISK, "", ); const commentLineNumber = content.slice(0, jsdocMatch.index).split("\n").length;
checkCodeBlocks(comment, path, commentLineNumber); } }}
console.log(`Checked ${countChecked} files`);if (shouldFail) Deno.exit(1);