arui-scripts 23.0.2 → 23.2.0

package/build/configs/util/apply-overrides.d.ts

@@ -2,19 +2,19 @@ import type * as rspack from '@rspack/core';
 import { type Configuration as RspackDevServerConfiguration } from '@rspack/dev-server';
 import { type Options as SwcOptions } from '@swc/core';
 import { type AppContextWithConfigs } from '../app-configs/types';
-import { type createSingleClientWebpackConfig } from '../webpack.client';
+import { type createSingleClientWebpackConfig } from '../rspack.client';
 import { type findLoader } from './find-loader';
 import { type createFindPluginFunction } from './find-plugin';
 type Overrides = {
-    webpack: rspack.Configuration | rspack.Configuration[];
-    webpackClient: rspack.Configuration | rspack.Configuration[];
-    webpackDev: rspack.Configuration | rspack.Configuration[];
-    webpackClientDev: rspack.Configuration | rspack.Configuration[];
-    webpackServer: rspack.Configuration;
-    webpackServerDev: rspack.Configuration;
-    webpackProd: rspack.Configuration;
-    webpackClientProd: rspack.Configuration | rspack.Configuration[];
-    webpackServerProd: rspack.Configuration;
+    rspack: rspack.Configuration | rspack.Configuration[];
+    rspackClient: rspack.Configuration | rspack.Configuration[];
+    rspackDev: rspack.Configuration | rspack.Configuration[];
+    rspackClientDev: rspack.Configuration | rspack.Configuration[];
+    rspackServer: rspack.Configuration;
+    rspackServerDev: rspack.Configuration;
+    rspackProd: rspack.Configuration;
+    rspackClientProd: rspack.Configuration | rspack.Configuration[];
+    rspackServerProd: rspack.Configuration;
     devServer: RspackDevServerConfiguration;
     stats: rspack.RspackOptionsNormalized['stats'];
     babel: any;
@@ -37,14 +37,26 @@ type Overrides = {
     serverExternalsExemptions: Array<string | RegExp>;
     html: string;
 };
+declare const DEPRECATED_OVERRIDE_KEYS: {
+    readonly webpack: "rspack";
+    readonly webpackClient: "rspackClient";
+    readonly webpackDev: "rspackDev";
+    readonly webpackClientDev: "rspackClientDev";
+    readonly webpackServer: "rspackServer";
+    readonly webpackServerDev: "rspackServerDev";
+    readonly webpackProd: "rspackProd";
+    readonly webpackClientProd: "rspackClientProd";
+    readonly webpackServerProd: "rspackServerProd";
+};
+type DeprecatedOverrideKey = keyof typeof DEPRECATED_OVERRIDE_KEYS;
 type OmitFirstArg<F> = F extends (x: any, ...args: infer P) => infer R ? (...args: P) => R : never;
 type BoundCreateSingleClientWebpackConfig = OmitFirstArg<typeof createSingleClientWebpackConfig>;
-type ClientWebpackAdditionalArgs = {
+type ClientRspackAdditionalArgs = {
     createSingleClientWebpackConfig: BoundCreateSingleClientWebpackConfig;
     findLoader: typeof findLoader;
     findPlugin: ReturnType<typeof createFindPluginFunction<'client'>>;
 };
-type ServerWebpackAdditionalArgs = {
+type ServerRspackAdditionalArgs = {
     findLoader: typeof findLoader;
     findPlugin: ReturnType<typeof createFindPluginFunction<'server'>>;
 };
@@ -52,20 +64,38 @@ type ServerWebpackAdditionalArgs = {
  * Дополнительные аргументы, которые будут переданы в функцию оверрайда
  */
 type OverridesAdditionalArgs = {
-    webpack: ClientWebpackAdditionalArgs;
-    webpackClient: ClientWebpackAdditionalArgs;
-    webpackDev: ClientWebpackAdditionalArgs;
-    webpackClientDev: ClientWebpackAdditionalArgs;
-    webpackProd: ClientWebpackAdditionalArgs;
-    webpackClientProd: ClientWebpackAdditionalArgs;
-    webpackServer: ServerWebpackAdditionalArgs;
-    webpackServerDev: ServerWebpackAdditionalArgs;
-    webpackServerProd: ServerWebpackAdditionalArgs;
+    rspack: ClientRspackAdditionalArgs;
+    rspackClient: ClientRspackAdditionalArgs;
+    rspackDev: ClientRspackAdditionalArgs;
+    rspackClientDev: ClientRspackAdditionalArgs;
+    rspackProd: ClientRspackAdditionalArgs;
+    rspackClientProd: ClientRspackAdditionalArgs;
+    rspackServer: ServerRspackAdditionalArgs;
+    rspackServerDev: ServerRspackAdditionalArgs;
+    rspackServerProd: ServerRspackAdditionalArgs;
+    /** @deprecated используйте rspack */
+    webpack: ClientRspackAdditionalArgs;
+    /** @deprecated используйте rspackClient */
+    webpackClient: ClientRspackAdditionalArgs;
+    /** @deprecated используйте rspackDev */
+    webpackDev: ClientRspackAdditionalArgs;
+    /** @deprecated используйте rspackClientDev */
+    webpackClientDev: ClientRspackAdditionalArgs;
+    /** @deprecated используйте rspackProd */
+    webpackProd: ClientRspackAdditionalArgs;
+    /** @deprecated используйте rspackClientProd */
+    webpackClientProd: ClientRspackAdditionalArgs;
+    /** @deprecated используйте rspackServer */
+    webpackServer: ServerRspackAdditionalArgs;
+    /** @deprecated используйте rspackServerDev */
+    webpackServerDev: ServerRspackAdditionalArgs;
+    /** @deprecated используйте rspackServerProd */
+    webpackServerProd: ServerRspackAdditionalArgs;
 };
-type OverrideFunction<K extends keyof Overrides, AdditionalArgs = K extends keyof OverridesAdditionalArgs ? OverridesAdditionalArgs[K] : undefined> = (config: Overrides[K], appConfig: AppContextWithConfigs, additionalArgs: AdditionalArgs) => Overrides[K];
+type OverrideFunction<K extends keyof Overrides> = (config: Overrides[K], appConfig: AppContextWithConfigs, additionalArgs: K extends keyof OverridesAdditionalArgs ? OverridesAdditionalArgs[K] : undefined) => Overrides[K];
 export type OverrideFile = {
     [K in keyof Overrides]?: OverrideFunction<K>;
-};
+} & Partial<Record<DeprecatedOverrideKey, OverrideFunction<'rspack'>>>;
 /**
  *
  * @param {String|String[]} overridesKey Ключи оверрайда

package/build/configs/util/apply-overrides.js

@@ -2,6 +2,40 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.applyOverrides = applyOverrides;
 const app_configs_1 = require("../app-configs");
+// Маппинг устаревших webpack-ключей оверрайдов на актуальные ключи для rspack
+// Поддержка webpack-ключей будет скоро удалена.
+const DEPRECATED_OVERRIDE_KEYS = {
+    webpack: 'rspack',
+    webpackClient: 'rspackClient',
+    webpackDev: 'rspackDev',
+    webpackClientDev: 'rspackClientDev',
+    webpackServer: 'rspackServer',
+    webpackServerDev: 'rspackServerDev',
+    webpackProd: 'rspackProd',
+    webpackClientProd: 'rspackClientProd',
+    webpackServerProd: 'rspackServerProd',
+};
+/**
+ * Переносит устаревшие webpack-ключи оверрайдов на актуальные rspack-ключи и
+ * предупреждает о необходимости миграции. Если заданы оба ключа — приоритет у
+ * нового, устаревший игнорируется.
+ */
+function normalizeDeprecatedOverrideKeys(override) {
+    const result = Object.assign({}, override);
+    Object.keys(DEPRECATED_OVERRIDE_KEYS).forEach((deprecatedKey) => {
+        if (!Object.prototype.hasOwnProperty.call(result, deprecatedKey)) {
+            return;
+        }
+        const newKey = DEPRECATED_OVERRIDE_KEYS[deprecatedKey];
+        console.warn(`[arui-scripts] Ключ оверрайда "${deprecatedKey}" устарел, используйте "${newKey}". ` +
+            `Поддержка "${deprecatedKey}" будет скоре удалена.`);
+        if (!Object.prototype.hasOwnProperty.call(result, newKey)) {
+            result[newKey] = result[deprecatedKey];
+        }
+        delete result[deprecatedKey];
+    });
+    return result;
+}
 let overrides = [];
 overrides = app_configs_1.configs.overridesPath.map((path) => {
     try {
@@ -10,9 +44,9 @@ overrides = app_configs_1.configs.overridesPath.map((path) => {
         // eslint-disable-next-line no-underscore-dangle
         if (requireResult.__esModule) {
             // ts-node импортирует esModules, из них надо вытягивать default именно так
-            return requireResult.default;
+            return normalizeDeprecatedOverrideKeys(requireResult.default);
         }
-        return requireResult;
+        return normalizeDeprecatedOverrideKeys(requireResult);
     }
     catch (e) {
         console.error(`Unable to process override file "${path}"`);
@@ -40,6 +74,8 @@ function applyOverrides(overridesKey, config, args) {
                     throw new TypeError(`Override ${key} must be a function`);
                 }
                 // eslint-disable-next-line no-param-reassign
+                // @ts-expect-error Union type conflict between rspack and deprecated webpack keys - resolved at runtime
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any,no-param-reassign
                 config = overrideFn(config, app_configs_1.configs, args);
             }
         });

package/build/configs/util/find-plugin.d.ts

@@ -5,10 +5,10 @@ import type AssetsPlugin from 'assets-webpack-plugin';
 import type CaseSensitivePathsPlugin from 'case-sensitive-paths-webpack-plugin';
 import type CompressionPlugin from 'compression-webpack-plugin';
 import type MiniCssExtractPlugin from 'mini-css-extract-plugin';
+import { type RspackManifestPlugin } from 'rspack-manifest-plugin';
 import { type RunScriptWebpackPlugin } from 'run-script-webpack-plugin';
 import { type TsCheckerRspackPluginOptions } from 'ts-checker-rspack-plugin/lib/plugin-options';
 import { type WebpackDeduplicationPlugin } from 'webpack-deduplication-plugin';
-import { type WebpackManifestPlugin } from 'webpack-manifest-plugin';
 type PluginsListClient = {
     AssetsWebpackPlugin: {
         options: AssetsPlugin.Options;
@@ -45,7 +45,7 @@ type PluginsListClient = {
         };
     };
     WebpackManifestPlugin: {
-        options: ConstructorParameters<typeof WebpackManifestPlugin>[number];
+        options: ConstructorParameters<typeof RspackManifestPlugin>[number];
     };
     CompressionPlugin: {
         options: ConstructorParameters<typeof CompressionPlugin>[number];

package/build/index.d.ts

@@ -3,4 +3,4 @@ export type { AppConfigs, CompatModuleConfig, PackageSettings } from './configs/
 export { prepareFilesForDocker } from './commands/util/docker-build';
 export { getBuildParamsFromArgs } from './commands/util/docker-build';
 export { getDockerBuildCommand } from './commands/util/docker-build';
-export { patchMainWebpackConfigForModules } from './configs/modules';
+export { patchMainRspackConfigForModules, patchMainWebpackConfigForModules, } from './configs/modules';

package/build/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.patchMainWebpackConfigForModules = exports.getDockerBuildCommand = exports.getBuildParamsFromArgs = exports.prepareFilesForDocker = void 0;
+exports.patchMainWebpackConfigForModules = exports.patchMainRspackConfigForModules = exports.getDockerBuildCommand = exports.getBuildParamsFromArgs = exports.prepareFilesForDocker = void 0;
 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");
@@ -8,4 +8,5 @@ Object.defineProperty(exports, "getBuildParamsFromArgs", { enumerable: true, get
 var docker_build_3 = require("./commands/util/docker-build");
 Object.defineProperty(exports, "getDockerBuildCommand", { enumerable: true, get: function () { return docker_build_3.getDockerBuildCommand; } });
 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/build/plugins/reload-server-plugin.d.ts

@@ -1,5 +1,5 @@
 import { type Worker } from 'cluster';
-import { type Compiler } from 'webpack';
+import { type Compiler } from '@rspack/core';
 export declare class ReloadServerPlugin {
     workers: Worker[];
     done: null | (() => void);

package/build/plugins/watch-missing-node-modules-plugin.d.ts

@@ -1,4 +1,4 @@
-import { type Compiler } from 'webpack';
+import { type Compiler } from '@rspack/core';
 export declare class WatchMissingNodeModulesPlugin {
     nodeModulesPath: string;
     constructor(nodeModulesPath: string);

package/docs/cli.md

@@ -0,0 +1,23 @@
+# CLI arui-scripts
+
+`arui-scripts` предоставляет CLI для сборки, запуска и тестирования react-приложений.
+После установки пакета команды доступны через `arui-scripts <команда>`
+
+Для генерации нового проекта используйте отдельный пакет
+[`create-arui-scripts-app`](../../create-arui-scripts-app/README.md):
+
+```bash
+npx create-arui-scripts-app my-app
+```
+
+## Глобальные флаги
+
+- `arui-scripts --help` — список всех команд с описаниями.
+- `arui-scripts --version` (`-v`) - версия пакета.
+- `arui-scripts <команда> --help` - справка по конкретной команде.
+
+## Команды
+
+Полный список и описание — в [docs/commands.md](commands.md):
+`start`, `start:prod`, `build`, `docker-build`, `docker-build:compiled`, `test`, `test:vitest`,
+`archive-build`, `bundle-analyze`, `ensure-yarn`, `changelog`.

package/docs/commands.md

@@ -1,33 +1,45 @@
-Доступные команды
+# Доступные команды
+
 ===
 
-### start
+CLI `arui-scripts` поддерживает глобальные флаги:
+
+- `arui-scripts --help` - список всех команд с описаниями.
+- `arui-scripts --version` (`-v`) - версия пакета.
+- `arui-scripts <command> --help` - справка по конкретной команде.
+
+## start
+
 Запускает dev-сервер для клиентского кода и серверный код в watch-режиме.
 
 **Как запустить?**
+
 ```bash
 arui-scripts start
 ```
 
-### start:prod
+## start:prod
+
 Запускает dev-сервер для клиентского кода и серверный код в watch-режиме. При этом использует production-конфигурацию для rspack.
 Может быть полезна для сбора метрик производительности.
 
 **Как запустить?**
+
 ```bash
 arui-scripts start:prod
 ```
 
-### build
+## build
+
 Собирает клиентский и серверный код в production-режиме.
 
 **Как запустить?**
+
 ```bash
 arui-scripts build
 ```
 
-### test
-Команда `arui-scripts test` внутри запускает jest с дополнительной конфигурацией.
+## test
 
 Конфигурация включает в себя:
 - Использование `jest-snapshot-serializer-class-name-to-string` для правильной работы с `cn`
@@ -36,6 +48,8 @@ arui-scripts build
 - Компиляцию .ts/.tsx файлов используя tsc
 - Замену импортов остальных типов файлов на импорт строк с названием файла
 
+Команда `arui-scripts test` внутри запускает jest с дополнительной конфигурацией.
+
 По умолчанию под маску для поиска тестов попадают все файлы `*test*.(js|jsx|ts|tsx)`, `*spec*.((js|jsx|ts|tsx))`, `*/__test__/*.(js|jsx|ts|tsx)`.
 
 Вы можете переопределять любые настройки jest в `package.json`, [документация](https://facebook.github.io/jest/docs/en/configuration.html).
@@ -53,11 +67,13 @@ _package.json_
 ```
 
 **Как запустить?**
+
 ```bash
 arui-scripts test
 ```
 
-### test:vitest
+## test:vitest
+
 Команда `arui-scripts test:vitest` запускает unit тесты через [Vitest](https://vitest.dev/).
 
 Если в корне проекта есть `vitest.config.ts` (или `.js`, `.mjs`, `.cjs`), то используется он.
@@ -91,10 +107,12 @@ export default mergeConfig(aruiConfig, defineConfig({
 arui-scripts test:vitest
 ```
 
-### docker-build
+## docker-build
+
 Собирает клиентский и серверный код в production-режиме, создает docker-образ и пушит его в docker-репозиторий.
 
 **Как запустить?**
+
 ```bash
 arui-scripts docker-build
 ```
@@ -115,7 +133,7 @@ yarn будет использоваться когда в рутовой пап
 docker run -p 8080:8080 container-name:version ./start.sh
 ```
 
-### docker-build:compiled
+## docker-build:compiled
 
 Команда `arui-scripts docker-build:compiled` во многом аналогична `docker-build`, но вместо сборки проекта использует уже скомпилированный в папку `.build` код.
 При этом в контейнер будут устанавливаться только production зависимости.
@@ -130,11 +148,12 @@ Dockerfile при этом будет сгенерирован автомати
 Локальный `Dockerfile` в корне проекта в данном случае полностью игнорируется.
 
 **Как запустить?**
+
 ```bash
 arui-scripts docker-build:compiled
 ```
 
-### archive-build
+## archive-build
 
 Собирает архив с production сборкой.
 
@@ -147,11 +166,12 @@ yarn будет использоваться когда в рутовой пап
 Итоговый архив будет содержать в себе `.build`, `node_modules`, `package.json` и `config` папки вашего проекта.
 
 **Как запустить?**
+
 ```bash
 arui-scripts archive-build
 ```
 
-### bundle-analyze
+## bundle-analyze
 
 Запускает [webpack-bundle-analyzer](https://www.npmjs.com/package/webpack-bundle-analyzer) и [rsdoctor](https://rsdoctor.dev/) для анализа бандла и сборки.
 Так же при запуске будет генерироваться [stats-файл](https://webpack.js.org/api/stats/), который можно использовать в

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arui-scripts",
-  "version": "23.0.2",
+  "version": "23.2.0",
   "main": "./build/index.js",
   "typings": "./build/index.d.ts",
   "exports": {
@@ -63,6 +63,7 @@
     "brotli-dict": "^1.1.4",
     "case-sensitive-paths-webpack-plugin": "2.4.0",
     "chalk": "^2.4.2",
+    "commander": "^12",
     "compression-webpack-plugin": "9.2.0",
     "core-js": "3.32.0",
     "css-loader": "6.8.1",
@@ -83,7 +84,6 @@
     "mini-css-extract-plugin": "2.7.6",
     "mini-svg-data-uri": "^1.4.4",
     "null-loader": "0.1.1",
-    "pnp-webpack-plugin": "1.7.0",
     "postcss": "^8.5.10",
     "postcss-calc": "^9.0.0",
     "postcss-color-function": "^4.0.0",
@@ -126,7 +126,6 @@
     "vitest": "^4.1.5",
     "webpack-bundle-analyzer": "4.10.2",
     "webpack-deduplication-plugin": "^0.0.8",
-    "webpack-manifest-plugin": "3.2.0",
     "webpack-node-externals": "3.0.0"
   },
   "devDependencies": {
@@ -141,12 +140,8 @@
     "@types/semver": "^7.5.0",
     "@types/serialize-javascript": "^5.0.4",
     "@types/shelljs": "^0.8.12",
-    "@types/start-server-webpack-plugin": "2.2.2",
     "@types/tar": "^4.0.5",
-    "@types/webpack": "^5.28.5",
     "@types/webpack-bundle-analyzer": "4.7.0",
-    "@types/webpack-dev-server": "4.7.2",
-    "@types/webpack-manifest-plugin": "3.0.5",
     "@types/webpack-node-externals": "^3.0.0",
     "babel-plugin-transform-import-meta": "^2.3.3",
     "type-fest": "2.19.0",
@@ -157,6 +152,7 @@
   },
   "scripts": {
     "build": "sh bin/build.sh",
+    "cli": "node build/bin/index.js",
     "test": "jest",
     "test:vitest": "vitest",
     "lint:scripts": "arui-presets-lint scripts",