@alfalab/arui-scripts-artifacts 0.0.0-beta-20260824133302

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (142) hide show
  1. package/.eslintignore +2 -0
  2. package/.eslintrc.js +8 -0
  3. package/.prettierignore +2 -0
  4. package/.turbo/turbo-build.log +0 -0
  5. package/.turbo/turbo-test.log +15 -0
  6. package/CHANGELOG.md +42 -0
  7. package/README.md +298 -0
  8. package/build/archive/build-archive.d.ts +14 -0
  9. package/build/archive/build-archive.js +69 -0
  10. package/build/archive/constants.d.ts +6 -0
  11. package/build/archive/constants.js +6 -0
  12. package/build/archive/index.d.ts +2 -0
  13. package/build/archive/index.js +2 -0
  14. package/build/cjs/archive/build-archive.d.ts +14 -0
  15. package/build/cjs/archive/build-archive.js +75 -0
  16. package/build/cjs/archive/constants.d.ts +6 -0
  17. package/build/cjs/archive/constants.js +9 -0
  18. package/build/cjs/archive/index.d.ts +2 -0
  19. package/build/cjs/archive/index.js +9 -0
  20. package/build/cjs/bin/index.d.ts +2 -0
  21. package/build/cjs/bin/index.js +58 -0
  22. package/build/cjs/cli/config-file.d.ts +46 -0
  23. package/build/cjs/cli/config-file.js +117 -0
  24. package/build/cjs/cli/create-cli.d.ts +25 -0
  25. package/build/cjs/cli/create-cli.js +75 -0
  26. package/build/cjs/cli/index.d.ts +3 -0
  27. package/build/cjs/cli/index.js +17 -0
  28. package/build/cjs/cli/load-config-file.d.ts +15 -0
  29. package/build/cjs/cli/load-config-file.js +62 -0
  30. package/build/cjs/config/index.d.ts +10 -0
  31. package/build/cjs/config/index.js +132 -0
  32. package/build/cjs/config/types.d.ts +226 -0
  33. package/build/cjs/config/types.js +2 -0
  34. package/build/cjs/docker/build-command.d.ts +13 -0
  35. package/build/cjs/docker/build-command.js +65 -0
  36. package/build/cjs/docker/build-docker-image.d.ts +21 -0
  37. package/build/cjs/docker/build-docker-image.js +65 -0
  38. package/build/cjs/docker/build-params.d.ts +20 -0
  39. package/build/cjs/docker/build-params.js +52 -0
  40. package/build/cjs/docker/constants.d.ts +19 -0
  41. package/build/cjs/docker/constants.js +22 -0
  42. package/build/cjs/docker/index.d.ts +7 -0
  43. package/build/cjs/docker/index.js +26 -0
  44. package/build/cjs/docker/prepare-files.d.ts +19 -0
  45. package/build/cjs/docker/prepare-files.js +81 -0
  46. package/build/cjs/docker/templates/dockerfile-compiled.template.d.ts +6 -0
  47. package/build/cjs/docker/templates/dockerfile-compiled.template.js +52 -0
  48. package/build/cjs/docker/templates/dockerfile.template.d.ts +5 -0
  49. package/build/cjs/docker/templates/dockerfile.template.js +46 -0
  50. package/build/cjs/index.d.ts +15 -0
  51. package/build/cjs/index.js +45 -0
  52. package/build/cjs/nginx/constants.d.ts +11 -0
  53. package/build/cjs/nginx/constants.js +19 -0
  54. package/build/cjs/nginx/index.d.ts +3 -0
  55. package/build/cjs/nginx/index.js +13 -0
  56. package/build/cjs/nginx/templates/base-nginx.conf.template.d.ts +7 -0
  57. package/build/cjs/nginx/templates/base-nginx.conf.template.js +57 -0
  58. package/build/cjs/nginx/templates/nginx.conf.template.d.ts +5 -0
  59. package/build/cjs/nginx/templates/nginx.conf.template.js +52 -0
  60. package/build/cjs/pipeline/build-artifact.d.ts +8 -0
  61. package/build/cjs/pipeline/build-artifact.js +16 -0
  62. package/build/cjs/pipeline/host-pipeline.d.ts +9 -0
  63. package/build/cjs/pipeline/host-pipeline.js +33 -0
  64. package/build/cjs/pipeline/index.d.ts +3 -0
  65. package/build/cjs/pipeline/index.js +9 -0
  66. package/build/cjs/pipeline/render.d.ts +16 -0
  67. package/build/cjs/pipeline/render.js +38 -0
  68. package/build/cjs/start-script/constants.d.ts +4 -0
  69. package/build/cjs/start-script/constants.js +7 -0
  70. package/build/cjs/start-script/index.d.ts +2 -0
  71. package/build/cjs/start-script/index.js +8 -0
  72. package/build/cjs/start-script/start.template.d.ts +6 -0
  73. package/build/cjs/start-script/start.template.js +74 -0
  74. package/build/cjs/utils/exec.d.ts +12 -0
  75. package/build/cjs/utils/exec.js +36 -0
  76. package/build/cjs/utils/shell.d.ts +6 -0
  77. package/build/cjs/utils/shell.js +16 -0
  78. package/build/cjs/utils/yarn.d.ts +25 -0
  79. package/build/cjs/utils/yarn.js +70 -0
  80. package/build/cli/config-file.d.ts +46 -0
  81. package/build/cli/config-file.js +110 -0
  82. package/build/cli/create-cli.d.ts +25 -0
  83. package/build/cli/create-cli.js +71 -0
  84. package/build/cli/index.d.ts +3 -0
  85. package/build/cli/index.js +3 -0
  86. package/build/cli/load-config-file.d.ts +15 -0
  87. package/build/cli/load-config-file.js +53 -0
  88. package/build/config/index.d.ts +10 -0
  89. package/build/config/index.js +126 -0
  90. package/build/config/types.d.ts +226 -0
  91. package/build/config/types.js +1 -0
  92. package/build/docker/build-command.d.ts +13 -0
  93. package/build/docker/build-command.js +57 -0
  94. package/build/docker/build-docker-image.d.ts +21 -0
  95. package/build/docker/build-docker-image.js +59 -0
  96. package/build/docker/build-params.d.ts +20 -0
  97. package/build/docker/build-params.js +44 -0
  98. package/build/docker/constants.d.ts +19 -0
  99. package/build/docker/constants.js +19 -0
  100. package/build/docker/index.d.ts +7 -0
  101. package/build/docker/index.js +7 -0
  102. package/build/docker/prepare-files.d.ts +19 -0
  103. package/build/docker/prepare-files.js +75 -0
  104. package/build/docker/templates/dockerfile-compiled.template.d.ts +6 -0
  105. package/build/docker/templates/dockerfile-compiled.template.js +49 -0
  106. package/build/docker/templates/dockerfile.template.d.ts +5 -0
  107. package/build/docker/templates/dockerfile.template.js +43 -0
  108. package/build/index.d.ts +15 -0
  109. package/build/index.js +20 -0
  110. package/build/nginx/constants.d.ts +11 -0
  111. package/build/nginx/constants.js +16 -0
  112. package/build/nginx/index.d.ts +3 -0
  113. package/build/nginx/index.js +3 -0
  114. package/build/nginx/templates/base-nginx.conf.template.d.ts +7 -0
  115. package/build/nginx/templates/base-nginx.conf.template.js +54 -0
  116. package/build/nginx/templates/nginx.conf.template.d.ts +5 -0
  117. package/build/nginx/templates/nginx.conf.template.js +49 -0
  118. package/build/pipeline/build-artifact.d.ts +8 -0
  119. package/build/pipeline/build-artifact.js +13 -0
  120. package/build/pipeline/host-pipeline.d.ts +9 -0
  121. package/build/pipeline/host-pipeline.js +27 -0
  122. package/build/pipeline/index.d.ts +3 -0
  123. package/build/pipeline/index.js +3 -0
  124. package/build/pipeline/render.d.ts +16 -0
  125. package/build/pipeline/render.js +35 -0
  126. package/build/start-script/constants.d.ts +4 -0
  127. package/build/start-script/constants.js +4 -0
  128. package/build/start-script/index.d.ts +2 -0
  129. package/build/start-script/index.js +2 -0
  130. package/build/start-script/start.template.d.ts +6 -0
  131. package/build/start-script/start.template.js +71 -0
  132. package/build/utils/exec.d.ts +12 -0
  133. package/build/utils/exec.js +28 -0
  134. package/build/utils/shell.d.ts +6 -0
  135. package/build/utils/shell.js +13 -0
  136. package/build/utils/yarn.d.ts +25 -0
  137. package/build/utils/yarn.js +61 -0
  138. package/jest.config.js +12 -0
  139. package/package.json +57 -0
  140. package/tsconfig.cjs.json +13 -0
  141. package/tsconfig.eslint.json +7 -0
  142. package/tsconfig.json +22 -0
