Инструменты и выполнение

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

Выберите команды для файла или пакета и проверьте результаты форматирования, тестов, запуска и сборки.

Выберите команды для форматирования, проверки, тестирования, запуска и сборки программы на Топазе. Можно начать с одного файла или объединить несколько файлов и зависимости в пакет.

Установите topaz по руководству Первая программа. Пример пакета ниже использует готовый проект study-plan из Первого приложения.

Выберите файл или пакет

В папке с first-program.tpz из Первой программы выполните следующие команды.

BASH
topaz check first-program.tpz
topaz run first-program.tpz

Успешная проверка завершается с кодом 0. Программа печатает Topaz basics: 25 minutes. Для работы с пакетом выполните следующие команды внутри study-plan, рядом с topaz.toml и созданным topaz.lock.

BASH
topaz fmt --check --root .
topaz check --root . --locked
topaz test tests/plan.tpz --root . --locked
topaz run --root . --locked
topaz build --root . --locked --out-dir product
КомандаЧто проверить
fmt --checkКод завершения 0 означает, что исходники отформатированы по правилам Топаза. При различиях выполните topaz fmt --root . и повторите проверку.
checkКод завершения 0 означает успешную проверку синтаксиса, имён, импортов и типов. Программа ещё не запускалась.
test tests/plan.tpzВыполняет выбранный тестовый файл. Успешный тест выводит test-ok.
runУчебный планировщик печатает tasks=2, remaining=25 minutes.
buildСоздаёт product/ с исполняемым файлом и topaz-artifact.json, который содержит сведения о созданных файлах.

Если файл не указан, команды пакета используют точку входа из topaz.toml. Для выполнения теста укажите его файл. Флаг --locked сверяет манифест и содержимое локальных зависимостей с topaz.lock. Раздел Пакеты и распространение объясняет, как создать или обновить этот файл.

Команда build создаёт файлы для распространения. Для нативной и Web-сборки нужен инструментарий Rust для выбранной цели. Выберите её в разделе Интерпретатор и бэкенды, затем следуйте руководству Артефакты и развёртывание.

Используйте компилятор в редакторе

Компилятор self выбран по умолчанию. Он написан на Топазе и входит в установленный исполняемый файл. Для сравнения с эталонным компилятором на Rust выберите --compiler rust. Сведения об установке приведены в разделе Состояние инструментария.

Установите официальное расширение из Visual Studio Marketplace для VS Code или Open VSX Registry для VSCodium и совместимых редакторов.

Оба магазина предлагают одно и то же расширение. Оно распознаёт файлы .tpz, добавляет значок файла, подсветку синтаксиса, настройки комментариев и скобок, а также основные сниппеты. Для отображения диагностики компилятора расширение запускает установленный сервер topaz lsp.

Установите компилятор отдельно. Если исполняемый файл отсутствует, редактор сообщит об этом, а подсветка и статические функции редактирования продолжат работать. Задайте topaz.executablePath, если topaz отсутствует в PATH.

Продолжите работу после ошибки

Если команда завершилась с ненулевым кодом, исправьте первую ошибку и повторите команду. Параметры и коды ошибок описаны в разделе CLI и диагностика.

Если при сборке не найден инструментарий Rust, установите его для выбранной цели. Если файлы в существующем каталоге вывода изменились, сохраните каталог и выберите новый пустой --out-dir.