@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,74 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.renderStartScript = renderStartScript;
4
+ const constants_1 = require("./constants");
5
+ /**
6
+ * start.sh — entrypoint артефакта: используется и docker-образом, и tar-архивом. Для serverful-режима
7
+ * поднимает nginx + nodejs, для clientOnly — подставляет env-config и запускает nginx.
8
+ */
9
+ function renderStartScript(config) {
10
+ const { clientOnly, buildPath, serverOutput } = config;
11
+ const serverStartTemplate = `#!/bin/sh
12
+
13
+ # Подменяем env переменные в nginx конфиге перед стартом
14
+ # Сначала заменяем все слова, начинающиеся на $ но без \${} на ~~слово~~
15
+ # затем запускаем envsubst, после этого обратно заменяем ~~слово~~ на $слово.
16
+ # Это нужно для того, чтоб специальные переменные nginx не подменялись envsubst'ом на
17
+ # пустые строки. envsubst будет заменять только \${слово}.
18
+ cat ./nginx.conf \\
19
+ | sed 's/\\$\\([a-zA-Z0-9_-]\\{1,\\}\\)/~~\\1~~/g' \\
20
+ | envsubst \\
21
+ | sed 's/~~\\([a-zA-Z0-9_-]\\{1,\\}\\)~~/$\\1/g' \\
22
+ > /etc/nginx/conf.d/default.conf
23
+
24
+ # Достаем лимит памяти из cgroup, это то, как его докер задает.
25
+ if [[ -f /sys/fs/cgroup/cgroup.controllers ]]; then
26
+ max_total_memory=$(cat /sys/fs/cgroup/memory.max)
27
+ else
28
+ max_total_memory=$(cat /sys/fs/cgroup/memory/memory.limit_in_bytes)
29
+ fi
30
+ # Самой nodejs мы не можем отдать совсем всю память, операционная система+nginx все же требуют какого то количества.
31
+ # Поэтому мы вычитаем 100мб на нужды ос
32
+ node_memory_limit="$(($max_total_memory / 1024 / 1024 - 100))"
33
+
34
+ # Start the nginx process in background
35
+ nginx &
36
+
37
+ # Start nodejs process
38
+ exec node --max-old-space-size="$node_memory_limit" ./${buildPath}/${serverOutput}
39
+ `;
40
+ const envConfigTargetPath = `/src/${buildPath}/${constants_1.ENV_CONFIG_FILENAME}`;
41
+ const envConfigPath = `/src/${constants_1.ENV_CONFIG_FILENAME}`;
42
+ const htmlPath = `/src/${buildPath}/index.html`;
43
+ const clientOnlyStartTemplate = `#!/bin/sh
44
+
45
+ # Мы подставляем значения из env в env-config.json если он есть, и кладем его в публичную папку.
46
+ # Дополнительно подставляем контент полученного файла в index.html
47
+ # Так как контент env-config может быть многострочным - дополнительно обрабатываем его через awk.
48
+ if [ -f ${envConfigPath} ]; then
49
+ cat ${envConfigPath} \\
50
+ | envsubst \\
51
+ > ${envConfigTargetPath}
52
+
53
+ # Define the placeholder and the file paths
54
+ PLACEHOLDER='<%= envConfig %>'
55
+ SETTINGS_FILE='${envConfigTargetPath}'
56
+ TARGET_FILE='${htmlPath}'
57
+
58
+ # Escape the placeholder for sed usage
59
+ ESCAPED_PLACEHOLDER=$(echo "$PLACEHOLDER" | sed 's/[\\/&]/\\\\&/g')
60
+
61
+ # Read the content of the settings and prepare it for substitution
62
+ SETTINGS_CONTENT=$(awk '{printf "%s\\\\n", $0}' "$SETTINGS_FILE")
63
+
64
+ # Replace the placeholder in the target file with the content of settings
65
+ cat ${htmlPath} \\
66
+ | sed "s/$ESCAPED_PLACEHOLDER/$SETTINGS_CONTENT/" \\
67
+ > /tmp/index.html
68
+
69
+ mv /tmp/index.html ${htmlPath}
70
+ fi
71
+
72
+ nginx`;
73
+ return clientOnly ? clientOnlyStartTemplate : serverStartTemplate;
74
+ }
@@ -0,0 +1,12 @@
1
+ /** Ошибка выполнения shell-команды. Код возврата доступен в `exitCode`. */
2
+ export declare class ExecError extends Error {
3
+ readonly exitCode: number;
4
+ readonly command: string;
5
+ constructor(command: string, exitCode: number);
6
+ }
7
+ /**
8
+ * Выполняет shell-команду, резолвится кодом возврата при успехе и реджектится {@link ExecError}
9
+ * при ошибке.
10
+ */
11
+ export declare function exec(command: string): Promise<number>;
12
+ export default exec;
@@ -0,0 +1,36 @@
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.ExecError = void 0;
7
+ exports.exec = exec;
8
+ const shelljs_1 = __importDefault(require("shelljs"));
9
+ /** Ошибка выполнения shell-команды. Код возврата доступен в `exitCode`. */
10
+ class ExecError extends Error {
11
+ exitCode;
12
+ command;
13
+ constructor(command, exitCode) {
14
+ super(`Command failed with exit code ${exitCode}: ${command}`);
15
+ this.name = 'ExecError';
16
+ this.command = command;
17
+ this.exitCode = exitCode;
18
+ }
19
+ }
20
+ exports.ExecError = ExecError;
21
+ /**
22
+ * Выполняет shell-команду, резолвится кодом возврата при успехе и реджектится {@link ExecError}
23
+ * при ошибке.
24
+ */
25
+ function exec(command) {
26
+ return new Promise((resolve, reject) => {
27
+ console.log(`Executing command: ${command}`);
28
+ shelljs_1.default.exec(command, (code) => {
29
+ if (code === 0) {
30
+ return resolve(code);
31
+ }
32
+ return reject(new ExecError(command, code));
33
+ });
34
+ });
35
+ }
36
+ exports.default = exec;
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Экранирует значение для подстановки в shell-команду. Нужно потому, что итоговая строка
3
+ * выполняется через шелл, а значения (`buildArgs`, имя образа, контекст) приходят из
4
+ * пользовательского конфига и переменных окружения CI.
5
+ */
6
+ export declare function shellQuote(value: string): string;
@@ -0,0 +1,16 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.shellQuote = shellQuote;
4
+ /** Символы, которые шелл не трактует специальным образом — такие значения можно не экранировать. */
5
+ const SHELL_SAFE = /^[\w.:/=@+-]+$/;
6
+ /**
7
+ * Экранирует значение для подстановки в shell-команду. Нужно потому, что итоговая строка
8
+ * выполняется через шелл, а значения (`buildArgs`, имя образа, контекст) приходят из
9
+ * пользовательского конфига и переменных окружения CI.
10
+ */
11
+ function shellQuote(value) {
12
+ if (SHELL_SAFE.test(value)) {
13
+ return value;
14
+ }
15
+ return `'${value.replace(/'/g, "'\\''")}'`;
16
+ }
@@ -0,0 +1,25 @@
1
+ import { type YarnVersion } from '../config/types';
2
+ type GetYarnVersionParams = {
3
+ useYarn: boolean;
4
+ };
5
+ /**
6
+ * Определяет версию yarn, доступную в системе. Если yarn не используется/недоступен — `'unavailable'`.
7
+ */
8
+ export declare function getYarnVersion({ useYarn }: GetYarnVersionParams): YarnVersion;
9
+ /**
10
+ * Проверяет наличие `yarn.lock` в директории проекта. Используется как дефолт для `useYarn`.
11
+ */
12
+ export declare function detectUseYarn(cwd: string): boolean;
13
+ type GetPruningCommandParams = {
14
+ yarnVersion: YarnVersion;
15
+ clientOnly: boolean;
16
+ };
17
+ /**
18
+ * Команда удаления dev-зависимостей перед копированием проекта в образ.
19
+ */
20
+ export declare function getPruningCommand({ yarnVersion, clientOnly }: GetPruningCommandParams): string;
21
+ /**
22
+ * Команда установки production-зависимостей внутри образа (для compiled-варианта).
23
+ */
24
+ export declare function getInstallProductionCommand(yarnVersion: YarnVersion): string;
25
+ export {};
@@ -0,0 +1,70 @@
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.getYarnVersion = getYarnVersion;
7
+ exports.detectUseYarn = detectUseYarn;
8
+ exports.getPruningCommand = getPruningCommand;
9
+ exports.getInstallProductionCommand = getInstallProductionCommand;
10
+ const path_1 = __importDefault(require("path"));
11
+ const fs_extra_1 = __importDefault(require("fs-extra"));
12
+ const shelljs_1 = __importDefault(require("shelljs"));
13
+ /**
14
+ * Определяет версию yarn, доступную в системе. Если yarn не используется/недоступен — `'unavailable'`.
15
+ */
16
+ function getYarnVersion({ useYarn }) {
17
+ if (useYarn && shelljs_1.default.which('yarn')) {
18
+ const yarnVersion = shelljs_1.default.exec('yarn -v', { silent: true });
19
+ const yarnMajorVersion = Number(yarnVersion.split('.')[0]);
20
+ return yarnMajorVersion > 1 ? '2+' : '1';
21
+ }
22
+ return 'unavailable';
23
+ }
24
+ /**
25
+ * Проверяет наличие `yarn.lock` в директории проекта. Используется как дефолт для `useYarn`.
26
+ */
27
+ function detectUseYarn(cwd) {
28
+ return fs_extra_1.default.existsSync(path_1.default.join(cwd, 'yarn.lock'));
29
+ }
30
+ /**
31
+ * Команда удаления dev-зависимостей перед копированием проекта в образ.
32
+ */
33
+ function getPruningCommand({ yarnVersion, clientOnly }) {
34
+ if (clientOnly) {
35
+ return 'echo "Skipping pruning in client only mode"';
36
+ }
37
+ switch (yarnVersion) {
38
+ case '1': {
39
+ return 'yarn install --production --ignore-optional --frozen-lockfile --ignore-scripts --prefer-offline';
40
+ }
41
+ case '2+': {
42
+ return 'yarn workspaces focus --production --all';
43
+ }
44
+ case 'unavailable': {
45
+ return 'npm prune --production';
46
+ }
47
+ default: {
48
+ return '';
49
+ }
50
+ }
51
+ }
52
+ /**
53
+ * Команда установки production-зависимостей внутри образа (для compiled-варианта).
54
+ */
55
+ function getInstallProductionCommand(yarnVersion) {
56
+ switch (yarnVersion) {
57
+ case '1': {
58
+ return 'yarn install --production --ignore-optional --frozen-lockfile --ignore-scripts --prefer-offline';
59
+ }
60
+ case '2+': {
61
+ return 'yarn workspaces focus --production --all';
62
+ }
63
+ case 'unavailable': {
64
+ return 'npm install --production';
65
+ }
66
+ default: {
67
+ return '';
68
+ }
69
+ }
70
+ }
@@ -0,0 +1,46 @@
1
+ import { type ArtifactsOptions } from '../config/types';
2
+ import { type BuildArtifactOptions } from '../pipeline/build-artifact';
3
+ /**
4
+ * Содержимое `arui-scripts-artifacts.ts` — единственный источник правды для всех команд проекта.
5
+ *
6
+ * Верхний уровень описывает общие для проекта настройки, `commands` — конкретные сборки. Команда
7
+ * наследует верхний уровень, поэтому «еще один образ с другим портом» — это несколько строк в
8
+ * конфиге, а не отдельный скрипт.
9
+ */
10
+ export type ArtifactsConfigFile = ArtifactsOptions & {
11
+ /**
12
+ * Именованные команды. Имя становится аргументом CLI: `arui-scripts-artifacts <имя>`.
13
+ * Встроенные `docker-build`, `docker-build:compiled` и `archive-build` можно донасыщать или
14
+ * переопределять.
15
+ */
16
+ commands?: Record<string, ArtifactsOptions>;
17
+ };
18
+ /** Конфиг может экспортировать объект или (в т.ч. асинхронную) функцию, возвращающую объект. */
19
+ export type ArtifactsConfigFileExport = ArtifactsConfigFile | (() => ArtifactsConfigFile | Promise<ArtifactsConfigFile>);
20
+ /**
21
+ * Хелпер для типизации `arui-scripts-artifacts.ts`. Ничего не делает в рантайме — существует только
22
+ * ради автодополнения и проверки типов в конфиге.
23
+ */
24
+ export declare function defineConfig(config: ArtifactsConfigFileExport): ArtifactsConfigFileExport;
25
+ /**
26
+ * Встроенные команды. Задают только то, что отличает одну команду от другой; все остальное берется
27
+ * из конфига проекта.
28
+ */
29
+ export declare const BUILT_IN_COMMANDS: Record<string, ArtifactsOptions>;
30
+ /**
31
+ * Сливает несколько конфигов в один: каждый следующий переопределяет предыдущие по тем же правилам,
32
+ * что и команда переопределяет верхний уровень — секции по полям, `commands` по имени команды.
33
+ *
34
+ * Нужно тем, кто отдает CLI собственный конфиг (`-c`) и хочет доложить поверх пользовательский —
35
+ * так делает arui-scripts, чтобы `arui-scripts-artifacts.ts` в корне проекта продолжал работать.
36
+ */
37
+ export declare function mergeConfigFiles(...configFiles: ArtifactsConfigFile[]): ArtifactsConfigFile;
38
+ /** Список команд, доступных с данным конфигом: встроенные плюс объявленные в проекте. */
39
+ export declare function getAvailableCommands(configFile?: ArtifactsConfigFile): string[];
40
+ /**
41
+ * Собирает опции конкретной команды. Приоритет (по возрастанию):
42
+ * дефолты встроенной команды → верхний уровень конфига → секция `commands[command]`.
43
+ *
44
+ * Возвращает `null`, если такой команды нет ни среди встроенных, ни в конфиге.
45
+ */
46
+ export declare function resolveCommandOptions(command: string, configFile?: ArtifactsConfigFile): BuildArtifactOptions | null;
@@ -0,0 +1,110 @@
1
+ /**
2
+ * Хелпер для типизации `arui-scripts-artifacts.ts`. Ничего не делает в рантайме — существует только
3
+ * ради автодополнения и проверки типов в конфиге.
4
+ */
5
+ export function defineConfig(config) {
6
+ return config;
7
+ }
8
+ /**
9
+ * Встроенные команды. Задают только то, что отличает одну команду от другой; все остальное берется
10
+ * из конфига проекта.
11
+ */
12
+ export const BUILT_IN_COMMANDS = {
13
+ 'docker-build': {
14
+ artifact: 'docker',
15
+ docker: { variant: 'runtime', addNodeModulesToDockerIgnore: false },
16
+ localFiles: { allowDockerfile: true, allowStartScript: true },
17
+ },
18
+ 'docker-build:compiled': {
19
+ artifact: 'docker',
20
+ docker: { variant: 'compiled', addNodeModulesToDockerIgnore: true },
21
+ localFiles: { allowDockerfile: false, allowStartScript: false },
22
+ },
23
+ 'archive-build': {
24
+ artifact: 'archive',
25
+ },
26
+ };
27
+ /** Секции конфига — их сливаем по полям, а не заменяем целиком. */
28
+ const MERGED_SECTIONS = [
29
+ 'docker',
30
+ 'nginx',
31
+ 'archive',
32
+ 'build',
33
+ 'packageManager',
34
+ 'localFiles',
35
+ 'templates',
36
+ 'overrides',
37
+ ];
38
+ function isPlainObject(value) {
39
+ return Boolean(value) && typeof value === 'object' && !Array.isArray(value);
40
+ }
41
+ function mergeSection(base, patch) {
42
+ const result = { ...base, ...patch };
43
+ // единственная вложенная в секцию секция — `nginx.baseConf`, и ее тоже ожидаемо сливать по полям.
44
+ // `baseConf: false/null` — осмысленное «не генерировать базовый конфиг», такое значение не сливаем
45
+ Object.keys(patch).forEach((key) => {
46
+ if (isPlainObject(base[key]) && isPlainObject(patch[key])) {
47
+ result[key] = { ...base[key], ...patch[key] };
48
+ }
49
+ });
50
+ return result;
51
+ }
52
+ function mergeOptions(base, patch) {
53
+ const result = { ...base, ...patch };
54
+ MERGED_SECTIONS.forEach((key) => {
55
+ const baseValue = base[key];
56
+ const patchValue = patch[key];
57
+ if (isPlainObject(baseValue) && isPlainObject(patchValue)) {
58
+ Object.assign(result, { [key]: mergeSection(baseValue, patchValue) });
59
+ }
60
+ });
61
+ return result;
62
+ }
63
+ /**
64
+ * Сливает несколько конфигов в один: каждый следующий переопределяет предыдущие по тем же правилам,
65
+ * что и команда переопределяет верхний уровень — секции по полям, `commands` по имени команды.
66
+ *
67
+ * Нужно тем, кто отдает CLI собственный конфиг (`-c`) и хочет доложить поверх пользовательский —
68
+ * так делает arui-scripts, чтобы `arui-scripts-artifacts.ts` в корне проекта продолжал работать.
69
+ */
70
+ export function mergeConfigFiles(...configFiles) {
71
+ return configFiles.reduce((base, patch) => {
72
+ const { commands: baseCommands, ...baseShared } = base;
73
+ const { commands: patchCommands, ...patchShared } = patch;
74
+ const merged = mergeOptions(baseShared, patchShared);
75
+ const commandNames = [
76
+ ...new Set([...Object.keys(baseCommands ?? {}), ...Object.keys(patchCommands ?? {})]),
77
+ ];
78
+ if (commandNames.length) {
79
+ merged.commands = Object.fromEntries(commandNames.map((name) => [
80
+ name,
81
+ mergeOptions(baseCommands?.[name] ?? {}, patchCommands?.[name] ?? {}),
82
+ ]));
83
+ }
84
+ return merged;
85
+ }, {});
86
+ }
87
+ /** Список команд, доступных с данным конфигом: встроенные плюс объявленные в проекте. */
88
+ export function getAvailableCommands(configFile = {}) {
89
+ return Array.from(new Set([...Object.keys(BUILT_IN_COMMANDS), ...Object.keys(configFile.commands ?? {})]));
90
+ }
91
+ /**
92
+ * Собирает опции конкретной команды. Приоритет (по возрастанию):
93
+ * дефолты встроенной команды → верхний уровень конфига → секция `commands[command]`.
94
+ *
95
+ * Возвращает `null`, если такой команды нет ни среди встроенных, ни в конфиге.
96
+ */
97
+ export function resolveCommandOptions(command, configFile = {}) {
98
+ const { commands, ...sharedOptions } = configFile;
99
+ const builtIn = BUILT_IN_COMMANDS[command];
100
+ const declared = commands?.[command];
101
+ if (!builtIn && !declared) {
102
+ return null;
103
+ }
104
+ let options = builtIn ?? {};
105
+ options = mergeOptions(options, sharedOptions);
106
+ if (declared) {
107
+ options = mergeOptions(options, declared);
108
+ }
109
+ return options;
110
+ }
@@ -0,0 +1,25 @@
1
+ import { Command } from 'commander';
2
+ import { type ArtifactsConfigFile } from './config-file';
3
+ /**
4
+ * Достает путь до конфига до того, как построен основной CLI: список команд зависит от конфига,
5
+ * а конфиг — от аргументов. Разбирает тем же commander, просто с выключенными проверками.
6
+ */
7
+ export declare function extractConfigPath(argv: string[]): string | undefined;
8
+ export type RunCommandParams = {
9
+ /** Имя команды из конфига или встроенной. */
10
+ command: string;
11
+ /** Позиционные аргументы команды (`name=... version=... registry=...`). */
12
+ args: string[];
13
+ };
14
+ export type CreateCliParams = {
15
+ /** Загруженный конфиг проекта — из него берется список доступных команд. */
16
+ configFile: ArtifactsConfigFile;
17
+ version: string;
18
+ run: (params: RunCommandParams) => Promise<void> | void;
19
+ };
20
+ /**
21
+ * Собирает CLI: по одной подкоманде на каждую доступную сборку — встроенные плюс объявленные в
22
+ * `commands` конфига проекта. Благодаря этому `--help` показывает и кастомные команды, а опечатка в
23
+ * имени дает подсказку вместо простого списка.
24
+ */
25
+ export declare function createCli({ configFile, version, run }: CreateCliParams): Command;
@@ -0,0 +1,71 @@
1
+ import { Command } from 'commander';
2
+ import { BUILT_IN_COMMANDS, getAvailableCommands } from './config-file';
3
+ /** Описания встроенных команд для `--help`. */
4
+ const BUILT_IN_DESCRIPTIONS = {
5
+ 'docker-build': 'Сборка приложения на хосте, создание docker образа и пуш в registry',
6
+ 'docker-build:compiled': 'Как docker-build, но зависимости и сборка выполняются внутри образа (для CI/CD)',
7
+ 'archive-build': 'Собирает tar-архив с production-сборкой (buildPath, node_modules, package.json, config)',
8
+ };
9
+ const CONFIG_OPTION_HELP = 'Путь до конфига (по умолчанию arui-scripts-artifacts.ts в корне проекта)';
10
+ /**
11
+ * Добавляет опцию конфига. Кроме канонических `-c`/`--config` принимаем и `--c` — commander не умеет
12
+ * несколько длинных имен у одной опции, поэтому вторая объявлена отдельно и скрыта из справки.
13
+ */
14
+ function addConfigOption(command) {
15
+ return command
16
+ .option('-c, --config <path>', CONFIG_OPTION_HELP)
17
+ .addOption(new Command().createOption('--c <path>', CONFIG_OPTION_HELP).hideHelp());
18
+ }
19
+ /** Значение опции конфига, из какого бы из ее написаний оно ни пришло. */
20
+ function getConfigPath(options) {
21
+ return options.config ?? options.c;
22
+ }
23
+ /**
24
+ * Достает путь до конфига до того, как построен основной CLI: список команд зависит от конфига,
25
+ * а конфиг — от аргументов. Разбирает тем же commander, просто с выключенными проверками.
26
+ */
27
+ export function extractConfigPath(argv) {
28
+ const program = addConfigOption(new Command())
29
+ .allowUnknownOption()
30
+ .allowExcessArguments()
31
+ .helpOption(false);
32
+ program.parse(argv, { from: 'user' });
33
+ return getConfigPath(program.opts());
34
+ }
35
+ /**
36
+ * Собирает CLI: по одной подкоманде на каждую доступную сборку — встроенные плюс объявленные в
37
+ * `commands` конфига проекта. Благодаря этому `--help` показывает и кастомные команды, а опечатка в
38
+ * имени дает подсказку вместо простого списка.
39
+ */
40
+ export function createCli({ configFile, version, run }) {
41
+ const program = new Command('arui-scripts-artifacts');
42
+ program
43
+ .description('Сборка docker-образов для приложений на arui-scripts')
44
+ .version(version, '-v, --version', 'Показать версию')
45
+ .showHelpAfterError('(используйте --help для списка команд)')
46
+ .showSuggestionAfterError();
47
+ addConfigOption(program);
48
+ getAvailableCommands(configFile).forEach((name) => {
49
+ const isBuiltIn = Boolean(BUILT_IN_COMMANDS[name]);
50
+ const description = isBuiltIn
51
+ ? BUILT_IN_DESCRIPTIONS[name]
52
+ : 'Команда из arui-scripts-artifacts конфига проекта';
53
+ const command = program
54
+ .command(name)
55
+ .description(description)
56
+ // name=/version=/registry= — позиционные аргументы, а не опции commander
57
+ .allowUnknownOption()
58
+ .allowExcessArguments()
59
+ .action(async () => {
60
+ await run({ command: name, args: command.args });
61
+ });
62
+ addConfigOption(command);
63
+ });
64
+ program.addHelpText('after', [
65
+ '',
66
+ 'Имя образа формируется как {docker.registry}/{name}:{version}.',
67
+ 'name и version по умолчанию берутся из package.json, но их можно переопределить:',
68
+ ' arui-scripts-artifacts docker-build name=container-name version=0.1-beta',
69
+ ].join('\n'));
70
+ return program;
71
+ }
@@ -0,0 +1,3 @@
1
+ export { createCli, extractConfigPath, type CreateCliParams, type RunCommandParams, } from './create-cli';
2
+ export { BUILT_IN_COMMANDS, defineConfig, getAvailableCommands, mergeConfigFiles, resolveCommandOptions, type ArtifactsConfigFile, type ArtifactsConfigFileExport, } from './config-file';
3
+ export { CONFIG_FILE_NAMES, findConfigFile, loadConfigFile, resolveConfigFile, } from './load-config-file';
@@ -0,0 +1,3 @@
1
+ export { createCli, extractConfigPath, } from './create-cli';
2
+ export { BUILT_IN_COMMANDS, defineConfig, getAvailableCommands, mergeConfigFiles, resolveCommandOptions, } from './config-file';
3
+ export { CONFIG_FILE_NAMES, findConfigFile, loadConfigFile, resolveConfigFile, } from './load-config-file';
@@ -0,0 +1,15 @@
1
+ import { type ArtifactsConfigFile } from './config-file';
2
+ /** Имена, по которым конфиг ищется автоматически, если не передан `--config`. */
3
+ export declare const CONFIG_FILE_NAMES: string[];
4
+ /**
5
+ * Ищет конфиг в `cwd`. Явно переданный путь имеет приоритет и обязан существовать — молча
6
+ * игнорировать опечатку в `--config` хуже, чем упасть.
7
+ */
8
+ export declare function findConfigFile(cwd: string, explicitPath?: string): string | null;
9
+ /**
10
+ * Загружает конфиг. Через jiti, поэтому одинаково работают TypeScript, ESM и CommonJS без
11
+ * дополнительных загрузчиков в проекте.
12
+ */
13
+ export declare function loadConfigFile(configPath: string): Promise<ArtifactsConfigFile>;
14
+ /** Находит и загружает конфиг проекта. Если конфига нет — пустой объект. */
15
+ export declare function resolveConfigFile(cwd: string, explicitPath?: string): Promise<ArtifactsConfigFile>;
@@ -0,0 +1,53 @@
1
+ import path from 'path';
2
+ import fs from 'fs-extra';
3
+ import { createJiti } from 'jiti';
4
+ /** Имена, по которым конфиг ищется автоматически, если не передан `--config`. */
5
+ export const CONFIG_FILE_NAMES = [
6
+ 'arui-scripts-artifacts.ts',
7
+ 'arui-scripts-artifacts.mts',
8
+ 'arui-scripts-artifacts.cts',
9
+ 'arui-scripts-artifacts.js',
10
+ 'arui-scripts-artifacts.mjs',
11
+ 'arui-scripts-artifacts.cjs',
12
+ 'arui-scripts-artifacts.config.ts',
13
+ 'arui-scripts-artifacts.config.js',
14
+ ];
15
+ /**
16
+ * Ищет конфиг в `cwd`. Явно переданный путь имеет приоритет и обязан существовать — молча
17
+ * игнорировать опечатку в `--config` хуже, чем упасть.
18
+ */
19
+ export function findConfigFile(cwd, explicitPath) {
20
+ if (explicitPath) {
21
+ const configPath = path.resolve(cwd, explicitPath);
22
+ if (!fs.existsSync(configPath)) {
23
+ throw new Error(`Config file not found: ${configPath}`);
24
+ }
25
+ return configPath;
26
+ }
27
+ return (CONFIG_FILE_NAMES.map((fileName) => path.join(cwd, fileName)).find((filePath) => fs.existsSync(filePath)) ?? null);
28
+ }
29
+ /**
30
+ * Загружает конфиг. Через jiti, поэтому одинаково работают TypeScript, ESM и CommonJS без
31
+ * дополнительных загрузчиков в проекте.
32
+ */
33
+ export async function loadConfigFile(configPath) {
34
+ // База резолва — сам конфиг: его импорты должны разрешаться относительно проекта, а не либы.
35
+ // Заодно не зависим от __filename/import.meta, которых нет то в одной, то в другой сборке.
36
+ const jiti = createJiti(configPath, { interopDefault: true });
37
+ const configModule = await jiti.import(configPath, {
38
+ default: true,
39
+ });
40
+ const config = typeof configModule === 'function' ? await configModule() : configModule;
41
+ if (!config || typeof config !== 'object') {
42
+ throw new Error(`Config file ${configPath} must export an object or a function returning an object`);
43
+ }
44
+ return config;
45
+ }
46
+ /** Находит и загружает конфиг проекта. Если конфига нет — пустой объект. */
47
+ export async function resolveConfigFile(cwd, explicitPath) {
48
+ const configPath = findConfigFile(cwd, explicitPath);
49
+ if (!configPath) {
50
+ return {};
51
+ }
52
+ return loadConfigFile(configPath);
53
+ }
@@ -0,0 +1,10 @@
1
+ import { type ArtifactsOptions, type ResolvedArtifactsConfig } from './types';
2
+ /**
3
+ * Донасыщает частичные опции сборки полным набором значений с дефолтами.
4
+ *
5
+ * Все дефолты артефактов живут здесь (и в константах доменных папок) — потребители, включая
6
+ * arui-scripts, только транслируют то, что задал пользователь. Значения по умолчанию совпадают с
7
+ * историческим поведением arui-scripts, поэтому вызов без аргументов даст такой же образ, как
8
+ * команда `arui-scripts docker-build`.
9
+ */
10
+ export declare function resolveArtifactsConfig(options?: ArtifactsOptions): ResolvedArtifactsConfig;