package/.eslintignore ADDED
@@ -0,0 +1,2 @@
1
+ build
2
+ .turbo
package/.eslintrc.js ADDED
@@ -0,0 +1,8 @@
1
+ module.exports = {
2
+ root: true,
3
+ extends: [require.resolve('arui-presets-lint/eslint')],
4
+ parserOptions: {
5
+ tsconfigRootDir: __dirname,
6
+ project: ['./tsconfig.eslint.json'],
7
+ },
8
+ };
@@ -0,0 +1,2 @@
1
+ .turbo
2
+ build
File without changes
@@ -0,0 +1,15 @@
1
+ ts-jest[versions] (WARN) Version 6.0.2 of typescript installed has not been tested with ts-jest. If you're experiencing issues, consider using a supported version (>=4.3.0 <6.0.0-0). Please do not report issues in ts-jest if you are using unsupported versions.
2
+ ts-jest[versions] (WARN) Version 6.0.2 of typescript installed has not been tested with ts-jest. If you're experiencing issues, consider using a supported version (>=4.3.0 <6.0.0-0). Please do not report issues in ts-jest if you are using unsupported versions.
3
+ ts-jest[versions] (WARN) Version 6.0.2 of typescript installed has not been tested with ts-jest. If you're experiencing issues, consider using a supported version (>=4.3.0 <6.0.0-0). Please do not report issues in ts-jest if you are using unsupported versions.
4
+ PASS src/config/__tests__/config.test.ts (10.258 s)
5
+ PASS src/pipeline/__tests__/render.test.ts (10.745 s)
6
+ PASS src/cli/__tests__/config-file.test.ts (11.651 s)
7
+ PASS src/cli/__tests__/cli.test.ts
8
+ PASS src/docker/__tests__/docker-build.test.ts
9
+ PASS src/cli/__tests__/load-config-file.test.ts
10
+
11
+ Test Suites: 6 passed, 6 total
12
+ Tests: 74 passed, 74 total
13
+ Snapshots: 0 total
14
+ Time: 14.127 s
15
+ Ran all test suites.
package/CHANGELOG.md ADDED
@@ -0,0 +1,42 @@
1
+ # @alfalab/arui-scripts-artifacts
2
+
3
+ ## 0.0.0-beta-20260824133302
4
+
5
+ ### Minor Changes
6
+
7
+ - [#565](https://github.com/core-ds/arui-scripts/pull/565) [`8eae13cb`](https://github.com/core-ds/arui-scripts/commit/8eae13cb128be2ad0b8c873b7bd314b02d11cfb7) Thanks [@sowtame](https://github.com/sowtame)! - Сборка артефактов поставки вынесена в отдельный пакет `@alfalab/arui-scripts-artifacts`.
8
+
9
+ Пакет устроен как набор чистых функций и настраивается одним файлом `arui-scripts-artifacts.ts` в
10
+ корне проекта (путь можно задать через `--c`/`--config`). Конфиг может быть на TypeScript, ESM или
11
+ CommonJS и описывает всё: базовый образ, параметры nginx, кастомные шаблоны и свои команды сборки —
12
+ так что кастомные сборочные скрипты в проектах больше не нужны.
13
+
14
+ Поддерживаются оба типа артефактов: docker-образ (`docker-build`, `docker-build:compiled`) и
15
+ tar-архив (`archive-build`). Хост-пайплайн (очистка `buildPath` → сборка приложения → удаление
16
+ dev-зависимостей) у них общий.
17
+
18
+ `arui-scripts` теперь использует этот пакет вместо собственной копии шаблонов и утилит. Поведение
19
+ команд и все ключи оверрайдов (`Dockerfile`, `DockerfileCompiled`, `nginx`, `nginxConf`, `start.sh`)
20
+ сохранены без изменений — отрендеренные Dockerfile, nginx-конфиги и start.sh совпадают побайтово.
21
+
22
+ Попутно починен `archive-build`: он падал с `TypeError: Cannot read properties of undefined
23
+ (reading 'c')`, потому что в `tar@7` нет default-экспорта, а код использовал `import tar from 'tar'`.
24
+
25
+ Команды `arui-scripts docker-build`, `docker-build:compiled` и `archive-build` теперь запускают CLI
26
+ `@alfalab/arui-scripts-artifacts` с конфигом, который arui-scripts возит с собой. Благодаря этому
27
+ `arui-scripts-artifacts.ts` в корне проекта работает и через команды arui-scripts: он находится по
28
+ обычным правилам и кладется поверх настроек из конфига arui-scripts. Заводить его по-прежнему не
29
+ обязательно.
30
+
31
+ Настройки сборки артефактов в конфиге arui-scripts (`dockerRegistry`, `baseDockerImage`,
32
+ `nginxRootPath`, `nginx`, `runFromNonRootUser`, `removeDevDependenciesDuringDockerBuild`,
33
+ `archiveName`, `additionalBuildPath`) и оверрайды `Dockerfile`, `DockerfileCompiled`, `nginx`,
34
+ `nginxConf`, `start.sh` объявлены устаревшими: они продолжают работать, но команды сборки печатают
35
+ предупреждение со ссылкой на замену, а в следующей мажорной версии будут удалены.
36
+
37
+ Настройки в конфиге @alfalab/arui-scripts-artifacts сгруппированы по доменам: `docker`, `nginx`, `archive`, `build`,
38
+ `packageManager`, `localFiles`. Так же разложен и код пакета — по папке на домен.
39
+
40
+ Единственное отличие в поведении: `archive-build` теперь подхватывает локальный `start.sh` из корня
41
+ проекта так же, как уже подхватывал `nginx.conf` (раньше игнорировал). Отключается опцией
42
+ `localFiles.allowStartScript: false`.
package/README.md ADDED
@@ -0,0 +1,298 @@
1
+ # @alfalab/arui-scripts-artifacts
2
+
3
+ Сборка артефактов поставки — docker-образа и tar-архива — для приложений, основанных на `arui-scripts`.
4
+
5
+ Пакет устроен как набор чистых функций: конфиг → строка. Никакого глобального состояния, никакой
6
+ зависимости от `arui-scripts` — всё, что влияет на результат, приходит явным объектом опций. Из этого
7
+ следует главное свойство: **в проекте не нужны кастомные сборочные скрипты**. Всё, включая свои
8
+ команды, кастомный nginx и параметры базового nginx, описывается одним файлом `arui-scripts-artifacts.ts`.
9
+
10
+ ## Быстрый старт
11
+
12
+ ```bash
13
+ yarn add -D @alfalab/arui-scripts-artifacts
14
+ ```
15
+
16
+ `arui-scripts-artifacts.ts` в корне проекта:
17
+
18
+ ```ts
19
+ import { defineConfig } from '@alfalab/arui-scripts-artifacts';
20
+
21
+ export default defineConfig({
22
+ docker: {
23
+ baseImage: 'alfabankui/arui-scripts:24.10.0-slim',
24
+ registry: 'registry.example.com',
25
+ },
26
+ nginx: {
27
+ baseConf: { workerProcesses: 4 },
28
+ },
29
+ });
30
+ ```
31
+
32
+ `package.json`:
33
+
34
+ ```json
35
+ {
36
+ "scripts": {
37
+ "docker-build": "arui-scripts-artifacts docker-build",
38
+ "docker-build:compiled": "arui-scripts-artifacts docker-build:compiled"
39
+ }
40
+ }
41
+ ```
42
+
43
+ ## Структура конфига
44
+
45
+ Настройки сгруппированы по тому, к чему относятся. На верхнем уровне остается только то, что общее
46
+ для всех артефактов, — идентификация и форма самого приложения:
47
+
48
+ | Секция | За что отвечает |
49
+ | ---------------- | -------------------------------------------------------------------------------- |
50
+ | _верхний уровень_ | `artifact`, `name`, `version`, `cwd`, `debug`, `clientOnly`, `buildPath`, `serverOutput`, `serverPort`, `assetsPath`, `publicPath` |
51
+ | `docker` | `variant`, `registry`, `baseImage`, `runFromNonRootUser`, `context`, `tempDirName`, `push`, `platform`, `buildArgs`, `addNodeModulesToDockerIgnore` |
52
+ | `nginx` | `port`, `rootPath`, `enablePreviousVersionHeaders`, `baseConf` (http-блок) |
53
+ | `archive` | `name`, `tempDirName`, `additionalPaths` |
54
+ | `build` | хост-пайплайн: `cleanBuildPath`, `command`, `removeDevDependencies` |
55
+ | `packageManager` | `useYarn`, `yarnVersion`, `installProductionCommand`, `pruneCommand` |
56
+ | `localFiles` | пути до `dockerfile`/`startScript`/`nginxConf`/`nginxBaseConf` и флаги `allowDockerfile`/`allowStartScript` |
57
+ | `templates`, `overrides` | кастомизация шаблонов (см. ниже) |
58
+
59
+ Все поля опциональны — недостающие донасыщает `resolveArtifactsConfig`. Дефолты совпадают с
60
+ историческим поведением `arui-scripts`, поэтому конфиг без единой настройки соберет тот же образ,
61
+ что и `arui-scripts docker-build`.
62
+
63
+ `nginx.baseConf` по умолчанию `null` — базовый конфиг не генерируется и не кладется в артефакт
64
+ (используется тот, что лежит в базовом образе). Любой объект включает его; `false`/`null` — выключает.
65
+
66
+ Код пакета разложен по тем же доменам: `src/docker`, `src/nginx`, `src/archive`, `src/start-script`,
67
+ `src/config`, `src/pipeline`, `src/cli`.
68
+
69
+ ## CLI
70
+
71
+ ```bash
72
+ arui-scripts-artifacts <команда> [--c <путь до конфига>] [name=... version=... registry=...]
73
+ ```
74
+
75
+ Конфиг по умолчанию берется из корня проекта (`arui-scripts-artifacts.ts`, а также `.mts`/`.cts`/`.js`/
76
+ `.mjs`/`.cjs`/`.config.ts`). Путь можно задать явно — `--c`, `--config` или `-c`, со знаком равенства
77
+ или отдельным аргументом:
78
+
79
+ ```bash
80
+ arui-scripts-artifacts docker-build --c './configs/docker.prod.ts'
81
+ arui-scripts-artifacts docker-build --config=./configs/docker.prod.ts version=1.2.3
82
+ ```
83
+
84
+ Конфиг может быть на TypeScript, ESM или CommonJS — загрузчик разбирается сам, регистрировать
85
+ `ts-node`/`tsx` в проекте не нужно. Экспортировать можно объект или (в т.ч. асинхронную) функцию,
86
+ возвращающую объект.
87
+
88
+ ### Встроенные команды
89
+
90
+ | Команда | Что делает |
91
+ | ----------------------- | ------------------------------------------------------------------------------------- |
92
+ | `docker-build` | приложение собирается на хосте (`npm run build`), результат кладется в образ |
93
+ | `docker-build:compiled` | зависимости и сборка выполняются внутри образа, слои кешируются |
94
+ | `archive-build` | tar-архив с production-сборкой: `buildPath`, `node_modules`, `package.json`, `config` |
95
+
96
+ CLI сам подхватывает лежащие в корне `Dockerfile`, `start.sh`, `nginx.conf` и `base-nginx.conf` —
97
+ если они есть, они заменяют сгенерированные шаблоны (для `docker-build:compiled` подмена Dockerfile
98
+ и start.sh запрещена, как и в `arui-scripts`).
99
+
100
+ ### Свои команды
101
+
102
+ Вместо отдельного скрипта — секция `commands`. Команда наследует верхний уровень конфига, поэтому в
103
+ ней описывается только то, чем она отличается:
104
+
105
+ ```ts
106
+ import { defineConfig } from '@alfalab/arui-scripts-artifacts';
107
+
108
+ export default defineConfig({
109
+ docker: { baseImage: 'registry.example.com/base:2.0.0' },
110
+ nginx: { baseConf: { workerProcesses: 4 } },
111
+
112
+ commands: {
113
+ // серверный образ: свой энтрипоинт и порт, всё остальное — из верхнего уровня
114
+ 'docker-build:server': {
115
+ docker: { variant: 'compiled' },
116
+ serverOutput: 'server/index.js',
117
+ // сольется с верхнеуровневой секцией nginx
118
+ nginx: { port: 9090, baseConf: { workerConnections: 100 } },
119
+ },
120
+
121
+ // образ только со статикой
122
+ 'docker-build:static': {
123
+ clientOnly: true,
124
+ build: { command: 'npm run build:static' },
125
+ },
126
+
127
+ // еще один архив — с отдельным именем и своей сборкой
128
+ 'archive-build:e2e': {
129
+ artifact: 'archive',
130
+ archive: { name: 'e2e.tar' },
131
+ build: { command: 'npm run build:e2e' },
132
+ },
133
+ },
134
+ });
135
+ ```
136
+
137
+ ```bash
138
+ arui-scripts-artifacts docker-build:server
139
+ ```
140
+
141
+ Запуск без команды печатает список доступных — встроенные плюс объявленные в конфиге.
142
+
143
+ Секции (`docker`, `nginx`, `archive`, `build`, `packageManager`, `localFiles`, `templates`,
144
+ `overrides`) сливаются по полям, скалярные опции заменяются целиком.
145
+
146
+ ## Кастомизация файлов образа
147
+
148
+ Каждый файл настраивается на четырех уровнях, по возрастанию приоритета:
149
+
150
+ 1. **Опции** — секции `docker`, `nginx` и верхнеуровневые `clientOnly`, `buildPath`, `serverOutput`,
151
+ `publicPath` и остальные из `ArtifactsOptions`.
152
+ 2. **`templates`** — полная замена рендерера: `(config) => string`.
153
+ 3. **`overrides`** — точечная функция поверх сгенерированного: `(generated, config) => string`.
154
+ 4. **Локальные файлы** — `Dockerfile`, `start.sh`, `nginx.conf`, `base-nginx.conf` в корне проекта.
155
+
156
+ Ключи шаблонов: `dockerfile`, `dockerfileCompiled`, `nginxConf` (server-блок), `baseNginxConf`
157
+ (http-блок), `startScript`.
158
+
159
+ ```ts
160
+ import { defineConfig } from '@alfalab/arui-scripts-artifacts';
161
+
162
+ export default defineConfig({
163
+ // целиком свой server-блок nginx
164
+ templates: {
165
+ nginxConf: (config) => `
166
+ client_max_body_size 20m;
167
+
168
+ server {
169
+ listen ${config.nginx.port};
170
+ location = /health { return 200 ''; }
171
+ location / { proxy_pass http://127.0.0.1:${config.serverPort}; }
172
+ }`,
173
+ },
174
+
175
+ // или дописать к сгенерированному
176
+ overrides: {
177
+ dockerfile: (generated) => `${generated}\nLABEL team="web"`,
178
+ nginxConf: (generated, config) =>
179
+ config.clientOnly ? generated : `${generated}\n# proxy tuning\n`,
180
+ },
181
+ });
182
+ ```
183
+
184
+ Рендереры (`renderDockerfile`, `renderDockerfileCompiled`, `renderNginxConf`, `renderBaseNginxConf`,
185
+ `renderStartScript`) экспортируются наружу — их можно вызывать и оборачивать из своих шаблонов.
186
+
187
+ ## Программное API
188
+
189
+ `buildArtifact` — тот же пайплайн, что и у CLI (диспетчеризует на `buildDockerImage`/`buildArchive`
190
+ по полю `artifact`):
191
+
192
+ ```ts
193
+ import { buildArtifact } from '@alfalab/arui-scripts-artifacts';
194
+
195
+ await buildArtifact({
196
+ name: 'my-app',
197
+ version: '1.0.0',
198
+ docker: {
199
+ variant: 'compiled',
200
+ registry: 'registry.example.com',
201
+ buildArgs: { COMMIT_SHA: process.env.COMMIT_SHA ?? '' },
202
+ },
203
+ });
204
+ ```
205
+
206
+ Если нужен контроль над каждым шагом — те же чистые функции по отдельности:
207
+
208
+ ```ts
209
+ import {
210
+ exec,
211
+ getBuildParams,
212
+ getDockerBuildCommand,
213
+ prepareFilesForDocker,
214
+ renderTemplates,
215
+ resolveArtifactsConfig,
216
+ } from '@alfalab/arui-scripts-artifacts';
217
+
218
+ const config = resolveArtifactsConfig({
219
+ serverOutput: 'server/index.js',
220
+ docker: { variant: 'compiled' },
221
+ });
222
+ const templates = renderTemplates({ config });
223
+
224
+ const { restoreDockerIgnore } = await prepareFilesForDocker({ config, templates });
225
+
226
+ await exec(getDockerBuildCommand(config));
227
+ await restoreDockerIgnore();
228
+ await exec(`docker push ${getBuildParams(config).imageFullName}`);
229
+ ```
230
+
231
+ Разбор конфига тоже доступен отдельно — так CLI можно встроить в свой:
232
+
233
+ ```ts
234
+ import {
235
+ extractConfigPath,
236
+ resolveCommandOptions,
237
+ resolveConfigFile,
238
+ } from '@alfalab/arui-scripts-artifacts';
239
+
240
+ const argv = process.argv.slice(2);
241
+ const configFile = await resolveConfigFile(process.cwd(), extractConfigPath(argv));
242
+ const options = resolveCommandOptions('docker-build:server', configFile);
243
+ ```
244
+
245
+ ## Пайплайн сборки
246
+
247
+ Хост-пайплайн общий для образа и архива, поэтому оба собираются из одного состояния проекта.
248
+ Какие шаги выполнятся — зависит от типа артефакта, варианта и опций:
249
+
250
+ | Шаг | Опция | Дефолт `runtime` | Дефолт `compiled` |
251
+ | ------------------------- | ------------------------------------------------- | ----------------- | ----------------- |
252
+ | очистка `buildPath` | `build.cleanBuildPath` | `true` | `false` |
253
+ | хук перед сборкой | `beforeBuild` | — | — |
254
+ | сборка приложения | `build.command` | `'npm run build'` | `null` |
255
+ | удаление dev-зависимостей | `build.removeDevDependencies` / `packageManager.pruneCommand` | `true` | `false` |
256
+ | `docker build` / `tar` | — | всегда | всегда |
257
+ | `docker push` | `docker.push` | `!debug` | `!debug` |
258
+
259
+ Для `artifact: 'archive'` хост-пайплайн включен всегда (внутри tar-а собирать нечего), поэтому
260
+ `docker.variant` на него не влияет.
261
+
262
+ ## Миграция с `arui-scripts docker-build`
263
+
264
+ Поведение и шаблоны совпадают, отличаются имена и расположение настроек:
265
+
266
+ | arui-scripts | @alfalab/arui-scripts-artifacts |
267
+ | ------------------------------------------------------------ | -------------------------------------- |
268
+ | `configs.dockerRegistry` | `docker.registry` |
269
+ | `configs.baseDockerImage` | `docker.baseImage` |
270
+ | `configs.runFromNonRootUser` | `docker.runFromNonRootUser` |
271
+ | `configs.clientServerPort` | `nginx.port` |
272
+ | `configs.nginxRootPath` | `nginx.rootPath` |
273
+ | `configs.nginx` (настройки базового конфига) | `nginx.baseConf` |
274
+ | `configs.dictionaryCompression.enablePreviousVersionHeaders` | `nginx.enablePreviousVersionHeaders` |
275
+ | `configs.archiveName` | `archive.name` |
276
+ | `configs.additionalBuildPath` | `archive.additionalPaths` |
277
+ | `configs.removeDevDependenciesDuringDockerBuild` | `build.removeDevDependencies` |
278
+ | `configs.useYarn` | `packageManager.useYarn` |
279
+ | `configs.localDockerfile` и соседние | `localFiles.dockerfile` и соседние |
280
+ | оверрайд `Dockerfile` | `overrides.dockerfile` |
281
+ | оверрайд `DockerfileCompiled` | `overrides.dockerfileCompiled` |
282
+ | оверрайд `nginx` (server-блок) | `overrides.nginxConf` |
283
+ | оверрайд `nginxConf` (базовый http-блок) | `overrides.baseNginxConf` |
284
+ | оверрайд `start.sh` | `overrides.startScript` |
285
+
286
+ ⚠️ В `arui-scripts` имена `nginx` и `nginxConf` исторически перепутаны: `nginx` — это server-блок, а
287
+ `nginxConf` — базовый конфиг. Здесь они названы по смыслу, поэтому **`nginxConf` в двух пакетах
288
+ означает разные файлы**. Переносить оверрайды по таблице выше, а не по совпадению имен.
289
+
290
+ `publicPath` по умолчанию — `` `${assetsPath}/` `` (то есть `assets/`), как это считает `arui-scripts`.
291
+ Пустой `publicPath` дал бы в nginx-конфиге второй `location /` и nginx не поднялся бы с
292
+ `duplicate location "/"`.
293
+
294
+ ### Отличие в `archive-build`
295
+
296
+ Старый `arui-scripts archive-build` подхватывал локальный `nginx.conf`, но игнорировал локальный
297
+ `start.sh`. Здесь локальные файлы обрабатываются единообразно: `start.sh` из корня проекта тоже
298
+ используется. Отключается через `localFiles.allowStartScript: false`.
@@ -0,0 +1,14 @@
1
+ import { type ArtifactsOptions } from '../config/types';
2
+ import { type BeforeBuildHook } from '../pipeline/host-pipeline';
3
+ export type BuildArchiveOptions = ArtifactsOptions & {
4
+ /** Хук, вызываемый после очистки `buildPath`, но до сборки приложения. */
5
+ beforeBuild?: BeforeBuildHook;
6
+ };
7
+ /**
8
+ * Собирает tar-архив с production-сборкой: nginx-конфиг, start.sh, `buildPath`, `node_modules`,
9
+ * `package.json` и дополнительные директории из `archive.additionalPaths`.
10
+ *
11
+ * Хост-пайплайн (очистка, сборка, удаление dev-зависимостей) — тот же, что у docker-образа, поэтому
12
+ * архив и образ собираются из одного и того же состояния проекта.
13
+ */
14
+ export declare function buildArchive(options?: BuildArchiveOptions): Promise<void>;
@@ -0,0 +1,69 @@
1
+ import path from 'path';
2
+ import fs from 'fs-extra';
3
+ import { create as createTar } from 'tar';
4
+ import { resolveArtifactsConfig } from '../config';
5
+ import { NGINX_CONFIG_FILENAME } from '../nginx/constants';
6
+ import { runHostPipeline } from '../pipeline/host-pipeline';
7
+ import { renderTemplates } from '../pipeline/render';
8
+ import { START_SCRIPT_FILENAME } from '../start-script/constants';
9
+ const NODE_MODULES_DIR_NAME = 'node_modules';
10
+ const PACKAGE_JSON_FILENAME = 'package.json';
11
+ /**
12
+ * Собирает tar-архив с production-сборкой: nginx-конфиг, start.sh, `buildPath`, `node_modules`,
13
+ * `package.json` и дополнительные директории из `archive.additionalPaths`.
14
+ *
15
+ * Хост-пайплайн (очистка, сборка, удаление dev-зависимостей) — тот же, что у docker-образа, поэтому
16
+ * архив и образ собираются из одного и того же состояния проекта.
17
+ */
18
+ export async function buildArchive(options = {}) {
19
+ const { beforeBuild, templates, overrides, ...rest } = options;
20
+ const config = resolveArtifactsConfig({
21
+ ...rest,
22
+ artifact: 'archive',
23
+ });
24
+ const { cwd, buildPath, archive, localFiles } = config;
25
+ const pathToTempDir = path.join(cwd, archive.tempDirName);
26
+ try {
27
+ console.log(`Build archive ${archive.name}`);
28
+ console.time('Total time');
29
+ console.time('Setting up time');
30
+ const rendered = renderTemplates({ config, templates, overrides });
31
+ await fs.emptyDir(pathToTempDir);
32
+ const nginxConf = localFiles.nginxConf
33
+ ? await fs.readFile(localFiles.nginxConf, 'utf8')
34
+ : rendered.nginxConf;
35
+ const startScript = localFiles.startScript && localFiles.allowStartScript
36
+ ? await fs.readFile(localFiles.startScript, 'utf8')
37
+ : rendered.startScript;
38
+ await Promise.all([
39
+ fs.writeFile(path.join(pathToTempDir, NGINX_CONFIG_FILENAME), nginxConf, 'utf8'),
40
+ fs.writeFile(path.join(pathToTempDir, START_SCRIPT_FILENAME), startScript, {
41
+ encoding: 'utf8',
42
+ mode: 0o555,
43
+ }),
44
+ ]);
45
+ console.timeEnd('Setting up time');
46
+ await runHostPipeline(config, beforeBuild);
47
+ console.time('Archive build time');
48
+ await Promise.all([
49
+ fs.copy(path.resolve(cwd, buildPath), path.join(pathToTempDir, buildPath)),
50
+ fs.copy(path.join(cwd, NODE_MODULES_DIR_NAME), path.join(pathToTempDir, NODE_MODULES_DIR_NAME)),
51
+ fs.copy(path.join(cwd, PACKAGE_JSON_FILENAME), path.join(pathToTempDir, PACKAGE_JSON_FILENAME)),
52
+ ...archive.additionalPaths.map((additionalPath) => fs.copy(path.join(cwd, additionalPath), path.join(pathToTempDir, additionalPath))),
53
+ ]);
54
+ await createTar({ file: archive.name, cwd: pathToTempDir }, fs.readdirSync(pathToTempDir));
55
+ console.timeEnd('Archive build time');
56
+ console.time('Cleanup time');
57
+ await fs.remove(pathToTempDir);
58
+ console.timeEnd('Cleanup time');
59
+ console.timeEnd('Total time');
60
+ }
61
+ catch (err) {
62
+ await fs.remove(pathToTempDir);
63
+ console.error('Error during archive-build.');
64
+ if (config.debug) {
65
+ console.error(err);
66
+ }
67
+ throw err;
68
+ }
69
+ }
@@ -0,0 +1,6 @@
1
+ /** Имя tar-архива по умолчанию. */
2
+ export declare const DEFAULT_ARCHIVE_NAME = "build.tar";
3
+ /** Имя временной директории, в которой собирается содержимое tar-архива. */
4
+ export declare const DEFAULT_ARCHIVE_TEMP_DIR_NAME = ".archive-build";
5
+ /** Директории проекта, которые кладутся в архив рядом со сборкой. */
6
+ export declare const DEFAULT_ARCHIVE_ADDITIONAL_PATHS: string[];
@@ -0,0 +1,6 @@
1
+ /** Имя tar-архива по умолчанию. */
2
+ export const DEFAULT_ARCHIVE_NAME = 'build.tar';
3
+ /** Имя временной директории, в которой собирается содержимое tar-архива. */
4
+ export const DEFAULT_ARCHIVE_TEMP_DIR_NAME = '.archive-build';
5
+ /** Директории проекта, которые кладутся в архив рядом со сборкой. */
6
+ export const DEFAULT_ARCHIVE_ADDITIONAL_PATHS = ['config'];
@@ -0,0 +1,2 @@
1
+ export { buildArchive, type BuildArchiveOptions } from './build-archive';
2
+ export { DEFAULT_ARCHIVE_ADDITIONAL_PATHS, DEFAULT_ARCHIVE_NAME, DEFAULT_ARCHIVE_TEMP_DIR_NAME, } from './constants';
@@ -0,0 +1,2 @@
1
+ export { buildArchive } from './build-archive';
2
+ export { DEFAULT_ARCHIVE_ADDITIONAL_PATHS, DEFAULT_ARCHIVE_NAME, DEFAULT_ARCHIVE_TEMP_DIR_NAME, } from './constants';
@@ -0,0 +1,14 @@
1
+ import { type ArtifactsOptions } from '../config/types';
2
+ import { type BeforeBuildHook } from '../pipeline/host-pipeline';
3
+ export type BuildArchiveOptions = ArtifactsOptions & {
4
+ /** Хук, вызываемый после очистки `buildPath`, но до сборки приложения. */
5
+ beforeBuild?: BeforeBuildHook;
6
+ };
7
+ /**
8
+ * Собирает tar-архив с production-сборкой: nginx-конфиг, start.sh, `buildPath`, `node_modules`,
9
+ * `package.json` и дополнительные директории из `archive.additionalPaths`.
10
+ *
11
+ * Хост-пайплайн (очистка, сборка, удаление dev-зависимостей) — тот же, что у docker-образа, поэтому
12
+ * архив и образ собираются из одного и того же состояния проекта.
13
+ */
14
+ export declare function buildArchive(options?: BuildArchiveOptions): Promise<void>;
@@ -0,0 +1,75 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.buildArchive = buildArchive;
7
+ const path_1 = __importDefault(require("path"));
8
+ const fs_extra_1 = __importDefault(require("fs-extra"));
9
+ const tar_1 = require("tar");
10
+ const config_1 = require("../config");
11
+ const constants_1 = require("../nginx/constants");
12
+ const host_pipeline_1 = require("../pipeline/host-pipeline");
13
+ const render_1 = require("../pipeline/render");
14
+ const constants_2 = require("../start-script/constants");
15
+ const NODE_MODULES_DIR_NAME = 'node_modules';
16
+ const PACKAGE_JSON_FILENAME = 'package.json';
17
+ /**
18
+ * Собирает tar-архив с production-сборкой: nginx-конфиг, start.sh, `buildPath`, `node_modules`,
19
+ * `package.json` и дополнительные директории из `archive.additionalPaths`.
20
+ *
21
+ * Хост-пайплайн (очистка, сборка, удаление dev-зависимостей) — тот же, что у docker-образа, поэтому
22
+ * архив и образ собираются из одного и того же состояния проекта.
23
+ */
24
+ async function buildArchive(options = {}) {
25
+ const { beforeBuild, templates, overrides, ...rest } = options;
26
+ const config = (0, config_1.resolveArtifactsConfig)({
27
+ ...rest,
28
+ artifact: 'archive',
29
+ });
30
+ const { cwd, buildPath, archive, localFiles } = config;
31
+ const pathToTempDir = path_1.default.join(cwd, archive.tempDirName);
32
+ try {
33
+ console.log(`Build archive ${archive.name}`);
34
+ console.time('Total time');
35
+ console.time('Setting up time');
36
+ const rendered = (0, render_1.renderTemplates)({ config, templates, overrides });
37
+ await fs_extra_1.default.emptyDir(pathToTempDir);
38
+ const nginxConf = localFiles.nginxConf
39
+ ? await fs_extra_1.default.readFile(localFiles.nginxConf, 'utf8')
40
+ : rendered.nginxConf;
41
+ const startScript = localFiles.startScript && localFiles.allowStartScript
42
+ ? await fs_extra_1.default.readFile(localFiles.startScript, 'utf8')
43
+ : rendered.startScript;
44
+ await Promise.all([
45
+ fs_extra_1.default.writeFile(path_1.default.join(pathToTempDir, constants_1.NGINX_CONFIG_FILENAME), nginxConf, 'utf8'),
46
+ fs_extra_1.default.writeFile(path_1.default.join(pathToTempDir, constants_2.START_SCRIPT_FILENAME), startScript, {
47
+ encoding: 'utf8',
48
+ mode: 0o555,
49
+ }),
50
+ ]);
51
+ console.timeEnd('Setting up time');
52
+ await (0, host_pipeline_1.runHostPipeline)(config, beforeBuild);
53
+ console.time('Archive build time');
54
+ await Promise.all([
55
+ fs_extra_1.default.copy(path_1.default.resolve(cwd, buildPath), path_1.default.join(pathToTempDir, buildPath)),
56
+ fs_extra_1.default.copy(path_1.default.join(cwd, NODE_MODULES_DIR_NAME), path_1.default.join(pathToTempDir, NODE_MODULES_DIR_NAME)),
57
+ fs_extra_1.default.copy(path_1.default.join(cwd, PACKAGE_JSON_FILENAME), path_1.default.join(pathToTempDir, PACKAGE_JSON_FILENAME)),
58
+ ...archive.additionalPaths.map((additionalPath) => fs_extra_1.default.copy(path_1.default.join(cwd, additionalPath), path_1.default.join(pathToTempDir, additionalPath))),
59
+ ]);
60
+ await (0, tar_1.create)({ file: archive.name, cwd: pathToTempDir }, fs_extra_1.default.readdirSync(pathToTempDir));
61
+ console.timeEnd('Archive build time');
62
+ console.time('Cleanup time');
63
+ await fs_extra_1.default.remove(pathToTempDir);
64
+ console.timeEnd('Cleanup time');
65
+ console.timeEnd('Total time');
66
+ }
67
+ catch (err) {
68
+ await fs_extra_1.default.remove(pathToTempDir);
69
+ console.error('Error during archive-build.');
70
+ if (config.debug) {
71
+ console.error(err);
72
+ }
73
+ throw err;
74
+ }
75
+ }
@@ -0,0 +1,6 @@
1
+ /** Имя tar-архива по умолчанию. */
2
+ export declare const DEFAULT_ARCHIVE_NAME = "build.tar";
3
+ /** Имя временной директории, в которой собирается содержимое tar-архива. */
4
+ export declare const DEFAULT_ARCHIVE_TEMP_DIR_NAME = ".archive-build";
5
+ /** Директории проекта, которые кладутся в архив рядом со сборкой. */
6
+ export declare const DEFAULT_ARCHIVE_ADDITIONAL_PATHS: string[];
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.DEFAULT_ARCHIVE_ADDITIONAL_PATHS = exports.DEFAULT_ARCHIVE_TEMP_DIR_NAME = exports.DEFAULT_ARCHIVE_NAME = void 0;
4
+ /** Имя tar-архива по умолчанию. */
5
+ exports.DEFAULT_ARCHIVE_NAME = 'build.tar';
6
+ /** Имя временной директории, в которой собирается содержимое tar-архива. */
7
+ exports.DEFAULT_ARCHIVE_TEMP_DIR_NAME = '.archive-build';
8
+ /** Директории проекта, которые кладутся в архив рядом со сборкой. */
9
+ exports.DEFAULT_ARCHIVE_ADDITIONAL_PATHS = ['config'];
@@ -0,0 +1,2 @@
1
+ export { buildArchive, type BuildArchiveOptions } from './build-archive';
2
+ export { DEFAULT_ARCHIVE_ADDITIONAL_PATHS, DEFAULT_ARCHIVE_NAME, DEFAULT_ARCHIVE_TEMP_DIR_NAME, } from './constants';
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.DEFAULT_ARCHIVE_TEMP_DIR_NAME = exports.DEFAULT_ARCHIVE_NAME = exports.DEFAULT_ARCHIVE_ADDITIONAL_PATHS = exports.buildArchive = void 0;
4
+ var build_archive_1 = require("./build-archive");
5
+ Object.defineProperty(exports, "buildArchive", { enumerable: true, get: function () { return build_archive_1.buildArchive; } });
6
+ var constants_1 = require("./constants");
7
+ Object.defineProperty(exports, "DEFAULT_ARCHIVE_ADDITIONAL_PATHS", { enumerable: true, get: function () { return constants_1.DEFAULT_ARCHIVE_ADDITIONAL_PATHS; } });
8
+ Object.defineProperty(exports, "DEFAULT_ARCHIVE_NAME", { enumerable: true, get: function () { return constants_1.DEFAULT_ARCHIVE_NAME; } });
9
+ Object.defineProperty(exports, "DEFAULT_ARCHIVE_TEMP_DIR_NAME", { enumerable: true, get: function () { return constants_1.DEFAULT_ARCHIVE_TEMP_DIR_NAME; } });
@@ -0,0 +1,2 @@
1
+ #! /usr/bin/env node
2
+ export {};