From 5d8455e8259152ee439b154e7cf995f7e88797cb Mon Sep 17 00:00:00 2001 From: Pjandro Date: Sun, 25 Oct 2026 21:29:57 +0000 Subject: [PATCH] =?UTF-8?q?docs:=20README=20=E2=80=94=20=D1=81=D0=B5=D0=BA?= =?UTF-8?q?=D1=86=D0=B8=D1=8F=20=D0=BF=D1=80=D0=BE=20project-local=20mise?= =?UTF-8?q?=20(bootstrap,=20=D0=BE=D0=B1=D1=91=D1=80=D1=82=D0=BA=D0=B8,=20?= =?UTF-8?q?=D0=B7=D0=B0=D0=B4=D0=B0=D1=87=D0=B8)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 46 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 45 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fceafdc..f37be19 100644 --- a/README.md +++ b/README.md @@ -34,9 +34,53 @@ java-word-pdf/ | `ru.pjandro.wordpdf.internal.DocxOnOffNormalizer` | нормализация `w:val="off"/"on"` перед загрузкой | | `ru.pjandro.wordpdf.internal.FopFallbackFonts` | декларация fallback-семейства в FOP-конфиге | +## Инструменты проекта (mise) + +Java, Maven, Node и Python для разработки ставит project-local mise: сам бинарь — +в `./.mise/bin` (gitignored), кеш инструментов — в user-директории mise, в систему +ничего не устанавливается. Версии зафиксированы в корневом `mise.toml` +(temurin-17, maven 3.9.16, node 24, python 3.15). + +Первая настройка — скачивает mise, ставит инструменты и делает `npm ci` SPA: + +```bash +sh bootstrap.sh # Linux / macOS +``` + +```powershell +powershell -ExecutionPolicy Bypass -File .\bootstrap.ps1 # Windows +``` + +Дальше команды — через обёртку `./mise.sh` (Linux/macOS) или `.\mise.ps1` (Windows): + +```bash +./mise.sh run verify # полный гейт перед push: тесты + PMD + JaCoCo +./mise.sh exec -- mvn -v # любая команда с инструментами проекта в PATH +./mise.sh tasks # список задач с описаниями +``` + +Задачи проекта (`./mise.sh run <задача>`): + +|Задача|Содержание| +|---|---| +|`verify`|`mvn clean verify` — тесты + PMD + JaCoCo| +|`app-package`|исполняемый jar бэкенда| +|`app-run`|бэкенд на :8080, ключ выключен (после `app-package`)| +|`web-install`|`npm ci` в `wordpdf-web`| +|`web-build`|гейт SPA: `tsc -b && vite build`| +|`web-lint`|oxlint| +|`web-dev`|SPA на :5173, vite-proxy на :8080| +|`prod-tests`|прод-автотесты; обязателен `WORDPDF_BASE_URL`, факультативно `WORDPDF_API_KEY`| + +Альтернатива обёртке — активировать mise в шелле и работать напрямую +(`mvn`, `npm`, `python`): `eval "$(./.mise/bin/mise activate bash)"`. + ## Сборка -Требуется **Java 17** и **Maven** (бэкенд), **Node.js ≥ 20.19** (веб-интерфейс). +Требуется **Java 17** и **Maven** (бэкенд), **Node.js ≥ 20.19** (веб-интерфейс) — всё +это ставит project-local mise (см. «Инструменты проекта (mise)» выше). Команды ниже +запускайте через `./mise.sh exec -- …` (Windows: `.\mise.ps1 exec -- …`) либо после +активации mise в шелле. ```bash mvn clean verify # все модули + тесты -- 2.56.1