arui-scripts 23.9.3 → 25.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. package/.turbo/turbo-test.log +13 -11
  2. package/CHANGELOG.md +38 -0
  3. package/README.md +4 -1
  4. package/build/commands/build/build-wrapper.js +2 -2
  5. package/build/commands/build/client.js +26 -8
  6. package/build/commands/build/server.js +1 -1
  7. package/build/commands/bundle-analyze/index.js +10 -10
  8. package/build/commands/start/server.js +1 -1
  9. package/build/commands/start-prod/client.js +1 -1
  10. package/build/commands/start-prod/server.js +1 -1
  11. package/build/commands/util/build-size-budgets.d.ts +6 -0
  12. package/build/commands/util/build-size-budgets.js +158 -0
  13. package/build/commands/util/client-assets-sizes.d.ts +1 -1
  14. package/build/commands/util/client-assets-sizes.js +2 -2
  15. package/build/commands/util/{format-webpack-messages.d.ts → format-rspack-messages.d.ts} +1 -1
  16. package/build/commands/util/{format-webpack-messages.js → format-rspack-messages.js} +2 -2
  17. package/build/configs/app-configs/get-defaults.js +1 -0
  18. package/build/configs/app-configs/types.d.ts +14 -4
  19. package/build/configs/app-configs/types.js +3 -0
  20. package/build/configs/app-configs/validate-build-size-budgets.d.ts +1 -0
  21. package/build/configs/app-configs/validate-build-size-budgets.js +31 -0
  22. package/build/configs/app-configs/validate-config.js +2 -0
  23. package/build/configs/app-configs/warn-about-deprecations.js +0 -5
  24. package/build/configs/client-env-config/client-config-plugin.js +2 -3
  25. package/build/configs/config-extras/minimizers/imagemin/imagemin.d.ts +1 -10
  26. package/build/configs/config-extras/minimizers/imagemin/imagemin.js +2 -14
  27. package/build/configs/modules.d.ts +2 -4
  28. package/build/configs/modules.js +23 -25
  29. package/build/configs/postcss.d.ts +2 -2
  30. package/build/configs/rspack.client.d.ts +3 -3
  31. package/build/configs/rspack.client.dev.js +2 -2
  32. package/build/configs/rspack.client.js +15 -15
  33. package/build/configs/rspack.client.prod.d.ts +1 -1
  34. package/build/configs/rspack.client.prod.js +3 -3
  35. package/build/configs/rspack.server.dev.d.ts +1 -1
  36. package/build/configs/rspack.server.dev.js +2 -2
  37. package/build/configs/rspack.server.prod.d.ts +1 -1
  38. package/build/configs/rspack.server.prod.js +2 -2
  39. package/build/configs/util/apply-overrides.d.ts +4 -34
  40. package/build/configs/util/apply-overrides.js +2 -38
  41. package/build/configs/util/find-plugin.d.ts +1 -1
  42. package/build/configs/util/find-plugin.js +1 -1
  43. package/build/index.d.ts +1 -1
  44. package/build/index.js +1 -2
  45. package/docs/cli.md +2 -0
  46. package/docs/commands.md +5 -0
  47. package/docs/overrides.md +25 -25
  48. package/docs/settings.md +37 -2
  49. package/package.json +7 -5
  50. package/tsconfig-local.tsbuildinfo +1 -1
  51. package/build/configs/util/get-webpack-cache-dependencies.d.ts +0 -1
  52. package/build/configs/util/get-webpack-cache-dependencies.js +0 -15
package/docs/overrides.md CHANGED
@@ -1,7 +1,7 @@
1
1
  Тонкая настройка
2
2
  ===
3
3
 
4
- Если вам не хватает гибкости при использовании `arui-scripts`, например вы хотите добавить свой плагин для вебпака -
4
+ Если вам не хватает гибкости при использовании `arui-scripts`, например вы хотите добавить свой плагин для rspack -
5
5
  вы можете воспользоваться механизмом `overrides`.
