codeImport()

Importa código de arquivos externos para code blocks fenced.

import { codeImport } from "@unifast/node";

Assinatura

function codeImport(options?: CodeImportPluginOptions): UnifastPlugin

Parâmetros

options?

Configuração para o comportamento de importação de código

PropriedadeTipoPadrãoDescrição
rootDirstring—Diretório raiz para resolver caminhos de arquivo. Quando omitido, os caminhos são resolvidos relativos ao diretório de trabalho atual.

Uso

import { compile, codeImport } from "@unifast/node";

const md = `
\`\`\`ts file="./src/example.ts"
\`\`\`
`;

const result = compile(md, {
  plugins: [
    codeImport({
      rootDir: "/path/to/project",
    }),
  ],
});

console.log(result.output);
// The code block is replaced with the contents of ./src/example.ts

Exemplos

Importação básica de arquivo

```ts file="./src/utils.ts"
```

O conteúdo do code block é substituído pelo conteúdo do arquivo, preservando a linguagem para syntax highlighting.

Com rootDir

import { compile, codeImport } from "@unifast/node";

const result = compile(md, {
  plugins: [
    codeImport({ rootDir: "/home/user/project" }),
  ],
});

console.log(result.output);
// File paths are resolved relative to rootDir

Sem rootDir

import { compile, codeImport } from "@unifast/node";

const result = compile(md, {
  plugins: [codeImport()],
});

console.log(result.output);
// File paths are resolved relative to the current working directory