메뉴
Scaffold — создание нового Go-сервиса из шаблона gold-apisrv. Используй когда нужно завести новый сервис с нуля (репо, структура, Makefile, CI, конфиг, main).
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
API Health — проверка здоровья JSON-RPC сервиса через SMD. Используй когда нужно убедиться что RPC-endpoint жив, собрать тайминги методов или диагностировать недоступность API.
Appkit — библиотека vmkteam/appkit: метрики, pprof, HTTP client, service metadata, X-Request-ID. Используй при подключении метрик/pprof в сервис, работе с HTTP-клиентом appkit или добавлении корреляционных ID.
CI/CD — GitLab CI + Nomad deploy для Go-сервисов vmkteam. Используй при редактировании .gitlab-ci.yml, *.nomad.hcl, настройке пайплайна или дебаге деплоя.
Colgen — генератор коллекций для Go-структур. Используй при работе с collection.go и конвертерами между слоями.
Commit message — краткое сообщение коммита на английском из git diff. Используй перед `git commit`, после /solve, или при явной просьбе 'сгенерируй commit message'.
Cron — менеджер cron-задач с UI, middleware и Prometheus-метриками. Используй при добавлении/правке cron-задачи, подключении пакета vmkteam/cron или настройке CronConfig.
| name | scaffold |
| description | Scaffold — создание нового Go-сервиса из шаблона gold-apisrv. Используй когда нужно завести новый сервис с нуля (репо, структура, Makefile, CI, конфиг, main). |
Создание нового проекта из шаблона vmkteam/gold-apisrv (https://github.com/vmkteam/gold-apisrv).
Спроси у пользователя:
reviewsrv, ordersrv)ordersrv → бизнес-слой orders). По умолчанию = имя проекта без суффикса srv~/{workspace}/{name}/)public)git clone https://github.com/vmkteam/gold-apisrv.git {path}/{name}
cd {path}/{name}
rm -rf .git
git init
В шаблоне есть make init который выполняет начальную настройку, включая генерацию Makefile.mk из Makefile.mk.dist. Запустить:
make init
Makefile.mk — локальный конфиг проекта (переменные, пути), подключается из основного Makefile. Находится в .gitignore.
# go.mod
sed -i '' 's/module apisrv/module {name}/' go.mod
# Все импорты в .go файлах
find . -name '*.go' -not -path './vendor/*' -exec sed -i '' 's|"apisrv/|"{name}/|g' {} +
Файлы для правки:
| Файл | Что менять |
|---|---|
cmd/apisrv/main.go | const appName = "apisrv" → "{name}" |
Makefile | NAME := apisrv → NAME := {name} |
Makefile | PGDATABASE ?= apisrv → PGDATABASE ?= {name} |
Makefile | TEST_PGDATABASE ?= test-apisrv → TEST_PGDATABASE ?= test-{name} |
deployments/Dockerfile | CI_PROJECT_NAME=apisrv → CI_PROJECT_NAME={name} |
cfg/local.toml.dist | Database = "apisrv" → Database = "{name}" |
mv cmd/apisrv cmd/{name}
mv docs/model/apisrv.mfd docs/model/{name}.mfd
mv docs/apisrv.sql docs/{name}.sql
mv docs/apisrv.pgd docs/{name}.pgd 2>/dev/null
# Обновить ссылки в Makefile
sed -i '' 's/apisrv\.mfd/{name}.mfd/g' Makefile
Если бизнес-слой называется иначе (например billing вместо order):
# Переименовать domain-пакет если существует
mv pkg/apisrv pkg/{domain_name} 2>/dev/null
# Обновить импорты
find . -name '*.go' -not -path './vendor/*' -exec sed -i '' 's|"{name}/pkg/apisrv"|"{name}/pkg/{domain_name}"|g' {} +
Если VT не нужен — удалить:
rm -rf pkg/vt/
# Убрать registerVTApiHandlers из pkg/app/handlers.go
# Убрать VT-импорты из pkg/app/app.go
cp cfg/local.toml.dist cfg/local.toml
Обновить в cfg/local.toml:
Port = {port}Database = "{name}"EnableVFS = {true/false}В docs/model/{name}.mfd:
<Name>{name}.mfd</Name>
make db # создать БД и загрузить схему
make db-test # создать тестовую БД
make mod # go mod tidy && go mod vendor
make build # скомпилировать
make run # запустить в dev-режиме
curl http://localhost:{port}/status
curl http://localhost:{port}/v1/rpc/
curl http://localhost:{port}/metrics
{name}/
├── Makefile # основной (include Makefile.mk)
├── Makefile.mk # локальные переменные (gitignored)
├── cmd/{name}/main.go # точка входа
├── pkg/
│ ├── app/ # App, handlers, metrics, config
│ ├── db/ # ORM-модели, репозитории
│ ├── {domain_name}/ # Domain (бизнес-логика, если нужна)
│ ├── rpc/ # Публичный API
│ └── vt/ # Admin API (если нужен)
├── docs/
│ ├── {name}.sql # DDL
│ ├── {name}.pgd # Схема pgDesigner
│ ├── init.sql # seed data
│ ├── patches/ # Миграции (pgmigrator)
│ └── model/{name}.mfd # MFD-схема
├── cfg/
│ ├── local.toml # конфиг (gitignored)
│ └── local.toml.dist # шаблон конфига
├── deployments/Dockerfile
└── go.mod
docs/{name}.sql — всегда актуальный. Это source of truth. Миграций нет.
При изменении схемы:
docs/{name}.pgd → pgdesigner generate → обновить docs/{name}.sqlmake db — пересоздать БД с нуляmake mfd-xml && make mfd-model — перегенерировать Go-кодНельзя пересоздать БД на devel → появляются миграции в docs/patches/.
При изменении схемы:
docs/patches/ (/pgmigrator)docs/{name}.sql (держать в актуальном состоянии)pgmigrator run на develmake mfd-xml && make mfd-modelpgdesigner generatemake db → make mfd-xml → make mfd-model → /mfdmake mfd-vt-rpc NS=...)