@mintlify/cli 4.0.1812 → 4.1.1

package/bin/validate/rules/content/unknownComponent.js

@@ -1,121 +0,0 @@
-import { collectPatternNames, collectExportedNames, getAST, isBuiltInComponent, JSX_EXTENSIONS, visitReferences, } from '@mintlify/common';
-import { visit } from 'unist-util-visit';
-const getDeclared = (context) => {
-    const declared = new Set();
-    visit(context.tree, 'mdxjsEsm', (node) => {
-        var _a, _b, _c;
-        for (const statement of (_c = (_b = (_a = node.data) === null || _a === void 0 ? void 0 : _a.estree) === null || _b === void 0 ? void 0 : _b.body) !== null && _c !== void 0 ? _c : []) {
-            if (statement.type === 'ImportDeclaration') {
-                for (const specifier of statement.specifiers) {
-                    collectPatternNames(specifier.local, declared);
-                }
-            }
-            else if (statement.type === 'ExportNamedDeclaration') {
-                const declaration = statement.declaration;
-                if ((declaration === null || declaration === void 0 ? void 0 : declaration.type) === 'VariableDeclaration') {
-                    for (const declarator of declaration.declarations) {
-                        collectPatternNames(declarator.id, declared);
-                    }
-                }
-                else if (declaration) {
-                    collectPatternNames(declaration.id, declared);
-                }
-                for (const specifier of statement.specifiers) {
-                    collectPatternNames(specifier.local, declared);
-                    collectPatternNames(specifier.exported, declared);
-                }
-            }
-            else if (statement.type === 'ExportDefaultDeclaration') {
-                const declaration = statement.declaration;
-                if (declaration.type === 'FunctionDeclaration' || declaration.type === 'ClassDeclaration') {
-                    collectPatternNames(declaration.id, declared);
-                }
-            }
-        }
-    });
-    return declared;
-};
-const getImportPosition = (context) => {
-    var _a, _b;
-    const frontmatter = context.tree.children.find((child) => ['yaml', 'toml'].includes(child.type));
-    return (_b = (_a = frontmatter === null || frontmatter === void 0 ? void 0 : frontmatter.position) === null || _a === void 0 ? void 0 : _a.end.offset) !== null && _b !== void 0 ? _b : 0;
-};
-const getSpecifier = (snippet, file, name) => {
-    let exported;
-    try {
-        exported = collectExportedNames(getAST(snippet, file));
-    }
-    catch (_a) {
-        return undefined;
-    }
-    if (exported.has(name))
-        return `{ ${name} }`;
-    return exported.has('default') ? name : undefined;
-};
-export const unknownComponent = {
-    id: 'unknown-component',
-    group: 'content',
-    severity: 'error',
-    scope: 'file',
-    description: 'JSX components that are not built in, imported or exported',
-    pagesOnly: true,
-    check: (context) => {
-        var _a, _b;
-        const declared = getDeclared(context);
-        const reported = new Set();
-        const issues = [];
-        const insertAt = getImportPosition(context);
-        const prefix = insertAt === 0 ? '' : '\n\n';
-        const following = (_b = (_a = /^\n*/.exec(context.content.slice(insertAt))) === null || _a === void 0 ? void 0 : _a[0].length) !== null && _b !== void 0 ? _b : 0;
-        const suffix = '\n'.repeat(Math.max(0, 2 - following));
-        const check = (tag, position) => {
-            var _a;
-            const name = tag === null || tag === void 0 ? void 0 : tag.split('.')[0];
-            if (!tag || !name || !/^[A-Z]/.test(name))
-                return;
-            if (declared.has(name) || reported.has(tag) || isBuiltInComponent(tag))
-                return;
-            reported.add(tag);
-            const file = JSX_EXTENSIONS.map((extension) => `snippets/${name}${extension}`).find((candidate) => { var _a; return ((_a = context.readFile) === null || _a === void 0 ? void 0 : _a.call(context, candidate)) !== undefined; });
-            const source = file && ((_a = context.readFile) === null || _a === void 0 ? void 0 : _a.call(context, file));
-            const specifier = file && source !== undefined && tag === name ? getSpecifier(source, file, name) : undefined;
-            issues.push({
-                line: position === null || position === void 0 ? void 0 : position.line,
-                column: position === null || position === void 0 ? void 0 : position.column,
-                message: `<${tag}> is not built in, imported or exported on this page`,
-                edit: specifier
-                    ? {
-                        start: insertAt,
-                        end: insertAt,
-                        text: `${prefix}import ${specifier} from "/${file}";${suffix}`,
-                    }
-                    : undefined,
-            });
-        };
-        const checkJsxInExpression = (estree, fallback) => visitReferences(estree, new Set(), {
-            reference: (identifier) => {
-                var _a;
-                if (identifier.type !== 'JSXIdentifier')
-                    return;
-                const loc = identifier.loc;
-                check(String(identifier.name), (_a = loc === null || loc === void 0 ? void 0 : loc.start) !== null && _a !== void 0 ? _a : fallback);
-            },
-        });
-        visit(context.tree, (node) => {
-            var _a, _b, _c, _d, _e;
-            if (node.type === 'mdxJsxFlowElement' || node.type === 'mdxJsxTextElement') {
-                check(node.name, (_a = node.position) === null || _a === void 0 ? void 0 : _a.start);
-                for (const attribute of node.attributes) {
-                    const value = attribute.type === 'mdxJsxAttribute' ? attribute.value : attribute;
-                    if (value && typeof value === 'object') {
-                        checkJsxInExpression((_b = value.data) === null || _b === void 0 ? void 0 : _b.estree, (_c = node.position) === null || _c === void 0 ? void 0 : _c.start);
-                    }
-                }
-            }
-            else if (node.type === 'mdxFlowExpression' || node.type === 'mdxTextExpression') {
-                checkJsxInExpression((_d = node.data) === null || _d === void 0 ? void 0 : _d.estree, (_e = node.position) === null || _e === void 0 ? void 0 : _e.start);
-            }
-        });
-        return issues;
-    },
-};

