Перейти до основного вмісту

@ditsmod/cli

Цей пакет надає інтерфейс командного рядка (CLI) та інструменти розробки для застосунків Ditsmod.

Встановлення​

npm i -g @ditsmod/cli

Або запустіть його безпосередньо без встановлення за допомогою npx:

npx @ditsmod/cli <command>

Примітка: Бінарні аліаси ditsmod та dm доступні після встановлення пакета.

Команди​

ditsmod new​

Створює новий застосунок Ditsmod у цільовій директорії за допомогою офіційних шаблонів старту.

ditsmod new my-app [options]

Параметри:​

  • -t, --template <name>: Стартовий шаблон для використання (rest, rest-monorepo, trpc-monorepo). По дефолту: "rest".
  • -m, --package-manager <name>: Менеджер пакетів (npm, yarn, pnpm). По дефолту: "npm".
  • --skip-install: Пропустити автоматичне встановлення пакетів.
  • --skip-git: Пропустити ініціалізацію чистого репозиторію Git.

Приклади:​

# Створення REST застосунку за допомогою Yarn
dm new my-rest-api -m yarn

# Створення tRPC монорепозиторію без встановлення пакетів
dm new my-trpc-app -t trpc-monorepo --skip-install

ditsmod start​

Запускає застосунок Ditsmod у режимі розробки з інкрементною компіляцією TypeScript та плавним перезапуском процесів.

ditsmod start [entryFile] [options]

Параметри:​

  • -p, --project <path>: Шлях до конфігураційного файлу TypeScript або каталогу проєкту. По дефолту: "tsconfig.build.json".
  • -e, --exec <binary>: Бінарний файл для виконання вхідного файлу. По дефолту: "node".
  • -d, --debug [hostport]: Запуск Node.js у режимі відлагодження із прапорцем --inspect.
  • --env-file <paths...>: Файл(и) оточення для завантаження в process.env.
  • --entry-file <file>: Відносний шлях до скомпільованого вхідного файлу JavaScript. По дефолту: "dist/main.js".
  • --watch-assets <globs...>: Глоби не-TypeScript ресурсів для відстеження та копіювання в dist/.
  • --preserve-watch-output: Не очищати екран терміналу між циклами компіляції.

Приклади:​

# Запуск застосунку з кастомним вхідним файлом та увімкненим режимом відлагодження
dm start tmp.ts -d 9229

# Запуск із файлом оточення та відстеженням змін у JSON-файлах
dm start --env-file .env.local --watch-assets "src/**/*.json"

Програмний API​

@ditsmod/cli експортує свої основні класи та допоміжні функції команд для програмного використання:

import { WatchCompiler, ProcessManager, AssetWatcher, startCommand, newCommand } from '@ditsmod/cli';