fuma-nama/fumadocs fumadocs-typescript@4.0.0

on GitHub

Major Changes

• b83d946: Use createGenerator API

  Create a generator instance:

  import { createGenerator } from 'fumadocs-typescript';
  
  const generator = createGenerator(tsconfig);

  Refactor:

  import { remarkAutoTypeTable, createTypeTable } from 'fumadocs-typescript';
  
  generateDocumentation('./file.ts', 'MyClass', fs.readFileSync('./file.ts').toString())
  generateMDX('content', {...})
  generateFiles({...})
  const processor = createProcessor({
      remarkPlugins: [remarkAutoTypeTable],
  });
  
  const AutoTypeTable = createTypeTable()
  return <AutoTypeTable {...props} />

  To:

  import { AutoTypeTable, remarkAutoTypeTable } from "fumadocs-typescript";
  
  generator.generateDocumentation({path: './file.ts'}, 'MyClass')
  generateMDX(generator, 'content', { ... })
  generateFiles(generator, { ... })
  const processor = createProcessor({
      remarkPlugins: [
          [remarkAutoTypeTable, { generator }],
      ],
  });
  
  return <AutoTypeTable generator={generator} {...props} />

  This ensure the compiler instance is always re-used.