package/bin/validate/rules/content/voidTags.js

@@ -1,38 +0,0 @@
-import { htmlVoidElements } from 'html-void-elements';
-import { maskNonMarkup } from '../../mdx.js';
-const VOID_TAG_NAMES = htmlVoidElements.filter((tag) => tag !== 'image');
-const ATTRIBUTE = String.raw `"[^"]*"|'[^']*'|\{[^{}]*\}|[^<>"'{}]`;
-const VOID_TAG = new RegExp(String.raw `<(${VOID_TAG_NAMES.join('|')})(?=[\s/>])(?:${ATTRIBUTE})*?(\/?)>`, 'g');
-export const voidTags = {
-    id: 'void-tags',
-    group: 'content',
-    severity: 'error',
-    scope: 'file',
-    description: "self-close void HTML tags (<br>, <img>, <source>, …); MDX can't parse them unclosed",
-    raw: true,
-    check: ({ content }) => {
-        var _a, _b;
-        const masked = maskNonMarkup(content);
-        const issues = [];
-        for (const match of masked.matchAll(VOID_TAG)) {
-            if (match[2])
-                continue;
-            const start = match.index;
-            const end = start + match[0].length;
-            if (new RegExp(`^\\s*</${match[1]}\\s*>`).test(masked.slice(end)))
-                continue;
-            const before = content.slice(0, start).split('\n');
-            issues.push({
-                line: before.length,
-                column: ((_b = (_a = before.pop()) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0) + 1,
-                message: `<${match[1]}> must be self-closed`,
-                edit: {
-                    start,
-                    end,
-                    text: `${content.slice(start, end - 1).trimEnd()} />`,
-                },
-            });
-        }
-        return issues;
-    },
-};

package/bin/validate/rules/index.js

@@ -1,21 +0,0 @@
-import { BUILD_RULES } from './build.js';
-import { duplicateH1 } from './content/duplicateH1.js';
-import { foreignSyntax } from './content/foreignSyntax.js';
-import { katexRule } from './content/katex.js';
-import { missingSnippet } from './content/missingSnippet.js';
-import { undefinedVariable } from './content/undefinedVariable.js';
-import { unknownComponent } from './content/unknownComponent.js';
-import { voidTags } from './content/voidTags.js';
-import { openApiSpec } from './openapi.js';
-/** Every check mint validate runs, in report order. */
-export const RULES = [
-    voidTags,
-    duplicateH1,
-    unknownComponent,
-    undefinedVariable,
-    missingSnippet,
-    katexRule,
-    foreignSyntax,
-    openApiSpec,
-    ...BUILD_RULES,
-];

package/bin/validate/rules/openapi.js

@@ -1,50 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import fs from 'node:fs/promises';
-import path from 'node:path';
-import { errorMessage } from '../../helpers.js';
-import { buildOverlayRegistryForCheck, checkOpenApiFile, getOpenApiFilenamesFromDocsConfig, } from '../../openApiCheck.js';
-export const openApiSpec = {
-    id: 'openapi-spec',
-    group: 'openapi',
-    severity: 'error',
-    scope: 'site',
-    description: "OpenAPI specs in docs.json or mint.json that don't parse or validate, with overlays applied",
-    check: (site) => __awaiter(void 0, void 0, void 0, function* () {
-        let filenames = [];
-        try {
-            const config = JSON.parse(yield fs.readFile(path.join(site.baseDir, site.configFile), 'utf-8'));
-            // mint.json lists its specs under a top-level openapi key
-            filenames = getOpenApiFilenamesFromDocsConfig(site.configFile === 'mint.json' ? { api: { openapi: config.openapi } } : config);
-        }
-        catch (_a) {
-            // A missing or invalid config file is the build's to report
-        }
-        if (filenames.length === 0)
-            return [];
-        let overlayRegistry;
-        try {
-            overlayRegistry = yield buildOverlayRegistryForCheck(site.localSchema);
-        }
-        catch (error) {
-            return [{ file: site.configFile, message: `OpenAPI overlays: ${errorMessage(error)}` }];
-        }
-        const perFile = yield Promise.all(filenames.map((file) => __awaiter(void 0, void 0, void 0, function* () {
-            const messages = [];
-            yield checkOpenApiFile(file, site.localSchema, overlayRegistry, (message) => messages.push(message));
-            return messages.flatMap(({ level, message }) => level === 'error'
-                ? [{ file, message }]
-                : level === 'warning'
-                    ? [{ file, message, severity: 'warning' }]
-                    : []);
-        })));
-        return perFile.flat();
-    }),
-};

package/bin/validate/rules/parseError.js

@@ -1,7 +0,0 @@
-/** The engine's built-in diagnostic for files neither parser can parse; not a selectable rule. */
-export const PARSE_ERROR = {
-    id: 'parse-error',
-    group: 'content',
-    severity: 'error',
-    description: "files MDX can't parse; other checks skip them",
-};

package/bin/validate/site.js

@@ -1,57 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import fs from 'node:fs';
-import path from 'node:path';
-import { readSiteFiles } from './files.js';
-import { toPosition } from './mdx.js';
-const readVariables = (config) => {
-    try {
-        const { variables } = JSON.parse(config);
-        return variables && typeof variables === 'object'
-            ? variables
-            : undefined;
-    }
-    catch (_a) {
-        return undefined;
-    }
-};
-/** Lists the site's pages and snippets; locate reads files from disk on demand. */
-export const loadSite = (baseDir_1, _a) => __awaiter(void 0, [baseDir_1, _a], void 0, function* (baseDir, { selected, localSchema }) {
-    var _b;
-    const files = yield readSiteFiles(baseDir);
-    const byPath = new Map();
-    const configFile = fs.existsSync(path.join(baseDir, 'docs.json')) ? 'docs.json' : 'mint.json';
-    const read = (file) => {
-        if (!byPath.has(file)) {
-            try {
-                byPath.set(file, fs.readFileSync(path.join(baseDir, file), 'utf-8'));
-            }
-            catch (_a) {
-                byPath.set(file, undefined);
-            }
-        }
-        return byPath.get(file);
-    };
-    return {
-        baseDir,
-        files,
-        selected,
-        configFile,
-        variables: readVariables((_b = read(configFile)) !== null && _b !== void 0 ? _b : ''),
-        localSchema,
-        read,
-        locate: (file, text) => {
-            var _a;
-            const content = (_a = read(file)) !== null && _a !== void 0 ? _a : '';
-            const offset = text ? content.indexOf(text) : -1;
-            return offset === -1 ? {} : toPosition(content, offset);
-        },
-    };
-});

package/bin/validate/types.js

@@ -1 +0,0 @@
-export const GROUPS = ['content', 'nav', 'config', 'openapi'];