docs: README — как пользоваться mise #53
@@ -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 # все модули + тесты
|
||||
|
||||
Reference in New Issue
Block a user