codeImport()

Importa codice da file esterni all'interno di blocchi di codice recintati.

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

Firma

function codeImport(options?: CodeImportPluginOptions): UnifastPlugin

Parametri

options?

Configurazione del comportamento dell’import di codice

ProprietàTipoPredefinitoDescrizione
rootDirstring—Directory radice per risolvere i percorsi dei file. Se omessa, i percorsi vengono risolti rispetto alla directory di lavoro corrente.

Utilizzo

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

Esempi

Import di base di un file

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

Il contenuto del blocco di codice viene sostituito con il contenuto del file, preservando il linguaggio per l’evidenziazione della sintassi.

Con 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

Senza 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