4e926a43a7
* fix(readme): russian heading, simplified support, access_url, env username * fix(ci): wrap long assert to satisfy ruff E501 in test_permissions.py * docs(project-map): add PR#118 tags (create-readme, repo-readme, .env.example) * fix(ci): format test_permissions.py for ruff format check --------- Co-authored-by: opencode-agent <agent@opencode.local>
63 lines
No EOL
3.4 KiB
Markdown
63 lines
No EOL
3.4 KiB
Markdown
---
|
||
pr: 118
|
||
title: fix(readme): russian heading, simplified support, access_url, env username
|
||
---
|
||
|
||
## Что сделано
|
||
|
||
4 фикса в `create-readme` tool (`.opencode/tools/create-readme.ts`):
|
||
- **RU заголовок:** `## 🇷🇺 Русская версия` → `## 🇷🇺 Русский`.
|
||
- **Switcher anchor:** `[Русский](#-русская-версия)` →
|
||
`[Русский](#-русский)`.
|
||
- **Support блок** — убрана строка `Have questions or want to support?`,
|
||
оставлена только ссылка `👉 **[slaid098.dev/support]...`.
|
||
- **`access_url`** — новый optional параметр. Если передан, после Quick Start
|
||
bash-блока добавляется `Access at {url}` (EN) и `Доступ: {url}` (RU).
|
||
|
||
`validateReadme()` — добавлены 2 проверки:
|
||
- `## 🇷🇺 Русский` header (не "Русская версия").
|
||
- `[Русский](#-русский)` switcher link (не `#-русская-версия`).
|
||
|
||
Schema: добавлен `access_url` (optional string). `execute()` передаёт
|
||
`access_url` в `generateReadme()`. `description` обновлён (упоминание RU header
|
||
+ anchor checks).
|
||
|
||
Обновлён скилл `repo-readme` (`.opencode/skills/repo-readme/SKILL.md`):
|
||
- §5 (Шаблон README) — `## 🇷🇺 Русский`, `[Русский](#-русский)`, Support без
|
||
"Have questions", `access_url` строки после Quick Start bash-блоков.
|
||
- §5 — описание `validate` дополнено (RU header + anchor checks).
|
||
- §7 (Параметры тулзы) — добавлен `access_url`.
|
||
|
||
`.env.example`: добавлен `OPENCODE_SERVER_USERNAME` (отсутствовал).
|
||
|
||
`tests/test_permissions.py`: добавлен
|
||
`test_opencode_server_username_present_in_env_example`.
|
||
|
||
`README.md`: перегенерирован по обновлённому шаблону (Русский, упрощённый
|
||
Support, Access at / Доступ: http://localhost:4096, License секция).
|
||
|
||
`docs/project-map/README.md`: описание `create-readme.ts` обновлено (добавлено
|
||
`access_url`).
|
||
|
||
Проверки: `tsc --noEmit` (с `--types node`) чисто; `pytest
|
||
tests/test_permissions.py` OK (13 passed); `check-permissions.py` OK.
|
||
|
||
## Почему
|
||
|
||
Polish после PR#116 (v2). "Русская версия" — длинно, "Русский" короче и
|
||
соответствует anchor. Support блок перегружен описанием — достаточно ссылки.
|
||
`OPENCODE_SERVER_USERNAME` отсутствовал в `.env.example` (opencode server
|
||
требует username). `access_url` нужен для репо с web-доступом (например,
|
||
opencode-config — http://localhost:4096).
|
||
|
||
## Pending
|
||
|
||
—
|
||
|
||
## Watch out
|
||
|
||
`access_url` — optional. Если не передан, Access/Доступ строки не
|
||
добавляются (обратно совместимо). `validate` теперь проверяет RU header
|
||
(`## 🇷🇺 Русский`) и anchor (`[Русский](#-русский)`) — существующие README,
|
||
сгенерированные старой версией тулзы (с "Русская версия"), не пройдут
|
||
валидацию. Требуется перегенерация через `create-readme` (mode: create). |