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

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.
@@ -1,15 +1,16 @@
1
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
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
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
4
+ PASS src/cli/__tests__/config-file.test.ts (13.756 s)
5
+ PASS src/config/__tests__/config.test.ts (14.054 s)
6
+ PASS src/pipeline/__tests__/render.test.ts (14.77 s)
7
+ PASS src/docker/__tests__/dockerfile-templates.test.ts
8
8
  PASS src/docker/__tests__/docker-build.test.ts
9
+ PASS src/cli/__tests__/cli.test.ts
9
10
  PASS src/cli/__tests__/load-config-file.test.ts
10
11
 
11
- Test Suites: 6 passed, 6 total
12
- Tests: 74 passed, 74 total
12
+ Test Suites: 7 passed, 7 total
13
+ Tests: 85 passed, 85 total
13
14
  Snapshots: 0 total
14
- Time: 14.127 s
15
+ Time: 18.532 s
15
16
  Ran all test suites.
package/CHANGELOG.md CHANGED
@@ -1,10 +1,10 @@
1
1
  # @alfalab/arui-scripts-artifacts
2
2
 
3
- ## 0.0.0-beta-20260824133302
3
+ ## 1.0.0
4
4
 
5
- ### Minor Changes
5
+ ### Major Changes
6
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`.
7
+ - [#565](https://github.com/core-ds/arui-scripts/pull/565) [`a6c84b42`](https://github.com/core-ds/arui-scripts/commit/a6c84b4246fdeb156da2a0e5980dfba796e2d7d5) Thanks [@sowtame](https://github.com/sowtame)! - Сборка артефактов поставки вынесена в отдельный пакет `@alfalab/arui-scripts-artifacts`.
8
8
 
9
9
  Пакет устроен как набор чистых функций и настраивается одним файлом `arui-scripts-artifacts.ts` в
10
10
  корне проекта (путь можно задать через `--c`/`--config`). Конфиг может быть на TypeScript, ESM или
@@ -30,7 +30,7 @@
30
30
 
31
31
  Настройки сборки артефактов в конфиге arui-scripts (`dockerRegistry`, `baseDockerImage`,
32
32
  `nginxRootPath`, `nginx`, `runFromNonRootUser`, `removeDevDependenciesDuringDockerBuild`,
33
- `archiveName`, `additionalBuildPath`) и оверрайды `Dockerfile`, `DockerfileCompiled`, `nginx`,
33
+ `deleteNpm`, `archiveName`, `additionalBuildPath`) и оверрайды `Dockerfile`, `DockerfileCompiled`, `nginx`,
34
34
  `nginxConf`, `start.sh` объявлены устаревшими: они продолжают работать, но команды сборки печатают
35
35
  предупреждение со ссылкой на замену, а в следующей мажорной версии будут удалены.
36
36
 
package/README.md CHANGED
@@ -40,259 +40,17 @@ export default defineConfig({
40
40
  }
41
41
  ```
