Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
path: root/content/ru-RU/docs/2.reference/1.commands.md
blob: ebc6b1b452ebd98ade8e9f1a50060e4118ddd3f8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
---
title: Команды
description: Каждая команда tazel, её параметры и метки, которые она принимает.
---

<!-- SPDX-FileCopyrightText: 2026 Progmasoft <[email protected]> -->
<!-- SPDX-License-Identifier: AGPL-3.0-or-later -->

```text
tazel <command> [options] [labels]
```

| Команда | Что делает |
| --- | --- |
| `build` | собирает цели, например `tazel build //app/:greeter` или `tazel build //...` |
| `run` | собирает одну цель `bin` и запускает её; то, что после `--`, передаётся программе |
| `test` | собирает и запускает тестовые цели; то, что после `--`, передаётся каждому тесту |
| `fmt` | форматирует исходники и заголовки целей с помощью clang-format и `zig fmt`; `--check` только сообщает |
| `lint` | проверяет исходники семейства C с помощью clang-tidy; `--fix` применяет его исправления |
| `custom` | запускает команду из `tazel_custom.txt` или выводит их список |
| `version` | выводит версию Tazel |
| `help` | выводит справку |

Для опечатки в команде предлагается ближайшая команда.

## Метки

| Метка | Означает |
| --- | --- |
| `//:x` | цель `x` корневого `BUILD.kts` |
| `//dir/:x` | цель `x` файла `dir/BUILD.kts` |
| `:x` | цель `x` того же `BUILD.kts`, внутри файла проекта |
| `@name//:x` | цель `x` зависимости `name`: её имя, псевдоним или имя её локального блока |
| `//dir/...` | каждая цель `dir/BUILD.kts` и пакетов ниже |
| `//...` | каждая цель модуля |

Без метки `build`, `run` и `test` берут пакет текущего каталога. Шаблон не берёт тест с тегом `MANUAL`; такой тест
запускается, только когда его назвали.

## build, run и test

| Параметр | Действие |
| --- | --- |
| `--release` | собирает в режиме release; без него — debug |
| `--triple <triple>` | собирает для этой целевой тройки LLVM, например `aarch64-unknown-linux-gnu`; без него — для этой машины |

Каждая цель собирается для каждой тройки, которую она называет и которую запрашивает команда, в режиме сборки команды.
Результаты попадают в `.tazel/out/<triple>/<mode>`. Каждая компиляция, архивация, компоновка и сборка Zig запускается
снова, только если изменились её командная строка, окружение или содержимое прочитанного файла либо записанный
результат отсутствует или изменён.

`tazel test` запускает каждый тест в его каталоге результатов, рядом с его данными, с его `args` и `env`. Тест
проходит, если завершается с кодом 0. Тесты идут параллельно, кроме тестов с тегом `EXCLUSIVE`, которые идут
поодиночке. Тест останавливается по тайм-ауту, повторяется до трёх раз при `flaky = true` и делится на `shards` с
`TEST_TOTAL_SHARDS` и `TEST_SHARD_INDEX`. Прошедший тест не запускается снова, пока его программа, данные, аргументы
и окружение те же, если у него нет тега `NO_CACHE`.

## fmt и lint

```bash
tazel fmt //...
tazel fmt --check //...
tazel lint //...
tazel lint --fix //app/...
```

`fmt` форматирует исходники, каталоги заголовков и текстовые заголовки выбранных целей с помощью clang-format (C, C++,
Objective-C, Objective-C++) и `zig fmt` (Zig); `--check` сообщает, что не отформатировано, и ничего не меняет.

`lint` записывает базу компиляции выбранных целей и их библиотек в
`.tazel/out/<triple>/<mode>/compile_commands.json`, копирует её для редакторов в `.tazel/compile_commands.json` и
запускает clang-tidy для каждой единицы трансляции семейства C. `--fix` применяет исправления по одной единице за раз.
Цели на Zig пропускаются.

Для обеих команд то, что после `--`, передаётся инструменту. Каждый инструмент читает свою конфигурацию, например
`.clang-format` и `.clang-tidy`.

## custom

`tazel custom` запускает команды из `tazel_custom.txt` в корне модуля; `tazel custom` без аргументов выводит их
список.

```text
# tazel_custom.txt
format-check: ("tazel" "fmt" "--check" "//...");

all:
    ("tazel" "build" "//...")
    ("tazel" "test" "//...");

hello: s("echo hello from the shell");

build with: ("tazel" "build" <1> <2>);
```

- Команда — это имя, `:`, один или несколько шагов и `;`. Имя может состоять из нескольких слов:
  `tazel custom build with`.
- Шаг `("program" "argument" ...)` запускает программу с этими аргументами. Строки пишутся в `"..."`, `'...'` или
  `` `...` ``; экранирующих символов нет.
- Шаг `s("...")` передаёт одну командную строку оболочке: `sh` в Linux и macOS, `cmd` в Windows.
- `<1>`, `<2>` и далее передают аргументы командной строки по позиции; `<*>` передаёт все. `s(...)` аргументов не
  принимает. `tazel custom first -- second` передаёт `second` команде `first`, если существует команда `first second`.
- `#` начинает комментарий до конца строки; `<# ... #>` — многострочный комментарий.

`tazel_options.txt` в корне модуля хранит параметры самого Tazel:

```text
sandboxing-with-microvm: false;
```

При `sandboxing-with-microvm: true` пользовательские команды должны идти в MicroVM, которую эта версия не запускает,
поэтому они завершаются с ошибкой. `microvm-network`, `microvm-memory` и `microvm-cpus` настраивают эту MicroVM.

## version и help

```bash
tazel version
tazel help
```