@mintlify/cli 4.0.1813 → 4.1.1

package/__test__/validateEngine.test.ts

@@ -1,245 +0,0 @@
-import fs from 'fs-extra';
-import fsSync from 'node:fs';
-import os from 'node:os';
-import path from 'node:path';
-
-import { applyFixes, checkSite, selectRules, UsageError } from '../src/validate/engine.js';
-import { RULES } from '../src/validate/rules/index.js';
-import {
-  GROUPS,
-  type Diagnostic,
-  type FileRule,
-  type Site,
-  type SiteRule,
-} from '../src/validate/types.js';
-
-const ids = (rules: { id: string }[]) => rules.map(({ id }) => id);
-
-describe('selectRules', () => {
-  it('starts from every rule; --disable all empties the selection', () => {
-    expect(ids(selectRules({}))).toEqual(ids(RULES));
-    expect(ids(selectRules({ disable: ['all'] }))).toEqual([]);
-  });
-
-  it('turns on the rules of an enabled group', () => {
-    const content = ids(selectRules({ disable: ['all'], enable: ['content'] }));
-
-    expect(content).toEqual([
-      'void-tags',
-      'duplicate-h1',
-      'unknown-component',
-      'undefined-variable',
-      'missing-snippet',
-      'katex',
-      'foreign-syntax',
-      'missing-file',
-      'import-error',
-    ]);
-  });
-
-  it('applies --enable after --disable', () => {
-    expect(ids(selectRules({ disable: ['content'], enable: ['void-tags'] }))).toContain(
-      'void-tags'
-    );
-    expect(ids(selectRules({ disable: ['content'] }))).not.toContain('void-tags');
-  });
-
-  it('rejects unknown names and naming parse-error', () => {
-    expect(() => selectRules({ enable: ['nope'] })).toThrow(UsageError);
-    expect(() => selectRules({ disable: ['parse-error'] })).toThrow(
-      "parse-error always runs and can't be disabled"
-    );
-    expect(() => selectRules({ enable: ['parse-error'] })).toThrow(
-      "parse-error always runs and can't be disabled"
-    );
-  });
-
-  it('gives every rule a known group, a severity and a description', () => {
-    for (const rule of RULES) {
-      expect(GROUPS).toContain(rule.group);
-      expect(['error', 'warning']).toContain(rule.severity);
-      expect(rule.description).not.toBe('');
-      expect(rule.id).not.toBe('parse-error');
-      expect(GROUPS as string[]).not.toContain(rule.id);
-    }
-    expect(new Set(ids(RULES)).size).toBe(RULES.length);
-  });
-});
-
-describe('applyFixes', () => {
-  let dir: string;
-
-  beforeEach(() => {
-    dir = fs.mkdtempSync(path.join(os.tmpdir(), 'validate-engine-'));
-  });
-
-  afterEach(() => {
-    fs.removeSync(dir);
-  });
-
-  const site = () =>
-    ({
-      baseDir: dir,
-      files: [],
-      read: (file: string) => fs.readFileSync(path.join(dir, file), 'utf-8'),
-    }) as unknown as Site;
-
-  const diagnostic = (fix: Diagnostic['fix'], rule = 'r'): Diagnostic => ({
-    rule,
-    group: 'content',
-    severity: 'error',
-    file: 'a.mdx',
-    message: 'm',
-    fix,
-  });
-
-  it('applies fixes across files, skipping ones that overlap an applied fix', async () => {
-    fs.writeFileSync(path.join(dir, 'a.mdx'), 'one two three');
-    fs.writeFileSync(path.join(dir, 'b.json'), '{}');
-
-    const changes = await applyFixes(site(), [
-      diagnostic({ file: 'a.mdx', start: 0, end: 3, text: '1' }),
-      diagnostic({ file: 'a.mdx', start: 8, end: 13, text: '3' }),
-      diagnostic({ file: 'b.json', start: 1, end: 1, text: '"k":1' }),
-      // Overlaps the first fix, so it waits for the next pass
-      diagnostic({ file: 'a.mdx', start: 2, end: 5, text: 'x' }),
-    ]);
-
-    expect(fs.readFileSync(path.join(dir, 'a.mdx'), 'utf-8')).toBe('1 two 3');
-    expect(fs.readFileSync(path.join(dir, 'b.json'), 'utf-8')).toBe('{"k":1}');
-    expect(changes.map(({ file, before, after }) => [file, before, after])).toEqual([
-      ['a.mdx', 'one', '1'],
-      ['a.mdx', 'three', '3'],
-      ['b.json', '', '"k":1'],
-    ]);
-  });
-
-  it('applies two insertions at the same point', async () => {
-    fs.writeFileSync(path.join(dir, 'b.json'), '{}');
-
-    const changes = await applyFixes(site(), [
-      diagnostic({ file: 'b.json', start: 1, end: 1, text: ',"j":2' }),
-      diagnostic({ file: 'b.json', start: 1, end: 1, text: '"k":1' }),
-    ]);
-
-    expect(fs.readFileSync(path.join(dir, 'b.json'), 'utf-8')).toBe('{"k":1,"j":2}');
-    expect(changes).toHaveLength(2);
-  });
-
-  it('applies a replacement and an insertion at its start', async () => {
-    fs.writeFileSync(path.join(dir, 'a.mdx'), 'a<br>b');
-
-    const changes = await applyFixes(site(), [
-      diagnostic({ file: 'a.mdx', start: 1, end: 5, text: '<br />' }),
-      diagnostic({ file: 'a.mdx', start: 1, end: 1, text: 'x' }),
-    ]);
-
-    expect(fs.readFileSync(path.join(dir, 'a.mdx'), 'utf-8')).toBe('ax<br />b');
-    expect(changes.map(({ after }) => after)).toEqual(['<br />', 'x']);
-  });
-
-  it('skips writing a Markdown file whose fixed content no longer parses', async () => {
-    fs.writeFileSync(path.join(dir, 'a.mdx'), 'hello world\n');
-    fs.writeFileSync(path.join(dir, 'b.mdx'), 'line<br>\n');
-
-    const changes = await applyFixes(site(), [
-      diagnostic({ file: 'a.mdx', start: 0, end: 5, text: '<Note>' }),
-      diagnostic({ file: 'b.mdx', start: 4, end: 8, text: '<br />' }),
-    ]);
-
-    expect(fs.readFileSync(path.join(dir, 'a.mdx'), 'utf-8')).toBe('hello world\n');
-    expect(fs.readFileSync(path.join(dir, 'b.mdx'), 'utf-8')).toBe('line<br />\n');
-    expect(changes.map(({ file, after }) => [file, after])).toEqual([['b.mdx', '<br />']]);
-  });
-
-  it('fixes a page that only parses after the build preprocesses its <MDX> fragments', async () => {
-    const fragment = '{true ? <MDX>\n```bash\n<root>/{arch}/app.vpkg\n```\n</MDX> : null}\n';
-    fs.writeFileSync(path.join(dir, 'a.mdx'), `${fragment}\nline<br>\n`);
-    const start = fragment.length + 5;
-
-    const changes = await applyFixes(site(), [
-      diagnostic({ file: 'a.mdx', start, end: start + 4, text: '<br />' }),
-    ]);
-
-    expect(fs.readFileSync(path.join(dir, 'a.mdx'), 'utf-8')).toBe(`${fragment}\nline<br />\n`);
-    expect(changes).toHaveLength(1);
-  });
-
-  it('fixes an unparseable page even when another error keeps it unparseable', async () => {
-    fs.writeFileSync(path.join(dir, 'a.mdx'), 'line<br>\n');
-    fs.writeFileSync(path.join(dir, 'b.mdx'), 'line<br>\n\nText {broken\n');
-
-    const changes = await applyFixes(site(), [
-      diagnostic({ file: 'a.mdx', start: 4, end: 8, text: '<br />' }),
-      diagnostic({ file: 'b.mdx', start: 4, end: 8, text: '<br />' }),
-    ]);
-
-    expect(fs.readFileSync(path.join(dir, 'a.mdx'), 'utf-8')).toBe('line<br />\n');
-    expect(fs.readFileSync(path.join(dir, 'b.mdx'), 'utf-8')).toBe('line<br />\n\nText {broken\n');
-    expect(changes).toHaveLength(2);
-  });
-});
-
-describe('checkSite with fix', () => {
-  let dir: string;
-
-  beforeEach(() => {
-    dir = fs.mkdtempSync(path.join(os.tmpdir(), 'validate-fix-passes-'));
-    fs.writeJSONSync(path.join(dir, 'docs.json'), {
-      name: 'Test',
-      navigation: { pages: ['index', 'other'] },
-    });
-    fs.writeFileSync(path.join(dir, 'index.mdx'), '---\ntitle: Home\n---\n\nText\n');
-    fs.writeFileSync(path.join(dir, 'other.mdx'), '---\ntitle: Other\n---\n\nText!!!\n');
-  });
-
-  afterEach(() => {
-    fs.removeSync(dir);
-  });
-
-  /** Offers one "!" at a time until a page ends with `limit` of them, so each pass unlocks the next. */
-  const bang = (limit: number): FileRule => ({
-    id: 'bang',
-    group: 'content',
-    severity: 'warning',
-    scope: 'file',
-    raw: true,
-    description: 'test rule',
-    check: ({ content }) => {
-      const end = content.trimEnd().length;
-      return content.endsWith(`${'!'.repeat(limit)}\n`)
-        ? []
-        : [{ message: 'needs a bang', edit: { start: end, end, text: '!' } }];
-    },
-  });
-
-  const siteRule = (): SiteRule => ({
-    id: 'site',
-    group: 'config',
-    severity: 'warning',
-    scope: 'site',
-    description: 'test rule',
-    check: vi.fn(() => []),
-  });
-
-  it('rechecks only changed files between passes and runs site rules once more at the end', async () => {
-    const site = siteRule();
-    const reads = vi.spyOn(fsSync, 'readFileSync');
-
-    const result = await checkSite(dir, [bang(3), site], { localSchema: false, fix: true });
-
-    const otherReads = reads.mock.calls.filter(([file]) => String(file).endsWith('other.mdx'));
-    reads.mockRestore();
-    expect(result.fixed.map(({ file }) => file)).toEqual(['index.mdx', 'index.mdx', 'index.mdx']);
-    expect(fs.readFileSync(path.join(dir, 'index.mdx'), 'utf-8')).toContain('Text!!!\n');
-    expect(result.diagnostics).toEqual([]);
-    expect(site.check).toHaveBeenCalledTimes(2);
-    expect(otherReads).toHaveLength(2);
-  });
-
-  it('applies up to five passes of fixes', async () => {
-    const result = await checkSite(dir, [bang(10)], { localSchema: false, fix: true });
-
-    expect(result.fixed.filter(({ file }) => file === 'index.mdx')).toHaveLength(5);
-  });
-});