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

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

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

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

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

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

  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, добавляет значок Топаза и подсветку, а также запускает установленный LSP Топаза для автодополнения, навигации, диагностики, переименования, сигнатур и быстрых исправлений. Настройка topaz.compiler выбирает rust по умолчанию либо установленный компилятор self. Один процесс языкового сервера сохраняет один выбор, поэтому после изменения настройки перезагрузите редактор. Отдельная окончательная проверка выполняется командой topaz check.

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

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

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

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