6
6
 
7
7
  Для этого вам необходимо создать в корне вашего проекта файл `arui-scripts.overrides.js` или `arui-scripts.overrides.ts`, из которого вы сможете управлять
@@ -16,7 +16,7 @@
16
16
  ```javascript
17
17
  const path = require('path');
18
18
  module.exports = {
19
- webpack: (config, applicationConfig) => {
19
+ rspack: (config, applicationConfig) => {
20
20
  config.resolve.alias = {
21
21
  components: path.resolve(__dirname, 'src/components')
22
22
  };
@@ -31,7 +31,7 @@ import type { OverrideFile } from 'arui-scripts';
31
31
  import path from 'path';
32
32
 
33
33
  const overrides: OverrideFile = {
34
- webpack: (config, applicationConfig) => {
34
+ rspack: (config, applicationConfig) => {
35
35
  config.resolve.alias = {
36
36
  components: path.resolve(__dirname, 'src/components')
37
37
  };
@@ -44,7 +44,7 @@ export default overrides;
44
44
 
45
45
  **В случае, если у вас на проекте лежит и ts, и js файл с overrides, использоваться будет js версия.**
46
46
 
47
- С помощью этой конфигурации ко всем настройкам вебпака будет добавлен `alias` *components*.
47
+ С помощью этой конфигурации ко всем настройкам rspack будет добавлен `alias` *components*.
48
48
 
49
49
  На данный момент можно переопределять следующие конфигурации:
50
50
  - `babel-client` - конфигурация `babel` для клиентского кода. Ключи: `babel`, `babelClient`.
@@ -52,14 +52,14 @@ export default overrides;
52
52
  - `dev-server` - конфигурация `webpack-dev-server`. Ключи: `devServer`.
53
53
  - `postcss` - конфигурация плагинов для [`postcss`](https://github.com/postcss/postcss#webpack). Ключи: `postcss`.
54
54
  - `stats-options` - конфигурация для [webpack-stats](https://webpack.js.org/configuration/stats/). Ключи: `stats`.
55
- - `webpack.client.dev` - конфигурация для клиентского webpack в dev режиме.
56
- Ключи: `webpack`, `webpackClient`, `webpackDev`, `webpackClientDev`.
57
- - `webpack.client.prod` - конфигурация для клиентского webpack в prod режиме.
58
- Ключи: `webpack`, `webpackClient`, `webpackProd`, `webpackClientProd`.
59
- - `webpack.server.dev` - конфигурация для серверного webpack в dev режиме.
60
- Ключи: `webpack`, `webpackServer`, `webpackDev`, `webpackServerDev`.
61
- - `webpack.server.prod` - конфигурация для серверного webpack в prod режиме.
62
- Ключи: `webpack`, `webpackServer`, `webpackProd`, `webpackServerProd`.
55
+ - `rspack.client.dev` - конфигурация для клиентского rspack в dev режиме.
56
+ Ключи: `rspack`, `rspackClient`, `rspackDev`, `rspackClientDev`.
57
+ - `rspack.client.prod` - конфигурация для клиентского rspack в prod режиме.
58
+ Ключи: `rspack`, `rspackClient`, `rspackProd`, `rspackClientProd`.
59
+ - `rspack.server.dev` - конфигурация для серверного rspack в dev режиме.
60
+ Ключи: `rspack`, `rspackServer`, `rspackDev`, `rspackServerDev`.
61
+ - `rspack.server.prod` - конфигурация для серверного rspack в prod режиме.
62
+ Ключи: `rspack`, `rspackServer`, `rspackProd`, `rspackServerProd`.
63
63
  - `supporting-browsers` - список поддерживаемых браузеров в формате [browserslist](https://github.com/browserslist/browserslist).
64
64
  Альтернативно вы можете использовать любые методы передачи списка браузеров, поддерживаемые пакетом browserslist.
65
65
  Ключи: `browsers`, `supportingBrowsers`
@@ -89,18 +89,18 @@ export default overrides;
89
89
  > ([таблица соответствия](../../arui-scripts-artifacts/docs/migration.md)).
90
90
  > Команды сборки предупреждают о таких оверрайдах в консоли.
91
91
 
92
- ### Создание дополнительных конфигураций для webpack
93
- На некоторых проектах может потребоваться создать дополнительные конфигурации для webpack. Например, для создания
94
- service worker'а (или любых других кейсов). Для этого можно использовать функцию-хелпер `createSingleWebpackConfig`:
92
+ ### Создание дополнительных конфигураций для rspack
93
+ На некоторых проектах может потребоваться создать дополнительные конфигурации для rspack. Например, для создания
94
+ service worker'а (или любых других кейсов). Для этого можно использовать функцию-хелпер `createSingleClientRspackConfig`:
95
95
 
96
96
  ```ts
