@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
@@ -0,0 +1,126 @@
1
+ import path from 'path';
2
+ import fs from 'fs-extra';
3
+ import { DEFAULT_ARCHIVE_ADDITIONAL_PATHS, DEFAULT_ARCHIVE_NAME, DEFAULT_ARCHIVE_TEMP_DIR_NAME, } from '../archive/constants';
4
+ import { DEFAULT_BASE_DOCKER_IMAGE, DEFAULT_TEMP_DIR_NAME } from '../docker/constants';
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';
7
+ function readPackageJson(cwd) {
8
+ try {
9
+ return fs.readJsonSync(path.join(cwd, 'package.json'));
10
+ }
11
+ catch {
12
+ return {};
13
+ }
14
+ }
15
+ /**
16
+ * Дефолт значения флага `undefined ? fallback : value`, но с учетом того, что `false`/`0`/`''`
17
+ * — валидные значения, которые не должны затираться дефолтом.
18
+ */
19
+ function withDefault(value, fallback) {
20
+ return value === undefined ? fallback : value;
21
+ }
22
+ /**
23
+ * Донасыщает частичные опции сборки полным набором значений с дефолтами.
24
+ *
25
+ * Все дефолты артефактов живут здесь (и в константах доменных папок) — потребители, включая
26
+ * arui-scripts, только транслируют то, что задал пользователь. Значения по умолчанию совпадают с
27
+ * историческим поведением arui-scripts, поэтому вызов без аргументов даст такой же образ, как
28
+ * команда `arui-scripts docker-build`.
29
+ */
30
+ export function resolveArtifactsConfig(options = {}) {
31
+ const cwd = options.cwd ?? process.cwd();
32
+ const pkg = readPackageJson(cwd);
33
+ const artifact = withDefault(options.artifact, 'docker');
34
+ const clientOnly = withDefault(options.clientOnly, false);
35
+ const debug = withDefault(options.debug, false);
36
+ const buildPath = withDefault(options.buildPath, '.build');
37
+ const assetsPath = withDefault(options.assetsPath, 'assets');
38
+ return {
39
+ artifact,
40
+ name: options.name ?? pkg.name ?? '',
41
+ version: options.version ?? pkg.version ?? '',
42
+ cwd,
43
+ debug,
44
+ clientOnly,
45
+ buildPath,
46
+ serverOutput: withDefault(options.serverOutput, 'server.js'),
47
+ serverPort: withDefault(options.serverPort, 3000),
48
+ assetsPath,
49
+ // arui-scripts считает publicPath как `${assetsPath}/`. Пустой publicPath дал бы второй
50
+ // `location /` в nginx-конфиге и nginx не поднялся бы с `duplicate location "/"`.
51
+ publicPath: withDefault(options.publicPath, `${assetsPath}/`),
52
+ docker: resolveDocker(options, debug),
53
+ nginx: resolveNginx(options),
54
+ archive: resolveArchive(options),
55
+ build: resolveBuild(options, artifact),
56
+ packageManager: resolvePackageManager(options, cwd, clientOnly),
57
+ localFiles: resolveLocalFiles(options),
58
+ };
59
+ }
60
+ function resolveDocker(options, debug) {
61
+ const docker = options.docker ?? {};
62
+ return {
63
+ variant: withDefault(docker.variant, 'runtime'),
64
+ registry: withDefault(docker.registry, ''),
65
+ baseImage: withDefault(docker.baseImage, DEFAULT_BASE_DOCKER_IMAGE),
66
+ runFromNonRootUser: withDefault(docker.runFromNonRootUser, true),
67
+ context: withDefault(docker.context, '.'),
68
+ tempDirName: withDefault(docker.tempDirName, DEFAULT_TEMP_DIR_NAME),
69
+ push: withDefault(docker.push, !debug),
70
+ platform: withDefault(docker.platform, 'auto'),
71
+ buildArgs: withDefault(docker.buildArgs, {}),
72
+ addNodeModulesToDockerIgnore: withDefault(docker.addNodeModulesToDockerIgnore, false),
73
+ };
74
+ }
75
+ function resolveNginx(options) {
76
+ const nginx = options.nginx ?? {};
77
+ // `false` — то же самое, что `null`: базовый конфиг не генерируется
78
+ const baseConf = nginx.baseConf || null;
79
+ return {
80
+ port: withDefault(nginx.port, DEFAULT_NGINX_PORT),
81
+ rootPath: withDefault(nginx.rootPath, DEFAULT_NGINX_ROOT_PATH),
82
+ enablePreviousVersionHeaders: withDefault(nginx.enablePreviousVersionHeaders, false),
83
+ baseConf: baseConf && { ...DEFAULT_NGINX_BASE_CONF, ...baseConf },
84
+ };
85
+ }
86
+ function resolveArchive(options) {
87
+ const archive = options.archive ?? {};
88
+ return {
89
+ name: withDefault(archive.name, DEFAULT_ARCHIVE_NAME),
90
+ tempDirName: withDefault(archive.tempDirName, DEFAULT_ARCHIVE_TEMP_DIR_NAME),
91
+ additionalPaths: withDefault(archive.additionalPaths, DEFAULT_ARCHIVE_ADDITIONAL_PATHS),
92
+ };
93
+ }
94
+ function resolveBuild(options, artifact) {
95
+ const build = options.build ?? {};
96
+ // архив всегда собирается на хосте — внутри tar-а собирать нечего
97
+ const isHostBuild = artifact === 'archive' || withDefault(options.docker?.variant, 'runtime') === 'runtime';
98
+ const command = withDefault(build.command, isHostBuild ? 'npm run build' : null);
99
+ return {
100
+ cleanBuildPath: withDefault(build.cleanBuildPath, isHostBuild),
101
+ command: command || null,
102
+ removeDevDependencies: withDefault(build.removeDevDependencies, isHostBuild),
103
+ };
104
+ }
105
+ function resolvePackageManager(options, cwd, clientOnly) {
106
+ const packageManager = options.packageManager ?? {};
107
+ const useYarn = withDefault(packageManager.useYarn, detectUseYarn(cwd));
108
+ const yarnVersion = packageManager.yarnVersion ?? getYarnVersion({ useYarn });
109
+ return {
110
+ useYarn,
111
+ yarnVersion,
112
+ installProductionCommand: packageManager.installProductionCommand ?? getInstallProductionCommand(yarnVersion),
113
+ pruneCommand: packageManager.pruneCommand ?? getPruningCommand({ yarnVersion, clientOnly }),
114
+ };
115
+ }
116
+ function resolveLocalFiles(options) {
117
+ const localFiles = options.localFiles ?? {};
118
+ return {
119
+ dockerfile: localFiles.dockerfile ?? null,
120
+ startScript: localFiles.startScript ?? null,
121
+ nginxConf: localFiles.nginxConf ?? null,
122
+ nginxBaseConf: localFiles.nginxBaseConf ?? null,
123
+ allowDockerfile: withDefault(localFiles.allowDockerfile, true),
124
+ allowStartScript: withDefault(localFiles.allowStartScript, true),
125
+ };
126
+ }
@@ -0,0 +1,226 @@
1
+ export type YarnVersion = '1' | '2+' | 'unavailable';
2
+ /**
3
+ * Управление флагом `--platform` в команде `docker build`:
4
+ * - `'auto'` — историческое поведение: флаг подставляется только если версия docker его поддерживает;
5
+ * - `false` — никогда не добавлять флаг;
6
+ * - строка (например `'linux/amd64'`) — всегда использовать указанную платформу.
7
+ */
8
+ export type DockerPlatform = 'auto' | false | string;
9
+ /** Вариант Dockerfile: «сырой» (сборка на хосте) или compiled (сборка внутри образа). */
10
+ export type DockerfileVariant = 'runtime' | 'compiled';
11
+ /** Тип собираемого артефакта поставки. */
12
+ export type ArtifactKind = 'docker' | 'archive';
13
+ /** Настройки docker-образа. Не используются при `artifact: 'archive'`. */
14
+ export type DockerOptions = {
15
+ /**
16
+ * Вариант сборки. `runtime` (по умолчанию) — приложение собирается на хосте и результат кладется
17
+ * в образ; `compiled` — зависимости и сборка выполняются внутри образа. От варианта зависят
18
+ * дефолты хост-пайплайна (см. {@link BuildOptions}).
19
+ */
20
+ variant?: DockerfileVariant;
21
+ /** Docker registry, к которому будет добавлен образ (`registry/name:version`). */
22
+ registry?: string;
23
+ /** Базовый docker-образ (`FROM`). */
24
+ baseImage?: string;
25
+ /** Запускать ли процессы в образе от пользователя nginx (не root). */
26
+ runFromNonRootUser?: boolean;
27
+ /** Контекст сборки docker (последний аргумент `docker build`). */
28
+ context?: string;
29
+ /** Имя временной директории для сгенерированных файлов. */
30
+ tempDirName?: string;
31
+ /** Выполнять ли `docker push` после сборки. По умолчанию — да, кроме `debug`. */
32
+ push?: boolean;
33
+ /** Управление флагом `--platform`. */
34
+ platform?: DockerPlatform;
35
+ /** Дополнительные `--build-arg` для `docker build`. */
36
+ buildArgs?: Record<string, string>;
37
+ /** Добавлять ли `node_modules` в `.dockerignore` (нужно для compiled-образа). */
38
+ addNodeModulesToDockerIgnore?: boolean;
39
+ };
40
+ /** Настройки базового nginx-конфига (http-блок, `/etc/nginx/nginx.conf`). */
41
+ export type NginxBaseConfOptions = {
42
+ workerProcesses?: number;
43
+ workerRlimitNoFile?: number;
44
+ workerConnections?: number;
45
+ eventsUse?: string;
46
+ daemon?: string;
47
+ };
48
+ /** Настройки nginx: и server-блока, который генерируется всегда, и базового http-блока. */
49
+ export type NginxOptions = {
50
+ /** Порт, который слушает nginx внутри контейнера. */
51
+ port?: number;
52
+ /** Корень, из которого nginx раздает статику. */
53
+ rootPath?: string;
54
+ /** Добавлять ли заголовки для предыдущей версии словаря brotli. */
55
+ enablePreviousVersionHeaders?: boolean;
56
+ /**
57
+ * Базовый конфиг (http-блок). `null`/`false` (по умолчанию) — не генерировать и не класть в
58
+ * образ: используется тот, что лежит в базовом образе.
59
+ */
60
+ baseConf?: NginxBaseConfOptions | null | false;
61
+ };
62
+ /** Настройки tar-архива. Не используются при `artifact: 'docker'`. */
63
+ export type ArchiveOptions = {
64
+ /** Имя итогового tar-архива. */
65
+ name?: string;
66
+ /** Имя временной директории, в которой собирается содержимое архива. */
67
+ tempDirName?: string;
68
+ /** Дополнительные директории проекта, которые кладутся в архив рядом со сборкой. */
69
+ additionalPaths?: string[];
70
+ };
71
+ /** Хост-пайплайн: что выполняется на машине сборки перед упаковкой артефакта. */
72
+ export type BuildOptions = {
73
+ /**
74
+ * Удалять ли `buildPath` перед сборкой приложения.
75
+ * По умолчанию — `true` для `runtime` и `false` для `compiled`.
76
+ */
77
+ cleanBuildPath?: boolean;
78
+ /**
79
+ * Команда сборки приложения на хосте. `null`/`false` — не собирать.
80
+ * По умолчанию — `'npm run build'` для `runtime` и `null` для `compiled` (там сборка идет в образе).
81
+ */
82
+ command?: string | null | false;
83
+ /**
84
+ * Удалять ли dev-зависимости ({@link PackageManagerOptions.pruneCommand}) перед упаковкой.
85
+ * По умолчанию — `true` для `runtime` и `false` для `compiled`.
86
+ */
87
+ removeDevDependencies?: boolean;
88
+ };
89
+ /** Менеджер зависимостей: как ставить production-зависимости и как выкидывать dev-зависимости. */
90
+ export type PackageManagerOptions = {
91
+ /** Использовать ли yarn (если доступен). По умолчанию — по наличию `yarn.lock`. */
92
+ useYarn?: boolean;
93
+ /** Явно заданная версия yarn. По умолчанию определяется автоматически. */
94
+ yarnVersion?: YarnVersion;
95
+ /** Команда установки production-зависимостей внутри образа (для `compiled`). */
96
+ installProductionCommand?: string;
97
+ /** Команда очистки dev-зависимостей на хосте перед упаковкой артефакта. */
98
+ pruneCommand?: string;
99
+ };
100
+ /**
101
+ * Локальные файлы проекта, которые (если существуют и разрешены) используются вместо сгенерированных
102
+ * шаблонов.
103
+ */
104
+ export type LocalFilesOptions = {
105
+ dockerfile?: string | null;
106
+ startScript?: string | null;
107
+ nginxConf?: string | null;
108
+ nginxBaseConf?: string | null;
109
+ /** Разрешить подмену Dockerfile локальным файлом. */
110
+ allowDockerfile?: boolean;
111
+ /** Разрешить подмену start.sh локальным файлом. */
112
+ allowStartScript?: boolean;
113
+ };
114
+ /**
115
+ * Функция-оверрайд шаблона. Получает сгенерированную по умолчанию строку и итоговый конфиг,
116
+ * возвращает новую строку. Позволяет точечно донасыщать/подменять любой из шаблонов.
117
+ */
118
+ export type TemplateOverride = (generatedContent: string, config: ResolvedArtifactsConfig) => string;
119
+ /**
120
+ * Функция-рендерер шаблона. Полностью заменяет генерацию шаблона по умолчанию.
121
+ */
122
+ export type TemplateRenderer = (config: ResolvedArtifactsConfig) => string;
123
+ export type TemplateKey = 'dockerfile' | 'dockerfileCompiled' | 'nginxConf' | 'baseNginxConf' | 'startScript';
124
+ /**
125
+ * Кастомные рендереры шаблонов. Любой из них можно переопределить целиком.
126
+ */
127
+ export type ArtifactTemplates = Partial<Record<TemplateKey, TemplateRenderer>>;
128
+ /**
129
+ * Точечные оверрайды поверх сгенерированных по умолчанию шаблонов.
130
+ */
131
+ export type ArtifactTemplateOverrides = Partial<Record<TemplateKey, TemplateOverride>>;
132
+ /**
133
+ * Готовые (отрендеренные) содержимые файлов, которые кладутся в артефакт.
134
+ */
135
+ export type RenderedTemplates = {
136
+ dockerfile: string;
137
+ nginxConf: string;
138
+ nginxBaseConf: string;
139
+ startScript: string;
140
+ };
141
+ /**
142
+ * Полный набор опций сборки артефакта. Все поля опциональны — недостающие донасыщаются дефолтами
143
+ * в {@link resolveArtifactsConfig}. Это единственная точка входа для кастомизации: любой потребитель
144
+ * (arui-scripts, сторонние сборки, собственные скрипты) может собрать артефакт, передав сюда свои
145
+ * значения.
146
+ *
147
+ * Настройки сгруппированы по тому, к чему относятся: `docker`, `nginx`, `archive`, `build`,
148
+ * `packageManager`, `localFiles`. На верхнем уровне остается только то, что общее для всех
149
+ * артефактов, — идентификация и форма самого приложения.
150
+ */
151
+ export type ArtifactsOptions = {
152
+ /**
153
+ * Что собирать: docker-образ (по умолчанию) или tar-архив с production-сборкой.
154
+ * Секция `docker` при `artifact: 'archive'` не используется, и наоборот.
155
+ */
156
+ artifact?: ArtifactKind;
157
+ /** Имя артефакта (образа). По умолчанию берется из `package.json` в `cwd`. */
158
+ name?: string;
159
+ /** Версия/тег. По умолчанию берется из `package.json` в `cwd`. */
160
+ version?: string;
161
+ /** Рабочая директория проекта. */
162
+ cwd?: string;
163
+ /** Режим отладки: не пушить образ, печатать стек ошибок. */
164
+ debug?: boolean;
165
+ /** Собирается ли только клиентская часть (nginx без nodejs-сервера). */
166
+ clientOnly?: boolean;
167
+ /** Путь к директории со сборкой приложения относительно корня проекта. */
168
+ buildPath?: string;
169
+ /** Путь к серверному бандлу относительно `buildPath`. */
170
+ serverOutput?: string;
171
+ /** Порт, на котором поднимается nodejs-сервер приложения. */
172
+ serverPort?: number;
173
+ /** Директория со статикой внутри `buildPath`. Из нее выводится дефолт `publicPath`. */
174
+ assetsPath?: string;
175
+ /**
176
+ * Публичный префикс путей до статики — используется в `location` блоках nginx-конфига.
177
+ * По умолчанию `` `${assetsPath}/` ``, как это считает arui-scripts. Пустая строка приведет к
178
+ * дублирующемуся `location /` в nginx-конфиге, поэтому переопределять стоит осознанно.
179
+ */
180
+ publicPath?: string;
181
+ docker?: DockerOptions;
182
+ nginx?: NginxOptions;
183
+ archive?: ArchiveOptions;
184
+ build?: BuildOptions;
185
+ packageManager?: PackageManagerOptions;
186
+ localFiles?: LocalFilesOptions;
187
+ /** Полная замена рендереров шаблонов. */
188
+ templates?: ArtifactTemplates;
189
+ /** Точечные оверрайды поверх сгенерированных шаблонов. */
190
+ overrides?: ArtifactTemplateOverrides;
191
+ };
192
+ export type ResolvedDockerConfig = Required<DockerOptions>;
193
+ export type ResolvedNginxBaseConf = Required<NginxBaseConfOptions>;
194
+ export type ResolvedNginxConfig = Required<Omit<NginxOptions, 'baseConf'>> & {
195
+ /** `null` — базовый конфиг не генерируется и не кладется в артефакт. */
196
+ baseConf: ResolvedNginxBaseConf | null;
197
+ };
198
+ export type ResolvedArchiveConfig = Required<ArchiveOptions>;
199
+ export type ResolvedBuildConfig = Required<Omit<BuildOptions, 'command'>> & {
200
+ command: string | null;
201
+ };
202
+ export type ResolvedPackageManagerConfig = Required<PackageManagerOptions>;
203
+ export type ResolvedLocalFilesConfig = Required<LocalFilesOptions>;
204
+ /**
205
+ * Полностью донасыщенный конфиг сборки. С ним работают все шаблоны и утилиты — они не знают ничего
206
+ * о том, откуда пришли значения, что делает их независимыми и легко тестируемыми.
207
+ */
208
+ export type ResolvedArtifactsConfig = {
209
+ artifact: ArtifactKind;
210
+ name: string;
211
+ version: string;
212
+ cwd: string;
213
+ debug: boolean;
214
+ clientOnly: boolean;
215
+ buildPath: string;
216
+ serverOutput: string;
217
+ serverPort: number;
218
+ assetsPath: string;
219
+ publicPath: string;
220
+ docker: ResolvedDockerConfig;
221
+ nginx: ResolvedNginxConfig;
222
+ archive: ResolvedArchiveConfig;
223
+ build: ResolvedBuildConfig;
224
+ packageManager: ResolvedPackageManagerConfig;
225
+ localFiles: ResolvedLocalFilesConfig;
226
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,13 @@
1
+ import { type ResolvedArtifactsConfig } from '../config/types';
2
+ /**
3
+ * Проверяет, что версия docker (клиент и сервер) удовлетворяет semver-диапазону.
4
+ */
5
+ export declare function dockerVersionSatisfies(request: string): boolean;
6
+ /**
7
+ * Вычисляет значение флага `--platform` согласно настройке `docker.platform` в конфиге.
8
+ */
9
+ export declare function getPlatformFlag(config: ResolvedArtifactsConfig): string;
10
+ /**
11
+ * Формирует команду `docker build` для сгенерированной ранее временной директории.
12
+ */
13
+ export declare function getDockerBuildCommand(config: ResolvedArtifactsConfig): string;
@@ -0,0 +1,57 @@
1
+ // именно default-импорт пакета целиком: semver — CommonJS без exports-карты, и Node ESM не умеет
2
+ // ни глубокий путь без расширения, ни именованные импорты из него
3
+ import semver from 'semver';
4
+ import shell from 'shelljs';
5
+ import { BASE_NGINX_CONFIG_FILENAME, NGINX_CONFIG_FILENAME } from '../nginx/constants';
6
+ import { START_SCRIPT_FILENAME } from '../start-script/constants';
7
+ import { shellQuote } from '../utils/shell';
8
+ import { getBuildParams } from './build-params';
9
+ import { DEFAULT_PLATFORM, DOCKERFILE_FILENAME, PLATFORM_FLAG_MIN_DOCKER_VERSION, } from './constants';
10
+ /**
11
+ * Проверяет, что версия docker (клиент и сервер) удовлетворяет semver-диапазону.
12
+ */
13
+ export function dockerVersionSatisfies(request) {
14
+ const dockerServerVersion = shell.exec("docker version --format '{{.Server.Version}}'", {
15
+ silent: true,
16
+ });
17
+ const dockerClientVersion = shell.exec("docker version --format '{{.Client.Version}}'", {
18
+ silent: true,
19
+ });
20
+ return (semver.satisfies(dockerServerVersion.toString(), request) &&
21
+ semver.satisfies(dockerClientVersion.toString(), request));
22
+ }
23
+ /**
24
+ * Вычисляет значение флага `--platform` согласно настройке `docker.platform` в конфиге.
25
+ */
26
+ export function getPlatformFlag(config) {
27
+ const { platform } = config.docker;
28
+ if (platform === 'auto') {
29
+ // на маках с m1 без флага docker пытается вытянуть базовый образ под свою платформу и падает,
30
+ // но сам флаг поддерживается без экспериментальных флагов только начиная с docker 20.10.21.
31
+ return dockerVersionSatisfies(PLATFORM_FLAG_MIN_DOCKER_VERSION)
32
+ ? `--platform ${DEFAULT_PLATFORM}`
33
+ : '';
34
+ }
35
+ if (platform) {
36
+ return `--platform ${platform}`;
37
+ }
38
+ return '';
39
+ }
40
+ /**
41
+ * Формирует команду `docker build` для сгенерированной ранее временной директории.
42
+ */
43
+ export function getDockerBuildCommand(config) {
44
+ const { tempDirName, context, buildArgs } = config.docker;
45
+ const { imageFullName } = getBuildParams(config);
46
+ const platformFlag = getPlatformFlag(config);
47
+ const extraArgs = Object.entries(buildArgs)
48
+ .map(([key, value]) => `--build-arg ${key}=${shellQuote(value)}`)
49
+ .join(' ');
50
+ return `docker build ${platformFlag} \
51
+ -f ${shellQuote(`./${tempDirName}/${DOCKERFILE_FILENAME}`)} \
52
+ --build-arg START_SH_LOCATION=${shellQuote(`./${tempDirName}/${START_SCRIPT_FILENAME}`)} \
53
+ --build-arg NGINX_CONF_LOCATION=${shellQuote(`./${tempDirName}/${NGINX_CONFIG_FILENAME}`)} \
54
+ --build-arg NGINX_BASE_CONF_LOCATION=${shellQuote(`./${tempDirName}/${BASE_NGINX_CONFIG_FILENAME}`)} \
55
+ ${extraArgs} \
56
+ -t ${shellQuote(imageFullName)} ${shellQuote(context)}`;
57
+ }
@@ -0,0 +1,21 @@
1
+ import { type ArtifactsOptions } from '../config/types';
2
+ import { type BeforeBuildHook } from '../pipeline/host-pipeline';
3
+ export type BuildDockerImageOptions = ArtifactsOptions & {
4
+ /** Аргументы командной строки (`name=... version=... registry=...`), накладываются поверх опций. */
5
+ argv?: string[];
6
+ /**
7
+ * Хук, вызываемый после подготовки файлов и очистки `buildPath`, но до сборки приложения и
8
+ * `docker build`. Если приложение собирается им, выставьте `build.command: null`.
9
+ */
10
+ beforeBuild?: BeforeBuildHook;
11
+ };
12
+ /**
13
+ * Высокоуровневая сборка docker-образа. Повторяет пайплайн команд `arui-scripts docker-build` и
14
+ * `arui-scripts docker-build:compiled`: донасыщает конфиг, рендерит все шаблоны, готовит временную
15
+ * директорию, прогоняет хост-пайплайн, запускает `docker build`, чистит за собой и (опционально)
16
+ * пушит образ.
17
+ *
18
+ * Для более тонкого контроля используйте отдельные утилиты: {@link resolveArtifactsConfig},
19
+ * {@link renderTemplates}, {@link prepareFilesForDocker}, {@link getDockerBuildCommand}.
20
+ */
21
+ export declare function buildDockerImage(options?: BuildDockerImageOptions): Promise<void>;
@@ -0,0 +1,59 @@
1
+ import fs from 'fs-extra';
2
+ import { resolveArtifactsConfig } from '../config';
3
+ import { runHostPipeline } from '../pipeline/host-pipeline';
4
+ import { renderTemplates } from '../pipeline/render';
5
+ import { exec } from '../utils/exec';
6
+ import { getDockerBuildCommand } from './build-command';
7
+ import { applyCommandLineArguments, getBuildParams } from './build-params';
8
+ import { prepareFilesForDocker } from './prepare-files';
9
+ /**
10
+ * Высокоуровневая сборка docker-образа. Повторяет пайплайн команд `arui-scripts docker-build` и
11
+ * `arui-scripts docker-build:compiled`: донасыщает конфиг, рендерит все шаблоны, готовит временную
12
+ * директорию, прогоняет хост-пайплайн, запускает `docker build`, чистит за собой и (опционально)
13
+ * пушит образ.
14
+ *
15
+ * Для более тонкого контроля используйте отдельные утилиты: {@link resolveArtifactsConfig},
16
+ * {@link renderTemplates}, {@link prepareFilesForDocker}, {@link getDockerBuildCommand}.
17
+ */
18
+ export async function buildDockerImage(options = {}) {
19
+ const { argv, beforeBuild, templates, overrides, ...rest } = options;
20
+ let config = resolveArtifactsConfig({ ...rest, artifact: 'docker' });
21
+ if (argv) {
22
+ config = applyCommandLineArguments(config, argv);
23
+ }
24
+ const { imageFullName, pathToTempDir } = getBuildParams(config);
25
+ let restoreDockerIgnore = null;
26
+ try {
27
+ console.log(`Build docker image ${imageFullName}`);
28
+ console.time('Total time');
29
+ console.time('Setting up time');
30
+ const renderedTemplates = renderTemplates({ config, templates, overrides });
31
+ ({ restoreDockerIgnore } = await prepareFilesForDocker({
32
+ config,
33
+ templates: renderedTemplates,
34
+ }));
35
+ console.timeEnd('Setting up time');
36
+ await runHostPipeline(config, beforeBuild);
37
+ console.time('Build docker image time');
38
+ await exec(getDockerBuildCommand(config));
39
+ console.timeEnd('Build docker image time');
40
+ console.time('Cleanup time');
41
+ await fs.remove(pathToTempDir);
42
+ await restoreDockerIgnore();
43
+ restoreDockerIgnore = null;
44
+ if (config.docker.push) {
45
+ await exec(`docker push ${imageFullName}`);
46
+ }
47
+ console.timeEnd('Cleanup time');
48
+ console.timeEnd('Total time');
49
+ }
50
+ catch (err) {
51
+ await fs.remove(pathToTempDir);
52
+ await restoreDockerIgnore?.();
53
+ console.error('Error during docker-build.');
54
+ if (config.debug) {
55
+ console.error(err);
56
+ }
57
+ throw err;
58
+ }
59
+ }
@@ -0,0 +1,20 @@
1
+ import { type ResolvedArtifactsConfig } from '../config/types';
2
+ export type BuildParams = {
3
+ pathToTempDir: string;
4
+ imageFullName: string;
5
+ tempDirName: string;
6
+ };
7
+ /**
8
+ * Собирает параметры сборки (полное имя образа и пути) из конфига.
9
+ */
10
+ export declare function getBuildParams(config: ResolvedArtifactsConfig): BuildParams;
11
+ /**
12
+ * Разбирает аргументы командной строки вида `name=... version=... registry=...` и накладывает их
13
+ * поверх конфига. Неизвестные аргументы игнорируются с предупреждением.
14
+ */
15
+ export declare function applyCommandLineArguments(config: ResolvedArtifactsConfig, commandLineArguments: string[]): ResolvedArtifactsConfig;
16
+ /**
17
+ * Как {@link getBuildParams}, но с учетом аргументов командной строки (по умолчанию — `process.argv`,
18
+ * начиная с третьего, как в CLI arui-scripts).
19
+ */
20
+ export declare function getBuildParamsFromArgs(config: ResolvedArtifactsConfig, argv?: string[]): BuildParams;
@@ -0,0 +1,44 @@
1
+ import path from 'path';
2
+ /**
3
+ * Собирает параметры сборки (полное имя образа и пути) из конфига.
4
+ */
5
+ export function getBuildParams(config) {
6
+ const { name, version, cwd, docker } = config;
7
+ const { registry, tempDirName } = docker;
8
+ const pathToTempDir = path.join(cwd, tempDirName);
9
+ const imageFullName = `${registry ? `${registry}/` : ''}${name}:${version}`;
10
+ return { pathToTempDir, imageFullName, tempDirName };
11
+ }
12
+ /**
13
+ * Разбирает аргументы командной строки вида `name=... version=... registry=...` и накладывает их
14
+ * поверх конфига. Неизвестные аргументы игнорируются с предупреждением.
15
+ */
16
+ export function applyCommandLineArguments(config, commandLineArguments) {
17
+ const next = { ...config, docker: { ...config.docker } };
18
+ commandLineArguments.forEach((arg) => {
19
+ let [argName, argValue] = arg.split('=');
20
+ argName = argName.toLowerCase().trim();
21
+ argValue = argValue ? argValue.trim() : '';
22
+ switch (argName) {
23
+ case 'version':
24
+ next.version = argValue;
25
+ break;
26
+ case 'name':
27
+ next.name = argValue;
28
+ break;
29
+ case 'registry':
30
+ next.docker.registry = argValue;
31
+ break;
32
+ default:
33
+ console.warn(`Unknown argument ${argName}`);
34
+ }
35
+ });
36
+ return next;
37
+ }
38
+ /**
39
+ * Как {@link getBuildParams}, но с учетом аргументов командной строки (по умолчанию — `process.argv`,
40
+ * начиная с третьего, как в CLI arui-scripts).
41
+ */
42
+ export function getBuildParamsFromArgs(config, argv = process.argv.slice(3)) {
43
+ return getBuildParams(applyCommandLineArguments(config, argv));
44
+ }
@@ -0,0 +1,19 @@
1
+ /**
2
+ * Имя временной директории, в которую складываются сгенерированные файлы (Dockerfile, nginx-конфиги,
3
+ * start.sh) перед запуском `docker build`.
4
+ */
5
+ export declare const DEFAULT_TEMP_DIR_NAME = ".docker-build";
6
+ /** Базовый docker-образ по умолчанию. */
7
+ export declare const DEFAULT_BASE_DOCKER_IMAGE = "alfabankui/arui-scripts:24.10.0-slim";
8
+ /** Имя Dockerfile во временной директории. */
9
+ export declare const DOCKERFILE_FILENAME = "Dockerfile";
10
+ /** Имя файла со списком исключений сборочного контекста. */
11
+ export declare const DOCKERIGNORE_FILENAME = ".dockerignore";
12
+ /**
13
+ * Минимальная версия docker, начиная с которой флаг `--platform` поддерживается без экспериментальных
14
+ * флагов. На многих серверах до сих пор живет docker 1.13.1, который упадет при наличии этого флага.
15
+ * @see https://docs.docker.com/engine/release-notes/20.10/
16
+ */
17
+ export declare const PLATFORM_FLAG_MIN_DOCKER_VERSION = ">=20.10.21";
18
+ /** Значение флага `--platform`, которое подставляется при `platform: 'auto'` на новых версиях docker. */
19
+ export declare const DEFAULT_PLATFORM = "linux/x86_64";
@@ -0,0 +1,19 @@
1
+ /**
2
+ * Имя временной директории, в которую складываются сгенерированные файлы (Dockerfile, nginx-конфиги,
3
+ * start.sh) перед запуском `docker build`.
4
+ */
5
+ export const DEFAULT_TEMP_DIR_NAME = '.docker-build';
6
+ /** Базовый docker-образ по умолчанию. */
7
+ export const DEFAULT_BASE_DOCKER_IMAGE = 'alfabankui/arui-scripts:24.10.0-slim';
8
+ /** Имя Dockerfile во временной директории. */
9
+ export const DOCKERFILE_FILENAME = 'Dockerfile';
10
+ /** Имя файла со списком исключений сборочного контекста. */
11
+ export const DOCKERIGNORE_FILENAME = '.dockerignore';
12
+ /**
13
+ * Минимальная версия docker, начиная с которой флаг `--platform` поддерживается без экспериментальных
14
+ * флагов. На многих серверах до сих пор живет docker 1.13.1, который упадет при наличии этого флага.
15
+ * @see https://docs.docker.com/engine/release-notes/20.10/
16
+ */
17
+ export const PLATFORM_FLAG_MIN_DOCKER_VERSION = '>=20.10.21';
18
+ /** Значение флага `--platform`, которое подставляется при `platform: 'auto'` на новых версиях docker. */
19
+ export const DEFAULT_PLATFORM = 'linux/x86_64';
@@ -0,0 +1,7 @@
1
+ export { buildDockerImage, type BuildDockerImageOptions } from './build-docker-image';
2
+ export { applyCommandLineArguments, getBuildParams, getBuildParamsFromArgs, type BuildParams, } from './build-params';
3
+ export { dockerVersionSatisfies, getDockerBuildCommand, getPlatformFlag } from './build-command';
4
+ export { prepareFilesForDocker, type PrepareFilesForDockerResult } from './prepare-files';
5
+ export { renderDockerfile } from './templates/dockerfile.template';
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';
@@ -0,0 +1,7 @@
1
+ export { buildDockerImage } from './build-docker-image';
2
+ export { applyCommandLineArguments, getBuildParams, getBuildParamsFromArgs, } from './build-params';
3
+ export { dockerVersionSatisfies, getDockerBuildCommand, getPlatformFlag } from './build-command';
4
+ export { prepareFilesForDocker } from './prepare-files';
5
+ export { renderDockerfile } from './templates/dockerfile.template';
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';