arui-scripts 23.8.1 → 23.9.0

package/build/index.js

@@ -1,12 +1,36 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.patchMainWebpackConfigForModules = exports.patchMainRspackConfigForModules = exports.getDockerBuildCommand = exports.getBuildParamsFromArgs = exports.prepareFilesForDocker = void 0;
+exports.patchMainWebpackConfigForModules = exports.patchMainRspackConfigForModules = exports.resolveArtifactsConfig = exports.renderStartScript = exports.renderNginxConf = exports.renderTemplates = exports.renderDockerfileCompiled = exports.renderDockerfile = exports.renderBaseNginxConf = exports.getBuildParams = exports.buildDockerImage = exports.getResolvedArtifactsConfig = exports.getArtifactsOptions = exports.getDockerBuildCommand = exports.getBuildParamsFromArgs = exports.prepareFilesForDocker = void 0;
+/**
+ * Утилиты сборки docker-образа, привязанные к глобальному конфигу arui-scripts.
+ * @deprecated Используйте `@alfalab/arui-scripts-artifacts` — там те же функции принимают явный конфиг.
+ * В следующей мажорной версии эти реэкспорты будут удалены.
+ */
 var docker_build_1 = require("./commands/util/docker-build");
 Object.defineProperty(exports, "prepareFilesForDocker", { enumerable: true, get: function () { return docker_build_1.prepareFilesForDocker; } });
 var docker_build_2 = require("./commands/util/docker-build");
 Object.defineProperty(exports, "getBuildParamsFromArgs", { enumerable: true, get: function () { return docker_build_2.getBuildParamsFromArgs; } });
 var docker_build_3 = require("./commands/util/docker-build");
 Object.defineProperty(exports, "getDockerBuildCommand", { enumerable: true, get: function () { return docker_build_3.getDockerBuildCommand; } });
+/**
+ * Опции сборки docker-образа, собранные из конфига arui-scripts. Точка входа для тех, кто хочет
+ * собрать образ через `@alfalab/arui-scripts-artifacts`, но переиспользовать настройки arui-scripts.
+ * @deprecated Слой обратной совместимости: в следующей мажорной версии настройки сборки артефактов
+ * будут жить только в конфиге `arui-scripts-artifacts.ts`.
+ */
+var artifacts_config_1 = require("./commands/util/artifacts-config");
+Object.defineProperty(exports, "getArtifactsOptions", { enumerable: true, get: function () { return artifacts_config_1.getArtifactsOptions; } });
+Object.defineProperty(exports, "getResolvedArtifactsConfig", { enumerable: true, get: function () { return artifacts_config_1.getResolvedArtifactsConfig; } });
+var arui_scripts_artifacts_1 = require("@alfalab/arui-scripts-artifacts");
+Object.defineProperty(exports, "buildDockerImage", { enumerable: true, get: function () { return arui_scripts_artifacts_1.buildDockerImage; } });
+Object.defineProperty(exports, "getBuildParams", { enumerable: true, get: function () { return arui_scripts_artifacts_1.getBuildParams; } });
+Object.defineProperty(exports, "renderBaseNginxConf", { enumerable: true, get: function () { return arui_scripts_artifacts_1.renderBaseNginxConf; } });
+Object.defineProperty(exports, "renderDockerfile", { enumerable: true, get: function () { return arui_scripts_artifacts_1.renderDockerfile; } });
+Object.defineProperty(exports, "renderDockerfileCompiled", { enumerable: true, get: function () { return arui_scripts_artifacts_1.renderDockerfileCompiled; } });
+Object.defineProperty(exports, "renderTemplates", { enumerable: true, get: function () { return arui_scripts_artifacts_1.renderTemplates; } });
+Object.defineProperty(exports, "renderNginxConf", { enumerable: true, get: function () { return arui_scripts_artifacts_1.renderNginxConf; } });
+Object.defineProperty(exports, "renderStartScript", { enumerable: true, get: function () { return arui_scripts_artifacts_1.renderStartScript; } });
+Object.defineProperty(exports, "resolveArtifactsConfig", { enumerable: true, get: function () { return arui_scripts_artifacts_1.resolveArtifactsConfig; } });
 var modules_1 = require("./configs/modules");
 Object.defineProperty(exports, "patchMainRspackConfigForModules", { enumerable: true, get: function () { return modules_1.patchMainRspackConfigForModules; } });
 Object.defineProperty(exports, "patchMainWebpackConfigForModules", { enumerable: true, get: function () { return modules_1.patchMainWebpackConfigForModules; } });

package/docs/artifact.md

@@ -1,6 +1,10 @@
 Настройки сборки артефакта
 ===
 
+> ⚠️ Сборка артефактов живет в отдельном пакете [@alfalab/arui-scripts-artifacts](../../arui-scripts-artifacts/README.md).
+> Настройки и оверрайды артефакта в конфиге arui-scripts объявлены устаревшими и будут удалены в
+> следующей мажорной версии — новые проекты настраивают сборку через `arui-scripts-artifacts.ts`.
+
 ## docker
 
 По-умолчанию, базовым образом для сборки артефакта является [alpine-node-nginx](../../alpine-node-nginx).