97
97
  import type { OverrideFile } from 'arui-scripts';
98
98
 
99
99
  const overrides: OverrideFile = {
100
- webpackClient: (config, appConfig, { createSingleClientWebpackConfig }) => {
100
+ rspackClient: (config, appConfig, { createSingleClientRspackConfig }) => {
101
101
  return [
102
102
  config,
103
- createSingleClientWebpackConfig(
103
+ createSingleClientRspackConfig(
104
104
  './src/sw.js', // entrypoint, может быть массивом/объектом
105
105
  'sw', // наименование сборки, влияет на имена чанков
106
106
  ),
@@ -110,18 +110,18 @@ const overrides: OverrideFile = {
110
110
 
111
111
  export default overrides;
112
112
  ```
113
- Эта функция вернет независимую конфигурацию для webpack, которую можно использовать в качестве оверрайда. Вы так же можете ее модифицировать,
113
+ Эта функция вернет независимую конфигурацию для rspack, которую можно использовать в качестве оверрайда. Вы так же можете ее модифицировать,
114
114
  не боясь что это повлияет на другие конфигурации.
115
115
 
116
116
  Созданная таким образом конфигурация будет шарить с оригинальной конфигурацией только плагин для формирования assets-manifest'а.
117
117
 
118
- ### Переопределение плагинов или загрузчиков для конфигураций webpack
119
- Иногда может понадобиться возможность поменять конфигурацию конкретного загрузчика или плагина, для этого в `webpackClient`, `webpackClientDev`, `webpackServer` и `webpackServerDev` третьим параметром можно получить хелпер-функции `findLoader` и `findPlugin`:
118
+ ### Переопределение плагинов или загрузчиков для конфигураций rspack
119
+ Иногда может понадобиться возможность поменять конфигурацию конкретного загрузчика или плагина, для этого в `rspackClient`, `rspackClientDev`, `rspackServer` и `rspackServerDev` третьим параметром можно получить хелпер-функции `findLoader` и `findPlugin`:
120
120
  ```ts
121
121
  import type { OverrideFile } from 'arui-scripts';
122
122
 
123
123
  const overrides: OverrideFile = {
124
- webpackClient: (config, appConfig, { findLoader, findPlugin }) => {
124
+ rspackClient: (config, appConfig, { findLoader, findPlugin }) => {
125
125
  // ...
126
126
  }
127
127
  };
@@ -133,7 +133,7 @@ export default overrides;
133
133
  import type { OverrideFile } from 'arui-scripts';
134
134
 
135
135
  const overrides: OverrideFile = {
136
- webpackClient: (config, appConfig, { findLoader }) => {
136
+ rspackClient: (config, appConfig, { findLoader }) => {
137
137
  const cssModulesLoader = findLoader(config, '/\\.module\\.css$/')
138
138
  const currentCssLoader = cssModulesLoader.use.find((cssLoader) => {
139
139
  return cssLoader.loader.includes('css-loader') && !cssLoader.loader.includes('postcss-loader')
@@ -149,12 +149,12 @@ const overrides: OverrideFile = {
149
149
 
150
150
  export default overrides
151
151
  ```
152
- - `findPlugin` - помогает найти плагин для переопределения. Функция так же возвращает ссылку. В качестве аргументов принимает `config` и название плагина. Все типизировано, поэтому название можете достать из автокомплита. для `webpackClient` и `webpackClientDev` из автокомплита будут приходить клиентские плагины, а для `webpackServer` и `webpackServerDev` серверные. Примеры:
152
+ - `findPlugin` - помогает найти плагин для переопределения. Функция так же возвращает ссылку. В качестве аргументов принимает `config` и название плагина. Все типизировано, поэтому название можете достать из автокомплита. для `rspackClient` и `rspackClientDev` из автокомплита будут приходить клиентские плагины, а для `rspackServer` и `rspackServerDev` серверные. Примеры:
153
153
  ```ts
154
154
  import type { OverrideFile } from 'arui-scripts';
155
155
 
156
156
  const overrides: OverrideFile = {
157
- webpackClient: (config, appConfig, { findPlugin }) => {
157
+ rspackClient: (config, appConfig, { findPlugin }) => {
158
158
  const [MiniCssExtractPlugin] = findPlugin(config, 'MiniCssExtractPlugin')
159
159
 
160
160
  // возвращаемые плагины так же типизированы
@@ -162,7 +162,7 @@ const overrides: OverrideFile = {
162
162
 
163
163
  return config
164
164
  },
165
- webpackServerDev: (config, appConfig, { findPlugin }) => {
165
+ rspackServerDev: (config, appConfig, { findPlugin }) => {
166
166
  const [BannerPlugin] = findPlugin(config, 'BannerPlugin');
167
167
 
168
168
  BannerPlugin.options.banner = 'unexpected error';
package/docs/settings.md CHANGED
@@ -314,8 +314,8 @@ module.exports = {
314
314
  Добавлять ли инструменты для сборки coverage при сборке. По умолчанию определяется по env переменным - будет выставлено в `true` если `NODE_ENV = 'cypress'` или `USE_ISTANBUL = 'enabled'`.
315
315
  Сбор coverage не будет работать при использовании `codeLoader=tsc`.
316
316
 
317
- #### disableDevWebpackTypecheck
318
- Выключает проверку типов вебпаком во время разработки. По умолчанию `true`.
317
+ #### disableDevRspackTypecheck
318
+ Выключает проверку типов rspack во время разработки. По умолчанию `true`.
319
319
  Вместо этого будет запускаться отдельный процесс `tsc`, который будет выдавать сообщения об ошибках в типах только в консоль.
320
320
 
321
321
  #### nodeExternals
@@ -323,6 +323,40 @@ module.exports = {
323
323
 
324
324
  `allowlist` настраивается через систему [оверайдов](overrides.md), свойство `serverExternalsExemptions`
325
325
 
326
+ #### buildSizeBudgets
327
+
328
+ Позволяет заметить рост начального JS и CSS при production сборке.
329
+ По умолчанию проверка выключена. Чтобы включить ее, задайте лимиты в байтах в `arui-scripts.config.ts`:
330
+
331
+ ```ts
332
+ import type { PackageSettings } from 'arui-scripts';
333
+
334
+ const settings: PackageSettings = {
335
+ buildSizeBudgets: {
336
+ js: { raw: 1_536_000, gzip: 409_600 },
337
+ css: { gzip: 51_200 },
338
+ },
339
+ };
340
+
341
+ export default settings;
342
+ ```
343
+
344
+ Здесь лимит JS — 1500 КиБ без сжатия и 400 КиБ gzip, CSS — 50 КиБ gzip.
345
+ Можно задать только нужные значения. Числа должны быть целыми и неотрицательными.
346
+
347
+ `raw` — суммарный размер файлов без сжатия. Для `gzip` берeтся размер готового `.gz` файла, если сжатие включено и файл был собран; иначе файл сжимается в памяти с уровнем 9. В обоих случаях размеры файлов складываются. Поэтому при включeнном сжатии лимит gzip совпадает с числом из таблицы `Assets sizes` выше, а без него может отличаться от сжатия на вашем сервере. Gzip вычисляется только при заданном gzip лимите, а общие файлы измеряются один раз на клиентскую сборку.
348
+
349
+ При превышении после таблицы размеров печатается красный блок `BUILD SIZE BUDGET EXCEEDED` и строки превышения, например:
350
+
351
+ ```text
352
+ [buildSizeBudgets] main/main: initial JS (gzip) is 450 KB; limit 400 KB; exceeded by 50 KB.
353
+ ```
354
+
355
+ Первые два имени — имя клиентской сборки и еe точки входа. Превышение **завершает сборку с ненулевым кодом**. Если прочитать файл для измерения не удалось, выводится отдельное сообщение и сборка тоже падает. Ошибки в самих настройках лимитов, как и ошибки компиляции, остаются ошибками.
356
+
357
+ Проверка выполняется после успешной клиентской production сборки.
358
+ В `start`, `start:prod` и при упаковке уже готовой сборки через `docker-build:compiled` она не запускается.
359
+
326
360
  ### Обработка изображений
327
361
  #### dataUrlMaxSize
328
362
  Ресурсы, не превышающие данный размер (в байтах), будут включены в исходники `inline`, иначе вынесены в отдельный файл. По умолчанию `1536`.
@@ -363,3 +397,4 @@ module.exports = {
363
397
  #### disableModulesSupport
364
398
  Полностью выключает любые манипуляции с WMF плагином. По умолчанию `false`.
365
399
  Нужно для проектов, которые хотят реализовывать модули самостоятельно, чтобы избежать конфликтов в конфигурации плагинов.
400
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "arui-scripts",
3
- "version": "23.9.3",
3
+ "version": "25.0.0",
4
4
  "main": "./build/index.js",
5
5
  "typings": "./build/index.d.ts",
6
6
  "exports": {
@@ -8,7 +8,8 @@
8
8
  "./vitest": "./build/configs/vitest/config.js",
9
9
  "./jest-preset": "./jest-preset.js",
10
10
  "./jest-preset.js": "./jest-preset.js",
11
- "./tsconfig.json": "./tsconfig.json"
11
+ "./tsconfig.json": "./tsconfig.json",
12
+ "./build/configs/modules": "./build/configs/modules.js"
12
13
  },
13
14
  "license": "MPL-2.0",
14
15
  "repository": {
@@ -123,8 +124,9 @@
123
124
  "ts-jest": "29.1.0",
124
125
  "ts-loader": "9.4.4",
125
126
  "ts-node": "10.9.2",
127
+ "vite": "^8.3.1",
126
128
  "vite-tsconfig-paths": "^6.1.1",
127
- "vitest": "^4.1.11",
129
+ "vitest": "^5.0.2",
128
130
  "webpack-bundle-analyzer": "4.10.2",
129
131
  "webpack-deduplication-plugin": "^0.0.8",
130
132
  "webpack-node-externals": "3.0.0"
@@ -136,7 +138,7 @@
136
138
  "@types/fs-extra": "^9.0.13",
137
139
  "@types/jest": "^29.5.14",
138
140
  "@types/lodash.merge": "^4.6.7",
139
- "@types/node": "^20.19.0",
141
+ "@types/node": "^22.12.0",
140
142
  "@types/postcss-media-query-parser": "0.2.4",
141
143
  "@types/semver": "^7.5.0",
142
144
  "@types/serialize-javascript": "^5.0.4",
@@ -149,7 +151,7 @@
149
151
  "typescript": "6.0.2"
150
152
  },
151
153
  "engines": {
152
- "node": "^20.19.0 || >=22.12.0"
154
+ "node": "^22.12.0 || ^24.0.0 || >=26.0.0"
153
155
  },
154
156
  "scripts": {
155
157
  "build": "sh bin/build.sh",