|
| 1 | +import assert from 'node:assert/strict'; |
| 2 | +import { test } from 'node:test'; |
| 3 | + |
| 4 | +import { renderModule, toEntries } from './generate-docs.mjs'; |
| 5 | + |
| 6 | +test('maps doc paths to a kind and slug', () => { |
| 7 | + assert.deepEqual( |
| 8 | + toEntries([ |
| 9 | + 'src/primitives/accordion/accordion.doc.ts', |
| 10 | + 'src/hooks/use-pending-action.doc.ts', |
| 11 | + 'src/components/button/button.doc.ts', |
| 12 | + ]), |
| 13 | + [ |
| 14 | + { kind: 'components', slug: 'button', path: 'src/components/button/button.doc' }, |
| 15 | + { kind: 'hooks', slug: 'use-pending-action', path: 'src/hooks/use-pending-action.doc' }, |
| 16 | + { kind: 'primitives', slug: 'accordion', path: 'src/primitives/accordion/accordion.doc' }, |
| 17 | + ], |
| 18 | + ); |
| 19 | +}); |
| 20 | + |
| 21 | +test('leaves out docs the site does not publish', () => { |
| 22 | + assert.deepEqual(toEntries(['src/components/captcha/captcha.doc.ts', 'src/components/button/button.doc.ts']), [ |
| 23 | + { kind: 'components', slug: 'button', path: 'src/components/button/button.doc' }, |
| 24 | + ]); |
| 25 | +}); |
| 26 | + |
| 27 | +test('rejects a doc outside the documented locations', () => { |
| 28 | + assert.throws( |
| 29 | + () => toEntries(['src/components/button/parts/icon.doc.ts']), |
| 30 | + /src\/components\/button\/parts\/icon\.doc\.ts/, |
| 31 | + ); |
| 32 | + assert.throws(() => toEntries(['src/blocks/sign-in/sign-in.doc.ts']), /sign-in\.doc\.ts/); |
| 33 | +}); |
| 34 | + |
| 35 | +test('renders one typed import per doc', () => { |
| 36 | + const source = renderModule('../../../mosaic', [ |
| 37 | + { kind: 'components', slug: 'button', path: 'src/components/button/button.doc' }, |
| 38 | + { kind: 'hooks', slug: 'use-form', path: 'src/hooks/use-form.doc' }, |
| 39 | + ]); |
| 40 | + assert.match(source, /import type \{ ComponentDoc, HookDoc \} from '\.\.\/\.\.\/\.\.\/mosaic\/src\/docs-schema';/); |
| 41 | + assert.match(source, /import doc0 from '\.\.\/\.\.\/\.\.\/mosaic\/src\/components\/button\/button\.doc';/); |
| 42 | + assert.match(source, /import doc1 from '\.\.\/\.\.\/\.\.\/mosaic\/src\/hooks\/use-form\.doc';/); |
| 43 | + assert.match(source, /\{ kind: 'components', slug: 'button', doc: doc0 \}/); |
| 44 | + assert.match(source, /\{ kind: 'hooks', slug: 'use-form', doc: doc1 \}/); |
| 45 | +}); |
| 46 | + |
| 47 | +test('accepts Windows doc paths', () => { |
| 48 | + assert.deepEqual(toEntries(['src\\components\\button\\button.doc.ts']), [ |
| 49 | + { kind: 'components', slug: 'button', path: 'src/components/button/button.doc' }, |
| 50 | + ]); |
| 51 | +}); |
| 52 | + |
| 53 | +test('renders forward-slash imports from a Windows Mosaic directory', () => { |
| 54 | + const source = renderModule('..\\..\\mosaic', [ |
| 55 | + { kind: 'components', slug: 'button', path: 'src/components/button/button.doc' }, |
| 56 | + ]); |
| 57 | + assert.match(source, /from '\.\.\/\.\.\/mosaic\/src\/docs-schema';/); |
| 58 | + assert.match(source, /import doc0 from '\.\.\/\.\.\/mosaic\/src\/components\/button\/button\.doc';/); |
| 59 | +}); |
0 commit comments