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

summaryrefslogtreecommitdiffhomepage
path: root/content/ru-RU/docs/2.reference/2.module-file.md
blob: e420be84d694bb13d1515b750153dd5de9941803 (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
---
title: MODULE.kts
description: Файл в корне модуля: его имя, зависимости и то, как он собирается.
---

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

У модуля один `MODULE.kts`, в его корне. Это скрипт Kotlin; `module { }` — единственный обязательный блок.

```kotlin
module {
    name = "greeter"
    version = "1.2.0"
    description = "Greets people."
    authors("Ada Lovelace", "Alan Turing")
    license = "MIT"
}

dependencies {
    implementation("Publisher") {
        name = "toml"
        version = "1.0.0"
    }
    testImplementation("Progmasoft") {
        name = "catch3"
        version = "0.4.0"
    }
    localImplementation {
        name = "libs"
        include(glob("libs/*.vipkg"))
    }
}

execution {
    jobs = 8
    keepGoing = false
}
```

## module

| Настройка | Значение |
| --- | --- |
| `name` | имя модуля; обязательно |
| `version` | семантическая версия, например `1.2.0` |
| `description` | одно предложение о модуле |
| `authors(...)` | его авторы |
| `license` | выражение лицензии SPDX, например `MIT` или `Apache-2.0 OR MIT` |

## dependencies

| Блок | Даёт |
| --- | --- |
| `implementation("Publisher") { name; version; alias }` | пакет из ViGet, от которого может зависеть любая цель |
| `testImplementation("Publisher") { ... }` | то же, только для тестовых целей |
| `localImplementation { name; include(...) }` | пакеты из файлов `.vipkg` модуля |
| `localTestImplementation { ... }` | то же, только для тестовых целей |

Издатель — это [Progmasoft Account](https://progmasoft.com). Цель называет цель зависимости как `@name//:x`, где
`name` — это `name` зависимости, её `alias` или `name` локального блока. Локальный блок, `include` которого берёт
несколько пакетов, даёт им одно имя; одно и то же имя цели в двух из них — ошибка.

::note
Эта версия Tazel читает зависимости и проверяет метки, которые их называют; пакеты из ViGet она не загружает.
Версии, которые разрешает модуль, фиксируются в `LOCK.sqlite3` в его корне — файле блокировки Tazel, который эта
версия не записывает.
::

## viget

```kotlin
viget {
    push = true
    pushTarget("//core/:core", "//app/:greeter")
    exclude(glob("docs/**"))
}
```

`pushTarget` называет цели, которые содержит пакет модуля; в их `BUILD.kts` должно быть `isPublic = true`. `exclude`
исключает файлы из пакета. По умолчанию `push` — `false`.

## cache

```kotlin
cache {
    local = true
    keep = 8
    remote("https://cache.example.com") {
        read = true
        write = false
        token = env("TAZEL_CACHE_TOKEN")
    }
}
```

`local` (по умолчанию `true`) и `keep` (сколько результатов хранить на цель, по умолчанию `8`) описывают локальный
кэш; `remote(...)` добавляет общий, с `read` (по умолчанию `true`), `write` (по умолчанию `false`), `token`,
`publicKey` и `signingKey`. `env("NAME")` читает переменную окружения, чтобы секреты не попадали в файл.

## execution

| Настройка | По умолчанию | Действие |
| --- | --- | --- |
| `jobs` | число процессоров | сколько команд идёт одновременно |
| `memory` | без ограничения | ограничение вроде `16.gigabytes` |
| `keepGoing` | `false` | после ошибки запускать команды, которые от неё не зависят |
| `remote(url) { token }` | нет | машина, которая выполняет команды |

Эта версия Tazel учитывает `jobs` и `keepGoing`; остальные настройки `cache` и `execution` читаются и проверяются.