Команда vp check

vp check выполняет форматирование, линтинг и проверку типов одной командой.

Обзор

vp check — команда по умолчанию для быстрого выполнения статических проверок в Vite+. Она объединяет форматирование через Oxfmt, линтинг через Oxlint и проверку типов TypeScript через tsgolint. Объединяя все эти задачи в одной команде, vp check работает быстрее, чем запуск форматирования, линтинга и проверки типов отдельными инструментами в отдельных командах.

Когда параметр typeCheck включён в блоке lint.options файла vite.config.ts, vp check также выполняет проверку типов TypeScript средствами Oxlint, используя инструментарий TypeScript Go и tsgolint. Команды vp create и vp migrate включают параметры typeAware и typeCheck по умолчанию.

Мы рекомендуем включить typeCheck, чтобы vp check стал единой командой для выполнения статических проверок в процессе разработки.

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

vp check
vp check --fix              # Выполнить форматирование и автоматические исправления.
vp check --no-fmt           # Пропустить форматирование; выполнить линтинг (и проверку типов, если она включена).
vp check --no-lint          # Пропустить правила линтинга; сохранить проверку типов, если она включена.
vp check --no-fmt --no-lint # Только проверка типов (требуется включённый `typeCheck`).

Конфигурация

vp check использует ту же конфигурацию, которую вы уже определили для линтинга и форматирования:

• блок lint в vite.config.ts
• блок fmt в vite.config.ts
• структура проекта TypeScript и файлы tsconfig для линтинга с учётом типов

Рекомендуемая базовая конфигурация lint:

vite.config.ts

import { defineConfig } from 'vite-plus';

export default defineConfig({
  lint: {
    options: {
      typeAware: true,
      typeCheck: true,
    },
  },
});

Отключение шага по умолчанию

Чтобы vp check пропускал форматирование или линтинг без необходимости каждый раз передавать флаг, настройте блок check в vite.config.ts. Это полезно, когда в проекте используется остальная цепочка инструментов, но, например, без форматирования:

vite.config.ts

import { defineConfig } from 'vite-plus';

export default defineConfig({
  check: {
    fmt: false, // `vp check` выполняет линтинг (и проверку типов), но не форматирует код
  },
});

Эти настройки влияют только на vp check; отдельные команды vp fmt и vp lint продолжают работать как обычно. Шаг пропускается, если он отключён в конфигурации или передан соответствующий флаг --no-fmt / --no-lint. Так как настройки по умолчанию применяются ко всем запускам vp check, хук pre-commit, вызывающий vp check, также будет учитывать отключённые шаги. См. vp check для полной справки.