Топаздокументация
Инструменты и выполнение

Обзор инструментария

Стандартный цикл разработки и поставки Топаза и список руководств по выполнению задач.

Инструментарий Топаза проводит файлы и пакеты по единому проверенному пути от исходного кода до исполняемого продукта. Для работы с ним не нужно знать внутреннее устройство синтаксического анализатора или генератора кода.

Обычный порядок

Используйте команды в следующем порядке:

  1. fmt --check проверяет соответствие исходного кода каноническому форматированию.
  2. check выполняет разрешение модулей и сообщает о синтаксисе, именах и типах без запуска программы.
  3. test выполняет проверенные тестовые точки входа в детерминированной тестовой среде.
  4. run напрямую запускает консольное приложение в интерпретаторе.
  5. build создаёт один целевой артефакт продукта для последующей поставки.

Для пакета с зафиксированными зависимостями полный набор выглядит так:

BASH
topaz fmt --check --root my-app
topaz check --root my-app --locked
topaz test --root my-app --locked
topaz run --root my-app --locked
topaz build --root my-app --locked --out-dir product

Пакеты Web Application и HTTP используют topaz dev вместо topaz run для разработки с отслеживанием изменений через локальный сетевой интерфейс, после чего применяется та же пакетная команда build.

Поддержка редакторов

Официальное расширение Топаза доступно в Visual Studio Marketplace и Open VSX Registry. Для VS Code используйте Marketplace, а для VSCodium и других совместимых редакторов — Open VSX.

Оба магазина распространяют одно официальное расширение. Оно распознаёт файлы .tpz, добавляет значок Топаза и подсветку синтаксиса, настраивает правила для комментариев и скобок, предоставляет основные сниппеты и запускает установленный topaz lsp для отображения диагностики в редакторе. Значение topaz.compiler по умолчанию соответствует политике компилятора установленного Топаза. Выбирайте rust только для явного сравнения или восстановления, а self — чтобы явно запросить установленный самохостируемый компилятор.

Расширение не содержит компилятор. Если настроенный исполняемый файл Топаза не найден, подсветка и остальные статические возможности редактора остаются доступны, а редактор сообщает об отсутствующем файле. Если Топаза нет в PATH, задайте topaz.executablePath.

Что меняет успешная команда

fmt --check, check, test и run не создают продукт развёртывания. build создаёт управляемый каталог цели и записывает список его файлов в topaz-artifact.json. Пакетные команды считывают topaz.toml. При --locked файл topaz.lock также должен соответствовать манифесту и локальным байтам зависимостей.

Ненулевой код завершения означает, что запрошенный шаг не выполнен. Исправьте первую ошибку из диагностики Топаза и повторите этот шаг. Если отсутствует внешний компилятор, выберите цель с доступными требованиями либо установите нужный набор инструментов. Если управляемый каталог вывода изменился, сохраните его и используйте новый пустой каталог.

Следующая страница по задаче