Mise: project-local toolchain bootstrap (Linux + Windows) #51
@@ -38,3 +38,6 @@ DEPLOY.md
|
|||||||
# Индекс CodeGraph
|
# Индекс CodeGraph
|
||||||
.codegraph/
|
.codegraph/
|
||||||
|
|
||||||
|
# Mise: локальный бинарь mise (bootstrap.sh / bootstrap.ps1)
|
||||||
|
/.mise/
|
||||||
|
|
||||||
|
|||||||
@@ -62,12 +62,14 @@ Java2D → PNG 300 dpi (`ChartRenderer.DPI = 300`, `PADDING = 4.0`, растр
|
|||||||
|корневой `.env.example`|шаблон env для локальных/compose-стендов: `WORDPDF_API_KEY` (`openssl rand -hex 32`), закомментированные `WORDPDF_MAX_MB`/`WORDPDF_MAX_PAGES` (пустое значение ломает binding long/int); проду `.env` **не нужен**: ключ и лимиты подаёт job `deploy` из Gitea Secrets/Variables, legacy-`.env` на проде удаляется деплоем|
|
|корневой `.env.example`|шаблон env для локальных/compose-стендов: `WORDPDF_API_KEY` (`openssl rand -hex 32`), закомментированные `WORDPDF_MAX_MB`/`WORDPDF_MAX_PAGES` (пустое значение ломает binding long/int); проду `.env` **не нужен**: ключ и лимиты подаёт job `deploy` из Gitea Secrets/Variables, legacy-`.env` на проде удаляется деплоем|
|
||||||
|`.gitea/workflows/`|Gitea Actions: `pr.yml` (PR checks), `main.yml` (тесты + coverage-сводка и комментарий в PR → `images-app`/`images-web` (build+push в Nexus) → deploy (рендер прод-конфигов + pull) → autotests → rollback)|
|
|`.gitea/workflows/`|Gitea Actions: `pr.yml` (PR checks), `main.yml` (тесты + coverage-сводка и комментарий в PR → `images-app`/`images-web` (build+push в Nexus) → deploy (рендер прод-конфигов + pull) → autotests → rollback)|
|
||||||
|корневой `GITEA-vars.md`|инструкция владельца: Secrets/Variables, защита ветки, перезапуск — только имена переменных, без значений|
|
|корневой `GITEA-vars.md`|инструкция владельца: Secrets/Variables, защита ветки, перезапуск — только имена переменных, без значений|
|
||||||
|корневой `prod-autotests/`|прод-автотесты API (pytest + requests, 21 проверка): конфигурация стенда **только env** (`WORDPDF_BASE_URL` обязателен, `WORDPDF_API_KEY`/`WORDPDF_MAX_PAGES`/`WORDPDF_MAX_MB`/`WORDPDF_SAMPLES_DIR` факультативны) — прод-хостов/ключей в коде нет; окружение — mise (`mise.toml`: python 3.15 + автосоздаваемый `.venv`); прод-раннер вне git — `/home/pjandro/prod/java-word-pdf/run-prod-tests.sh`|
|
|корневой `prod-autotests/`|прод-автотесты API (pytest + requests, 21 проверка): конфигурация стенда **только env** (`WORDPDF_BASE_URL` обязателен, `WORDPDF_API_KEY`/`WORDPDF_MAX_PAGES`/`WORDPDF_MAX_MB`/`WORDPDF_SAMPLES_DIR` факультативны) — прод-хостов/ключей в коде нет; окружение — mise корневого `mise.toml` (python 3.15 + автосоздаваемый `.venv`; прод-тесты: `./mise.sh run prod-tests`); прод-раннер вне git — `/home/pjandro/prod/java-word-pdf/run-prod-tests.sh`|
|
||||||
|`docs/standards/`|нормативная документация OOXML: PDF+md ECMA-376 Part 1 (5-е изд.), md [MS-OI29500]/[MS-ODRAWXML], полные наборы XSD `schema/strict/`+`schema/transitional/` — источник истины для chart-движка и фикстур (правило — в секции «Chart-движок»); `validate-fixtures.py` — XSD-валидация `samples/*.docx` (lxml); регенерация — `docs/standards/README.md`|
|
|`docs/standards/`|нормативная документация OOXML: PDF+md ECMA-376 Part 1 (5-е изд.), md [MS-OI29500]/[MS-ODRAWXML], полные наборы XSD `schema/strict/`+`schema/transitional/` — источник истины для chart-движка и фикстур (правило — в секции «Chart-движок»); `validate-fixtures.py` — XSD-валидация `samples/*.docx` (lxml); регенерация — `docs/standards/README.md`|
|
||||||
|`develop/` (вне git, gitignored)|рабочие материалы и эталоны сравнения рендера (скриншоты `original.jpg`/`converted.jpg`) — **не фикстуры**, в тесты/jar не подключать; пиксельные замеры зашиты числами в chart-тестах|
|
|`develop/` (вне git, gitignored)|рабочие материалы и эталоны сравнения рендера (скриншоты `original.jpg`/`converted.jpg`) — **не фикстуры**, в тесты/jar не подключать; пиксельные замеры зашиты числами в chart-тестах|
|
||||||
|
|
||||||
## Development Commands
|
## Development Commands
|
||||||
|
|
||||||
|
Перед первой сборкой — бутстрап toolchain: скачивает сам mise в `./.mise/bin` (gitignored, в систему ничего не ставится) и ставит инструменты из корневого `mise.toml` — Linux/macOS `sh bootstrap.sh`, Windows `powershell -ExecutionPolicy Bypass -File .\bootstrap.ps1`. `mvn`/`npm`/`python`/`java` из команд ниже берутся из project-local mise: запуск `./mise.sh exec -- mvn clean verify` (Windows `.\mise.ps1 exec -- …`) либо активация шелла `eval "$(./.mise/bin/mise activate bash)"`; готовые задачи — `./mise.sh run verify|app-package|app-run|web-install|web-build|web-lint|web-dev|prod-tests`. Контейнерные/compose-команды не меняются.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
mvn clean verify # все модули + тесты + PMD (pmd-ruleset.xml) + гейты JaCoCo: 90% строк (оба модуля) и 85% веток (core) — обязательный гейт перед push; mvnw НЕТ — только системный Maven
|
mvn clean verify # все модули + тесты + PMD (pmd-ruleset.xml) + гейты JaCoCo: 90% строк (оба модуля) и 85% веток (core) — обязательный гейт перед push; mvnw НЕТ — только системный Maven
|
||||||
mvn -pl wordpdf-app -am package # исполняемый jar бэкенда
|
mvn -pl wordpdf-app -am package # исполняемый jar бэкенда
|
||||||
@@ -144,7 +146,7 @@ gateway). Кеш раннеров — сервер act_runner (серверна
|
|||||||
|
|
||||||
## Runtime & Tooling Preferences
|
## Runtime & Tooling Preferences
|
||||||
|
|
||||||
- Java 17 + Maven (обязательны; wrapper `mvnw` нет); UTF-8. Только Maven — никакого Gradle/Ant.
|
- Java 17 + Maven (обязательны; wrapper `mvnw` нет); UTF-8. Только Maven — никакого Gradle/Ant. Java/Maven/Node/Python для локальной разработки ставит project-local mise (бинарь в `.mise/`, вне системы; кеш инструментов — user-директория mise по умолчанию), версии пинятся в корневом `mise.toml`, ежедневный запуск — `./mise.sh` / `.\mise.ps1` (см. Development Commands).
|
||||||
- Версии зависимостей — только в корневом `pom.xml` (properties + dependencyManagement); новые зависимости — latest stable.
|
- Версии зависимостей — только в корневом `pom.xml` (properties + dependencyManagement); новые зависимости — latest stable.
|
||||||
- Фронт: Node `^20.19.0 || >=22.12.0` (engines vite/rolldown/oxlint из `package-lock.json` — в `package.json` секции `engines` нет; 21.x и 22.0–22.11 НЕ поддерживаются), npm с закоммиченным `package-lock.json` (`npm ci`); vite `^8.3`, React `^19.2`, TS `~6.0` (**`strict` нигде не включён** — `npm run build` не является strict-гейтом), Tailwind `^4.3`, oxlint `^1.81`; podman-сборка web на `node:24-alpine`.
|
- Фронт: Node `^20.19.0 || >=22.12.0` (engines vite/rolldown/oxlint из `package-lock.json` — в `package.json` секции `engines` нет; 21.x и 22.0–22.11 НЕ поддерживаются), npm с закоммиченным `package-lock.json` (`npm ci`); vite `^8.3`, React `^19.2`, TS `~6.0` (**`strict` нигде не включён** — `npm run build` не является strict-гейтом), Tailwind `^4.3`, oxlint `^1.81`; podman-сборка web на `node:24-alpine`.
|
||||||
- Контейнеры (podman/buildah): `FROM` только FQDN (`docker.io/library/...` — short-name не резолвится без `unqualified-search-registries`); buildah подмешивает хостовые прокси-переменные в `RUN`/`HEALTHCHECK` — обнулять `HTTP_PROXY= http_proxy= …` **на самой команде** (ENV не перебивает).
|
- Контейнеры (podman/buildah): `FROM` только FQDN (`docker.io/library/...` — short-name не резолвится без `unqualified-search-registries`); buildah подмешивает хостовые прокси-переменные в `RUN`/`HEALTHCHECK` — обнулять `HTTP_PROXY= http_proxy= …` **на самой команде** (ENV не перебивает).
|
||||||
|
|||||||
@@ -0,0 +1,16 @@
|
|||||||
|
# Скачивает mise в .\.mise\bin (без установки в систему) и ставит инструменты проекта.
|
||||||
|
$ErrorActionPreference = 'Stop'
|
||||||
|
$version = '2026.10.19'
|
||||||
|
$root = $PSScriptRoot
|
||||||
|
$zip = Join-Path $env:TEMP 'mise-bootstrap.zip'
|
||||||
|
$tmp = Join-Path $env:TEMP 'mise-bootstrap'
|
||||||
|
Invoke-WebRequest "https://github.com/jdx/mise/releases/download/v$version/mise-v$version-windows-x64.zip" -OutFile $zip
|
||||||
|
Remove-Item -Recurse -Force $tmp -ErrorAction SilentlyContinue
|
||||||
|
Expand-Archive -Path $zip -DestinationPath $tmp
|
||||||
|
$bin = Join-Path $root '.mise\bin'
|
||||||
|
New-Item -ItemType Directory -Force -Path $bin | Out-Null
|
||||||
|
Move-Item -Force (Join-Path $tmp 'mise\bin\mise.exe') (Join-Path $bin 'mise.exe')
|
||||||
|
& (Join-Path $bin 'mise.exe') trust
|
||||||
|
& (Join-Path $bin 'mise.exe') install
|
||||||
|
& (Join-Path $bin 'mise.exe') run web-install
|
||||||
|
Write-Host 'готово: .\mise.ps1 run verify'
|
||||||
Executable
+32
@@ -0,0 +1,32 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
# Скачивает mise в ./.mise/bin (без установки в систему) и ставит инструменты проекта.
|
||||||
|
set -eu
|
||||||
|
MISE_VERSION=2026.10.19
|
||||||
|
root=$(CDPATH= cd -- "$(dirname -- "$0")" && pwd)
|
||||||
|
os=$(uname -s)
|
||||||
|
arch=$(uname -m)
|
||||||
|
case "$os" in
|
||||||
|
Linux) case "$arch" in
|
||||||
|
x86_64) plat=linux-x64 ;;
|
||||||
|
aarch64) plat=linux-arm64 ;;
|
||||||
|
*) echo "неподдерживаемая архитектура: $arch" >&2; exit 1 ;;
|
||||||
|
esac ;;
|
||||||
|
Darwin) case "$arch" in
|
||||||
|
x86_64) plat=darwin-x64 ;;
|
||||||
|
arm64) plat=darwin-arm64 ;;
|
||||||
|
*) echo "неподдерживаемая архитектура: $arch" >&2; exit 1 ;;
|
||||||
|
esac ;;
|
||||||
|
*) echo "запустите bootstrap.ps1 (Windows) или скачайте mise вручную" >&2; exit 1 ;;
|
||||||
|
esac
|
||||||
|
url="https://github.com/jdx/mise/releases/download/v${MISE_VERSION}/mise-v${MISE_VERSION}-${plat}.tar.xz"
|
||||||
|
tmp=$(mktemp -d)
|
||||||
|
trap 'rm -rf "$tmp"' EXIT
|
||||||
|
curl -fsSL "$url" -o "$tmp/mise.tar.xz"
|
||||||
|
tar xJf "$tmp/mise.tar.xz" -C "$tmp"
|
||||||
|
mkdir -p "$root/.mise/bin"
|
||||||
|
mv "$tmp/mise/bin/mise" "$root/.mise/bin/mise"
|
||||||
|
chmod +x "$root/.mise/bin/mise"
|
||||||
|
"$root/.mise/bin/mise" trust
|
||||||
|
"$root/.mise/bin/mise" install
|
||||||
|
"$root/.mise/bin/mise" run web-install
|
||||||
|
echo "готово: ./mise.sh run verify"
|
||||||
@@ -0,0 +1,2 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
exec "$(dirname "$0")/.mise/bin/mise" "$@"
|
||||||
@@ -0,0 +1,48 @@
|
|||||||
|
# Инструменты проекта: ставятся в кеш mise (~/.local/share/mise), не в систему.
|
||||||
|
# Сам mise — в ./.mise/bin (bootstrap.sh / bootstrap.ps1), см. README-секцию ниже.
|
||||||
|
[tools]
|
||||||
|
java = "temurin-17" # CI и Containerfile — temurin 17
|
||||||
|
maven = "3.9.16" # ровно версия из .gitea/workflows/{pr,main}.yml
|
||||||
|
node = "24" # wordpdf-web/Containerfile — node:24-alpine
|
||||||
|
python = "3.15" # prod-autotests (pytest 9.1.1 + requests 2.34.2)
|
||||||
|
|
||||||
|
[env]
|
||||||
|
# venv прод-автотестов; путь от корня проекта. Создаётся автоматически.
|
||||||
|
_.python.venv = { path = "prod-autotests/.venv", create = true }
|
||||||
|
|
||||||
|
[tasks.verify]
|
||||||
|
description = "mvn clean verify — полный гейт перед push (тесты + PMD + JaCoCo)"
|
||||||
|
run = "mvn clean verify"
|
||||||
|
|
||||||
|
[tasks.app-package]
|
||||||
|
description = "Исполняемый jar бэкенда"
|
||||||
|
run = "mvn -pl wordpdf-app -am package"
|
||||||
|
|
||||||
|
[tasks.app-run]
|
||||||
|
description = "Бэкенд на :8080, ключ выключен (после app-package)"
|
||||||
|
run = "java -jar wordpdf-app/target/wordpdf-app-1.0.0.jar"
|
||||||
|
|
||||||
|
[tasks.web-install]
|
||||||
|
description = "npm ci в wordpdf-web"
|
||||||
|
dir = "wordpdf-web"
|
||||||
|
run = "npm ci"
|
||||||
|
|
||||||
|
[tasks.web-build]
|
||||||
|
description = "Гейт SPA: tsc -b && vite build"
|
||||||
|
dir = "wordpdf-web"
|
||||||
|
run = "npm run build"
|
||||||
|
|
||||||
|
[tasks.web-lint]
|
||||||
|
description = "oxlint"
|
||||||
|
dir = "wordpdf-web"
|
||||||
|
run = "npm run lint"
|
||||||
|
|
||||||
|
[tasks.web-dev]
|
||||||
|
description = "SPA :5173, vite-proxy на :8080"
|
||||||
|
dir = "wordpdf-web"
|
||||||
|
run = "npm run dev"
|
||||||
|
|
||||||
|
[tasks.prod-tests]
|
||||||
|
description = "Прод-автотесты; обязателен WORDPDF_BASE_URL (факультативно WORDPDF_API_KEY)"
|
||||||
|
dir = "prod-autotests"
|
||||||
|
run = "python -m pip install -q -r requirements.txt && python -m pytest -q ."
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
[tools]
|
|
||||||
python = "3.15"
|
|
||||||
|
|
||||||
[env]
|
|
||||||
_.python.venv = { path = ".venv", create = true }
|
|
||||||
Reference in New Issue
Block a user