arui-scripts 0.0.0-client-only-envs-20250408153713

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 (222) hide show
  1. package/.browserslistrc +5 -0
  2. package/.eslintignore +2 -0
  3. package/.eslintrc.js +17 -0
  4. package/.turbo/turbo-build.log +0 -0
  5. package/.turbo/turbo-test.log +23 -0
  6. package/CHANGELOG.md +1571 -0
  7. package/README.md +47 -0
  8. package/bin/build.sh +2 -0
  9. package/build/bin/index.d.ts +3 -0
  10. package/build/bin/index.js +29 -0
  11. package/build/commands/archive-build/index.d.ts +1 -0
  12. package/build/commands/archive-build/index.js +80 -0
  13. package/build/commands/build/build-wrapper.d.ts +8 -0
  14. package/build/commands/build/build-wrapper.js +42 -0
  15. package/build/commands/build/client.d.ts +1 -0
  16. package/build/commands/build/client.js +41 -0
  17. package/build/commands/build/index.d.ts +1 -0
  18. package/build/commands/build/index.js +15 -0
  19. package/build/commands/build/server.d.ts +1 -0
  20. package/build/commands/build/server.js +29 -0
  21. package/build/commands/bundle-analyze/index.d.ts +1 -0
  22. package/build/commands/bundle-analyze/index.js +40 -0
  23. package/build/commands/changelog/index.d.ts +5 -0
  24. package/build/commands/changelog/index.js +113 -0
  25. package/build/commands/docker-build/index.d.ts +1 -0
  26. package/build/commands/docker-build/index.js +73 -0
  27. package/build/commands/docker-build-compiled/index.d.ts +1 -0
  28. package/build/commands/docker-build-compiled/index.js +54 -0
  29. package/build/commands/ensure-yarn/index.d.ts +0 -0
  30. package/build/commands/ensure-yarn/index.js +8 -0
  31. package/build/commands/start/client.d.ts +1 -0
  32. package/build/commands/start/client.js +8 -0
  33. package/build/commands/start/index.d.ts +1 -0
  34. package/build/commands/start/index.js +17 -0
  35. package/build/commands/start/print-compiler-output.d.ts +1 -0
  36. package/build/commands/start/print-compiler-output.js +16 -0
  37. package/build/commands/start/server.d.ts +1 -0
  38. package/build/commands/start/server.js +8 -0
  39. package/build/commands/start-prod/client.d.ts +1 -0
  40. package/build/commands/start-prod/client.js +8 -0
  41. package/build/commands/start-prod/index.d.ts +1 -0
  42. package/build/commands/start-prod/index.js +17 -0
  43. package/build/commands/start-prod/server.d.ts +1 -0
  44. package/build/commands/start-prod/server.js +8 -0
  45. package/build/commands/test/get-config.d.ts +1 -0
  46. package/build/commands/test/get-config.js +104 -0
  47. package/build/commands/test/index.d.ts +1 -0
  48. package/build/commands/test/index.js +60 -0
  49. package/build/commands/util/client-assets-sizes.d.ts +26 -0
  50. package/build/commands/util/client-assets-sizes.js +82 -0
  51. package/build/commands/util/docker-build.d.ts +23 -0
  52. package/build/commands/util/docker-build.js +127 -0
  53. package/build/commands/util/exec.d.ts +2 -0
  54. package/build/commands/util/exec.js +20 -0
  55. package/build/commands/util/format-webpack-messages.d.ts +11 -0
  56. package/build/commands/util/format-webpack-messages.js +95 -0
  57. package/build/commands/util/make-tmp-dir.d.ts +6 -0
  58. package/build/commands/util/make-tmp-dir.js +29 -0
  59. package/build/commands/util/run-client-dev-server.d.ts +2 -0
  60. package/build/commands/util/run-client-dev-server.js +46 -0
  61. package/build/commands/util/run-compilers.d.ts +1 -0
  62. package/build/commands/util/run-compilers.js +37 -0
  63. package/build/commands/util/run-server-watch-compiler.d.ts +2 -0
  64. package/build/commands/util/run-server-watch-compiler.js +19 -0
  65. package/build/commands/util/tsc.d.ts +1 -0
  66. package/build/commands/util/tsc.js +13 -0
  67. package/build/commands/util/yarn.d.ts +5 -0
  68. package/build/commands/util/yarn.js +55 -0
  69. package/build/configs/app-configs/calculate-dependent-config.d.ts +9 -0
  70. package/build/configs/app-configs/calculate-dependent-config.js +38 -0
  71. package/build/configs/app-configs/get-defaults.d.ts +5 -0
  72. package/build/configs/app-configs/get-defaults.js +139 -0
  73. package/build/configs/app-configs/index.d.ts +6 -0
  74. package/build/configs/app-configs/index.js +24 -0
  75. package/build/configs/app-configs/read-config-file.d.ts +2 -0
  76. package/build/configs/app-configs/read-config-file.js +28 -0
  77. package/build/configs/app-configs/types.d.ts +126 -0
  78. package/build/configs/app-configs/types.js +2 -0
  79. package/build/configs/app-configs/update-with-config-file.d.ts +2 -0
  80. package/build/configs/app-configs/update-with-config-file.js +17 -0
  81. package/build/configs/app-configs/update-with-env.d.ts +2 -0
  82. package/build/configs/app-configs/update-with-env.js +23 -0
  83. package/build/configs/app-configs/update-with-package.d.ts +2 -0
  84. package/build/configs/app-configs/update-with-package.js +13 -0
  85. package/build/configs/app-configs/update-with-presets.d.ts +3 -0
  86. package/build/configs/app-configs/update-with-presets.js +41 -0
  87. package/build/configs/app-configs/validate-settings-keys.d.ts +4 -0
  88. package/build/configs/app-configs/validate-settings-keys.js +13 -0
  89. package/build/configs/app-configs/warn-about-deprecations.d.ts +2 -0
  90. package/build/configs/app-configs/warn-about-deprecations.js +20 -0
  91. package/build/configs/babel-client.d.ts +32 -0
  92. package/build/configs/babel-client.js +72 -0
  93. package/build/configs/babel-dependencies.d.ts +14 -0
  94. package/build/configs/babel-dependencies.js +39 -0
  95. package/build/configs/babel-server.d.ts +27 -0
  96. package/build/configs/babel-server.js +48 -0
  97. package/build/configs/client-env-config/add-env-to-html-template.d.ts +1 -0
  98. package/build/configs/client-env-config/add-env-to-html-template.js +7 -0
  99. package/build/configs/client-env-config/client-config-plugin.d.ts +5 -0
  100. package/build/configs/client-env-config/client-config-plugin.js +26 -0
  101. package/build/configs/client-env-config/constants.d.ts +1 -0
  102. package/build/configs/client-env-config/constants.js +4 -0
  103. package/build/configs/client-env-config/get-env-config.d.ts +2 -0
  104. package/build/configs/client-env-config/get-env-config.js +28 -0
  105. package/build/configs/client-env-config/index.d.ts +3 -0
  106. package/build/configs/client-env-config/index.js +9 -0
  107. package/build/configs/config-extras/minimizers/imagemin/imagemin.d.ts +28 -0
  108. package/build/configs/config-extras/minimizers/imagemin/imagemin.js +65 -0
  109. package/build/configs/config-extras/minimizers/imagemin/index.d.ts +1 -0
  110. package/build/configs/config-extras/minimizers/imagemin/index.js +17 -0
  111. package/build/configs/config-extras/minimizers/index.d.ts +1 -0
  112. package/build/configs/config-extras/minimizers/index.js +17 -0
  113. package/build/configs/dev-server.d.ts +2 -0
  114. package/build/configs/dev-server.js +73 -0
  115. package/build/configs/jest/babel-transform.d.ts +2 -0
  116. package/build/configs/jest/babel-transform.js +6 -0
  117. package/build/configs/jest/css-mock.d.ts +1 -0
  118. package/build/configs/jest/css-mock.js +2 -0
  119. package/build/configs/jest/file-transform.d.ts +3 -0
  120. package/build/configs/jest/file-transform.js +11 -0
  121. package/build/configs/jest/settings.d.ts +21 -0
  122. package/build/configs/jest/settings.js +58 -0
  123. package/build/configs/modules.d.ts +16 -0
  124. package/build/configs/modules.js +149 -0
  125. package/build/configs/mq.css +22 -0
  126. package/build/configs/postcss.config.d.ts +36 -0
  127. package/build/configs/postcss.config.js +71 -0
  128. package/build/configs/postcss.d.ts +2 -0
  129. package/build/configs/postcss.js +11 -0
  130. package/build/configs/process-assets-plugin-output.d.ts +2 -0
  131. package/build/configs/process-assets-plugin-output.js +45 -0
  132. package/build/configs/server-externals-exemptions.d.ts +1 -0
  133. package/build/configs/server-externals-exemptions.js +21 -0
  134. package/build/configs/stats-options.d.ts +3 -0
  135. package/build/configs/stats-options.js +49 -0
  136. package/build/configs/supporting-browsers.d.ts +2 -0
  137. package/build/configs/supporting-browsers.js +8 -0
  138. package/build/configs/swc.d.ts +4 -0
  139. package/build/configs/swc.js +35 -0
  140. package/build/configs/util/apply-overrides.d.ts +76 -0
  141. package/build/configs/util/apply-overrides.js +52 -0
  142. package/build/configs/util/check-node-version.d.ts +2 -0
  143. package/build/configs/util/check-node-version.js +7 -0
  144. package/build/configs/util/find-loader.d.ts +2 -0
  145. package/build/configs/util/find-loader.js +24 -0
  146. package/build/configs/util/find-plugin.d.ts +85 -0
  147. package/build/configs/util/find-plugin.js +22 -0
  148. package/build/configs/util/get-entry.d.ts +9 -0
  149. package/build/configs/util/get-entry.js +22 -0
  150. package/build/configs/util/get-polyfills.d.ts +2 -0
  151. package/build/configs/util/get-polyfills.js +26 -0
  152. package/build/configs/util/get-webpack-cache-dependencies.d.ts +1 -0
  153. package/build/configs/util/get-webpack-cache-dependencies.js +18 -0
  154. package/build/configs/util/install-sourcemap-support.d.ts +1 -0
  155. package/build/configs/util/install-sourcemap-support.js +11 -0
  156. package/build/configs/util/node-assets-ignore.d.ts +0 -0
  157. package/build/configs/util/node-assets-ignore.js +33 -0
  158. package/build/configs/util/noop.d.ts +1 -0
  159. package/build/configs/util/noop.js +2 -0
  160. package/build/configs/util/register-ts-node.d.ts +0 -0
  161. package/build/configs/util/register-ts-node.js +18 -0
  162. package/build/configs/util/resolve.d.ts +12 -0
  163. package/build/configs/util/resolve.js +29 -0
  164. package/build/configs/webpack.client.d.ts +10 -0
  165. package/build/configs/webpack.client.dev.d.ts +2 -0
  166. package/build/configs/webpack.client.dev.js +15 -0
  167. package/build/configs/webpack.client.js +475 -0
  168. package/build/configs/webpack.client.prod.d.ts +2 -0
  169. package/build/configs/webpack.client.prod.js +15 -0
  170. package/build/configs/webpack.server.d.ts +2 -0
  171. package/build/configs/webpack.server.dev.d.ts +2 -0
  172. package/build/configs/webpack.server.dev.js +11 -0
  173. package/build/configs/webpack.server.js +256 -0
  174. package/build/configs/webpack.server.prod.d.ts +2 -0
  175. package/build/configs/webpack.server.prod.js +11 -0
  176. package/build/index.d.ts +5 -0
  177. package/build/index.js +9 -0
  178. package/build/plugins/arui-runtime/arui-runtime-module.d.ts +7 -0
  179. package/build/plugins/arui-runtime/arui-runtime-module.js +20 -0
  180. package/build/plugins/arui-runtime/index.d.ts +11 -0
  181. package/build/plugins/arui-runtime/index.js +47 -0
  182. package/build/plugins/postcss-global-variables/postcss-global-variables.d.ts +6 -0
  183. package/build/plugins/postcss-global-variables/postcss-global-variables.js +38 -0
  184. package/build/plugins/postcss-global-variables/utils/utils.d.ts +7 -0
  185. package/build/plugins/postcss-global-variables/utils/utils.js +91 -0
  186. package/build/plugins/postcss-prefix-selector.d.ts +6 -0
  187. package/build/plugins/postcss-prefix-selector.js +62 -0
  188. package/build/plugins/reload-server-plugin.d.ts +10 -0
  189. package/build/plugins/reload-server-plugin.js +44 -0
  190. package/build/plugins/turn-off-split-remote-entry.d.ts +11 -0
  191. package/build/plugins/turn-off-split-remote-entry.js +71 -0
  192. package/build/plugins/watch-missing-node-modules-plugin.d.ts +6 -0
  193. package/build/plugins/watch-missing-node-modules-plugin.js +20 -0
  194. package/build/templates/base-nginx.conf.template.d.ts +2 -0
  195. package/build/templates/base-nginx.conf.template.js +61 -0
  196. package/build/templates/dockerfile-compiled.template.d.ts +2 -0
  197. package/build/templates/dockerfile-compiled.template.js +52 -0
  198. package/build/templates/dockerfile.template.d.ts +2 -0
  199. package/build/templates/dockerfile.template.js +41 -0
  200. package/build/templates/html.template.d.ts +1 -0
  201. package/build/templates/html.template.js +25 -0
  202. package/build/templates/nginx.conf.template.d.ts +2 -0
  203. package/build/templates/nginx.conf.template.js +39 -0
  204. package/build/templates/start.template.d.ts +2 -0
  205. package/build/templates/start.template.js +69 -0
  206. package/build/tsconfig-local.tsbuildinfo +1 -0
  207. package/docs/artifact.md +58 -0
  208. package/docs/caveats.md +41 -0
  209. package/docs/client-only.md +77 -0
  210. package/docs/commands.md +125 -0
  211. package/docs/compilers.md +18 -0
  212. package/docs/examples.md +100 -0
  213. package/docs/modules.md +780 -0
  214. package/docs/overrides.md +167 -0
  215. package/docs/presets.md +65 -0
  216. package/docs/settings.md +287 -0
  217. package/jest-preset.js +5 -0
  218. package/package.json +180 -0
  219. package/stylelint.config.js +11 -0
  220. package/tsconfig-local.json +16 -0
  221. package/tsconfig.eslint.json +5 -0
  222. package/tsconfig.json +71 -0
