Установка

В настоящее время Valibot доступен для Node, Bun и Deno. Ниже вы узнаете, как добавить библиотеку в свой проект.

Общие сведения

За исключением этого руководства, остальная документация предполагает, что в операторах импорта в примерах кода вы используете npm.

Не имеет значения, используете ли вы отдельные импорты или импорт с подстановочным знаком. В обоих случаях должны работать удаление неиспользуемого кода и разделение кода.

Распространяемые файлы Valibot рассчитаны на ES2020. Убедитесь, что ваш сборщик или транспилятор поддерживает синтаксис ES2020.

Если вы используете TypeScript, рекомендуем включить строгий режим в вашем tsconfig.json, чтобы все типы вычислялись правильно.

Минимально необходимая версия TypeScript — v5.0.2.

{
  "compilerOptions": {
    "strict": true
    // ...
  }
}

Для ИИ-агентов

Мы предоставляем навык для агентов, который обучает ИИ-агентов правильным шаблонам создания схем Valibot. Установить его можно, выполнив в терминале следующую команду:

npx skills add open-circle/agent-skills --skill valibot

Подробнее о навыке агента Valibot можно узнать здесь.

Из npm

Для Node и Bun вы можете добавить библиотеку в свой проект одной командой с помощью предпочитаемого пакетного менеджера.

npm install valibot     # npm
yarn add valibot        # yarn
pnpm add valibot        # pnpm
bun add valibot         # bun

Затем вы можете импортировать её в любой файл JavaScript или TypeScript.

// With individual imports
import { … } from 'valibot';

// With a wildcard import
import * as v from 'valibot';

Из JSR

Для Node, Deno и Bun вы можете добавить библиотеку в свой проект одной командой с помощью предпочитаемого пакетного менеджера.

deno add jsr:@valibot/valibot      # deno
npx jsr add @valibot/valibot       # npm
yarn dlx jsr add @valibot/valibot  # yarn
pnpm dlx jsr add @valibot/valibot  # pnpm
bunx jsr add @valibot/valibot      # bun

Затем вы можете импортировать её в любой файл JavaScript или TypeScript.

// With individual imports
import { … } from '@valibot/valibot';

// With a wildcard import
import * as v from '@valibot/valibot';

В Deno вы также можете ссылаться на меня напрямую с помощью спецификаторов jsr:.

// With individual imports
import { … } from 'jsr:@valibot/valibot';

// With a wildcard import
import * as v from 'jsr:@valibot/valibot';

Из Deno

В Deno вы можете ссылаться на библиотеку напрямую через URL deno.land/x.

// With individual imports
import { … } from 'https://deno.land/x/valibot/mod.ts';

// With a wildcard import
import * as v from 'https://deno.land/x/valibot/mod.ts';