@@ -9,13 +13,13 @@
 
 Вы также можете переопределить полностью процесс сборки docker-образа используя механизм [overrides](#тонкая-настройка)
 или создав в корневой директории проекта `Dockerfile` содержащий необходимый набор инструкций.
-Пример [Dockerfile](src/templates/dockerfile.template.ts).
+Пример [Dockerfile](../../arui-scripts-artifacts/src/docker/templates/dockerfile.template.ts).
 
 `Dockerfile` в корне проекта имеет приоритет над overrides.
 
 Чтобы переопределить скрипт запуска, воспользуйтесь механизмом [overrides](#тонкая-настройка)
 или создайте в корневой директории проекта `start.sh` файл содержащий необходимый набор инструкций.
-Пример [start.sh](src/templates/start.template.ts).
+Пример [start.sh](../../arui-scripts-artifacts/src/start-script/start.template.ts).
 
 `start.sh` в корне проекта имеет приоритет над overrides.
 
@@ -23,7 +27,7 @@
 ## Концигурация nginx
 Несмотря на то, что nginx имеет готовый конфиг с роутингом, иногда возникает необходимость добавлять свои роуты.
 Вы можете использовать механизм [overrides](overrides.md).
-Так же вы можете создать `nginx.conf` на уровне проекта со своими роутами. Пример конфига [тут](../src/templates/nginx.conf.template.ts).
+Так же вы можете создать `nginx.conf` на уровне проекта со своими роутами. Пример конфига [тут](../../arui-scripts-artifacts/src/nginx/templates/nginx.conf.template.ts).
 Файл nginx.conf имеет приоритет над оверрайдами.
 
 ### Использование env переменных в nginx.conf

package/docs/overrides.md

@@ -64,17 +64,17 @@ export default overrides;
   Альтернативно вы можете использовать любые методы передачи списка браузеров, поддерживаемые пакетом browserslist.
   Ключи: `browsers`, `supportingBrowsers`
 - `supportingNode` - список поддерживаемых версий nodejs в формате [browserslist](https://github.com/browserslist/browserslist).
-- `Dockerfile` - докерфайл, который будет использоваться для сборки контейнера.
-  Базовый шаблон [тут](../src/templates/dockerfile.template.ts).
+- `Dockerfile` - :warning: устарел, см. врезку ниже. Докерфайл, который будет использоваться для сборки контейнера.
+  Базовый шаблон [тут](../../arui-scripts-artifacts/src/docker/templates/dockerfile.template.ts).
   [`Dockerfile` в корне проекта](#docker) имеет приоритет над overrides.
-- `DockerfileCompiled` - докерфайл, который будет использоваться для сборки контейнера при использовании команды `arui-scripts docker-build:compiled`
-- `nginx` - шаблон конфигурации для nginx внутри контейнера.
-  Базовый шаблон [тут](../src/templates/nginx.conf.template.ts).
+- `DockerfileCompiled` - :warning: устарел. Докерфайл, который будет использоваться для сборки контейнера при использовании команды `arui-scripts docker-build:compiled`
+- `nginx` - :warning: устарел. Шаблон конфигурации для nginx внутри контейнера.
+  Базовый шаблон [тут](../../arui-scripts-artifacts/src/nginx/templates/nginx.conf.template.ts).
   [Файл `nginx.conf`](nginx.md) в корне имеет приоритет над оверрайдами.
-- `nginxConf` - шаблон базовой конфигурации для nginx внутри  контейнера
-  Базовый шаблон аналогичный тому, который добавлется в базовый образ [тут](../src/templates/base-nginx.conf.template.ts).
+- `nginxConf` - :warning: устарел. Шаблон базовой конфигурации для nginx внутри  контейнера
+  Базовый шаблон аналогичный тому, который добавлется в базовый образ [тут](../../arui-scripts-artifacts/src/nginx/templates/base-nginx.conf.template.ts).
   [Файл `base-nginx.conf`](base-nginx.md) в корне имеет приоритет над оверрайдами.
-- `start.sh` - шаблон entrypoint докер контейнера. Базовый шаблон [тут](../src/templates/start.template.ts).
+- `start.sh` - :warning: устарел. Шаблон entrypoint докер контейнера. Базовый шаблон [тут](../../arui-scripts-artifacts/src/start-script/start.template.ts).
 - `serverExternalsExemptions` - список модулей, которые не будут добавлены в список внешних зависимостей сервера. [Подробнее](caveats.md#node-externals).
 - `html` - шаблон для htmlWebpackPlugin, будет использоваться только в режиме [`clientOnly`](./settings.md#clientonly).
 - `swc-client` - конфигурация `swc` для клиентского кода. Ключи: `swc`, `swcClient`.
@@ -83,6 +83,12 @@ export default overrides;
 
 Для некоторых конфигураций определены несколько ключей, они будут применяться в том порядке, в котором они приведены в этом файле.
 
+> ⚠️ Оверрайды файлов артефакта поставки (`Dockerfile`, `DockerfileCompiled`, `nginx`, `nginxConf`,
+> `start.sh`) объявлены устаревшими и будут удалены в следующей мажорной версии arui-scripts.
+> Переносите их в секцию `overrides` конфига `arui-scripts-artifacts.ts`
+> ([таблица соответствия](../../arui-scripts-artifacts/docs/migration.md)).
+> Команды сборки предупреждают о таких оверрайдах в консоли.
+
 ### Создание дополнительных конфигураций для webpack
 На некоторых проектах может потребоваться создать дополнительные конфигурации для webpack. Например, для создания
 service worker'а (или любых других кейсов). Для этого можно использовать функцию-хелпер `createSingleWebpackConfig`:

package/docs/settings.md

@@ -132,6 +132,9 @@ export default settings;
 #### additionalBuildPath
 Массив путей, которые попадут в архив при использовании [команды archive-build](./commands.md#archive-build). По умолчанию `['config']`.
 
+:warning: Настройка устарела, см. [настройки сборки артефактов](#настройки-сборки-артефактов).
+Замена — `archive.additionalPaths` в конфиге `arui-scripts-artifacts.ts`.
+
 #### statsOutputFilename
 Имя [stats-файла](https://webpack.js.org/api/stats/), которое будет использоваться в [bundle-analyze команде](./commands.md#bundle-analyze). По умолчанию `stats.json`
 
@@ -166,6 +169,13 @@ const settings = {
 
 ### Настройки сборки артефактов
 
+> ⚠️ **Объявлены устаревшими.** Эти настройки arui-scripts просто транслирует в
+> [@alfalab/arui-scripts-artifacts](../../arui-scripts-artifacts/README.md), где и живут их значения по
+> умолчанию. В следующей мажорной версии arui-scripts они будут удалены — переносите их в конфиг
+> `arui-scripts-artifacts.ts` в корне проекта (таблица соответствия — в
+> [документации пакета](../../arui-scripts-artifacts/docs/migration.md)).
+> Команды сборки предупреждают о таких настройках в консоли.
+
 #### dockerRegistry
 Адрес используемого docker registry, по умолчанию `''`, то есть используется публичный registry
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arui-scripts",
-  "version": "23.8.1",
+  "version": "23.9.0",
   "main": "./build/index.js",
   "typings": "./build/index.d.ts",
   "exports": {
@@ -21,6 +21,7 @@
   "homepage": "https://github.com/core-ds/arui-scripts#readme",
   "bin": "./build/bin/index.js",
   "dependencies": {
+    "@alfalab/arui-scripts-artifacts": "^1.0.0",
     "@alfalab/postcss-custom-properties": "^9.1.2",
     "@babel/core": "7.29.7",
     "@babel/plugin-proposal-decorators": "^7.29.7",
@@ -45,12 +46,12 @@
     "@babel/runtime": "^7.29.7",
     "@module-federation/runtime-tools": "^2.0.0",
     "@pmmmwh/react-refresh-webpack-plugin": "0.6.2",
-    "@rsdoctor/rspack-plugin": "1.5.9",
-    "@rspack/cli": "2.0.0",
-    "@rspack/core": "2.0.0",
-    "@rspack/dev-server": "2.0.0",
-    "@rspack/plugin-react-refresh": "2.0.0",
-    "@swc/core": "1.15.1",
+    "@rsdoctor/rspack-plugin": "1.6.4",
+    "@rspack/cli": "2.2.5",
+    "@rspack/core": "2.2.5",
+    "@rspack/dev-server": "2.2.1",
+    "@rspack/plugin-react-refresh": "2.0.2",
+    "@swc/core": "1.16.2",
     "@swc/jest": "0.2.39",
     "assets-webpack-plugin": "7.1.1",
     "autoprefixer": "^10.3.16",
@@ -107,7 +108,7 @@
     "react-refresh": "0.19.0",
     "react-refresh-typescript": "2.0.12",
     "rimraf": "^2.7.1",
-    "rspack-manifest-plugin": "5.2.1",
+    "rspack-manifest-plugin": "5.2.2",
     "run-script-webpack-plugin": "0.0.11",
     "semver": "^7.5.4",
     "serialize-javascript": "^7.0.5",
@@ -115,10 +116,10 @@
     "strip-ansi": "6.0.1",
     "style-loader": "3.3.3",
     "swc-loader": "^0.2.6",
-    "swc-plugin-coverage-instrument": "0.0.32",
+    "swc-plugin-coverage-instrument": "0.0.33",
     "tar": "7.5.21",
     "terser-webpack-plugin": "5.3.14",
-    "ts-checker-rspack-plugin": "^1.3.0",
+    "ts-checker-rspack-plugin": "^1.6.1",
     "ts-jest": "29.1.0",
     "ts-loader": "9.4.4",
     "ts-node": "10.9.2",