arui-scripts 17.0.2 → 17.1.0

package/docs/client-only.md

@@ -0,0 +1,11 @@
+## Режим clientOnly
+Если на вашем проекте не требуется иметь nodejs-сервер, то clientOnly режим работы - для вас.
+
+Он полностью отключает сборку сервера, добавляет [HtmlWebpackPlugin](https://webpack.js.org/plugins/html-webpack-plugin/) для генерации
+простой html, а так же значительно упрощает докер-контейнер, собираемый в качестве артефакта.
+
+По-умолчанию html, создаваемый скриптами будет иметь единственный div с id `react-app`. Вы модифицировать этот html
+используя [механизм оверрайдов](./overrides.md).
+
+docker-контейнер, формируемый командой [arui-scripts docker-build](./commands.md#docker-build) будет содержать
+только собранные файлы. node_modules, все что лежит в вашем `src` и других папках проекта будет игнорироваться.

package/docs/commands.md

@@ -89,6 +89,8 @@ docker run -p 8080:8080 container-name:version ./start.sh
 За счет того, что в контейнер папки node_modules не копируются, а устанавливаются только production зависимости, скорость сборки контейнера значительно увеличивается.
 В процессе сборки так же будет модифицироваться файл `.dockerignore` для того чтобы гарантировано исключить папку `node_modules` из контекста сборки докера.
 
+**⚠️ Внимание** команда не работает с `clientOnly` режимом.
+
 `arui-scripts docker-build:compiled` имеет те же опции, что и `arui-scripts docker-build`.
 Dockerfile при этом будет сгенерирован автоматически, но вы можете переопределить его используя механизм [overrides](overrides.md).
 Локальный `Dockerfile` в корне проекта в данном случае полностью игнорируется.

package/docs/overrides.md

@@ -92,6 +92,7 @@ export default overrides;
   [Файл `nginx.conf`](nginx.md) в корне имеет приоритет над оверрайдами.
 - `start.sh` - шаблон entrypoint докер контейнера. Базовый шаблон [тут](../src/templates/start.template.ts).
 - `serverExternalsExemptions` - список модулей, которые не будут добавлены в список внешних зависимостей сервера. [Подробнее](caveats.md#node-externals).
+- `html` - шаблон для htmlWebpackPlugin, будет использоваться только в режиме [`clientOnly`](./settings.md#clientonly).
 
 Для некоторых конфигураций определены несколько ключей, они будут применяться в том порядке, в котором они приведены в этом файле.
 
@@ -128,7 +129,7 @@ import type { OverrideFile } from 'arui-scripts';
 
 const overrides: OverrideFile = {
     webpackClient: (config, appConfig, { findLoader, findPlugin }) => {
-      // ...        
+      // ...
     }
 };
 

package/docs/settings.md

@@ -115,6 +115,10 @@ export default settings;
 
 :warning: Эта настройка работает только в **дев режиме**.
 
+#### clientOnly
+Позволяет отключить сборку сервера, оставив только клиентскую часть. По умолчанию `false`. Подробнее можно прочитать в
+[документации client-only режима](./client-only.md).
+
 
 ### Настройки путей
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "arui-scripts",
-    "version": "17.0.2",
+    "version": "17.1.0",
     "main": "./build/index.js",
     "typings": "./build/index.d.ts",
     "license": "MPL-2.0",
@@ -55,6 +55,7 @@
         "fork-ts-checker-webpack-plugin": "6.5.3",
         "fs-extra": "6.0.1",
         "gzip-size": "5.1.1",
+        "html-webpack-plugin": "^5.6.0",
         "image-minimizer-webpack-plugin": "^3.8.3",
         "imagemin": "^8.0.1",
         "imagemin-svgo": "^10.0.1",