42
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`.
43
+ Все настройки опциональны: конфиг без единой настройки соберет тот же образ, что и
44
+ `arui-scripts docker-build`.
45
+
46
+ ## Документация
47
+
48
+ - [CLI](docs/cli.md) — запуск, флаги, поиск и формат конфига
49
+ - [Команды](docs/commands.md) — встроенные команды и свои сборки в секции `commands`
50
+ - [Настройки](docs/settings.md) — полный справочник опций с дефолтами
51
+ - [Кастомизация файлов артефакта](docs/templates.md) — `templates`, `overrides`, локальные файлы
52
+ - [Пайплайн сборки](docs/pipeline.md) — что и в каком порядке происходит
53
+ - [Программное API](docs/api.md) — сборка и разбор конфига из своего кода
54
+ - [Миграция с `arui-scripts docker-build`](docs/migration.md) — таблица соответствия настроек
55
+ - [Список актуальных версий docker-образов](../alpine-node-nginx/README.md)
56
+ - [Документация arui-scripts](../arui-scripts/README.md)
@@ -76,6 +76,7 @@ function resolveDocker(options, debug) {
76
76
  platform: withDefault(docker.platform, 'auto'),
77
77
  buildArgs: withDefault(docker.buildArgs, {}),
78
78
  addNodeModulesToDockerIgnore: withDefault(docker.addNodeModulesToDockerIgnore, false),
79
+ deleteNpm: withDefault(docker.deleteNpm, false),
79
80
  };
80
81
  }
81
82
  function resolveNginx(options) {
@@ -117,6 +118,7 @@ function resolvePackageManager(options, cwd, clientOnly) {
117
118
  yarnVersion,
118
119
  installProductionCommand: packageManager.installProductionCommand ?? (0, yarn_1.getInstallProductionCommand)(yarnVersion),
119
120
  pruneCommand: packageManager.pruneCommand ?? (0, yarn_1.getPruningCommand)({ yarnVersion, clientOnly }),
121
+ yarnBinSymlinkCommand: packageManager.yarnBinSymlinkCommand ?? (0, yarn_1.getYarnBinSymlinkCommand)({ yarnVersion, cwd }),
120
122
  };
121
123
  }
122
124
  function resolveLocalFiles(options) {
@@ -36,6 +36,11 @@ export type DockerOptions = {
36
36
  buildArgs?: Record<string, string>;
37
37
  /** Добавлять ли `node_modules` в `.dockerignore` (нужно для compiled-образа). */
38
38
  addNodeModulesToDockerIgnore?: boolean;
39
+ /**
40
+ * Удалять ли npm и связанные библиотеки из итогового образа. Нужно тем, кому npm в образе
41
+ * фонит в сканерах уязвимостей.
42
+ */
43
+ deleteNpm?: boolean;
39
44
  };
40
45
  /** Настройки базового nginx-конфига (http-блок, `/etc/nginx/nginx.conf`). */
41
46
  export type NginxBaseConfOptions = {
@@ -96,6 +101,11 @@ export type PackageManagerOptions = {
96
101
  installProductionCommand?: string;
97
102
  /** Команда очистки dev-зависимостей на хосте перед упаковкой артефакта. */
98
103
  pruneCommand?: string;
104
+ /**
105
+ * Команда создания symlink на бинарник yarn внутри образа (для `compiled`). По умолчанию
106
+ * подставляется для yarn 2+ с `yarnPath` в `.yarnrc.yml`, иначе — пустая строка.
107
+ */
108
+ yarnBinSymlinkCommand?: string;
99
109
  };
100
110
  /**
101
111
  * Локальные файлы проекта, которые (если существуют и разрешены) используются вместо сгенерированных
@@ -17,3 +17,5 @@ export declare const DOCKERIGNORE_FILENAME = ".dockerignore";
17
17
  export declare const PLATFORM_FLAG_MIN_DOCKER_VERSION = ">=20.10.21";
18
18
  /** Значение флага `--platform`, которое подставляется при `platform: 'auto'` на новых версиях docker. */
19
19
  export declare const DEFAULT_PLATFORM = "linux/x86_64";
20
+ /** Команда удаления npm и связанных библиотек из образа (`docker.deleteNpm`). */
21
+ export declare const DELETE_NPM_COMMAND = "RUN rm -rf /usr/local/bin/npm /usr/local/bin/npx /usr/local/lib/node_modules/npm";
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.DEFAULT_PLATFORM = exports.PLATFORM_FLAG_MIN_DOCKER_VERSION = exports.DOCKERIGNORE_FILENAME = exports.DOCKERFILE_FILENAME = exports.DEFAULT_BASE_DOCKER_IMAGE = exports.DEFAULT_TEMP_DIR_NAME = void 0;
3
+ exports.DELETE_NPM_COMMAND = exports.DEFAULT_PLATFORM = exports.PLATFORM_FLAG_MIN_DOCKER_VERSION = exports.DOCKERIGNORE_FILENAME = exports.DOCKERFILE_FILENAME = exports.DEFAULT_BASE_DOCKER_IMAGE = exports.DEFAULT_TEMP_DIR_NAME = void 0;
4
4
  /**
5
5
  * Имя временной директории, в которую складываются сгенерированные файлы (Dockerfile, nginx-конфиги,
6
6
  * start.sh) перед запуском `docker build`.
@@ -20,3 +20,5 @@ exports.DOCKERIGNORE_FILENAME = '.dockerignore';
20
20
  exports.PLATFORM_FLAG_MIN_DOCKER_VERSION = '>=20.10.21';
21
21
  /** Значение флага `--platform`, которое подставляется при `platform: 'auto'` на новых версиях docker. */
22
22
  exports.DEFAULT_PLATFORM = 'linux/x86_64';
23
+ /** Команда удаления npm и связанных библиотек из образа (`docker.deleteNpm`). */
24
+ exports.DELETE_NPM_COMMAND = 'RUN rm -rf /usr/local/bin/npm /usr/local/bin/npx /usr/local/lib/node_modules/npm';
@@ -4,4 +4,4 @@ export { dockerVersionSatisfies, getDockerBuildCommand, getPlatformFlag } from '
4
4
  export { prepareFilesForDocker, type PrepareFilesForDockerResult } from './prepare-files';
5
5
  export { renderDockerfile } from './templates/dockerfile.template';
6
6
  export { renderDockerfileCompiled } from './templates/dockerfile-compiled.template';
7
- export { DEFAULT_BASE_DOCKER_IMAGE, DEFAULT_PLATFORM, DEFAULT_TEMP_DIR_NAME, DOCKERFILE_FILENAME, DOCKERIGNORE_FILENAME, PLATFORM_FLAG_MIN_DOCKER_VERSION, } from './constants';
7
+ export { DEFAULT_BASE_DOCKER_IMAGE, DEFAULT_PLATFORM, DEFAULT_TEMP_DIR_NAME, DELETE_NPM_COMMAND, DOCKERFILE_FILENAME, DOCKERIGNORE_FILENAME, PLATFORM_FLAG_MIN_DOCKER_VERSION, } from './constants';
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.PLATFORM_FLAG_MIN_DOCKER_VERSION = exports.DOCKERIGNORE_FILENAME = exports.DOCKERFILE_FILENAME = exports.DEFAULT_TEMP_DIR_NAME = exports.DEFAULT_PLATFORM = exports.DEFAULT_BASE_DOCKER_IMAGE = exports.renderDockerfileCompiled = exports.renderDockerfile = exports.prepareFilesForDocker = exports.getPlatformFlag = exports.getDockerBuildCommand = exports.dockerVersionSatisfies = exports.getBuildParamsFromArgs = exports.getBuildParams = exports.applyCommandLineArguments = exports.buildDockerImage = void 0;
3
+ exports.PLATFORM_FLAG_MIN_DOCKER_VERSION = exports.DOCKERIGNORE_FILENAME = exports.DOCKERFILE_FILENAME = exports.DELETE_NPM_COMMAND = exports.DEFAULT_TEMP_DIR_NAME = exports.DEFAULT_PLATFORM = exports.DEFAULT_BASE_DOCKER_IMAGE = exports.renderDockerfileCompiled = exports.renderDockerfile = exports.prepareFilesForDocker = exports.getPlatformFlag = exports.getDockerBuildCommand = exports.dockerVersionSatisfies = exports.getBuildParamsFromArgs = exports.getBuildParams = exports.applyCommandLineArguments = exports.buildDockerImage = void 0;
4
4
  var build_docker_image_1 = require("./build-docker-image");
5
5
  Object.defineProperty(exports, "buildDockerImage", { enumerable: true, get: function () { return build_docker_image_1.buildDockerImage; } });
6
6
  var build_params_1 = require("./build-params");
@@ -21,6 +21,7 @@ var constants_1 = require("./constants");
21
21
  Object.defineProperty(exports, "DEFAULT_BASE_DOCKER_IMAGE", { enumerable: true, get: function () { return constants_1.DEFAULT_BASE_DOCKER_IMAGE; } });
22
22
  Object.defineProperty(exports, "DEFAULT_PLATFORM", { enumerable: true, get: function () { return constants_1.DEFAULT_PLATFORM; } });
23
23
  Object.defineProperty(exports, "DEFAULT_TEMP_DIR_NAME", { enumerable: true, get: function () { return constants_1.DEFAULT_TEMP_DIR_NAME; } });
24
+ Object.defineProperty(exports, "DELETE_NPM_COMMAND", { enumerable: true, get: function () { return constants_1.DELETE_NPM_COMMAND; } });
24
25
  Object.defineProperty(exports, "DOCKERFILE_FILENAME", { enumerable: true, get: function () { return constants_1.DOCKERFILE_FILENAME; } });
25
26
  Object.defineProperty(exports, "DOCKERIGNORE_FILENAME", { enumerable: true, get: function () { return constants_1.DOCKERIGNORE_FILENAME; } });
26
27
  Object.defineProperty(exports, "PLATFORM_FLAG_MIN_DOCKER_VERSION", { enumerable: true, get: function () { return constants_1.PLATFORM_FLAG_MIN_DOCKER_VERSION; } });
@@ -1,13 +1,14 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.renderDockerfileCompiled = renderDockerfileCompiled;
4
+ const constants_1 = require("../constants");
4
5
  /**
5
6
  * Dockerfile для compiled-образа: зависимости и сборка приложения происходят внутри образа, что
6
7
  * позволяет кешировать установку зависимостей на уровне docker-слоев.
7
8
  */
8
9
  function renderDockerfileCompiled(config) {
9
10
  const { docker, nginx, packageManager } = config;
10
- const { yarnVersion, installProductionCommand } = packageManager;
11
+ const { yarnVersion, installProductionCommand, yarnBinSymlinkCommand } = packageManager;
11
12
  // В зависимости от используемого менеджера зависимостей для их установки нужно копировать разный
12
13
  // набор файлов
13
14
  const filesRequiredToInstallDependencies = [
@@ -35,11 +36,14 @@ ${filesRequiredToInstallDependencies
35
36
  .map((file) => `ADD --chown=nginx:nginx ${file} /src/${file}`)
36
37
  .join('\n')}
37
38
 
38
- RUN ${installProductionCommand} && \\
39
+ RUN ${yarnBinSymlinkCommand}${installProductionCommand} && \\
39
40
  ${yarnVersion === 'unavailable' ? 'npm cache clean --force' : 'yarn cache clean --all'}
40
41
 
41
42
  ADD --chown=nginx:nginx . /src
42
43
 
44
+ # При необходимости удаляем npm и связанные библиотеки из образа
45
+ ${docker.deleteNpm ? constants_1.DELETE_NPM_COMMAND : ''}
46
+
43
47
  # Создаем директории для nginx и выставляем правильные права
44
48
  RUN mkdir -p /var/lib/nginx && \
45
49
  chown -R nginx:nginx /var/lib/nginx && \
@@ -1,12 +1,13 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.renderDockerfile = renderDockerfile;
4
+ const constants_1 = require("../constants");
4
5
  /**
5
6
  * Dockerfile для «сырого» образа: приложение собирается на хосте, в образ кладется результат сборки.
6
7
  */
7
8
  function renderDockerfile(config) {
8
9
  const { clientOnly, buildPath, docker, nginx } = config;
9
- const { runFromNonRootUser, baseImage } = docker;
10
+ const { runFromNonRootUser, baseImage, deleteNpm } = docker;
10
11
  const appPathToAdd = clientOnly ? buildPath : '.';
11
12
  const appTargetPath = clientOnly ? `/src/${buildPath}` : '/src';
12
13
  const nginxConfTargetLocation = clientOnly
@@ -35,6 +36,8 @@ ADD $START_SH_LOCATION /src/start.sh
35
36
  ADD $NGINX_CONF_LOCATION ${nginxConfTargetLocation}
36
37
  ${nginx.baseConf ? 'ADD $NGINX_BASE_CONF_LOCATION /etc/nginx/nginx.conf' : ''}
37
38
 
39
+ ${deleteNpm ? constants_1.DELETE_NPM_COMMAND : ''}
40
+
38
41
  ${nginxNonRootPart}
39
42
 
40
43
  ${runFromNonRootUser
@@ -12,4 +12,4 @@ export * from './start-script';
12
12
  export * from './cli';
13
13
  export { exec, ExecError } from './utils/exec';
14
14
  export { shellQuote } from './utils/shell';
15
- export { detectUseYarn, getInstallProductionCommand, getPruningCommand, getYarnVersion, } from './utils/yarn';
15
+ export { detectUseYarn, getInstallProductionCommand, getPruningCommand, getYarnBinSymlinkCommand, getYarnPathFromRc, getYarnVersion, } from './utils/yarn';
@@ -18,7 +18,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
18
18
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
19
19
  };
20
20
  Object.defineProperty(exports, "__esModule", { value: true });
21
- exports.getYarnVersion = exports.getPruningCommand = exports.getInstallProductionCommand = exports.detectUseYarn = exports.shellQuote = exports.ExecError = exports.exec = exports.resolveArtifactsConfig = void 0;
21
+ exports.getYarnVersion = exports.getYarnPathFromRc = exports.getYarnBinSymlinkCommand = exports.getPruningCommand = exports.getInstallProductionCommand = exports.detectUseYarn = exports.shellQuote = exports.ExecError = exports.exec = exports.resolveArtifactsConfig = void 0;
22
22
  /* Конфиг */
23
23
  var config_1 = require("./config");
24
24
  Object.defineProperty(exports, "resolveArtifactsConfig", { enumerable: true, get: function () { return config_1.resolveArtifactsConfig; } });
@@ -42,4 +42,6 @@ var yarn_1 = require("./utils/yarn");
42
42
  Object.defineProperty(exports, "detectUseYarn", { enumerable: true, get: function () { return yarn_1.detectUseYarn; } });
43
43
  Object.defineProperty(exports, "getInstallProductionCommand", { enumerable: true, get: function () { return yarn_1.getInstallProductionCommand; } });
44
44
  Object.defineProperty(exports, "getPruningCommand", { enumerable: true, get: function () { return yarn_1.getPruningCommand; } });
45
+ Object.defineProperty(exports, "getYarnBinSymlinkCommand", { enumerable: true, get: function () { return yarn_1.getYarnBinSymlinkCommand; } });
46
+ Object.defineProperty(exports, "getYarnPathFromRc", { enumerable: true, get: function () { return yarn_1.getYarnPathFromRc; } });
45
47
  Object.defineProperty(exports, "getYarnVersion", { enumerable: true, get: function () { return yarn_1.getYarnVersion; } });
@@ -10,6 +10,22 @@ export declare function getYarnVersion({ useYarn }: GetYarnVersionParams): YarnV
10
10
  * Проверяет наличие `yarn.lock` в директории проекта. Используется как дефолт для `useYarn`.
11
11
  */
12
12
  export declare function detectUseYarn(cwd: string): boolean;
13
+ type GetYarnBinSymlinkCommandParams = {
14
+ yarnVersion: YarnVersion;
15
+ cwd: string;
16
+ };
17
+ /**
18
+ * Читает значение yarnPath из .yarnrc.yml.
19
+ * Возвращает путь к бинарнику yarn (например .yarn/releases/yarn-4.18.0.cjs) или null.
20
+ */
21
+ export declare function getYarnPathFromRc(cwd: string): string | null;
22
+ /**
23
+ * Возвращает команду для создания symlink на yarn бинарник в Docker-образе.
24
+ * Используется при yarn 2+ с yarnPath в .yarnrc.yml, чтобы yarn был доступен
25
+ * в PATH внутри Docker-образов (где yarn не установлен глобально).
26
+ * Возвращает пустую строку, если symlink не нужен.
27
+ */
28
+ export declare function getYarnBinSymlinkCommand({ yarnVersion, cwd, }: GetYarnBinSymlinkCommandParams): string;
13
29
  type GetPruningCommandParams = {
14
30
  yarnVersion: YarnVersion;
15
31
  clientOnly: boolean;
@@ -5,6 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
6
  exports.getYarnVersion = getYarnVersion;
7
7
  exports.detectUseYarn = detectUseYarn;
8
+ exports.getYarnPathFromRc = getYarnPathFromRc;
9
+ exports.getYarnBinSymlinkCommand = getYarnBinSymlinkCommand;
8
10
  exports.getPruningCommand = getPruningCommand;
9
11
  exports.getInstallProductionCommand = getInstallProductionCommand;
10
12
  const path_1 = __importDefault(require("path"));
@@ -27,6 +29,44 @@ function getYarnVersion({ useYarn }) {
27
29
  function detectUseYarn(cwd) {
28
30
  return fs_extra_1.default.existsSync(path_1.default.join(cwd, 'yarn.lock'));
29
31
  }
32
+ /**
33
+ * Читает значение yarnPath из .yarnrc.yml.
34
+ * Возвращает путь к бинарнику yarn (например .yarn/releases/yarn-4.18.0.cjs) или null.
35
+ */
36
+ function getYarnPathFromRc(cwd) {
37
+ const rcPath = path_1.default.join(cwd, '.yarnrc.yml');
38
+ if (!shelljs_1.default.test('-f', rcPath)) {
39
+ return null;
40
+ }
41
+ let content;
42
+ try {
43
+ content = fs_extra_1.default.readFileSync(rcPath, 'utf8');
44
+ }
45
+ catch {
46
+ return null;
47
+ }
48
+ // Ищем строку вида: yarnPath: .yarn/releases/yarn-4.18.0.cjs
49
+ // Значение может быть в кавычках или без
50
+ const match = content.match(/^\s*yarnPath:\s*['"]?([^'"\s]+)['"]?\s*$/m);
51
+ return match ? match[1] : null;
52
+ }
53
+ /**
54
+ * Возвращает команду для создания symlink на yarn бинарник в Docker-образе.
55
+ * Используется при yarn 2+ с yarnPath в .yarnrc.yml, чтобы yarn был доступен
56
+ * в PATH внутри Docker-образов (где yarn не установлен глобально).
57
+ * Возвращает пустую строку, если symlink не нужен.
58
+ */
59
+ function getYarnBinSymlinkCommand({ yarnVersion, cwd, }) {
60
+ if (yarnVersion !== '2+') {
61
+ return '';
62
+ }
63
+ const yarnPath = getYarnPathFromRc(cwd);
64
+ if (!yarnPath) {
65
+ return '';
66
+ }
67
+ // WORKDIR в Dockerfile = /src
68
+ return `ln -sf /src/${yarnPath} /usr/local/bin/yarn && \\\n `;
69
+ }
30
70
  /**
31
71
  * Команда удаления dev-зависимостей перед копированием проекта в образ.
32
72
  */
@@ -3,7 +3,7 @@ import fs from 'fs-extra';
3
3
  import { DEFAULT_ARCHIVE_ADDITIONAL_PATHS, DEFAULT_ARCHIVE_NAME, DEFAULT_ARCHIVE_TEMP_DIR_NAME, } from '../archive/constants';
4
4
  import { DEFAULT_BASE_DOCKER_IMAGE, DEFAULT_TEMP_DIR_NAME } from '../docker/constants';
5
5
  import { DEFAULT_NGINX_BASE_CONF, DEFAULT_NGINX_PORT, DEFAULT_NGINX_ROOT_PATH, } from '../nginx/constants';
6
- import { detectUseYarn, getInstallProductionCommand, getPruningCommand, getYarnVersion, } from '../utils/yarn';
6
+ import { detectUseYarn, getInstallProductionCommand, getPruningCommand, getYarnBinSymlinkCommand, getYarnVersion, } from '../utils/yarn';
7
7
  function readPackageJson(cwd) {
8
8
  try {
9
9
  return fs.readJsonSync(path.join(cwd, 'package.json'));
@@ -70,6 +70,7 @@ function resolveDocker(options, debug) {
70
70
  platform: withDefault(docker.platform, 'auto'),
71
71
  buildArgs: withDefault(docker.buildArgs, {}),
72
72
  addNodeModulesToDockerIgnore: withDefault(docker.addNodeModulesToDockerIgnore, false),
73
+ deleteNpm: withDefault(docker.deleteNpm, false),
73
74
  };
74
75
  }
75
76
  function resolveNginx(options) {
@@ -111,6 +112,7 @@ function resolvePackageManager(options, cwd, clientOnly) {
111
112
  yarnVersion,
112
113
  installProductionCommand: packageManager.installProductionCommand ?? getInstallProductionCommand(yarnVersion),
113
114
  pruneCommand: packageManager.pruneCommand ?? getPruningCommand({ yarnVersion, clientOnly }),
115
+ yarnBinSymlinkCommand: packageManager.yarnBinSymlinkCommand ?? getYarnBinSymlinkCommand({ yarnVersion, cwd }),
114
116
  };
115
117
  }
116
118
  function resolveLocalFiles(options) {
@@ -36,6 +36,11 @@ export type DockerOptions = {
36
36
  buildArgs?: Record<string, string>;
37
37
  /** Добавлять ли `node_modules` в `.dockerignore` (нужно для compiled-образа). */
38
38
  addNodeModulesToDockerIgnore?: boolean;
39
+ /**
40
+ * Удалять ли npm и связанные библиотеки из итогового образа. Нужно тем, кому npm в образе
41
+ * фонит в сканерах уязвимостей.
42
+ */
43
+ deleteNpm?: boolean;
39
44
  };
40
45
  /** Настройки базового nginx-конфига (http-блок, `/etc/nginx/nginx.conf`). */
41
46
  export type NginxBaseConfOptions = {
@@ -96,6 +101,11 @@ export type PackageManagerOptions = {
96
101
  installProductionCommand?: string;
97
102
  /** Команда очистки dev-зависимостей на хосте перед упаковкой артефакта. */
98
103
  pruneCommand?: string;
104
+ /**
105
+ * Команда создания symlink на бинарник yarn внутри образа (для `compiled`). По умолчанию
106
+ * подставляется для yarn 2+ с `yarnPath` в `.yarnrc.yml`, иначе — пустая строка.
107
+ */
108
+ yarnBinSymlinkCommand?: string;
99
109
  };
100
110
  /**
101
111
  * Локальные файлы проекта, которые (если существуют и разрешены) используются вместо сгенерированных
@@ -17,3 +17,5 @@ export declare const DOCKERIGNORE_FILENAME = ".dockerignore";
17
17
  export declare const PLATFORM_FLAG_MIN_DOCKER_VERSION = ">=20.10.21";
18
18
  /** Значение флага `--platform`, которое подставляется при `platform: 'auto'` на новых версиях docker. */
19
19
  export declare const DEFAULT_PLATFORM = "linux/x86_64";
20
+ /** Команда удаления npm и связанных библиотек из образа (`docker.deleteNpm`). */
21
+ export declare const DELETE_NPM_COMMAND = "RUN rm -rf /usr/local/bin/npm /usr/local/bin/npx /usr/local/lib/node_modules/npm";