@@ -0,0 +1,167 @@
1
+ Тонкая настройка
2
+ ===
3
+
4
+ Если вам не хватает гибкости при использовании `arui-scripts`, например вы хотите добавить свой плагин для вебпака -
5
+ вы можете воспользоваться механизмом `overrides`.
6
+
7
+ Для этого вам необходимо создать в корне вашего проекта файл `arui-scripts.overrides.js` или `arui-scripts.overrides.ts`, из которого вы сможете управлять
8
+ конфигурацией почти всех инструментов, используемых в `arui-scripts`.
9
+
10
+ Принцип работы тут следующий. Для всех конфигураций определен набор ключей, которые они будут искать в `arui-scripts.overrides.js`,
11
+ В случае если такой ключ найден и это функция - она будет вызвана, и в качестве аргументов ей будут переданы
12
+ существующая конфигурация и полный конфиг приложения (см [AppConfig](../src/configs/app-configs/types.ts)).
13
+ Возвращать такая функция должна так же конфигурацию.
14
+
15
+ Пример `arui-scripts.overrides.js`:
16
+ ```javascript
17
+ const path = require('path');
18
+ module.exports = {
19
+ webpack: (config, applicationConfig) => {
20
+ config.resolve.alias = {
21
+ components: path.resolve(__dirname, 'src/components')
22
+ };
23
+ return config;
24
+ }
25
+ };
26
+ ```
27
+
28
+ Пример `arui-scripts.overrides.ts`:
29
+ ```ts
30
+ import type { OverrideFile } from 'arui-scripts';
31
+ import path from 'path';
32
+
33
+ const overrides: OverrideFile = {
34
+ webpack: (config, applicationConfig) => {
35
+ config.resolve.alias = {
36
+ components: path.resolve(__dirname, 'src/components')
37
+ };
38
+ return config;
39
+ }
40
+ };
41
+
42
+ export default overrides;
43
+ ```
44
+
45
+ **В случае, если у вас на проекте лежит и ts, и js файл с overrides, использоваться будет js версия.**
46
+
47
+ С помощью этой конфигурации ко всем настройкам вебпака будет добавлен `alias` *components*.
48
+
49
+ На данный момент можно переопределять следующие конфигурации:
50
+ - `babel-client` - конфигурация `babel` для клиентского кода. Ключи: `babel`, `babelClient`.
51
+ - `babel-server` - конфигурация `babel` для серверноого кода. Ключи: `babel`, `babelServer`.
52
+ - `dev-server` - конфигурация `webpack-dev-server`. Ключи: `devServer`.
53
+ - `postcss` - конфигурация плагинов для [`postcss`](https://github.com/postcss/postcss#webpack). Ключи: `postcss`.
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`.
63
+ - `supporting-browsers` - список поддерживаемых браузеров в формате [browserslist](https://github.com/browserslist/browserslist).
64
+ Ключи: `browsers`, `supportingBrowsers`
65
+ - `Dockerfile` - докерфайл, который будет использоваться для сборки контейнера.
66
+ Базовый шаблон [тут](../src/templates/dockerfile.template.ts).
67
+ [`Dockerfile` в корне проекта](#docker) имеет приоритет над overrides.
68
+ - `DockerfileCompiled` - докерфайл, который будет использоваться для сборки контейнера при использовании команды `arui-scripts docker-build:compiled`
69
+ - `nginx` - шаблон конфигурации для nginx внутри контейнера.
70
+ Базовый шаблон [тут](../src/templates/nginx.conf.template.ts).
71
+ [Файл `nginx.conf`](nginx.md) в корне имеет приоритет над оверрайдами.
72
+ - `nginxConf` - шаблон базовой конфигурации для nginx внутри контейнера
73
+ Базовый шаблон аналогичный тому, который добавлется в базовый образ [тут](../src/templates/base-nginx.conf.template.ts).
74
+ [Файл `base-nginx.conf`](base-nginx.md) в корне имеет приоритет над оверрайдами.
75
+ - `start.sh` - шаблон entrypoint докер контейнера. Базовый шаблон [тут](../src/templates/start.template.ts).
76
+ - `serverExternalsExemptions` - список модулей, которые не будут добавлены в список внешних зависимостей сервера. [Подробнее](caveats.md#node-externals).
77
+ - `html` - шаблон для htmlWebpackPlugin, будет использоваться только в режиме [`clientOnly`](./settings.md#clientonly).
78
+ - `swc-client` - конфигурация `swc` для клиентского кода. Ключи: `swc`, `swcClient`.
79
+ - `swc-server` - конфигурация `swc` для серверного кода. Ключи: `swc`, `swcServer`.
80
+ - `swc-jest` - конфигурация `swc` для тестов. Ключи: `swc`, `swcJest`.
81
+
82
+ Для некоторых конфигураций определены несколько ключей, они будут применяться в том порядке, в котором они приведены в этом файле.
83
+
84
+ ### Создание дополнительных конфигураций для webpack
85
+ На некоторых проектах может потребоваться создать дополнительные конфигурации для webpack. Например, для создания
86
+ service worker'а (или любых других кейсов). Для этого можно использовать функцию-хелпер `createSingleWebpackConfig`:
87
+
88
+ ```ts
89
+ import type { OverrideFile } from 'arui-scripts';
90
+
91
+ const overrides: OverrideFile = {
92
+ webpackClient: (config, appConfig, { createSingleClientWebpackConfig }) => {
93
+ return [
94
+ config,
95
+ createSingleClientWebpackConfig(
96
+ './src/sw.js', // entrypoint, может быть массивом/объектом
97
+ 'sw', // наименование сборки, влияет на имена чанков
98
+ ),
99
+ ];
100
+ }
101
+ };
102
+
103
+ export default overrides;
104
+ ```
105
+ Эта функция вернет независимую конфигурацию для webpack, которую можно использовать в качестве оверрайда. Вы так же можете ее модифицировать,
106
+ не боясь что это повлияет на другие конфигурации.
107
+
108
+ Созданная таким образом конфигурация будет шарить с оригинальной конфигурацией только плагин для формирования assets-manifest'а.
109
+
110
+ ### Переопределение плагинов или загрузчиков для конфигураций webpack
111
+ Иногда может понадобиться возможность поменять конфигурацию конкретного загрузчика или плагина, для этого в `webpackClient`, `webpackClientDev`, `webpackServer` и `webpackServerDev` третьим параметром можно получить хелпер-функции `findLoader` и `findPlugin`:
112
+ ```ts
113
+ import type { OverrideFile } from 'arui-scripts';
114
+
115
+ const overrides: OverrideFile = {
116
+ webpackClient: (config, appConfig, { findLoader, findPlugin }) => {
117
+ // ...
118
+ }
119
+ };
120
+
121
+ export default overrides;
122
+ ```
123
+ - `findLoader` - помогает найти загрузчик для переопределения. Функция возвращает ссылку, поэтому вы можете спокойно мутировать этот результат и обходиться без создания нового объекта через spread-оператор. В качестве аргументов принимает `config` и `testRule`, по которому будет искаться загрузчик. Пример:
124
+ ```ts
125
+ import type { OverrideFile } from 'arui-scripts';
126
+
127
+ const overrides: OverrideFile = {
128
+ webpackClient: (config, appConfig, { findLoader }) => {
129
+ const cssModulesLoader = findLoader(config, '/\\.module\\.css$/')
130
+ const currentCssLoader = cssModulesLoader.use.find((cssLoader) => {
131
+ return cssLoader.loader.includes('css-loader') && !cssLoader.loader.includes('postcss-loader')
132
+ })
133
+
134
+ currentCssLoader.options.modules = {
135
+ localIdentName: '[name]-[local]-[hash:base64:5]'
136
+ }
137
+
138
+ return config
139
+ }
140
+ };
141
+
142
+ export default overrides
143
+ ```
144
+ - `findPlugin` - помогает найти плагин для переопределения. Функция так же возвращает ссылку. В качестве аргументов принимает `config` и название плагина. Все типизировано, поэтому название можете достать из автокомплита. для `webpackClient` и `webpackClientDev` из автокомплита будут приходить клиентские плагины, а для `webpackServer` и `webpackServerDev` серверные. Примеры:
145
+ ```ts
146
+ import type { OverrideFile } from 'arui-scripts';
147
+
148
+ const overrides: OverrideFile = {
149
+ webpackClient: (config, appConfig, { findPlugin }) => {
150
+ const [MiniCssExtractPlugin] = findPlugin(config, 'MiniCssExtractPlugin')
151
+
152
+ // возвращаемые плагины так же типизированы
153
+ MiniCssExtractPlugin.options.ignoreOrder = false
154
+
155
+ return config
156
+ },
157
+ webpackServerDev: (config, appConfig, { findPlugin }) => {
158
+ const [BannerPlugin] = findPlugin(config, 'BannerPlugin');
159
+
160
+ BannerPlugin.options.banner = 'unexpected error';
161
+
162
+ return config
163
+ }
164
+ };
165
+
166
+ export default overrides
167
+ ```
@@ -0,0 +1,65 @@
1
+ Пресеты
2
+ ===
3
+
4
+ В случае, если вы хотите использовать определенный набор конфигураций и оверрайдов сразу в нескольких проектах - вам может
5
+ помочь механизм пресетов. Он позволяет выносить конфигурацию и оверрайды в отдельный пакет.
6
+ Для того, чтобы использовать пресеты на проекте, вы должны указать в настройках проекта имя пакета с пресетами:
7
+
8
+ ```json
9
+ {
10
+ "aruiScripts": {
11
+ "presets": "my-company-presets"
12
+ }
13
+ }
14
+ ```
15
+
16
+ Как пресет должен быть указан путь до папки с общими настройками (для поиска пути будет использоваться `require.resolve`
17
+ от папки, содержащей package.json. Так что это может быть как папка в проекте, так и пакет из node_modules).
18
+
19
+ Сам пакет с пресетами может содержать два файла:
20
+ - `arui-scirpts.config.js` (или `arui-scripts.config.ts`)
21
+ - `arui-scripts.overrides.js` (или `arui-scirpts.overrides.ts`)
22
+
23
+ ### arui-scripts.config (js | ts)
24
+ С помощью этого файла можно задать любые ключи [конфигурации](settings.md).
25
+ ```js
26
+ module.exports = {
27
+ baseDockerImage: 'my-company-artifactory.com/arui-scripts-base:11.2'
28
+ };
29
+ ```
30
+
31
+ Или в виде ts:
32
+ ```ts
33
+ import type { PackageSettings } from 'arui-scripts';
34
+
35
+ const settings: PackageSettings = {
36
+ baseDockerImage: 'my-company-artifactory.com/arui-scripts-base:11.2'
37
+ };
38
+
39
+ export default settings;
40
+ ```
41
+
42
+ На проекте конфигурация будет загружаться в следующем порядке:
43
+ 1. базовые настройки из arui-scripts
44
+ 2. настройки из presets
45
+ 3. настройки из package.json проекта
46
+ 4. настройки, переданные через env переменную.
47
+
48
+ **Важно!**
49
+
50
+ Если вы будете задавать относительные пути через общие конфигурации (например `serverEntry`, `additionalBuildPath` и другие),
51
+ они будут вычисляться относительно корня проекта, а не вашей конфигурации.
52
+ Вы можете использовать абсолютные пути при необходимости задать путь до файла внутри пакета с пресетами.
53
+
54
+ ### arui-scripts.overrides (js | ts)
55
+ С помощью этого файла можно задать базовые оверрайды проекта, аналогично [заданию оверрайдов на проекте](overrides.md).
56
+ ```js
57
+ module.exports = {
58
+ babelClient(config) {
59
+ config.plugins.push('my-awesome-babel-plugin');
60
+ return config;
61
+ }
62
+ };
63
+ ```
64
+
65
+ На проекте оверрайды из пресетов будут выполняться в первую очередь, после них будут выполняться оверрайды из проекта.
@@ -0,0 +1,287 @@
1
+ Настройка arui-scripts
2
+ ===
3
+
4
+ `arui-scripts` - гибкий инструмент, и зачастую вам необходимо настроить его под свои нужды.
5
+
6
+ Для этого предусмотрено несколько механизмов:
7
+
8
+ 1. [Пресеты](presets.md)
9
+ 2. Настройки в `package.json` (см. раздел [настройка через package.json](#настройка-через-packagejson))
10
+ 3. [Конфигурационный файл](#Конфигурационный-файл)
11
+ 4. [Переменные окружения](#переменные-окружения)
12
+
13
+ Если вы задаете одну и ту же настройку в разных местах, то она будет применена именно в том порядке, в котором они перечислены выше.
14
+
15
+ Предпочтительным способом настройки является использование конфигурационного файла.
16
+
17
+ ## Механизмы настройки
18
+
19
+ ### Настройка через package.json
20
+ Пример настройки через package.json:
21
+ ```json
22
+ {
23
+ "aruiScripts": {
24
+ "clientEntry": {
25
+ "mobile": "./src/mobile",
26
+ "desktop": "./src/desktop"
27
+ }
28
+ }
29
+ }
30
+ ```
31
+
32
+ ### Конфигурационный файл
33
+ Пример конфигурационного файла:
34
+
35
+ ```ts
36
+ import { PackageSettings } from 'arui-scripts';
37
+
38
+ const settings: PackageSettings = {
39
+ clientEntry: {
40
+ mobile: './src/mobile',
41
+ desktop: './src/desktop',
42
+ },
43
+ };
44
+
45
+ export default settings;
46
+
47
+ ```
48
+
49
+ ### Переменные окружения
50
+ Использование переменных окружения для настройки может быть полезным для отладки или использования в специфических сценариях на CI.
51
+
52
+ Пример настройки через переменные окружения:
53
+ ```bash
54
+ ARUI_SCRIPTS_CONFIG="{\"clientEntry\":{\"mobile\":\"./src/mobile\",\"desktop\":\"./src/desktop\"}}" yarn start
55
+ ```
56
+
57
+ ## Список настроек
58
+
59
+ ### Общие настройки
60
+ #### clientServerPort
61
+ Порт WebpackDevServer и nginx итогового контейнера. По умолчанию `8080`.
62
+
63
+ #### serverPort
64
+ Порт нодового сервера. Нужен для правильного проксирования запросов от дев сервера и nginx. По умолчанию `3000`.
65
+
66
+ #### debug
67
+ Режим отладки, в котором не выполняются некоторые нежелательные операции и выводится больше сообщений об ошибках, по умолчанию `false`.
68
+
69
+ #### devSourceMaps
70
+ Какой вид source-map использовать в режиме разработки. По умолчанию `inline-cheap-source-map`. Эта настройка может сильно влиять на время сборки.
71
+ Подробнее можно почитать [здесь](https://webpack.js.org/configuration/devtool/).
72
+
73
+ :warning: **Внимание**. При использовании любых source-map на основании eval webpack-dev-server будет
74
+ модифицировать заголовок `Content-Security-Policy` (при наличии) и добавлять в разрешенные источники для `script-src` `unsafe-eval`.
75
+
76
+ Это необходимо для того, чтобы код вообще запускался в браузере. Это не влияет на реальную безопасность приложения,
77
+ так как используется ТОЛЬКО в дев-режиме. Если по каким-то причинам вас такое поведение не устраивает - вы можете поменять
78
+ тип source-map на любой другой, не использующий eval.
79
+
80
+ #### devServerCors
81
+ Включает добавление CORS заголовков в ответы dev-сервера. По умолчанию `false`.
82
+
83
+ #### useServerHMR
84
+ Использовать ли HotModuleReplacement для сервера. По умолчанию `false`.
85
+
86
+ #### presets
87
+ Пресеты, которые будут использоваться для настройки сборки. См. [пресеты](presets.md).
88
+
89
+ #### proxy
90
+ Позволяет настроить проксирование запросов в dev-режиме. По умолчанию `[]`. Так же этот параметр можно задать в `package.json`.
91
+
92
+ В случае, если ваш фронт должен обращаться к API, отличному от вашего nodejs сервера, в **дев режиме** вы можете настроить проксирование запросов.
93
+
94
+ Например:
95
+
96
+ ```ts
97
+ import { PackageSettings } from 'arui-scripts';
98
+
99
+ const settings: PackageSettings = {
100
+ proxy: [
101
+ {
102
+ context: '/corp-shared-ui',
103
+ target: 'http://some-other-host',
104
+ headers: {
105
+ host: 'some-other-host',
106
+ },
107
+ },
108
+ ],
109
+ };
110
+
111
+ export default settings;
112
+ ```
113
+
114
+ Такая конфигурация будет проксировать запросы к `http://localhost:8080/corp-shared-ui/` на `http://some-other-host/corp-shared-ui`.
115
+ Подробнее о конфигурации прокси сервера можно почитать в [документации rspack](https://rspack.dev/guide/features/dev-server#proxy).
116
+
117
+ :warning: Эта настройка работает только в **дев режиме**.
118
+
119
+ #### clientOnly
120
+ Позволяет отключить сборку сервера, оставив только клиентскую часть. По умолчанию `false`. Подробнее можно прочитать в
121
+ [документации client-only режима](./client-only.md).
122
+
123
+
124
+ ### Настройки путей
125
+
126
+ #### buildPath
127
+ Папка, в которую будет производиться сборка. По умолчанию `.build`
128
+
129
+ #### assetsPath
130
+ Папка, в которую будут попадать статические файлы. По умолчанию `assets`.
131
+
132
+ #### additionalBuildPath
133
+ Массив путей, которые попадут в архив при использовании [команды archive-build](./commands.md#archive-build). По умолчанию `['config']`.
134
+
135
+ #### statsOutputFilename
136
+ Имя [stats-файла](https://webpack.js.org/api/stats/), которое будет использоваться в [bundle-analyze команде](./commands.md#bundle-analyze). По умолчанию `stats.json`
137
+
138
+ #### serverEntry
139
+ Точка входа для исходников сервера, по умолчанию `./src/server/index`
140
+
141
+ #### serverOutput
142
+ Имя файла для компиляции сервера, по умолчанию `server.js`
143
+
144
+ #### clientPolyfillsEntry
145
+ Точка входа для полифилов. Будет подключаться до основной точки входа. По умолчанию подтягивает полифилы из arui-feather, если он установлен.
146
+
147
+ #### clientEntry
148
+ Точка входа для клиентского приложения. По умолчанию `./src/index`.
149
+
150
+ Этот ключ принимает не только строки, но и любые возможные в [webpack варианты](https://webpack.js.org/concepts/entry-points/).
151
+ Например, вы можете создать две отдельных входных точки для мобильной и десктопной версии приложения:
152
+
153
+ ```js
154
+ const settings = {
155
+ clientEntry: {
156
+ mobile: './src/mobile',
157
+ desktop: './src/desktop',
158
+ },
159
+ };
160
+ ```
161
+
162
+ Ко всем клиентским entryPoint так же будут добавлены `clientPolyfillsEntry` (если задан)
163
+ и, в dev режиме, необходимые для hot-module-reload файлы
164
+
165
+
166
+ ### Настройки сборки артефактов
167
+
168
+ #### dockerRegistry
169
+ Адрес используемого docker registry, по умолчанию `''`, то есть используется публичный registry
170
+
171
+ #### baseDockerImage
172
+ Имя базового образа, используемого для построения docker образа. По умолчанию `'alfabankui/arui-scripts:latest'`
173
+
174
+ #### nginxRootPath
175
+ Базовый путь, до файлов в контейнере, который будет использоваться в nginx. По умолчанию `'/src'`.
176
+
177
+ #### nginx
178
+
179
+ Некоторые настройки для базовой конфигурации `nginx` (`/etc/nginx/nginx.conf`).
180
+
181
+ ```json
182
+ "aruiScripts": {
183
+ "nginx": {
184
+ "workerProcesses": 2,
185
+ "workerRlimitNoFile": 20000,
186
+ "workerConnections": 19000,
187
+ "eventsUse": "epoll",
188
+ "daemon": "off"
189
+ }
190
+ }
191
+ ```
192
+
193
+ #### runFromNonRootUser
194
+ Сборка образа под пользователем nginx. Нужна для совместимости с k8s, т.к там зачастую запрещен запуск контейнера из под root По умолчанию `true`.
195
+
196
+ #### removeDevDependenciesDuringDockerBuild
197
+ Отключает удаление devDependencies из node_modules при сборке докер образа. Используется когда вам не нужно удалять devDependencies,
198
+ т.к. в своём Dockerfile вы не переносите node_modules в докер-контейнер. По умолчанию `true`.
199
+
200
+ #### archiveName
201
+ Имя архива, который будет создан при использовании команды [archive-build](./commands.md#archive-build). По умолчанию `'build.tar'`.
202
+
203
+ ### Модификация сборки
204
+ #### keepPropTypes
205
+ Позволяет отключить удаление `prop-types` из бандла. По умолчанию `false`.
206
+
207
+ Так как в production режими proptypes не проверяются, их имеет смысл удалить из production сборки.
208
+
209
+ Сами объявления proptypes удаляются с помощью [babel-plugin-transform-react-remove-prop-types](https://www.npmjs.com/package/babel-plugin-transform-react-remove-prop-types).
210
+ Но импорты пакетов `prop-types` при этом не удаляются. Чтобы это реализовать, используется `webpack.NormalModuleReplacementPlugin`.
211
+ С помощью него заменяются на пустышку пакеты, попадающие под маску:
212
+
213
+ - `/^react-style-proptype$/`
214
+ - `/^thrift-services\/proptypes/`
215
+
216
+ #### codeLoader
217
+ Позволяет выбрать какой инструмент использовать для обработки js и ts кода приложения. По умолчанию `swc`.
218
+
219
+ Возможные значения:
220
+ - `babel` - для всего кода будет использоваться `babel-loader`;
221
+ - `tsc` - для ts кода будет использоваться `ts-loader`, для всего остального - `babel-loader`;
222
+ - `swc` - для всего кода будет использоваться `swc-loader`.
223
+
224
+ `swc` является предпочтительным режимом, дефолты не меняются для сохранения обратной совместимости.
225
+ Использование swc позволяет значительно ускорить сборку (до 2 раз на больших проектах), но не будет создавать полностью идентичный с babel код.
226
+ Итоговый бандл может получиться немного больше, чем при использовании babel, но разница полностью компенсируется при использовании сжатия.
227
+
228
+ #### installServerSourceMaps
229
+ Добавлять ли в серверную сборку пакет source-map-support. По умолчанию `false`.
230
+
231
+ #### jestCodeTransformer
232
+ Позволяет выбрать какой инструмент использовать для обработки js и ts кода приложения при запуске тестов. По умолчанию `swc`.
233
+
234
+ Возможные значения:
235
+ - `babel` - для всего кода будет использоваться `babel-jest`;
236
+ - `tsc` - для ts кода будет использоваться `ts-jest`, для всего остального - `babel-jest`;
237
+ - `swc` - для всего кода будет использоваться `@swc/jest`.
238
+ Swc более строго следует спецификациям и [не дает возможности](https://github.com/swc-project/swc/issues/5059) делать `spyOn` для экспортов из esm модулей.
239
+
240
+ #### collectCoverage
241
+ Добавлять ли инструменты для сборки coverage при сборке. По умолчанию определяется по env переменным - будет выставлено в `true` если `NODE_ENV = 'cypress'` или `USE_ISTANBUL = 'enabled'`.
242
+ Сбор coverage не будет работать при использовании `codeLoader=tsc`.
243
+
244
+ #### disableDevWebpackTypecheck
245
+ Выключает проверку типов вебпаком во время разработки. По умолчанию `true`.
246
+ Вместо этого будет запускаться отдельный процесс `tsc`, который будет выдавать сообщения об ошибках в типах только в консоль.
247
+
248
+ ### Обработка изображений
249
+ #### dataUrlMaxSize
250
+ Ресурсы, не превышающие данный размер (в байтах), будут включены в исходники `inline`, иначе вынесены в отдельный файл. По умолчанию `1536`.
251
+
252
+ #### imageMinimizer
253
+ Раздел настроек, связанных с оптимизацией графики.
254
+
255
+ :warning: **Внимание!** Если вы планируете использовать любые `imagemin`-плагины, кроме `svgo`, необходимо установить их дополнительно. <br/>
256
+ Так как после установки плагинам необходим прямой доступ в сеть для скачивания утилит (`cjpeg` и пр.), они указаны в `peerDependencies` `arui-scripts`, чтобы не приводить к ошибкам в закрытых контурах.<br/><br/>
257
+
258
+ - `imageMinimizer.svg.enabled` - включает/отключает оптимизацию `svg`. По умолчанию `true`.
259
+ - `imageMinimizer.gif.enabled` - включает/отключает оптимизацию `gif`. По умолчанию `false`.
260
+ - `imageMinimizer.gif.optimizationLevel` - уровень сжатия `gif`. От `1` до `3`. По умолчанию `1`.
261
+ - `imageMinimizer.jpg.enabled` - включает/отключает оптимизацию `jpg`. По умолчанию `false`.
262
+ - `imageMinimizer.jpg.quality` - качество выходного файла. От `0` до `100`. По умолчанию `75`.
263
+ - `imageMinimizer.png.enabled` - включает/отключает оптимизацию `png`. По умолчанию `false`. О структуре формата png и влиянии описанных далее оптимизаций можно прочитать [здесь](https://www.w3.org/TR/PNG-Chunks.html)
264
+ - `imageMinimizer.png.optimizationLevel` - уровень сжатия `png`. От `0` до `7`. По умолчанию `3`. [Подробнее](https://github.com/imagemin/imagemin-optipng#optimizationlevel)
265
+ - `imageMinimizer.png.bitDepthReduction` - допускает уменьшение глубины цвета изображения. По умолчанию `false`. [Подробнее](https://github.com/imagemin/imagemin-optipng#bitdepthreduction)
266
+ - `imageMinimizer.png.colorTypeReduction` - допускает изменение представления изображения (оттенки серого / прозрачность / пр.). По умолчанию `false`. [Подробнее](https://github.com/imagemin/imagemin-optipng#colortypereduction)
267
+ - `imageMinimizer.png.paletteReduction` - допускает уменьшение палитры изображения. По умолчанию `false`. [Подробнее](https://github.com/imagemin/imagemin-optipng#palettereduction)
268
+ - `imageMinimizer.png.interlaced` - потоковый порядок передачи изображение. По умолчанию этот параметр идентичен значению из входного изображения. [Подробнее](https://github.com/imagemin/imagemin-optipng#interlaced)
269
+
270
+ ### Обработка стилей
271
+ #### componentsTheme
272
+ Путь к css файлу с темой для [core-components](https://github.com/core-ds/core-components). По умолчанию `null`.
273
+
274
+ #### keepCssVars
275
+ Отключает postcss-custom-properties, css переменные будут оставаться в бандле. По умолчанию `false`.
276
+
277
+ ### Модули
278
+
279
+ #### modules
280
+ Позволяет настроить работу с модулями. По умолчанию `{}`. Подробнее в разделе [модули](modules.md).
281
+
282
+ #### compatModules
283
+ Позволяет настроить работу с `compat` модулями. По умолчанию `{}`. Подробнее в разделе [модули](modules.md).
284
+
285
+ #### disableModulesSupport
286
+ Полностью выключает любые манипуляции с WMF плагином. По умолчанию `false`.
287
+ Нужно для проектов, которые хотят реализовывать модули самостоятельно, чтобы избежать конфликтов в конфигурации плагинов.
package/jest-preset.js ADDED
@@ -0,0 +1,5 @@
1
+ /* eslint-disable @typescript-eslint/no-var-requires */
2
+
3
+ const settings = require('./build/configs/jest/settings');
4
+
5
+ module.exports = settings;