codeImport()

Импортирует код из внешних файлов в огороженные блоки кода.

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

Сигнатура

function codeImport(options?: CodeImportPluginOptions): UnifastPlugin

Параметры

options?

Конфигурация поведения импорта кода

СвойствоТипПо умолчаниюОписание
rootDirstring—Корневой каталог для разрешения путей к файлам. Если не указан, пути разрешаются относительно текущего рабочего каталога.

Использование

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);
// Блок кода заменён содержимым ./src/example.ts

Примеры

Базовый импорт файла

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

Содержимое блока кода заменяется содержимым файла с сохранением языка для подсветки синтаксиса.

С rootDir

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

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

console.log(result.output);
// Пути к файлам разрешаются относительно rootDir

Без rootDir

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

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

console.log(result.output);
// Пути к файлам разрешаются относительно текущего рабочего каталога