Compare commits
10
Commits
7ffba57a13
...
7c60482467
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7c60482467 | ||
|
|
1d80630fb2 | ||
|
|
ae812b0dfa | ||
|
|
fc13c66b0d | ||
|
|
db4eb04092 | ||
|
|
bd6f349dc4 | ||
|
|
157d79932a | ||
|
|
8014a968b7 | ||
|
|
dbd5762ecf | ||
|
|
9d5478ddeb |
No files matched your search
+2
-2
@@ -1,4 +1,4 @@
|
||||
title: 'GEO Helm'
|
||||
project:
|
||||
org: 'geo-helm'
|
||||
repo: 'geo-platform'
|
||||
org: 'jt4d'
|
||||
repo: 'jt4d'
|
||||
@@ -0,0 +1,29 @@
|
||||
name: Сообщить о баге
|
||||
about: Детальное описание ошибки
|
||||
title: '[Bug]: '
|
||||
labels:
|
||||
- bug
|
||||
body:
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Некорректное поведение
|
||||
description: Кратко расскажи что не так и в каком модуле
|
||||
placeholder: При работе с модулем X некорректно работает Y
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: steps-to-reproduce
|
||||
attributes:
|
||||
label: Как воспроизвести
|
||||
description: Опиши шаг за шагом что нужно выполнить, что бы воспроизвести ошибку
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: additional-info
|
||||
attributes:
|
||||
label: Дополнительная информация
|
||||
validations:
|
||||
required: false
|
||||
@@ -0,0 +1 @@
|
||||
blank_issues_enabled: true
|
||||
@@ -0,0 +1,64 @@
|
||||
name: Эпик
|
||||
about: Шаблон нового эпика
|
||||
title: '[EPIC]: '
|
||||
labels:
|
||||
- epic
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Пожалуйста заполни все поля
|
||||
visible: [form]
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Описание
|
||||
description: Опиши, что надо сделать на языке продукта
|
||||
placeholder: |
|
||||
Сейчас пользователи не получают уведомления о важных событиях (например, обновлении статуса заказа).
|
||||
Это приводит к недовольству и повышению нагрузки на службу поддержки.
|
||||
Мы планируем создать универсальную систему уведомлений для отправки e-mail, push, и SMS.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: big-user-story
|
||||
attributes:
|
||||
label: Большая пользовательская история
|
||||
placeholder: |
|
||||
Как пользователь, я хочу получать уведомления о важных событиях (например, изменении статуса заказа),
|
||||
чтобы быть в курсе происходящего в реальном времени.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: criteria
|
||||
attributes:
|
||||
label: Пользовательские истории
|
||||
description: Список всех user story входящих в эпик
|
||||
placeholder: |
|
||||
- [ ] Как участник организации, я хочу видеть список активных заявок на редактирование проекта,
|
||||
что бы продолжить их редактирование и видеть их статус
|
||||
- [ ] Как участник организации я хочу создать заявку на редактирование проекта что бы обновить информацию в нем
|
||||
- [ ] Как участник организации я хочу редактировать заявку на изменение проекта
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: markdown
|
||||
id: checklist
|
||||
visible: [content]
|
||||
attributes:
|
||||
value: |
|
||||
- [ ] Документация обновлена
|
||||
|
||||
- type: textarea
|
||||
id: additional-info
|
||||
attributes:
|
||||
label: Дополнительная информация
|
||||
description: |
|
||||
Добавьте любую дополнительную информацию, которая может быть полезна
|
||||
value: |
|
||||
Не требуется
|
||||
validations:
|
||||
required: false
|
||||
@@ -0,0 +1,73 @@
|
||||
name: Задача
|
||||
about: Шаблон новой задачи
|
||||
title: ''
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Пожалуйста заполни все поля
|
||||
visible: [form]
|
||||
|
||||
- type: textarea
|
||||
id: what-doing
|
||||
attributes:
|
||||
label: Что требуется сделать
|
||||
description: Опиши, что нужно сделать на языке продукта и, по возможности, укажи причину изменений
|
||||
placeholder: |
|
||||
Разработать крутую функциональность для выполнения требований заказчика
|
||||
- первое требования
|
||||
- второе требование
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: links
|
||||
attributes:
|
||||
label: User Story
|
||||
placeholder: '#1234'
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: details
|
||||
attributes:
|
||||
label: Технические детали
|
||||
description: Добавь технические детали, которые нужно учесть
|
||||
placeholder: |
|
||||
Сделать потребуется в папке folder
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: criteria
|
||||
attributes:
|
||||
label: Критерии готовности
|
||||
description: Как проверить что задача выполнена
|
||||
placeholder: |
|
||||
- [ ] Энпоинт добавлен
|
||||
- [ ] Индексы в БД настроены
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: markdown
|
||||
id: checklist
|
||||
visible: [content]
|
||||
attributes:
|
||||
value: |
|
||||
### Чеклист
|
||||
|
||||
- [ ] Документация соответствует коду
|
||||
- [ ] Тест кейсы покрывают все требования
|
||||
|
||||
- type: textarea
|
||||
id: test-cases
|
||||
attributes:
|
||||
label: Тест кейсы
|
||||
description: Какие ситуации нужно протестировать
|
||||
value: |
|
||||
- [ ] **Успешная отправка данные**
|
||||
- Все обязательные поля заполнены.
|
||||
- Нажать на кнопку "Отправить".
|
||||
- Ожидаемый результат: блокировка формы, уведомление, статус `Completed`.
|
||||
validations:
|
||||
required: true
|
||||
@@ -0,0 +1,54 @@
|
||||
name: Пользовательская история
|
||||
about: Шаблон User Story
|
||||
title: '[Story]: '
|
||||
labels:
|
||||
- story
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Пожалуйста заполни все поля
|
||||
visible: [form]
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Пользовательская история
|
||||
description: Помни про критерии INVEST
|
||||
placeholder: |
|
||||
Как участник организации, я хочу видеть список активных заявок на редактирование проекта,
|
||||
что бы продолжить их редактирование и видеть их статус
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: links
|
||||
attributes:
|
||||
label: Epic
|
||||
placeholder: '#1234'
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: criteria
|
||||
attributes:
|
||||
label: Критерии готовности
|
||||
description: Как проверить что user story работает
|
||||
placeholder: |
|
||||
- [ ] Уведомления отправляются через e-mail, push и SMS.
|
||||
- [ ] Доступна административная панель для управления шаблонами уведомлений.
|
||||
- [ ] Система подключена к основным событиям через шину событий.
|
||||
- [ ] Проверка интеграции в реальных условиях произведена.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: additional-info
|
||||
attributes:
|
||||
label: Дополнительная информация
|
||||
description: |
|
||||
Добавьте любую дополнительную информацию, которая может быть полезна
|
||||
value: |
|
||||
Не требуется
|
||||
validations:
|
||||
required: false
|
||||
+29
-27
@@ -44,8 +44,16 @@ jobs:
|
||||
- name: Check migrations list
|
||||
run: yarn ts-node tools/buildDataSource.ts --check
|
||||
|
||||
- name: Compute version
|
||||
id: version
|
||||
env:
|
||||
REF_NAME: ${{ github.head_ref || github.ref_name }}
|
||||
run: echo "VERSION=$REF_NAME-$(git rev-parse --short HEAD)" >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Build
|
||||
run: yarn build
|
||||
env:
|
||||
APP_VERSION: ${{ steps.version.outputs.VERSION }}
|
||||
|
||||
- name: Check data-source
|
||||
run: yarn ts-node tools/checkDataSource.ts
|
||||
@@ -56,8 +64,10 @@ jobs:
|
||||
context: apps/web
|
||||
file: apps/web/Dockerfile
|
||||
push: true
|
||||
tags: git.jt4d.ru/geo-helm/geo-platform/web:${{ github.head_ref || github.ref_name }}
|
||||
cache-from: git.jt4d.ru/geo-helm/geo-platform/web:latest
|
||||
build-args: |
|
||||
CADDYFILE=Caddyfile.staging
|
||||
tags: git.jt4d.ru/${{ github.repository }}/web:${{ github.head_ref || github.ref_name }}
|
||||
cache-from: git.jt4d.ru/${{ github.repository }}/web:latest
|
||||
labels: |
|
||||
org.opencontainers.image.ref.name=${{ github.head_ref || github.ref_name }}
|
||||
|
||||
@@ -70,8 +80,8 @@ jobs:
|
||||
context: apps/api
|
||||
file: apps/api/Dockerfile
|
||||
push: true
|
||||
tags: git.jt4d.ru/geo-helm/geo-platform/api:${{ github.head_ref || github.ref_name }}
|
||||
cache-from: git.jt4d.ru/geo-helm/geo-platform/api:latest
|
||||
tags: git.jt4d.ru/${{ github.repository }}/api:${{ github.head_ref || github.ref_name }}
|
||||
cache-from: git.jt4d.ru/${{ github.repository }}/api:latest
|
||||
labels: |
|
||||
org.opencontainers.image.ref.name=${{ github.head_ref || github.ref_name }}
|
||||
|
||||
@@ -79,56 +89,45 @@ jobs:
|
||||
name: Деплой на стейджинг
|
||||
runs-on: ubuntu-latest
|
||||
needs: build
|
||||
env:
|
||||
DEPLOY_URL: https://${{ github.head_ref || github.ref_name }}.jt4d.jt4d.ru.net
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Copy docker-compose file
|
||||
uses: appleboy/scp-action@v1
|
||||
with:
|
||||
host: ${{ vars.STAGING_HOST }}
|
||||
username: ${{ vars.STAGING_USER }}
|
||||
key: ${{ secrets.STAGING_SSH_PRIVATE_KEY }}
|
||||
port: ${{ vars.STAGING_PORT }}
|
||||
source: 'docker-compose.staging.yml'
|
||||
target: /home/${{ vars.STAGING_USER }}/${{ github.event.repository.name }}_${{ github.head_ref || github.ref_name }}
|
||||
|
||||
- name: Deploy via SSH
|
||||
uses: appleboy/ssh-action@v1
|
||||
uses: jt4d-lab/ssh-action@v1
|
||||
env:
|
||||
DEPLOY_DIR: ${{ github.event.repository.name }}_${{ github.head_ref || github.ref_name }}
|
||||
BRANCH: ${{ github.head_ref || github.ref_name }}
|
||||
with:
|
||||
host: ${{ vars.STAGING_HOST }}
|
||||
username: ${{ vars.STAGING_USER }}
|
||||
key: ${{ secrets.STAGING_SSH_PRIVATE_KEY }}
|
||||
port: ${{ vars.STAGING_PORT }}
|
||||
workdir: /home/${{ vars.STAGING_USER }}/${{ github.event.repository.name }}_${{ github.head_ref || github.ref_name }}
|
||||
files: docker-compose.staging.yml
|
||||
script_stop: true
|
||||
envs: DEPLOY_DIR,BRANCH
|
||||
envs: BRANCH
|
||||
script: |
|
||||
set -e
|
||||
cd "/home/${{ vars.STAGING_USER }}/$DEPLOY_DIR"
|
||||
mv -f docker-compose.*.yml docker-compose.yml
|
||||
mv -f docker-compose.staging.yml docker-compose.yml
|
||||
# \${BRANCH} — литеральный плейсхолдер в docker-compose.staging.yml,
|
||||
# $BRANCH — имя ветки из окружения.
|
||||
sed -i "s/\${BRANCH}/$BRANCH/g" docker-compose.yml
|
||||
docker compose pull --quiet
|
||||
staging-db-postgres create "${{ github.repository }}" "$BRANCH"
|
||||
docker compose down
|
||||
docker compose up -d
|
||||
|
||||
# echo "Список миграций"
|
||||
# docker compose exec -T api node_modules/.bin/typeorm migration:show -d data-source.js
|
||||
# echo "Применение миграций"
|
||||
# docker compose exec -T api node_modules/.bin/typeorm migration:run -t each -d data-source.js
|
||||
echo "Список миграций"
|
||||
docker compose exec -T api node_modules/.bin/typeorm migration:show -d data-source.js
|
||||
echo "Применение миграций"
|
||||
docker compose exec -T api node_modules/.bin/typeorm migration:run -t each -d data-source.js
|
||||
|
||||
# Если migration:run упадёт, prune под `set -e` не выполнится —
|
||||
# почистится на следующем деплое.
|
||||
docker system prune -f
|
||||
|
||||
- name: Set deployment status
|
||||
env:
|
||||
BRANCH: ${{ github.head_ref || github.ref_name }}
|
||||
DEPLOY_URL: http://${{ github.head_ref || github.ref_name }}.geo-platform.geo-helm.jt4d.ru.net
|
||||
run: |
|
||||
curl -s -X POST \
|
||||
-H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
|
||||
@@ -141,6 +140,9 @@ jobs:
|
||||
}' \
|
||||
"${{ github.server_url }}/api/v1/repos/${{ github.repository }}/statuses/${{ github.sha }}"
|
||||
|
||||
- name: Write stand URL to summary
|
||||
run: echo "**Стенд:** $DEPLOY_URL" >> "$GITHUB_STEP_SUMMARY"
|
||||
|
||||
check:
|
||||
name: Проверка кода
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
@@ -2,37 +2,50 @@ name: Cleanup
|
||||
|
||||
on:
|
||||
delete:
|
||||
pull_request:
|
||||
types: [closed]
|
||||
workflow_dispatch:
|
||||
|
||||
concurrency:
|
||||
group: cleanup-${{ github.event.pull_request.head.ref || github.event.ref || github.ref_name }}
|
||||
|
||||
jobs:
|
||||
cleanup:
|
||||
name: Удаление стенда
|
||||
runs-on: ubuntu-latest
|
||||
if: github.event.ref_type == 'branch'
|
||||
if: >-
|
||||
github.event_name == 'workflow_dispatch' ||
|
||||
(github.event_name == 'delete' && github.event.ref_type == 'branch') ||
|
||||
(github.event_name == 'pull_request' &&
|
||||
github.event.pull_request.head.repo.full_name == github.repository)
|
||||
steps:
|
||||
- name: Удаление стенда
|
||||
uses: appleboy/ssh-action@v1
|
||||
uses: jt4d-lab/ssh-action@v1
|
||||
with:
|
||||
host: ${{ vars.STAGING_HOST }}
|
||||
username: ${{ vars.STAGING_USER }}
|
||||
key: ${{ secrets.STAGING_SSH_PRIVATE_KEY }}
|
||||
port: ${{ vars.STAGING_PORT }}
|
||||
script_stop: true
|
||||
script: |
|
||||
BRANCH_NAME="${{ github.event.ref }}"
|
||||
BRANCH_NAME="${{ github.event.ref || github.event.pull_request.head.ref || github.ref_name }}"
|
||||
BRANCH_NAME="${BRANCH_NAME#refs/heads/}"
|
||||
DEPLOY_DIR="/home/${{ vars.STAGING_USER }}/${{ github.event.repository.name }}_${BRANCH_NAME}"
|
||||
echo "Deleting stand for branch: ${BRANCH_NAME}"
|
||||
echo $DEPLOY_DIR
|
||||
# Стек гасим до удаления базы: DROP DATABASE не пройдёт при живом подключении api.
|
||||
if [ -d "$DEPLOY_DIR" ]; then
|
||||
cd "$DEPLOY_DIR"
|
||||
docker compose down --rmi all || true
|
||||
cd ..
|
||||
rm -rf "$DEPLOY_DIR"
|
||||
docker system prune -f
|
||||
fi
|
||||
staging-db-postgres delete "${{ github.repository }}" "$BRANCH_NAME"
|
||||
cd "$HOME"
|
||||
rm -rf "$DEPLOY_DIR"
|
||||
docker system prune -f
|
||||
|
||||
- name: Удаление docker образов
|
||||
run: |
|
||||
BRANCH_NAME="${{ github.event.ref }}"
|
||||
BRANCH_NAME="${{ github.event.ref || github.event.pull_request.head.ref || github.ref_name }}"
|
||||
BRANCH_NAME="${BRANCH_NAME#refs/heads/}"
|
||||
OWNER="${{ github.repository_owner }}"
|
||||
REPO_NAME="${{ github.event.repository.name }}"
|
||||
|
||||
@@ -63,7 +63,7 @@ jobs:
|
||||
- name: Build
|
||||
run: yarn build
|
||||
env:
|
||||
APP_VERSION: ${{ steps.version.outputs.version }}
|
||||
APP_VERSION: ${{ steps.version.outputs.VERSION }}
|
||||
|
||||
- name: Check data-source
|
||||
run: yarn ts-node tools/checkDataSource.ts
|
||||
@@ -74,8 +74,8 @@ jobs:
|
||||
context: apps/web
|
||||
file: apps/web/Dockerfile
|
||||
push: true
|
||||
tags: git.jt4d.ru/geo-helm/geo-platform/web:${{ steps.version.outputs.VERSION }}
|
||||
cache-from: git.jt4d.ru/geo-helm/geo-platform/web:master
|
||||
tags: git.jt4d.ru/${{ github.repository }}/web:${{ steps.version.outputs.VERSION }}
|
||||
cache-from: git.jt4d.ru/${{ github.repository }}/web:master
|
||||
labels: |
|
||||
org.opencontainers.image.ref.name=${{ steps.version.outputs.VERSION }}
|
||||
|
||||
@@ -88,8 +88,8 @@ jobs:
|
||||
context: apps/api
|
||||
file: apps/api/Dockerfile
|
||||
push: true
|
||||
tags: git.jt4d.ru/geo-helm/geo-platform/api:${{ steps.version.outputs.VERSION }}
|
||||
cache-from: git.jt4d.ru/geo-helm/geo-platform/api:master
|
||||
tags: git.jt4d.ru/${{ github.repository }}/api:${{ steps.version.outputs.VERSION }}
|
||||
cache-from: git.jt4d.ru/${{ github.repository }}/api:master
|
||||
labels: |
|
||||
org.opencontainers.image.ref.name=${{ steps.version.outputs.VERSION }}
|
||||
|
||||
@@ -101,27 +101,8 @@ jobs:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup SSH key
|
||||
uses: shimataro/ssh-key-action@v2
|
||||
with:
|
||||
key: ${{ secrets.PROD_SSH_PRIVATE_KEY }}
|
||||
known_hosts: unnecessary
|
||||
|
||||
- name: Add prod host to known_hosts
|
||||
run: ssh-keyscan -p ${{ vars.PROD_PORT }} ${{ vars.PROD_HOST }} >> ~/.ssh/known_hosts
|
||||
|
||||
- name: Copy docker-compose file
|
||||
run: |
|
||||
ssh -p ${{ vars.PROD_PORT }} \
|
||||
${{ vars.PROD_USER }}@${{ vars.PROD_HOST }} \
|
||||
"mkdir -p /srv/geo-platform"
|
||||
scp -P ${{ vars.PROD_PORT }} \
|
||||
docker-compose.production.yml \
|
||||
${{ vars.PROD_USER }}@${{ vars.PROD_HOST }}:/srv/geo-platform/
|
||||
|
||||
- name: Deploy via SSH
|
||||
- name: Check log level
|
||||
env:
|
||||
VERSION: ${{ needs.build.outputs.version }}
|
||||
LOG_LEVEL: ${{ inputs.logLevel }}
|
||||
run: |
|
||||
# VERSION проверен regexp-ом в job build (шаг Compute version) и приходит
|
||||
@@ -134,21 +115,29 @@ jobs:
|
||||
;;
|
||||
esac
|
||||
|
||||
ssh -p ${{ vars.PROD_PORT }} \
|
||||
${{ vars.PROD_USER }}@${{ vars.PROD_HOST }} \
|
||||
"VERSION=$VERSION LOG_LEVEL=$LOG_LEVEL bash -s" << 'EOF'
|
||||
set -e
|
||||
export VERSION LOG_LEVEL
|
||||
cd /srv/geo-platform
|
||||
mv -f docker-compose.production.yml docker-compose.yml
|
||||
- name: Deploy via SSH
|
||||
uses: jt4d-lab/ssh-action@v1
|
||||
env:
|
||||
VERSION: ${{ needs.build.outputs.version }}
|
||||
LOG_LEVEL: ${{ inputs.logLevel }}
|
||||
with:
|
||||
host: ${{ vars.PROD_HOST }}
|
||||
username: ${{ vars.PROD_USER }}
|
||||
key: ${{ secrets.PROD_SSH_PRIVATE_KEY }}
|
||||
port: ${{ vars.PROD_PORT }}
|
||||
workdir: /srv/jt4d
|
||||
files: docker-compose.production.yml
|
||||
envs: VERSION,LOG_LEVEL
|
||||
script_stop: true
|
||||
script: |
|
||||
mv -f docker-compose.production.yml docker-compose.yml
|
||||
|
||||
docker-compose pull --quiet
|
||||
docker-compose down
|
||||
docker-compose up -d
|
||||
docker-compose pull --quiet
|
||||
docker-compose down
|
||||
docker-compose up -d
|
||||
|
||||
# Ожидания готовности нет намеренно
|
||||
echo "Список миграций"
|
||||
docker exec geo-platform_api node_modules/.bin/typeorm migration:show -d data-source.js
|
||||
echo "Применение миграций"
|
||||
docker exec geo-platform_api node_modules/.bin/typeorm migration:run -t each -d data-source.js
|
||||
EOF
|
||||
# Ожидания готовности нет намеренно
|
||||
echo "Список миграций"
|
||||
docker exec jt4d_api node_modules/.bin/typeorm migration:show -d data-source.js
|
||||
echo "Применение миграций"
|
||||
docker exec jt4d_api node_modules/.bin/typeorm migration:run -t each -d data-source.js
|
||||
+29
-29
@@ -1,40 +1,40 @@
|
||||
name: CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
pull_request:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
pull_request:
|
||||
|
||||
permissions:
|
||||
actions: read
|
||||
contents: read
|
||||
actions: read
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
main:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
with:
|
||||
filter: tree:0
|
||||
fetch-depth: 0
|
||||
main:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
with:
|
||||
filter: tree:0
|
||||
fetch-depth: 0
|
||||
|
||||
# This enables task distribution via Nx Cloud
|
||||
# Run this command as early as possible, before dependencies are installed
|
||||
# Learn more at https://nx.dev/docs/reference/nx-cloud-cli#npx-nxcloud-startcirun
|
||||
- run: npx nx start-ci-run --distribute-on="3 linux-medium-js" --stop-agents-after="e2e"
|
||||
# This enables task distribution via Nx Cloud
|
||||
# Run this command as early as possible, before dependencies are installed
|
||||
# Learn more at https://nx.dev/docs/reference/nx-cloud-cli#npx-nxcloud-startcirun
|
||||
- run: npx nx start-ci-run --distribute-on="3 linux-medium-js" --stop-agents-after="e2e"
|
||||
|
||||
# Cache node_modules
|
||||
- uses: actions/setup-node@v5
|
||||
with:
|
||||
node-version: 24
|
||||
cache: 'npm'
|
||||
# Cache node_modules
|
||||
- uses: actions/setup-node@v5
|
||||
with:
|
||||
node-version: 24
|
||||
cache: 'npm'
|
||||
|
||||
- run: npm ci
|
||||
- run: npm ci
|
||||
|
||||
# Prepend any command with "nx record --" to record its logs to Nx Cloud
|
||||
- run: npx nx record -- npx nx format:check --base="remotes/origin/main"
|
||||
- run: npx nx run-many -t lint test build typecheck e2e
|
||||
# Nx Cloud recommends fixes for failures to help you get CI green faster. Learn more: https://nx.dev/docs/features/ci-features/self-healing-ci
|
||||
- run: npx nx fix-ci
|
||||
if: always()
|
||||
# Prepend any command with "nx record --" to record its logs to Nx Cloud
|
||||
- run: npx nx record -- npx nx format:check --base="remotes/origin/main"
|
||||
- run: npx nx run-many -t lint test build typecheck e2e
|
||||
# Nx Cloud recommends fixes for failures to help you get CI green faster. Learn more: https://nx.dev/docs/features/ci-features/self-healing-ci
|
||||
- run: npx nx fix-ci
|
||||
if: always()
|
||||
@@ -0,0 +1,308 @@
|
||||
---
|
||||
description:
|
||||
Perform a non-destructive cross-artifact consistency and quality analysis across spec.md,
|
||||
plan.md, and tasks.md after task generation.
|
||||
---
|
||||
|
||||
## User Input
|
||||
|
||||
```text
|
||||
$ARGUMENTS
|
||||
```
|
||||
|
||||
You **MUST** consider the user input before proceeding (if not empty).
|
||||
|
||||
## Pre-Execution Checks
|
||||
|
||||
**Check for extension hooks (before analysis)**:
|
||||
|
||||
- Check if `.specify/extensions.yml` exists in the project root.
|
||||
- If it exists, read it and look for entries under the `hooks.before_analyze` key
|
||||
- If the YAML cannot be parsed or is invalid, do not skip silently: tell the user that
|
||||
`.specify/extensions.yml` could not be read (include the parser error) and that no hooks were
|
||||
checked, including any mandatory (`optional: false`) hooks registered there, then continue
|
||||
normally
|
||||
- Filter out hooks where `enabled` is explicitly `false`. Treat hooks without an `enabled` field as
|
||||
enabled by default.
|
||||
- For each remaining hook, do **not** attempt to interpret or evaluate hook `condition` expressions:
|
||||
- If the hook has no `condition` field, or it is null/empty, treat the hook as executable
|
||||
- If the hook defines a non-empty `condition`, skip the hook and leave condition evaluation to
|
||||
the HookExecutor implementation
|
||||
- For each executable hook, output the following based on its `optional` flag:
|
||||
- **Optional hook** (`optional: true`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Optional Pre-Hook**: {extension}
|
||||
Command: `/{command}`
|
||||
Description: {description}
|
||||
|
||||
Prompt: {prompt}
|
||||
To execute: `/{command}`
|
||||
```
|
||||
|
||||
- **Mandatory hook** (`optional: false`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Automatic Pre-Hook**: {extension}
|
||||
Executing: `/{command}`
|
||||
EXECUTE_COMMAND: {command}
|
||||
|
||||
Wait for the result of the hook command before proceeding to the Goal.
|
||||
```
|
||||
|
||||
After emitting the block above you MUST actually invoke the hook and wait for it to finish
|
||||
before continuing. Run it the same way you would run the command yourself in this
|
||||
agent/session (the invocation may differ from the literal `{command}` id shown above, e.g. a
|
||||
skills-mode agent runs it as `/skill:speckit-...` or `$speckit-...`). Emitting the block
|
||||
alone does not run the hook.
|
||||
|
||||
- If no hooks are registered or `.specify/extensions.yml` does not exist, skip silently
|
||||
|
||||
## Goal
|
||||
|
||||
Identify inconsistencies, duplications, ambiguities, and underspecified items across the three core
|
||||
artifacts (`spec.md`, `plan.md`, `tasks.md`) before implementation. This command MUST run only after
|
||||
`/speckit.tasks` has successfully produced a complete `tasks.md`.
|
||||
|
||||
## Operating Constraints
|
||||
|
||||
**STRICTLY READ-ONLY**: Do **not** modify any files. Output a structured analysis report. Offer an
|
||||
optional remediation plan (user must explicitly approve before any follow-up editing commands would
|
||||
be invoked manually).
|
||||
|
||||
**Constitution Authority**: The project constitution (`.specify/memory/constitution.md`) is
|
||||
**non-negotiable** within this analysis scope. Constitution conflicts are automatically CRITICAL and
|
||||
require adjustment of the spec, plan, or tasks—not dilution, reinterpretation, or silent ignoring of
|
||||
the principle. If a principle itself needs to change, that must occur in a separate, explicit
|
||||
constitution update outside `/speckit.analyze`.
|
||||
|
||||
## Execution Steps
|
||||
|
||||
### 1. Initialize Analysis Context
|
||||
|
||||
Run
|
||||
`.specify/scripts/bash/check-prerequisites.sh --json --require-spec --require-tasks --include-tasks`
|
||||
once from repo root and parse JSON for FEATURE_DIR and AVAILABLE_DOCS. Derive absolute paths:
|
||||
|
||||
- SPEC = FEATURE_DIR/spec.md
|
||||
- PLAN = FEATURE_DIR/plan.md
|
||||
- TASKS = FEATURE_DIR/tasks.md
|
||||
|
||||
Abort with an error message if any required file is missing (instruct the user to run missing
|
||||
prerequisite command). For single quotes in args like "I'm Groot", use escape syntax: e.g 'I'\''m
|
||||
Groot' (or double-quote if possible: "I'm Groot").
|
||||
|
||||
### 2. Load Artifacts (Progressive Disclosure)
|
||||
|
||||
Load only the minimal necessary context from each artifact:
|
||||
|
||||
**From spec.md:**
|
||||
|
||||
- Overview/Context
|
||||
- Functional Requirements
|
||||
- Success Criteria (measurable outcomes — e.g., performance, security, availability, user success,
|
||||
business impact)
|
||||
- User Stories
|
||||
- Edge Cases (if present)
|
||||
|
||||
**From plan.md:**
|
||||
|
||||
- Architecture/stack choices
|
||||
- Data Model references
|
||||
- Phases
|
||||
- Technical constraints
|
||||
|
||||
**From tasks.md:**
|
||||
|
||||
- Task IDs
|
||||
- Descriptions
|
||||
- Phase grouping
|
||||
- Parallel markers [P]
|
||||
- Referenced file paths
|
||||
|
||||
**From constitution:**
|
||||
|
||||
- Load `.specify/memory/constitution.md` for principle validation
|
||||
|
||||
### 3. Build Semantic Models
|
||||
|
||||
Create internal representations (do not include raw artifacts in output):
|
||||
|
||||
- **Requirements inventory**: For each Functional Requirement (FR-###) and Success Criterion
|
||||
(SC-###), record a stable key. Use the explicit FR-/SC- identifier as the primary key when
|
||||
present, and optionally also derive an imperative-phrase slug for readability (e.g., "User can
|
||||
upload file" → `user-can-upload-file`). Include only Success Criteria items that require buildable
|
||||
work (e.g., load-testing infrastructure, security audit tooling), and exclude post-launch outcome
|
||||
metrics and business KPIs (e.g., "Reduce support tickets by 50%").
|
||||
- **User story/action inventory**: Discrete user actions with acceptance criteria
|
||||
- **Task coverage mapping**: Map each task to one or more requirements or stories (inference by
|
||||
keyword / explicit reference patterns like IDs or key phrases)
|
||||
- **Constitution rule set**: Extract principle names and MUST/SHOULD normative statements
|
||||
|
||||
### 4. Detection Passes (Token-Efficient Analysis)
|
||||
|
||||
Focus on high-signal findings. Limit to 50 findings total; aggregate remainder in overflow summary.
|
||||
|
||||
#### A. Duplication Detection
|
||||
|
||||
- Identify near-duplicate requirements
|
||||
- Mark lower-quality phrasing for consolidation
|
||||
|
||||
#### B. Ambiguity Detection
|
||||
|
||||
- Flag vague adjectives (fast, scalable, secure, intuitive, robust) lacking measurable criteria
|
||||
- Flag unresolved placeholders (TODO, TKTK, ???, `<placeholder>`, etc.)
|
||||
|
||||
#### C. Underspecification
|
||||
|
||||
- Requirements with verbs but missing object or measurable outcome
|
||||
- User stories missing acceptance criteria alignment
|
||||
- Tasks referencing files or components not defined in spec/plan
|
||||
|
||||
#### D. Constitution Alignment
|
||||
|
||||
- Any requirement or plan element conflicting with a MUST principle
|
||||
- Missing mandated sections or quality gates from constitution
|
||||
|
||||
#### E. Coverage Gaps
|
||||
|
||||
- Requirements with zero associated tasks
|
||||
- Tasks with no mapped requirement/story
|
||||
- Success Criteria requiring buildable work (performance, security, availability) not reflected in
|
||||
tasks
|
||||
|
||||
#### F. Inconsistency
|
||||
|
||||
- Terminology drift (same concept named differently across files)
|
||||
- Data entities referenced in plan but absent in spec (or vice versa)
|
||||
- Task ordering contradictions (e.g., integration tasks before foundational setup tasks without
|
||||
dependency note)
|
||||
- Conflicting requirements (e.g., one requires Next.js while other specifies Vue)
|
||||
|
||||
### 5. Severity Assignment
|
||||
|
||||
Use this heuristic to prioritize findings:
|
||||
|
||||
- **CRITICAL**: Violates constitution MUST, missing core spec artifact, or requirement with zero
|
||||
coverage that blocks baseline functionality
|
||||
- **HIGH**: Duplicate or conflicting requirement, ambiguous security/performance attribute,
|
||||
untestable acceptance criterion
|
||||
- **MEDIUM**: Terminology drift, missing non-functional task coverage, underspecified edge case
|
||||
- **LOW**: Style/wording improvements, minor redundancy not affecting execution order
|
||||
|
||||
### 6. Produce Compact Analysis Report
|
||||
|
||||
Output a Markdown report (no file writes) with the following structure:
|
||||
|
||||
## Specification Analysis Report
|
||||
|
||||
| ID | Category | Severity | Location(s) | Summary | Recommendation |
|
||||
| --- | ----------- | -------- | ---------------- | ---------------------------- | ------------------------------------ |
|
||||
| A1 | Duplication | HIGH | spec.md:L120-134 | Two similar requirements ... | Merge phrasing; keep clearer version |
|
||||
|
||||
(Add one row per finding; generate stable IDs prefixed by category initial.)
|
||||
|
||||
**Coverage Summary Table:**
|
||||
|
||||
| Requirement Key | Has Task? | Task IDs | Notes |
|
||||
| --------------- | --------- | -------- | ----- |
|
||||
|
||||
**Constitution Alignment Issues:** (if any)
|
||||
|
||||
**Unmapped Tasks:** (if any)
|
||||
|
||||
**Metrics:**
|
||||
|
||||
- Total Requirements
|
||||
- Total Tasks
|
||||
- Coverage % (requirements with >=1 task)
|
||||
- Ambiguity Count
|
||||
- Duplication Count
|
||||
- Critical Issues Count
|
||||
|
||||
### 7. Provide Next Actions
|
||||
|
||||
At end of report, output a concise Next Actions block:
|
||||
|
||||
- If CRITICAL issues exist: Recommend resolving before `/speckit.implement`
|
||||
- If only LOW/MEDIUM: User may proceed, but provide improvement suggestions
|
||||
- Provide explicit command suggestions: e.g., "Run /speckit.specify with refinement", "Run
|
||||
/speckit.plan to adjust architecture", "Manually edit tasks.md to add coverage for
|
||||
'performance-metrics'"
|
||||
|
||||
### 8. Offer Remediation
|
||||
|
||||
Ask the user: "Would you like me to suggest concrete remediation edits for the top N issues?" (Do
|
||||
NOT apply them automatically.)
|
||||
|
||||
### 9. Check for extension hooks
|
||||
|
||||
After reporting, check if `.specify/extensions.yml` exists in the project root.
|
||||
|
||||
- If it exists, read it and look for entries under the `hooks.after_analyze` key
|
||||
- If the YAML cannot be parsed or is invalid, do not skip silently: tell the user that
|
||||
`.specify/extensions.yml` could not be read (include the parser error) and that no hooks were
|
||||
checked, including any mandatory (`optional: false`) hooks registered there, then continue
|
||||
normally
|
||||
- Filter out hooks where `enabled` is explicitly `false`. Treat hooks without an `enabled` field as
|
||||
enabled by default.
|
||||
- For each remaining hook, do **not** attempt to interpret or evaluate hook `condition` expressions:
|
||||
- If the hook has no `condition` field, or it is null/empty, treat the hook as executable
|
||||
- If the hook defines a non-empty `condition`, skip the hook and leave condition evaluation to
|
||||
the HookExecutor implementation
|
||||
- For each executable hook, output the following based on its `optional` flag:
|
||||
- **Optional hook** (`optional: true`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Optional Hook**: {extension}
|
||||
Command: `/{command}`
|
||||
Description: {description}
|
||||
|
||||
Prompt: {prompt}
|
||||
To execute: `/{command}`
|
||||
```
|
||||
|
||||
- **Mandatory hook** (`optional: false`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Automatic Hook**: {extension}
|
||||
Executing: `/{command}`
|
||||
EXECUTE_COMMAND: {command}
|
||||
```
|
||||
|
||||
After emitting the block above you MUST actually invoke the hook and wait for it to finish
|
||||
before continuing. Run it the same way you would run the command yourself in this
|
||||
agent/session (the invocation may differ from the literal `{command}` id shown above, e.g. a
|
||||
skills-mode agent runs it as `/skill:speckit-...` or `$speckit-...`). Emitting the block
|
||||
alone does not run the hook.
|
||||
|
||||
- If no hooks are registered or `.specify/extensions.yml` does not exist, skip silently
|
||||
|
||||
## Operating Principles
|
||||
|
||||
### Context Efficiency
|
||||
|
||||
- **Minimal high-signal tokens**: Focus on actionable findings, not exhaustive documentation
|
||||
- **Progressive disclosure**: Load artifacts incrementally; don't dump all content into analysis
|
||||
- **Token-efficient output**: Limit findings table to 50 rows; summarize overflow
|
||||
- **Deterministic results**: Rerunning without changes should produce consistent IDs and counts
|
||||
|
||||
### Analysis Guidelines
|
||||
|
||||
- **NEVER modify files** (this is read-only analysis)
|
||||
- **NEVER hallucinate missing sections** (if absent, report them accurately)
|
||||
- **Prioritize constitution violations** (these are always CRITICAL)
|
||||
- **Use examples over exhaustive rules** (cite specific instances, not generic patterns)
|
||||
- **Report zero issues gracefully** (emit success report with coverage statistics)
|
||||
|
||||
## Context
|
||||
|
||||
$ARGUMENTS
|
||||
@@ -0,0 +1,450 @@
|
||||
---
|
||||
description: Generate a custom checklist for the current feature based on user requirements.
|
||||
---
|
||||
|
||||
## Checklist Purpose: "Unit Tests for English"
|
||||
|
||||
**CRITICAL CONCEPT**: Checklists are **UNIT TESTS FOR REQUIREMENTS WRITING** - they validate the
|
||||
quality, clarity, and completeness of requirements in a given domain.
|
||||
|
||||
**NOT for verification/testing**:
|
||||
|
||||
- ❌ NOT "Verify the button clicks correctly"
|
||||
- ❌ NOT "Test error handling works"
|
||||
- ❌ NOT "Confirm the API returns 200"
|
||||
- ❌ NOT checking if code/implementation matches the spec
|
||||
|
||||
**FOR requirements quality validation**:
|
||||
|
||||
- ✅ "Are visual hierarchy requirements defined for all card types?" (completeness)
|
||||
- ✅ "Is 'prominent display' quantified with specific sizing/positioning?" (clarity)
|
||||
- ✅ "Are hover state requirements consistent across all interactive elements?" (consistency)
|
||||
- ✅ "Are accessibility requirements defined for keyboard navigation?" (coverage)
|
||||
- ✅ "Does the spec define what happens when logo image fails to load?" (edge cases)
|
||||
|
||||
**Metaphor**: If your spec is code written in English, the checklist is its unit test suite. You're
|
||||
testing whether the requirements are well-written, complete, unambiguous, and ready for
|
||||
implementation - NOT whether the implementation works.
|
||||
|
||||
**Ownership and checkbox lifecycle**:
|
||||
|
||||
- Custom checklists generated by this command are reviewer-owned requirements-quality review
|
||||
artifacts.
|
||||
- `[x]` means the reviewer determined the requirements-quality criterion is satisfied.
|
||||
- `[x]` does NOT mean implementation work is complete.
|
||||
- This command generates or appends checklist items; it MUST NOT mark generated items `[x]`.
|
||||
- An agent may assist with evaluating items only when explicitly asked by the reviewer.
|
||||
- `checklists/requirements.md` is a separate built-in spec-quality checklist maintained by
|
||||
`/speckit.specify` and `/speckit.clarify`; do not treat that exception as applying to custom
|
||||
checklists generated here.
|
||||
|
||||
## User Input
|
||||
|
||||
```text
|
||||
$ARGUMENTS
|
||||
```
|
||||
|
||||
You **MUST** consider the user input before proceeding (if not empty).
|
||||
|
||||
## Pre-Execution Checks
|
||||
|
||||
**Check for extension hooks (before checklist generation)**:
|
||||
|
||||
- Check if `.specify/extensions.yml` exists in the project root.
|
||||
- If it exists, read it and look for entries under the `hooks.before_checklist` key
|
||||
- If the YAML cannot be parsed or is invalid, do not skip silently: tell the user that
|
||||
`.specify/extensions.yml` could not be read (include the parser error) and that no hooks were
|
||||
checked, including any mandatory (`optional: false`) hooks registered there, then continue
|
||||
normally
|
||||
- Filter out hooks where `enabled` is explicitly `false`. Treat hooks without an `enabled` field as
|
||||
enabled by default.
|
||||
- For each remaining hook, do **not** attempt to interpret or evaluate hook `condition` expressions:
|
||||
- If the hook has no `condition` field, or it is null/empty, treat the hook as executable
|
||||
- If the hook defines a non-empty `condition`, skip the hook and leave condition evaluation to
|
||||
the HookExecutor implementation
|
||||
- For each executable hook, output the following based on its `optional` flag:
|
||||
- **Optional hook** (`optional: true`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Optional Pre-Hook**: {extension}
|
||||
Command: `/{command}`
|
||||
Description: {description}
|
||||
|
||||
Prompt: {prompt}
|
||||
To execute: `/{command}`
|
||||
```
|
||||
|
||||
- **Mandatory hook** (`optional: false`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Automatic Pre-Hook**: {extension}
|
||||
Executing: `/{command}`
|
||||
EXECUTE_COMMAND: {command}
|
||||
|
||||
Wait for the result of the hook command before proceeding to the Execution Steps.
|
||||
```
|
||||
|
||||
After emitting the block above you MUST actually invoke the hook and wait for it to finish
|
||||
before continuing. Run it the same way you would run the command yourself in this
|
||||
agent/session (the invocation may differ from the literal `{command}` id shown above, e.g. a
|
||||
skills-mode agent runs it as `/skill:speckit-...` or `$speckit-...`). Emitting the block
|
||||
alone does not run the hook.
|
||||
|
||||
- If no hooks are registered or `.specify/extensions.yml` does not exist, skip silently
|
||||
|
||||
## Execution Steps
|
||||
|
||||
1. **Setup**: Run
|
||||
`.specify/scripts/bash/check-prerequisites.sh --json --template checklist-template` from repo
|
||||
root and parse JSON for FEATURE_DIR, AVAILABLE_DOCS list, and TEMPLATE_CONTENT.
|
||||
- All file paths must be absolute.
|
||||
- For single quotes in args like "I'm Groot", use escape syntax: e.g 'I'\''m Groot' (or
|
||||
double-quote if possible: "I'm Groot").
|
||||
|
||||
2. **IF EXISTS**: Load `.specify/memory/constitution.md` for project principles and governance
|
||||
constraints.
|
||||
|
||||
3. **Clarify intent (dynamic)**: Derive up to THREE initial contextual clarifying questions (no
|
||||
pre-baked catalog). They MUST:
|
||||
- Be generated from the user's phrasing + extracted signals from spec/plan/tasks
|
||||
- Only ask about information that materially changes checklist content
|
||||
- Be skipped individually if already unambiguous in `$ARGUMENTS`
|
||||
- Prefer precision over breadth
|
||||
|
||||
Generation algorithm:
|
||||
1. Extract signals: feature domain keywords (e.g., auth, latency, UX, API), risk indicators
|
||||
("critical", "must", "compliance"), stakeholder hints ("QA", "review", "security team"), and
|
||||
explicit deliverables ("a11y", "rollback", "contracts").
|
||||
2. Cluster signals into candidate focus areas (max 4) ranked by relevance.
|
||||
3. Identify probable audience & timing (author, reviewer, QA, release) if not explicit.
|
||||
4. Detect missing dimensions: scope breadth, depth/rigor, risk emphasis, exclusion boundaries,
|
||||
measurable acceptance criteria.
|
||||
5. Formulate questions chosen from these archetypes:
|
||||
- Scope refinement (e.g., "Should this include integration touchpoints with X and Y or stay
|
||||
limited to local module correctness?")
|
||||
- Risk prioritization (e.g., "Which of these potential risk areas should receive mandatory
|
||||
gating checks?")
|
||||
- Depth calibration (e.g., "Is this a lightweight pre-commit sanity list or a formal release
|
||||
gate?")
|
||||
- Audience framing (e.g., "Will this be used by the author only or peers during PR review?")
|
||||
- Boundary exclusion (e.g., "Should we explicitly exclude performance tuning items this
|
||||
round?")
|
||||
- Scenario class gap (e.g., "No recovery flows detected—are rollback / partial failure paths
|
||||
in scope?")
|
||||
|
||||
Question formatting rules:
|
||||
- If presenting options, generate a compact table with columns: Option | Candidate | Why It
|
||||
Matters
|
||||
- Limit to A–E options maximum; omit table if a free-form answer is clearer
|
||||
- Never ask the user to restate what they already said
|
||||
- Avoid speculative categories (no hallucination). If uncertain, ask explicitly: "Confirm
|
||||
whether X belongs in scope."
|
||||
|
||||
Defaults when interaction impossible:
|
||||
- Depth: Standard
|
||||
- Audience: Reviewer (PR) if code-related; Author otherwise
|
||||
- Focus: Top 2 relevance clusters
|
||||
|
||||
Output the questions (label Q1/Q2/Q3). After answers: if ≥2 scenario classes (Alternate /
|
||||
Exception / Recovery / Non-Functional domain) remain unclear, you MAY ask up to TWO more
|
||||
targeted follow‑ups (Q4/Q5) with a one-line justification each (e.g., "Unresolved recovery path
|
||||
risk"). Do not exceed five total questions. Skip escalation if user explicitly declines more.
|
||||
|
||||
4. **Understand user request**: Combine `$ARGUMENTS` + clarifying answers:
|
||||
- Derive checklist theme (e.g., security, review, deploy, ux)
|
||||
- Consolidate explicit must-have items mentioned by user
|
||||
- Map focus selections to category scaffolding
|
||||
- Infer any missing context from spec/plan/tasks (do NOT hallucinate)
|
||||
|
||||
5. **Load feature context**: Read from FEATURE_DIR:
|
||||
- spec.md: Feature requirements and scope
|
||||
- plan.md (if exists): Technical details, dependencies
|
||||
- tasks.md (if exists): Implementation tasks
|
||||
|
||||
**Context Loading Strategy**:
|
||||
- Load only necessary portions relevant to active focus areas (avoid full-file dumping)
|
||||
- Prefer summarizing long sections into concise scenario/requirement bullets
|
||||
- Use progressive disclosure: add follow-on retrieval only if gaps detected
|
||||
- If source docs are large, generate interim summary items instead of embedding raw text
|
||||
|
||||
6. **Generate checklist** - Use TEMPLATE_CONTENT as the structural template and create "Unit Tests
|
||||
for Requirements":
|
||||
- Create `FEATURE_DIR/checklists/` directory if it doesn't exist
|
||||
- Generate unique checklist filename:
|
||||
- Use short, descriptive name based on domain (e.g., `ux.md`, `api.md`, `security.md`)
|
||||
- Format: `[domain].md`
|
||||
- File handling behavior:
|
||||
- If file does NOT exist: Create new file and number items starting from CHK001
|
||||
- If file exists: Append new items to existing file, continuing from the last CHK ID (e.g.,
|
||||
if last item is CHK015, start new items at CHK016)
|
||||
- Never delete or replace existing checklist content - always preserve and append
|
||||
- Leave every newly generated item unchecked (`[ ]`); checkbox state belongs to the reviewer
|
||||
|
||||
**CORE PRINCIPLE - Test the Requirements, Not the Implementation**: Every checklist item MUST
|
||||
evaluate the REQUIREMENTS THEMSELVES for:
|
||||
- **Completeness**: Are all necessary requirements present?
|
||||
- **Clarity**: Are requirements unambiguous and specific?
|
||||
- **Consistency**: Do requirements align with each other?
|
||||
- **Measurability**: Can requirements be objectively verified?
|
||||
- **Coverage**: Are all scenarios/edge cases addressed?
|
||||
|
||||
**Category Structure** - Group items by requirement quality dimensions:
|
||||
- **Requirement Completeness** (Are all necessary requirements documented?)
|
||||
- **Requirement Clarity** (Are requirements specific and unambiguous?)
|
||||
- **Requirement Consistency** (Do requirements align without conflicts?)
|
||||
- **Acceptance Criteria Quality** (Are success criteria measurable?)
|
||||
- **Scenario Coverage** (Are all flows/cases addressed?)
|
||||
- **Edge Case Coverage** (Are boundary conditions defined?)
|
||||
- **Non-Functional Requirements** (Performance, Security, Accessibility, etc. - are they
|
||||
specified?)
|
||||
- **Dependencies & Assumptions** (Are they documented and validated?)
|
||||
- **Ambiguities & Conflicts** (What needs clarification?)
|
||||
|
||||
**HOW TO WRITE CHECKLIST ITEMS - "Unit Tests for English"**:
|
||||
|
||||
❌ **WRONG** (Testing implementation):
|
||||
- "Verify landing page displays 3 episode cards"
|
||||
- "Test hover states work on desktop"
|
||||
- "Confirm logo click navigates home"
|
||||
|
||||
✅ **CORRECT** (Testing requirements quality):
|
||||
- "Are the exact number and layout of featured episodes specified?" [Completeness]
|
||||
- "Is 'prominent display' quantified with specific sizing/positioning?" [Clarity]
|
||||
- "Are hover state requirements consistent across all interactive elements?" [Consistency]
|
||||
- "Are keyboard navigation requirements defined for all interactive UI?" [Coverage]
|
||||
- "Is the fallback behavior specified when logo image fails to load?" [Edge Cases]
|
||||
- "Are loading states defined for asynchronous episode data?" [Completeness]
|
||||
- "Does the spec define visual hierarchy for competing UI elements?" [Clarity]
|
||||
|
||||
**ITEM STRUCTURE**: Each item should follow this pattern:
|
||||
- Question format asking about requirement quality
|
||||
- Focus on what's WRITTEN (or not written) in the spec/plan
|
||||
- Include quality dimension in brackets [Completeness/Clarity/Consistency/etc.]
|
||||
- Reference spec section `[Spec §X.Y]` when checking existing requirements
|
||||
- Use `[Gap]` marker when checking for missing requirements
|
||||
|
||||
**EXAMPLES BY QUALITY DIMENSION**:
|
||||
|
||||
Completeness:
|
||||
- "Are error handling requirements defined for all API failure modes? [Gap]"
|
||||
- "Are accessibility requirements specified for all interactive elements? [Completeness]"
|
||||
- "Are mobile breakpoint requirements defined for responsive layouts? [Gap]"
|
||||
|
||||
Clarity:
|
||||
- "Is 'fast loading' quantified with specific timing thresholds? [Clarity, Spec §NFR-2]"
|
||||
- "Are 'related episodes' selection criteria explicitly defined? [Clarity, Spec §FR-5]"
|
||||
- "Is 'prominent' defined with measurable visual properties? [Ambiguity, Spec §FR-4]"
|
||||
|
||||
Consistency:
|
||||
- "Do navigation requirements align across all pages? [Consistency, Spec §FR-10]"
|
||||
- "Are card component requirements consistent between landing and detail pages? [Consistency]"
|
||||
|
||||
Coverage:
|
||||
- "Are requirements defined for zero-state scenarios (no episodes)? [Coverage, Edge Case]"
|
||||
- "Are concurrent user interaction scenarios addressed? [Coverage, Gap]"
|
||||
- "Are requirements specified for partial data loading failures? [Coverage, Exception Flow]"
|
||||
|
||||
Measurability:
|
||||
- "Are visual hierarchy requirements measurable/testable? [Acceptance Criteria, Spec §FR-1]"
|
||||
- "Can 'balanced visual weight' be objectively verified? [Measurability, Spec §FR-2]"
|
||||
|
||||
**Scenario Classification & Coverage** (Requirements Quality Focus):
|
||||
- Check if requirements exist for: Primary, Alternate, Exception/Error, Recovery, Non-Functional
|
||||
scenarios
|
||||
- For each scenario class, ask: "Are [scenario type] requirements complete, clear, and
|
||||
consistent?"
|
||||
- If scenario class missing: "Are [scenario type] requirements intentionally excluded or
|
||||
missing? [Gap]"
|
||||
- Include resilience/rollback when state mutation occurs: "Are rollback requirements defined for
|
||||
migration failures? [Gap]"
|
||||
|
||||
**Traceability Requirements**:
|
||||
- MINIMUM: ≥80% of items MUST include at least one traceability reference
|
||||
- Each item should reference: spec section `[Spec §X.Y]`, or use markers: `[Gap]`,
|
||||
`[Ambiguity]`, `[Conflict]`, `[Assumption]`
|
||||
- If no ID system exists: "Is a requirement & acceptance criteria ID scheme established?
|
||||
[Traceability]"
|
||||
|
||||
**Surface & Resolve Issues** (Requirements Quality Problems): Ask questions about the
|
||||
requirements themselves:
|
||||
- Ambiguities: "Is the term 'fast' quantified with specific metrics? [Ambiguity, Spec §NFR-1]"
|
||||
- Conflicts: "Do navigation requirements conflict between §FR-10 and §FR-10a? [Conflict]"
|
||||
- Assumptions: "Is the assumption of 'always available podcast API' validated? [Assumption]"
|
||||
- Dependencies: "Are external podcast API requirements documented? [Dependency, Gap]"
|
||||
- Missing definitions: "Is 'visual hierarchy' defined with measurable criteria? [Gap]"
|
||||
|
||||
**Content Consolidation**:
|
||||
- Soft cap: If raw candidate items > 40, prioritize by risk/impact
|
||||
- Merge near-duplicates checking the same requirement aspect
|
||||
- If >5 low-impact edge cases, create one item: "Are edge cases X, Y, Z addressed in
|
||||
requirements? [Coverage]"
|
||||
|
||||
**🚫 ABSOLUTELY PROHIBITED** - These make it an implementation test, not a requirements test:
|
||||
- ❌ Any item starting with "Verify", "Test", "Confirm", "Check" + implementation behavior
|
||||
- ❌ References to code execution, user actions, system behavior
|
||||
- ❌ "Displays correctly", "works properly", "functions as expected"
|
||||
- ❌ "Click", "navigate", "render", "load", "execute"
|
||||
- ❌ Test cases, test plans, QA procedures
|
||||
- ❌ Implementation details (frameworks, APIs, algorithms)
|
||||
|
||||
**✅ REQUIRED PATTERNS** - These test requirements quality:
|
||||
- ✅ "Are [requirement type] defined/specified/documented for [scenario]?"
|
||||
- ✅ "Is [vague term] quantified/clarified with specific criteria?"
|
||||
- ✅ "Are requirements consistent between [section A] and [section B]?"
|
||||
- ✅ "Can [requirement] be objectively measured/verified?"
|
||||
- ✅ "Are [edge cases/scenarios] addressed in requirements?"
|
||||
- ✅ "Does the spec define [missing aspect]?"
|
||||
|
||||
7. **Structure Reference**: Generate the checklist following the canonical template in
|
||||
`.specify/templates/checklist-template.md` for title, meta section, category headings, ownership
|
||||
note, notes section, and ID formatting. If template is unavailable, use: H1 title,
|
||||
purpose/created meta lines, an ownership note explaining that `[x]` means reviewer approval of
|
||||
requirements quality, `##` category sections containing `- [ ] CHK### <requirement item>` lines
|
||||
with globally incrementing IDs starting at CHK001, and notes that `/speckit.implement` reads
|
||||
checklist state but does not modify markers.
|
||||
|
||||
8. **Report**: Output full path to checklist file, item count, and summarize whether the run created
|
||||
a new file or appended to an existing one. Summarize:
|
||||
- Focus areas selected
|
||||
- Depth level
|
||||
- Actor/timing
|
||||
- Any explicit user-specified must-have items incorporated
|
||||
|
||||
**Important**: Each `/speckit.checklist` command invocation uses a short, descriptive checklist
|
||||
filename and either creates a new file or appends to an existing one. This allows:
|
||||
|
||||
- Multiple checklists of different types (e.g., `ux.md`, `test.md`, `security.md`)
|
||||
- Simple, memorable filenames that indicate checklist purpose
|
||||
- Easy identification and navigation in the `checklists/` folder
|
||||
|
||||
To avoid clutter, use descriptive types and clean up obsolete checklists when done.
|
||||
|
||||
## Example Checklist Types & Sample Items
|
||||
|
||||
**UX Requirements Quality:** `ux.md`
|
||||
|
||||
Sample items (testing the requirements, NOT the implementation):
|
||||
|
||||
- "Are visual hierarchy requirements defined with measurable criteria? [Clarity, Spec §FR-1]"
|
||||
- "Is the number and positioning of UI elements explicitly specified? [Completeness, Spec §FR-1]"
|
||||
- "Are interaction state requirements (hover, focus, active) consistently defined? [Consistency]"
|
||||
- "Are accessibility requirements specified for all interactive elements? [Coverage, Gap]"
|
||||
- "Is fallback behavior defined when images fail to load? [Edge Case, Gap]"
|
||||
- "Can 'prominent display' be objectively measured? [Measurability, Spec §FR-4]"
|
||||
|
||||
**API Requirements Quality:** `api.md`
|
||||
|
||||
Sample items:
|
||||
|
||||
- "Are error response formats specified for all failure scenarios? [Completeness]"
|
||||
- "Are rate limiting requirements quantified with specific thresholds? [Clarity]"
|
||||
- "Are authentication requirements consistent across all endpoints? [Consistency]"
|
||||
- "Are retry/timeout requirements defined for external dependencies? [Coverage, Gap]"
|
||||
- "Is versioning strategy documented in requirements? [Gap]"
|
||||
|
||||
**Performance Requirements Quality:** `performance.md`
|
||||
|
||||
Sample items:
|
||||
|
||||
- "Are performance requirements quantified with specific metrics? [Clarity]"
|
||||
- "Are performance targets defined for all critical user journeys? [Coverage]"
|
||||
- "Are performance requirements under different load conditions specified? [Completeness]"
|
||||
- "Can performance requirements be objectively measured? [Measurability]"
|
||||
- "Are degradation requirements defined for high-load scenarios? [Edge Case, Gap]"
|
||||
|
||||
**Security Requirements Quality:** `security.md`
|
||||
|
||||
Sample items:
|
||||
|
||||
- "Are authentication requirements specified for all protected resources? [Coverage]"
|
||||
- "Are data protection requirements defined for sensitive information? [Completeness]"
|
||||
- "Is the threat model documented and requirements aligned to it? [Traceability]"
|
||||
- "Are security requirements consistent with compliance obligations? [Consistency]"
|
||||
- "Are security failure/breach response requirements defined? [Gap, Exception Flow]"
|
||||
|
||||
## Anti-Examples: What NOT To Do
|
||||
|
||||
**❌ WRONG - These test implementation, not requirements:**
|
||||
|
||||
```markdown
|
||||
- [ ] CHK001 - Verify landing page displays 3 episode cards [Spec §FR-001]
|
||||
- [ ] CHK002 - Test hover states work correctly on desktop [Spec §FR-003]
|
||||
- [ ] CHK003 - Confirm logo click navigates to home page [Spec §FR-010]
|
||||
- [ ] CHK004 - Check that related episodes section shows 3-5 items [Spec §FR-005]
|
||||
```
|
||||
|
||||
**✅ CORRECT - These test requirements quality:**
|
||||
|
||||
```markdown
|
||||
- [ ] CHK001 - Are the number and layout of featured episodes explicitly specified? [Completeness,
|
||||
Spec §FR-001]
|
||||
- [ ] CHK002 - Are hover state requirements consistently defined for all interactive elements?
|
||||
[Consistency, Spec §FR-003]
|
||||
- [ ] CHK003 - Are navigation requirements clear for all clickable brand elements? [Clarity, Spec
|
||||
§FR-010]
|
||||
- [ ] CHK004 - Is the selection criteria for related episodes documented? [Gap, Spec §FR-005]
|
||||
- [ ] CHK005 - Are loading state requirements defined for asynchronous episode data? [Gap]
|
||||
- [ ] CHK006 - Can "visual hierarchy" requirements be objectively measured? [Measurability, Spec
|
||||
§FR-001]
|
||||
```
|
||||
|
||||
**Key Differences:**
|
||||
|
||||
- Wrong: Tests if the system works correctly
|
||||
- Correct: Tests if the requirements are written correctly
|
||||
- Wrong: Verification of behavior
|
||||
- Correct: Validation of requirement quality
|
||||
- Wrong: "Does it do X?"
|
||||
- Correct: "Is X clearly specified?"
|
||||
|
||||
## Post-Execution Checks
|
||||
|
||||
**Check for extension hooks (after checklist generation)**: Check if `.specify/extensions.yml`
|
||||
exists in the project root.
|
||||
|
||||
- If it exists, read it and look for entries under the `hooks.after_checklist` key
|
||||
- If the YAML cannot be parsed or is invalid, do not skip silently: tell the user that
|
||||
`.specify/extensions.yml` could not be read (include the parser error) and that no hooks were
|
||||
checked, including any mandatory (`optional: false`) hooks registered there, then continue
|
||||
normally
|
||||
- Filter out hooks where `enabled` is explicitly `false`. Treat hooks without an `enabled` field as
|
||||
enabled by default.
|
||||
- For each remaining hook, do **not** attempt to interpret or evaluate hook `condition` expressions:
|
||||
- If the hook has no `condition` field, or it is null/empty, treat the hook as executable
|
||||
- If the hook defines a non-empty `condition`, skip the hook and leave condition evaluation to
|
||||
the HookExecutor implementation
|
||||
- For each executable hook, output the following based on its `optional` flag:
|
||||
- **Optional hook** (`optional: true`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Optional Hook**: {extension}
|
||||
Command: `/{command}`
|
||||
Description: {description}
|
||||
|
||||
Prompt: {prompt}
|
||||
To execute: `/{command}`
|
||||
```
|
||||
|
||||
- **Mandatory hook** (`optional: false`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Automatic Hook**: {extension}
|
||||
Executing: `/{command}`
|
||||
EXECUTE_COMMAND: {command}
|
||||
```
|
||||
|
||||
After emitting the block above you MUST actually invoke the hook and wait for it to finish
|
||||
before continuing. Run it the same way you would run the command yourself in this
|
||||
agent/session (the invocation may differ from the literal `{command}` id shown above, e.g. a
|
||||
skills-mode agent runs it as `/skill:speckit-...` or `$speckit-...`). Emitting the block
|
||||
alone does not run the hook.
|
||||
|
||||
- If no hooks are registered or `.specify/extensions.yml` does not exist, skip silently
|
||||
@@ -0,0 +1,386 @@
|
||||
---
|
||||
description:
|
||||
Identify underspecified areas in the current feature spec by asking up to 5 highly targeted
|
||||
clarification questions and encoding answers back into the spec.
|
||||
handoffs:
|
||||
- label: Build Technical Plan
|
||||
agent: speckit.plan
|
||||
prompt: Create a plan for the spec. I am building with...
|
||||
---
|
||||
|
||||
## User Input
|
||||
|
||||
```text
|
||||
$ARGUMENTS
|
||||
```
|
||||
|
||||
You **MUST** consider the user input before proceeding (if not empty).
|
||||
|
||||
## Pre-Execution Checks
|
||||
|
||||
**Check for extension hooks (before clarification)**:
|
||||
|
||||
- Check if `.specify/extensions.yml` exists in the project root.
|
||||
- If it exists, read it and look for entries under the `hooks.before_clarify` key
|
||||
- If the YAML cannot be parsed or is invalid, do not skip silently: tell the user that
|
||||
`.specify/extensions.yml` could not be read (include the parser error) and that no hooks were
|
||||
checked, including any mandatory (`optional: false`) hooks registered there, then continue
|
||||
normally
|
||||
- Filter out hooks where `enabled` is explicitly `false`. Treat hooks without an `enabled` field as
|
||||
enabled by default.
|
||||
- For each remaining hook, do **not** attempt to interpret or evaluate hook `condition` expressions:
|
||||
- If the hook has no `condition` field, or it is null/empty, treat the hook as executable
|
||||
- If the hook defines a non-empty `condition`, skip the hook and leave condition evaluation to
|
||||
the HookExecutor implementation
|
||||
- For each executable hook, output the following based on its `optional` flag:
|
||||
- **Optional hook** (`optional: true`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Optional Pre-Hook**: {extension}
|
||||
Command: `/{command}`
|
||||
Description: {description}
|
||||
|
||||
Prompt: {prompt}
|
||||
To execute: `/{command}`
|
||||
```
|
||||
|
||||
- **Mandatory hook** (`optional: false`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Automatic Pre-Hook**: {extension}
|
||||
Executing: `/{command}`
|
||||
EXECUTE_COMMAND: {command}
|
||||
|
||||
Wait for the result of the hook command before proceeding to the Outline.
|
||||
```
|
||||
|
||||
After emitting the block above you MUST actually invoke the hook and wait for it to finish
|
||||
before continuing. Run it the same way you would run the command yourself in this
|
||||
agent/session (the invocation may differ from the literal `{command}` id shown above, e.g. a
|
||||
skills-mode agent runs it as `/skill:speckit-...` or `$speckit-...`). Emitting the block
|
||||
alone does not run the hook.
|
||||
|
||||
- If no hooks are registered or `.specify/extensions.yml` does not exist, skip silently
|
||||
|
||||
## Outline
|
||||
|
||||
Goal: Detect and reduce ambiguity or missing decision points in the active feature specification and
|
||||
record the clarifications directly in the spec file.
|
||||
|
||||
Note: This clarification workflow is expected to run (and be completed) BEFORE invoking
|
||||
`/speckit.plan`. If the user explicitly states they are skipping clarification (e.g., exploratory
|
||||
spike), you may proceed, but must warn that downstream rework risk increases.
|
||||
|
||||
Execution steps:
|
||||
|
||||
1. Run `.specify/scripts/bash/check-prerequisites.sh --json --paths-only` from repo root **once**
|
||||
(combined `--json --paths-only` mode / `-Json -PathsOnly`). Parse minimal JSON payload fields:
|
||||
- `FEATURE_DIR`
|
||||
- `FEATURE_SPEC`
|
||||
- (Optionally capture `IMPL_PLAN`, `TASKS` for future chained flows.)
|
||||
- If JSON parsing fails, abort and instruct user to re-run `/speckit.specify` or verify feature
|
||||
branch environment.
|
||||
- For single quotes in args like "I'm Groot", use escape syntax: e.g 'I'\''m Groot' (or
|
||||
double-quote if possible: "I'm Groot").
|
||||
|
||||
2. **IF EXISTS**: Load `.specify/memory/constitution.md` for project principles and governance
|
||||
constraints.
|
||||
|
||||
3. Load the current spec file. Perform a structured ambiguity & coverage scan using this taxonomy.
|
||||
For each category, mark status: Clear / Partial / Missing. Produce an internal coverage map used
|
||||
for prioritization (do not output raw map unless no questions will be asked).
|
||||
|
||||
Functional Scope & Behavior:
|
||||
- Core user goals & success criteria
|
||||
- Explicit out-of-scope declarations
|
||||
- User roles / personas differentiation
|
||||
|
||||
Domain & Data Model:
|
||||
- Entities, attributes, relationships
|
||||
- Identity & uniqueness rules
|
||||
- Lifecycle/state transitions
|
||||
- Data volume / scale assumptions
|
||||
|
||||
Interaction & UX Flow:
|
||||
- Critical user journeys / sequences
|
||||
- Error/empty/loading states
|
||||
- Accessibility or localization notes
|
||||
|
||||
Non-Functional Quality Attributes:
|
||||
- Performance (latency, throughput targets)
|
||||
- Scalability (horizontal/vertical, limits)
|
||||
- Reliability & availability (uptime, recovery expectations)
|
||||
- Observability (logging, metrics, tracing signals)
|
||||
- Security & privacy (authN/Z, data protection, threat assumptions)
|
||||
- Compliance / regulatory constraints (if any)
|
||||
|
||||
Integration & External Dependencies:
|
||||
- External services/APIs and failure modes
|
||||
- Data import/export formats
|
||||
- Protocol/versioning assumptions
|
||||
|
||||
Edge Cases & Failure Handling:
|
||||
- Negative scenarios
|
||||
- Rate limiting / throttling
|
||||
- Conflict resolution (e.g., concurrent edits)
|
||||
|
||||
Constraints & Tradeoffs:
|
||||
- Technical constraints (language, storage, hosting)
|
||||
- Explicit tradeoffs or rejected alternatives
|
||||
|
||||
Terminology & Consistency:
|
||||
- Canonical glossary terms
|
||||
- Avoided synonyms / deprecated terms
|
||||
|
||||
Completion Signals:
|
||||
- Acceptance criteria testability
|
||||
- Measurable Definition of Done style indicators
|
||||
|
||||
Misc / Placeholders:
|
||||
- TODO markers / unresolved decisions
|
||||
- Ambiguous adjectives ("robust", "intuitive") lacking quantification
|
||||
|
||||
For each category with Partial or Missing status, add a candidate question opportunity unless:
|
||||
- Clarification would not materially change implementation or validation strategy
|
||||
- The item is specifically about implementation method, tech-stack comparison, or task breakdown
|
||||
(note internally)
|
||||
|
||||
4. Generate (internally) a prioritized queue of candidate clarification questions (maximum 5). Do
|
||||
NOT output them all at once. Apply these constraints:
|
||||
- Maximum of 5 total questions across the whole session.
|
||||
- Each question must be answerable with EITHER:
|
||||
- A short multiple‑choice selection (2–5 distinct, mutually exclusive options), OR
|
||||
- A one-word / short‑phrase answer (explicitly constrain: "Answer in <=5 words").
|
||||
- Only include questions whose answers materially impact architecture, data modeling, task
|
||||
decomposition, test design, UX behavior, operational readiness, or compliance validation.
|
||||
- Ensure category coverage balance: attempt to cover the highest impact unresolved categories
|
||||
first; avoid asking two low-impact questions when a single high-impact area (e.g., security
|
||||
posture) is unresolved.
|
||||
- Exclude questions already answered, trivial stylistic preferences, or plan-level execution
|
||||
details (unless blocking correctness).
|
||||
- Favor clarifications that reduce downstream rework risk or prevent misaligned acceptance
|
||||
tests.
|
||||
- If more than 5 categories remain unresolved, select the top 5 by (Impact \* Uncertainty)
|
||||
heuristic.
|
||||
|
||||
5. Sequential questioning loop (interactive):
|
||||
- Present EXACTLY ONE question at a time.
|
||||
- **Question writing quality (applies to every question, MC or short-answer):**
|
||||
- Lead with `**Question:**` followed by a full interrogative that ends with `?`. The
|
||||
question text before the `?` must make sense on its own.
|
||||
- NEVER use a topic label, section heading, or requirement id as the question itself. For
|
||||
example, `Acceptance device/runtime matrix (FR-023)` is INVALID — it is a label, not a
|
||||
question.
|
||||
- After the `?`, the only permitted suffix is an optional parenthesized requirement/question
|
||||
id. Exact format: `**Question:** <interrogative>?` or
|
||||
`**Question:** <interrogative>? (FR-023)`. Never put the id before the `?`, and never use
|
||||
the id (alone or with a topic label) as the whole prompt.
|
||||
- Immediately after the question line, add one plain-language "Why it matters" sentence (the
|
||||
stake for acceptance or shipping) before the recommendation/options.
|
||||
- Use everyday wording; introduce jargon only if defined in the same sentence. Self-check: a
|
||||
reader who does not know Spec Kit must be able to answer from the Question line alone.
|
||||
Terse is fine; cryptic labels are not.
|
||||
- For multiple‑choice questions:
|
||||
- **Analyze all options** and determine the **most suitable option** based on:
|
||||
- Best practices for the project type
|
||||
- Common patterns in similar implementations
|
||||
- Risk reduction (security, performance, maintainability)
|
||||
- Alignment with any explicit project goals or constraints visible in the spec
|
||||
- Present your **recommended option prominently** at the top with clear reasoning (1-2
|
||||
sentences explaining why this is the best choice).
|
||||
- Format as: `**Recommended:** Option [X] - <reasoning>`
|
||||
- Then render all options as a Markdown table:
|
||||
|
||||
| Option | Description |
|
||||
| ------ | --------------------------------------------------------------------------------------------------- |
|
||||
| A | <Option A description> |
|
||||
| B | <Option B description> |
|
||||
| C | <Option C description> (add D/E as needed up to 5) |
|
||||
| Short | Provide a different short answer (<=5 words) (Include only if free-form alternative is appropriate) |
|
||||
- After the table, add:
|
||||
`You can reply with the option letter (e.g., "A"), accept the recommendation by saying "yes" or "recommended", or provide your own short answer.`
|
||||
|
||||
- For short‑answer style (no meaningful discrete options):
|
||||
- Provide your **suggested answer** based on best practices and context.
|
||||
- Format as: `**Suggested:** <your proposed answer> - <brief reasoning>`
|
||||
- Then output:
|
||||
`Format: Short answer (<=5 words). You can accept the suggestion by saying "yes" or "suggested", or provide your own answer.`
|
||||
- After the user answers:
|
||||
- If the user replies with "yes", "recommended", or "suggested", use your previously stated
|
||||
recommendation/suggestion as the answer.
|
||||
- Otherwise, validate the answer maps to one option or fits the <=5 word constraint.
|
||||
- If ambiguous, ask for a quick disambiguation (count still belongs to same question; do not
|
||||
advance).
|
||||
- Once satisfactory, record it in working memory (do not yet write to disk) and move to the
|
||||
next queued question.
|
||||
- Stop asking further questions when:
|
||||
- All critical ambiguities resolved early (remaining queued items become unnecessary), OR
|
||||
- User signals completion ("done", "good", "no more"), OR
|
||||
- You reach 5 asked questions.
|
||||
- Never reveal future queued questions in advance.
|
||||
- If no valid questions exist at start, immediately report no critical ambiguities.
|
||||
|
||||
6. Integration after EACH accepted answer (incremental update approach):
|
||||
- Maintain in-memory representation of the spec (loaded once at start) plus the raw file
|
||||
contents.
|
||||
- For the first integrated answer in this session:
|
||||
- Ensure a `## Clarifications` section exists (create it just after the highest-level
|
||||
contextual/overview section per the spec template if missing).
|
||||
- Under it, create (if not present) a `### Session YYYY-MM-DD` subheading for today.
|
||||
- Append a bullet line immediately after acceptance: `- Q: <question> → A: <final answer>`.
|
||||
- Then immediately apply the clarification to the most appropriate section(s):
|
||||
- Functional ambiguity → Update or add a bullet in Functional Requirements.
|
||||
- User interaction / actor distinction → Update User Stories or Actors subsection (if
|
||||
present) with clarified role, constraint, or scenario.
|
||||
- Data shape / entities → Update Data Model (add fields, types, relationships) preserving
|
||||
ordering; note added constraints succinctly.
|
||||
- Non-functional constraint → Add/modify measurable criteria in Success Criteria >
|
||||
Measurable Outcomes (convert vague adjective to metric or explicit target).
|
||||
- Edge case / negative flow → Add a new bullet under Edge Cases / Error Handling (or create
|
||||
such subsection if template provides placeholder for it).
|
||||
- Terminology conflict → Normalize term across spec; retain original only if necessary by
|
||||
adding `(formerly referred to as "X")` once.
|
||||
- If the clarification invalidates an earlier ambiguous statement, replace that statement
|
||||
instead of duplicating; leave no obsolete contradictory text.
|
||||
- Save the spec file AFTER each integration to minimize risk of context loss (atomic overwrite).
|
||||
- Preserve formatting: do not reorder unrelated sections; keep heading hierarchy intact.
|
||||
- Keep each inserted clarification minimal and testable (avoid narrative drift).
|
||||
|
||||
7. Validation (performed after EACH write plus final pass):
|
||||
- Clarifications session contains exactly one bullet per accepted answer (no duplicates).
|
||||
- Total asked (accepted) questions ≤ 5.
|
||||
- Updated sections contain no lingering vague placeholders the new answer was meant to resolve.
|
||||
- No contradictory earlier statement remains (scan for now-invalid alternative choices removed).
|
||||
- Markdown structure valid; only allowed new headings: `## Clarifications`,
|
||||
`### Session YYYY-MM-DD`.
|
||||
- Terminology consistency: same canonical term used across all updated sections.
|
||||
|
||||
8. Write the updated spec back to `FEATURE_SPEC`.
|
||||
|
||||
9. **Re-validate Spec Quality Checklist** (if it exists):
|
||||
- Check if `FEATURE_DIR/checklists/requirements.md` exists.
|
||||
- If it does NOT exist, skip this step silently.
|
||||
- If it exists:
|
||||
1. Read the checklist file.
|
||||
2. Identify all GitHub task-list checkbox lines — lines matching `- [ ]`, `- [x]`, or
|
||||
`- [X]` (case-insensitive, tolerant of leading whitespace for nested items) outside of
|
||||
code fences. Ignore all other content (headings, notes, non-checkbox bullets, metadata).
|
||||
3. For each checkbox line, record its current marker state (checked or unchecked) and item
|
||||
text into a before-snapshot list.
|
||||
4. Re-evaluate each checkbox item against the **updated** spec (the version just saved in
|
||||
step 7).
|
||||
5. For each checkbox item, update only if the checked/unchecked state actually changes:
|
||||
- If the item now passes and was unchecked: change `[ ]` to `[x]`.
|
||||
- If the item now fails and was checked: change `[x]`/`[X]` to `[ ]`.
|
||||
- If the state is unchanged: leave the marker as-is (preserve existing case to avoid
|
||||
cosmetic diffs).
|
||||
6. Save the updated checklist file. **Only toggle the `[ ]`/`[x]` marker portion of checkbox
|
||||
lines whose state changed.** All other file content — headings, metadata, notes, line
|
||||
ordering, whitespace — must remain unchanged to avoid noisy diffs.
|
||||
7. Compare the before-snapshot with the current state to compute three lists for the
|
||||
Completion Report:
|
||||
- **Newly passing**: items that changed from unchecked to checked.
|
||||
- **Regressions**: items that changed from checked to unchecked.
|
||||
- **Still unchecked**: items that remain unchecked.
|
||||
8. Record the before/after pass counts as checked/total checkbox items (e.g., "12/16 → 15/16
|
||||
items passing").
|
||||
|
||||
Behavior rules:
|
||||
|
||||
- If no meaningful ambiguities found (or all potential questions would be low-impact), respond: "No
|
||||
critical ambiguities detected worth formal clarification." and suggest proceeding.
|
||||
- If spec file missing, instruct user to run `/speckit.specify` first (do not create a new spec
|
||||
here).
|
||||
- Never exceed 5 total asked questions (clarification retries for a single question do not count as
|
||||
new questions).
|
||||
- Avoid speculative tech stack questions unless the absence blocks functional clarity.
|
||||
- Respect user early termination signals ("stop", "done", "proceed").
|
||||
- If no questions asked due to full coverage, output a compact coverage summary (all categories
|
||||
Clear) then suggest advancing.
|
||||
- If quota reached with unresolved high-impact categories remaining, explicitly flag them under
|
||||
Deferred with rationale.
|
||||
|
||||
Context for prioritization: $ARGUMENTS
|
||||
|
||||
## Mandatory Post-Execution Hooks
|
||||
|
||||
**You MUST complete this section before reporting completion to the user.**
|
||||
|
||||
Check if `.specify/extensions.yml` exists in the project root.
|
||||
|
||||
- If it does not exist, or no hooks are registered under `hooks.after_clarify`, skip to the
|
||||
Completion Report.
|
||||
- If it exists, read it and look for entries under the `hooks.after_clarify` key.
|
||||
- If the YAML cannot be parsed or is invalid, do not skip silently: tell the user that
|
||||
`.specify/extensions.yml` could not be read (include the parser error) and that no hooks were
|
||||
checked, including any mandatory (`optional: false`) hooks registered there, then continue to the
|
||||
Completion Report.
|
||||
- Filter out hooks where `enabled` is explicitly `false`. Treat hooks without an `enabled` field as
|
||||
enabled by default.
|
||||
- For each remaining hook, do **not** attempt to interpret or evaluate hook `condition` expressions:
|
||||
- If the hook has no `condition` field, or it is null/empty, treat the hook as executable
|
||||
- If the hook defines a non-empty `condition`, skip the hook and leave condition evaluation to
|
||||
the HookExecutor implementation
|
||||
- For each executable hook, output the following based on its `optional` flag:
|
||||
- **Mandatory hook** (`optional: false`) — **You MUST emit `EXECUTE_COMMAND:` for each mandatory
|
||||
hook**:
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Automatic Hook**: {extension}
|
||||
Executing: `/{command}`
|
||||
EXECUTE_COMMAND: {command}
|
||||
```
|
||||
|
||||
After emitting the block above you MUST actually invoke the hook and wait for it to finish
|
||||
before continuing. Run it the same way you would run the command yourself in this
|
||||
agent/session (the invocation may differ from the literal `{command}` id shown above, e.g. a
|
||||
skills-mode agent runs it as `/skill:speckit-...` or `$speckit-...`). Emitting the block
|
||||
alone does not run the hook.
|
||||
|
||||
- **Optional hook** (`optional: true`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Optional Hook**: {extension}
|
||||
Command: `/{command}`
|
||||
Description: {description}
|
||||
|
||||
Prompt: {prompt}
|
||||
To execute: `/{command}`
|
||||
```
|
||||
|
||||
## Completion Report
|
||||
|
||||
Report completion (after questioning loop ends or early termination):
|
||||
|
||||
- Number of questions asked & answered.
|
||||
- Path to updated spec.
|
||||
- Sections touched (list names).
|
||||
- Spec quality checklist status (if `FEATURE_DIR/checklists/requirements.md` was re-validated): show
|
||||
before/after pass counts (e.g., "Spec Quality Checklist: 12/16 → 15/16 items passing") and list
|
||||
any items that changed state — both newly checked (unchecked → checked) and any regressions
|
||||
(checked → unchecked). If any items remain unchecked, list them as areas needing attention.
|
||||
- Coverage summary table listing each taxonomy category with Status: Resolved (was Partial/Missing
|
||||
and addressed), Deferred (exceeds question quota, or remaining item is specifically implementation
|
||||
method, tech-stack comparison, or task breakdown), Clear (already sufficient), Outstanding (still
|
||||
Partial/Missing but low impact).
|
||||
- If any Outstanding or Deferred remain, recommend whether to proceed to `/speckit.plan` or run
|
||||
`/speckit.clarify` again later post-plan.
|
||||
- Suggested next command.
|
||||
|
||||
## Done When
|
||||
|
||||
- [ ] Spec ambiguities identified and clarifications integrated into spec file
|
||||
- [ ] Spec quality checklist re-validated against updated spec (if
|
||||
`FEATURE_DIR/checklists/requirements.md` exists)
|
||||
- [ ] Extension hooks dispatched or skipped according to the rules in Mandatory Post-Execution Hooks
|
||||
above
|
||||
- [ ] Completion reported to user with questions answered, sections touched, checklist status, and
|
||||
coverage summary
|
||||
@@ -0,0 +1,220 @@
|
||||
---
|
||||
description:
|
||||
Create or update the project constitution from interactive or provided principle inputs.
|
||||
handoffs:
|
||||
- label: Build Specification
|
||||
agent: speckit.specify
|
||||
prompt:
|
||||
Implement the feature specification based on the updated constitution. I want to build...
|
||||
---
|
||||
|
||||
## User Input
|
||||
|
||||
```text
|
||||
$ARGUMENTS
|
||||
```
|
||||
|
||||
You **MUST** consider the user input before proceeding (if not empty).
|
||||
|
||||
## Scope Guard
|
||||
|
||||
This command's own work is limited to updating the project constitution itself. Dependent templates
|
||||
and commands read the constitution at runtime and are not modified here.
|
||||
|
||||
- Classify every part of the user input as either constitution content or a separate, non-governance
|
||||
intent.
|
||||
- If the input includes feature implementation, code generation, refactoring, building, or
|
||||
deployment requests, you **MUST NOT** execute them. Extract them as deferred intents instead.
|
||||
- You **MUST NOT** create, modify, or delete application source files, feature routes, components,
|
||||
tests, deployment files, or other artifacts unrelated to the constitution workflow.
|
||||
- If it is unclear whether an instruction is constitution content, ask for clarification before
|
||||
making changes.
|
||||
- After completing the constitution update, include a `Next Actions` section for each deferred
|
||||
intent. List the original intent and suggest the appropriate follow-up Spec Kit command, such as
|
||||
`/speckit.specify`, without invoking it.
|
||||
- If there are no non-governance intents, omit the `Next Actions` section.
|
||||
|
||||
## Pre-Execution Checks
|
||||
|
||||
**Check for extension hooks (before constitution update)**:
|
||||
|
||||
- Check if `.specify/extensions.yml` exists in the project root.
|
||||
- If it exists, read it and look for entries under the `hooks.before_constitution` key
|
||||
- If the YAML cannot be parsed or is invalid, do not skip silently: tell the user that
|
||||
`.specify/extensions.yml` could not be read (include the parser error) and that no hooks were
|
||||
checked, including any mandatory (`optional: false`) hooks registered there, then continue
|
||||
normally
|
||||
- Filter out hooks where `enabled` is explicitly `false`. Treat hooks without an `enabled` field as
|
||||
enabled by default.
|
||||
- For each remaining hook, do **not** attempt to interpret or evaluate hook `condition` expressions:
|
||||
- If the hook has no `condition` field, or it is null/empty, treat the hook as executable
|
||||
- If the hook defines a non-empty `condition`, skip the hook and leave condition evaluation to
|
||||
the HookExecutor implementation
|
||||
- For each executable hook, output the following based on its `optional` flag:
|
||||
- **Optional hook** (`optional: true`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Optional Pre-Hook**: {extension}
|
||||
Command: `/{command}`
|
||||
Description: {description}
|
||||
|
||||
Prompt: {prompt}
|
||||
To execute: `/{command}`
|
||||
```
|
||||
|
||||
- **Mandatory hook** (`optional: false`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Automatic Pre-Hook**: {extension}
|
||||
Executing: `/{command}`
|
||||
EXECUTE_COMMAND: {command}
|
||||
|
||||
Wait for the result of the hook command before proceeding to the Outline.
|
||||
```
|
||||
|
||||
After emitting the block above you MUST actually invoke the hook and wait for it to finish
|
||||
before continuing. Run it the same way you would run the command yourself in this
|
||||
agent/session (the invocation may differ from the literal `{command}` id shown above, e.g. a
|
||||
skills-mode agent runs it as `/skill:speckit-...` or `$speckit-...`). Emitting the block
|
||||
alone does not run the hook.
|
||||
|
||||
- If no hooks are registered or `.specify/extensions.yml` does not exist, skip silently
|
||||
|
||||
## Outline
|
||||
|
||||
You are updating the project constitution at `.specify/memory/constitution.md`. The active
|
||||
constitution scaffold is resolved at command time from `constitution-template` through the Spec Kit
|
||||
preset/template resolution stack.
|
||||
|
||||
Follow this execution flow:
|
||||
|
||||
1. Run `.specify/scripts/bash/resolve-template.sh constitution-template --json` from the repository
|
||||
root and parse `TEMPLATE_CONTENT` as the active template.
|
||||
- The shared resolver applies project overrides, composing preset layers, and extension layers
|
||||
before the core template fallback. It MUST succeed before continuing.
|
||||
- If it fails, stop and report the resolution error; do not continue with only one contributing
|
||||
template layer.
|
||||
- If `.specify/memory/constitution.md` exists, load it as the source of current project-specific
|
||||
values and amendments. Preserve information that is still applicable when applying the newly
|
||||
resolved scaffold.
|
||||
- If it does not exist, use the resolved template as the initial document.
|
||||
- Do not write back to any versioned template layer.
|
||||
- Identify every placeholder token of the form `[ALL_CAPS_IDENTIFIER]`. **IMPORTANT**: The user
|
||||
might require less or more principles than the ones used in the template. If a number is
|
||||
specified, respect that - follow the general template. You will update the doc accordingly.
|
||||
|
||||
2. Collect/derive values for placeholders:
|
||||
- If user input (conversation) supplies a value, use it.
|
||||
- Otherwise infer from existing repo context (README, docs, prior constitution versions if
|
||||
embedded).
|
||||
- For governance dates: `RATIFICATION_DATE` is the original adoption date (if unknown ask or
|
||||
mark TODO), `LAST_AMENDED_DATE` is today if changes are made, otherwise keep previous.
|
||||
- `CONSTITUTION_VERSION` must increment according to semantic versioning rules:
|
||||
- MAJOR: Backward incompatible governance/principle removals or redefinitions.
|
||||
- MINOR: New principle/section added or materially expanded guidance.
|
||||
- PATCH: Clarifications, wording, typo fixes, non-semantic refinements.
|
||||
- If version bump type ambiguous, propose reasoning before finalizing.
|
||||
|
||||
3. Draft the updated constitution content using the resolved template as the required structure:
|
||||
- Replace every placeholder with concrete text (no bracketed tokens left except intentionally
|
||||
retained template slots that the project has chosen not to define yet—explicitly justify any
|
||||
left).
|
||||
- Preserve heading hierarchy and comments can be removed once replaced unless they still add
|
||||
clarifying guidance.
|
||||
- Ensure each Principle section: succinct name line, paragraph (or bullet list) capturing
|
||||
non‑negotiable rules, explicit rationale if not obvious.
|
||||
- Ensure Governance section lists amendment procedure, versioning policy, and compliance review
|
||||
expectations.
|
||||
|
||||
4. Produce a Sync Impact Report as an HTML comment at the top of the constitution file after update.
|
||||
This report is temporary scratch material for human review of the amendment, not governance
|
||||
content; it is expected to be removed before the amended constitution file is committed.
|
||||
- Version change: old → new
|
||||
- List of modified principles (old title → new title if renamed)
|
||||
- Added sections
|
||||
- Removed sections
|
||||
- Follow-up TODOs if any placeholders intentionally deferred.
|
||||
|
||||
5. Validation before final output:
|
||||
- No remaining unexplained bracket tokens.
|
||||
- Version line matches report.
|
||||
- Dates ISO format YYYY-MM-DD.
|
||||
- Principles are declarative, testable, and free of vague language ("should" → replace with
|
||||
MUST/SHOULD rationale where appropriate).
|
||||
|
||||
6. Write the completed constitution back to `.specify/memory/constitution.md` (overwrite).
|
||||
|
||||
7. Output a final summary to the user with:
|
||||
- New version and bump rationale.
|
||||
- Any TODO placeholders or deferred items requiring manual follow-up.
|
||||
- Suggested commit message (e.g.,
|
||||
`docs: amend constitution to vX.Y.Z (principle additions + governance update)`).
|
||||
- A `Next Actions` section for any deferred non-governance intents.
|
||||
|
||||
Formatting & Style Requirements:
|
||||
|
||||
- Use Markdown headings exactly as in the template (do not demote/promote levels).
|
||||
- Wrap long rationale lines to keep readability (<100 chars ideally) but do not hard enforce with
|
||||
awkward breaks.
|
||||
- Keep a single blank line between sections.
|
||||
- Avoid trailing whitespace.
|
||||
|
||||
If the user supplies partial updates (e.g., only one principle revision), still perform validation
|
||||
and version decision steps.
|
||||
|
||||
If critical info missing (e.g., ratification date truly unknown), insert
|
||||
`TODO(<FIELD_NAME>): explanation` and include in the Sync Impact Report under deferred items.
|
||||
|
||||
Write only `.specify/memory/constitution.md`; do not create or modify template source files.
|
||||
|
||||
## Post-Execution Checks
|
||||
|
||||
**Check for extension hooks (after constitution update)**: Check if `.specify/extensions.yml` exists
|
||||
in the project root.
|
||||
|
||||
- If it exists, read it and look for entries under the `hooks.after_constitution` key
|
||||
- If the YAML cannot be parsed or is invalid, do not skip silently: tell the user that
|
||||
`.specify/extensions.yml` could not be read (include the parser error) and that no hooks were
|
||||
checked, including any mandatory (`optional: false`) hooks registered there, then continue
|
||||
normally
|
||||
- Filter out hooks where `enabled` is explicitly `false`. Treat hooks without an `enabled` field as
|
||||
enabled by default.
|
||||
- For each remaining hook, do **not** attempt to interpret or evaluate hook `condition` expressions:
|
||||
- If the hook has no `condition` field, or it is null/empty, treat the hook as executable
|
||||
- If the hook defines a non-empty `condition`, skip the hook and leave condition evaluation to
|
||||
the HookExecutor implementation
|
||||
- For each executable hook, output the following based on its `optional` flag:
|
||||
- **Optional hook** (`optional: true`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Optional Hook**: {extension}
|
||||
Command: `/{command}`
|
||||
Description: {description}
|
||||
|
||||
Prompt: {prompt}
|
||||
To execute: `/{command}`
|
||||
```
|
||||
|
||||
- **Mandatory hook** (`optional: false`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Automatic Hook**: {extension}
|
||||
Executing: `/{command}`
|
||||
EXECUTE_COMMAND: {command}
|
||||
```
|
||||
|
||||
After emitting the block above you MUST actually invoke the hook and wait for it to finish
|
||||
before continuing. Run it the same way you would run the command yourself in this
|
||||
agent/session (the invocation may differ from the literal `{command}` id shown above, e.g. a
|
||||
skills-mode agent runs it as `/skill:speckit-...` or `$speckit-...`). Emitting the block
|
||||
alone does not run the hook.
|
||||
|
||||
- If no hooks are registered or `.specify/extensions.yml` does not exist, skip silently
|
||||
@@ -0,0 +1,298 @@
|
||||
---
|
||||
description:
|
||||
Assess the current codebase against the feature's spec, plan, and tasks, then append any
|
||||
remaining unbuilt work as new tasks to tasks.md so implement can complete it.
|
||||
---
|
||||
|
||||
## User Input
|
||||
|
||||
```text
|
||||
$ARGUMENTS
|
||||
```
|
||||
|
||||
You **MUST** consider the user input before proceeding (if not empty).
|
||||
|
||||
## Pre-Execution Checks
|
||||
|
||||
**Check for extension hooks (before convergence)**:
|
||||
|
||||
- Check if `.specify/extensions.yml` exists in the project root.
|
||||
- If it exists, read it and look for entries under the `hooks.before_converge` key
|
||||
- If the YAML cannot be parsed or is invalid, do not skip silently: tell the user that
|
||||
`.specify/extensions.yml` could not be read (include the parser error) and that no hooks were
|
||||
checked, including any mandatory (`optional: false`) hooks registered there, then continue
|
||||
normally
|
||||
- Filter out hooks where `enabled` is explicitly `false`. Treat hooks without an `enabled` field as
|
||||
enabled by default.
|
||||
- For each remaining hook, do **not** attempt to interpret or evaluate hook `condition` expressions:
|
||||
- If the hook has no `condition` field, or it is null/empty, treat the hook as executable
|
||||
- If the hook defines a non-empty `condition`, skip the hook and leave condition evaluation to
|
||||
the HookExecutor implementation
|
||||
- For each executable hook, output the following based on its `optional` flag:
|
||||
- **Optional hook** (`optional: true`):
|
||||
|
||||
```text
|
||||
## Extension Hooks
|
||||
|
||||
**Optional Pre-Hook**: {extension}
|
||||
Command: `/{command}`
|
||||
Description: {description}
|
||||
|
||||
Prompt: {prompt}
|
||||
To execute: `/{command}`
|
||||
```
|
||||
|
||||
- **Mandatory hook** (`optional: false`):
|
||||
|
||||
```text
|
||||
## Extension Hooks
|
||||
|
||||
**Automatic Pre-Hook**: {extension}
|
||||
Executing: `/{command}`
|
||||
EXECUTE_COMMAND: {command}
|
||||
|
||||
Wait for the result of the hook command before proceeding to the Goal.
|
||||
```
|
||||
|
||||
After emitting the block above you MUST actually invoke the hook and wait for it to finish
|
||||
before continuing. Run it the same way you would run the command yourself in this
|
||||
agent/session (the invocation may differ from the literal `{command}` id shown above, e.g. a
|
||||
skills-mode agent runs it as `/skill:speckit-...` or `$speckit-...`). Emitting the block
|
||||
alone does not run the hook.
|
||||
|
||||
- If no hooks are registered or `.specify/extensions.yml` does not exist, skip silently
|
||||
|
||||
## Goal
|
||||
|
||||
Close the gap between what a feature's specification, plan, and tasks call for and what the codebase
|
||||
currently implements. Read `spec.md`, `plan.md`, and `tasks.md` as the **sole source of intent**
|
||||
(with the constitution as governing constraints), assess the current state of the code, determine
|
||||
which requirements, acceptance criteria, plan decisions, and existing tasks are unmet, incomplete,
|
||||
or only partially satisfied, and **append each piece of remaining work as a new, traceable task** at
|
||||
the bottom of `tasks.md` so that `/speckit.implement` can complete it. This command MUST run only
|
||||
after `/speckit.implement` has run on the current `tasks.md`, and after `/speckit.tasks` has
|
||||
produced a complete `tasks.md`.
|
||||
|
||||
This is **not** a diff tool and does **not** track changes. It assesses the present state of the
|
||||
code relative to the feature's artifacts — no git, no branch comparison, no history.
|
||||
|
||||
## Operating Constraints
|
||||
|
||||
**APPEND-ONLY, NEVER REWRITE**: The command's **only** write is appending a new
|
||||
`## Phase N: Convergence` section to `tasks.md`. It MUST NOT:
|
||||
|
||||
- modify `spec.md` or `plan.md` in any way;
|
||||
- rewrite, renumber, reorder, or delete any existing task (including tasks from a prior Convergence
|
||||
phase);
|
||||
- modify, create, or delete any application code — completing the appended tasks is the job of
|
||||
`/speckit.implement`.
|
||||
|
||||
When the codebase already satisfies everything, the command MUST leave `tasks.md` **byte-for-byte
|
||||
unchanged** (no empty Convergence header) and report a clean result.
|
||||
|
||||
**Constitution Authority**: The project constitution (`.specify/memory/constitution.md`) is
|
||||
**non-negotiable**. Code that violates a MUST principle is the highest-severity finding and produces
|
||||
a corresponding remediation task. If the constitution is an unfilled template, skip constitution
|
||||
checks gracefully rather than failing.
|
||||
|
||||
## Execution Steps
|
||||
|
||||
### 1. Initialize Convergence Context
|
||||
|
||||
Run
|
||||
`.specify/scripts/bash/check-prerequisites.sh --json --require-spec --require-tasks --include-tasks`
|
||||
once from repo root and parse JSON for FEATURE_DIR and AVAILABLE_DOCS. Derive absolute paths:
|
||||
|
||||
- SPEC = FEATURE_DIR/spec.md
|
||||
- PLAN = FEATURE_DIR/plan.md
|
||||
- TASKS = FEATURE_DIR/tasks.md
|
||||
- CONSTITUTION = `.specify/memory/constitution.md` (if present) If `spec.md`, `plan.md`, or
|
||||
`tasks.md` is missing, STOP with a clear, actionable message naming the prerequisite command to
|
||||
run (`/speckit.specify` for a missing spec, `/speckit.plan` for a missing plan, `/speckit.tasks`
|
||||
for missing tasks). Do not produce partial output. For single quotes in args like "I'm Groot", use
|
||||
escape syntax: e.g 'I'\''m Groot' (or double-quote if possible: "I'm Groot").
|
||||
|
||||
### 2. Load Artifacts (Progressive Disclosure)
|
||||
|
||||
Load only the minimal necessary context from each artifact:
|
||||
|
||||
**From spec.md:**
|
||||
|
||||
- Functional Requirements (FR-###)
|
||||
- Success Criteria (SC-###) — include only items requiring buildable work; exclude post-launch
|
||||
outcome metrics and business KPIs
|
||||
- User Stories and their Acceptance Scenarios
|
||||
- Edge Cases (if present)
|
||||
|
||||
**From plan.md:**
|
||||
|
||||
- Architecture/stack choices and technical decisions
|
||||
- Data Model references
|
||||
- Phases and named touch-points (files/components the plan says will be created or edited)
|
||||
- Technical constraints
|
||||
|
||||
**From tasks.md:**
|
||||
|
||||
- Task IDs (to compute the next ID and next phase number)
|
||||
- Descriptions, phase grouping, and referenced file paths
|
||||
|
||||
**From constitution (if not an unfilled template):**
|
||||
|
||||
- Principle names and MUST/SHOULD normative statements
|
||||
|
||||
### 3. Build the Intent Inventory
|
||||
|
||||
Create an internal model (do not echo raw artifacts):
|
||||
|
||||
- **Requirements inventory**: one stable key per FR-### / SC-### / user-story acceptance scenario
|
||||
(e.g. `US1/AC2`), plus the plan decisions and constitution principles that impose buildable
|
||||
obligations.
|
||||
- **Code-scope map**: from the file paths named in `plan.md` and `tasks.md`, plus a keyword search
|
||||
for the concepts each requirement describes, derive the set of source files and components in
|
||||
scope for assessment. Bound the assessment to these — do **not** infer scope beyond what the
|
||||
artifacts define.
|
||||
|
||||
### 4. Assess the Codebase and Classify Findings
|
||||
|
||||
Include every existing task in the intent inventory, regardless of checkbox state or Convergence
|
||||
phase: completion claims are not evidence. Verify current behavior against the spec, plan, tasks,
|
||||
and constitution; for corrective task chains, assess the resulting behavior, not superseded
|
||||
implementation details. Check both unmet obligations and implementation that contradicts, exceeds,
|
||||
or falls outside the stated intent.
|
||||
|
||||
For each item in the intent inventory, inspect the current code in scope and produce a `Finding`
|
||||
only where there is a gap. Classify every finding by **gap type**:
|
||||
|
||||
- **`missing`**: the required work is absent from the code entirely.
|
||||
- **`partial`**: the work exists but does not yet fully satisfy the requirement / acceptance
|
||||
criterion / plan decision.
|
||||
- **`contradicts`**: the code does something that conflicts with stated intent or a constitution
|
||||
MUST principle.
|
||||
- **`unrequested`**: the code contains work not called for by the spec, plan, or tasks (surfaced for
|
||||
awareness — converge does **not** delete code, it only appends a task to review/justify or remove
|
||||
it).
|
||||
|
||||
Each `Finding` records: a stable id, the `source-ref` it traces to, the `gap-type`, a severity, and
|
||||
a short human-readable description with the evidence (the file/area observed).
|
||||
|
||||
**Edge cases:**
|
||||
|
||||
- **Little or no code yet**: treat the entire specified scope as `missing` remaining work rather
|
||||
than failing.
|
||||
- **Nothing remains**: produce zero findings and follow the converged branch in Step 7.
|
||||
|
||||
### 5. Assign Severity
|
||||
|
||||
- **CRITICAL**: violates a constitution MUST principle, or a `missing`/`contradicts` gap that blocks
|
||||
baseline functionality of a P1 user story.
|
||||
- **HIGH**: a `missing` or `partial` gap on a core functional requirement or acceptance criterion.
|
||||
- **MEDIUM**: a `partial` gap on a secondary requirement, or an `unrequested` addition with unclear
|
||||
justification.
|
||||
- **LOW**: minor partial gaps, polish, or low-risk `unrequested` additions.
|
||||
|
||||
### 6. Present the In-Session Findings Summary
|
||||
|
||||
Before appending anything, output a compact, severity-graded summary (no file writes yet):
|
||||
|
||||
## Convergence Findings
|
||||
|
||||
| ID | Gap Type | Severity | Source | Evidence | Remaining Work |
|
||||
| --- | -------- | -------- | ------ | --------------------------------------------------------------------------------- | --------------------------- |
|
||||
| F1 | missing | HIGH | FR-008 | Example: no append-only guard detected in path/to/module.py when writing tasks.md | Add append-only enforcement |
|
||||
|
||||
**Summary metrics:**
|
||||
|
||||
- Requirements / acceptance criteria checked
|
||||
- Plan decisions checked
|
||||
- Constitution principles checked (or "skipped — template")
|
||||
- Findings by gap type (missing / partial / contradicts / unrequested)
|
||||
- Findings by severity
|
||||
|
||||
### 7. Append Convergence Tasks (or report converged)
|
||||
|
||||
**If there are one or more actionable findings** (`tasks_appended` outcome):
|
||||
|
||||
Append to the **end** of `tasks.md`, per the append contract:
|
||||
|
||||
1. Scan all existing task IDs; let `M` be the maximum. Determine the next phase number `N` (highest
|
||||
existing phase + 1).
|
||||
2. Write a single new section header `## Phase N: Convergence`.
|
||||
3. Emit one checklist item per actionable finding, ordered CRITICAL/HIGH first, assigning
|
||||
zero-padded IDs `T{M+1:03d}, T{M+2:03d}, …`:
|
||||
|
||||
```markdown
|
||||
- [ ] T042 <imperative description> per <source-ref> (<gap-type>)
|
||||
```
|
||||
|
||||
`<source-ref>` traces the task to its origin: e.g. `FR-003`, `SC-002`, `US1/AC2`,
|
||||
`plan: storage decision`, `Constitution II`.
|
||||
|
||||
`<gap-type>` is one of `missing`, `partial`, `contradicts`, `unrequested`.
|
||||
|
||||
Constitution-violation tasks MUST be emitted first and described as `CRITICAL`.
|
||||
|
||||
4. Never reuse or renumber existing IDs. If a prior Convergence phase exists, add a new,
|
||||
separately-numbered one below it — do not touch the old one.
|
||||
|
||||
**If there are no actionable findings** (`converged` outcome):
|
||||
|
||||
- Do **not** modify `tasks.md` at all — no empty phase header.
|
||||
- Report: **"✅ Converged — the implementation satisfies the spec, plan, and tasks."**
|
||||
- Include the summary counts of what was checked.
|
||||
|
||||
### 8. Provide Next Actions (Handoff)
|
||||
|
||||
- On `tasks_appended`: state how many tasks were appended under which phase, and recommend running
|
||||
`/speckit.implement` to complete them; note that a follow-up converge run will find fewer or no
|
||||
remaining items.
|
||||
- On `converged`: recommend proceeding to review / opening a PR. No further implement pass is needed
|
||||
for this feature's specified scope.
|
||||
|
||||
### 9. Check for extension hooks
|
||||
|
||||
After producing the result, check if `.specify/extensions.yml` exists in the project root.
|
||||
|
||||
- If it exists, read it and look for entries under the `hooks.after_converge` key
|
||||
- If the YAML cannot be parsed or is invalid, do not skip silently: tell the user that
|
||||
`.specify/extensions.yml` could not be read (include the parser error) and that no hooks were
|
||||
checked, including any mandatory (`optional: false`) hooks registered there, then continue
|
||||
normally
|
||||
- Filter out hooks where `enabled` is explicitly `false`. Treat hooks without an `enabled` field as
|
||||
enabled by default.
|
||||
- For each remaining hook, do **not** attempt to interpret or evaluate hook `condition` expressions:
|
||||
- If the hook has no `condition` field, or it is null/empty, treat the hook as executable
|
||||
- If the hook defines a non-empty `condition`, skip the hook and leave condition evaluation to
|
||||
the HookExecutor implementation
|
||||
- Report the convergence outcome (`converged` or `tasks_appended`) in-session before listing any
|
||||
hooks, so users can decide whether to run optional follow-up commands.
|
||||
- For each executable hook, output the following based on its `optional` flag:
|
||||
- **Optional hook** (`optional: true`):
|
||||
|
||||
```text
|
||||
## Extension Hooks
|
||||
|
||||
**Optional Hook**: {extension}
|
||||
Command: `/{command}`
|
||||
Description: {description}
|
||||
|
||||
Prompt: {prompt}
|
||||
To execute: `/{command}`
|
||||
```
|
||||
|
||||
- **Mandatory hook** (`optional: false`):
|
||||
|
||||
```text
|
||||
## Extension Hooks
|
||||
|
||||
**Automatic Hook**: {extension}
|
||||
Executing: `/{command}`
|
||||
EXECUTE_COMMAND: {command}
|
||||
```
|
||||
|
||||
After emitting the block above you MUST actually invoke the hook and wait for it to finish
|
||||
before continuing. Run it the same way you would run the command yourself in this
|
||||
agent/session (the invocation may differ from the literal `{command}` id shown above, e.g. a
|
||||
skills-mode agent runs it as `/skill:speckit-...` or `$speckit-...`). Emitting the block
|
||||
alone does not run the hook.
|
||||
|
||||
- If no hooks are registered or `.specify/extensions.yml` does not exist, skip silently
|
||||
@@ -0,0 +1,270 @@
|
||||
---
|
||||
description:
|
||||
Execute the implementation plan by processing and executing all tasks defined in tasks.md
|
||||
---
|
||||
|
||||
## User Input
|
||||
|
||||
```text
|
||||
$ARGUMENTS
|
||||
```
|
||||
|
||||
You **MUST** consider the user input before proceeding (if not empty).
|
||||
|
||||
## Pre-Execution Checks
|
||||
|
||||
**Check for extension hooks (before implementation)**:
|
||||
|
||||
- Check if `.specify/extensions.yml` exists in the project root.
|
||||
- If it exists, read it and look for entries under the `hooks.before_implement` key
|
||||
- If the YAML cannot be parsed or is invalid, do not skip silently: tell the user that
|
||||
`.specify/extensions.yml` could not be read (include the parser error) and that no hooks were
|
||||
checked, including any mandatory (`optional: false`) hooks registered there, then continue
|
||||
normally
|
||||
- Filter out hooks where `enabled` is explicitly `false`. Treat hooks without an `enabled` field as
|
||||
enabled by default.
|
||||
- For each remaining hook, do **not** attempt to interpret or evaluate hook `condition` expressions:
|
||||
- If the hook has no `condition` field, or it is null/empty, treat the hook as executable
|
||||
- If the hook defines a non-empty `condition`, skip the hook and leave condition evaluation to
|
||||
the HookExecutor implementation
|
||||
- For each executable hook, output the following based on its `optional` flag:
|
||||
- **Optional hook** (`optional: true`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Optional Pre-Hook**: {extension}
|
||||
Command: `/{command}`
|
||||
Description: {description}
|
||||
|
||||
Prompt: {prompt}
|
||||
To execute: `/{command}`
|
||||
```
|
||||
|
||||
- **Mandatory hook** (`optional: false`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Automatic Pre-Hook**: {extension}
|
||||
Executing: `/{command}`
|
||||
EXECUTE_COMMAND: {command}
|
||||
|
||||
Wait for the result of the hook command before proceeding to the Outline.
|
||||
```
|
||||
|
||||
After emitting the block above you MUST actually invoke the hook and wait for it to finish
|
||||
before continuing. Run it the same way you would run the command yourself in this
|
||||
agent/session (the invocation may differ from the literal `{command}` id shown above, e.g. a
|
||||
skills-mode agent runs it as `/skill:speckit-...` or `$speckit-...`). Emitting the block
|
||||
alone does not run the hook.
|
||||
|
||||
- If no hooks are registered or `.specify/extensions.yml` does not exist, skip silently
|
||||
|
||||
## Outline
|
||||
|
||||
1. Run `.specify/scripts/bash/check-prerequisites.sh --json --require-tasks --include-tasks` from
|
||||
repo root and parse FEATURE_DIR and AVAILABLE_DOCS list. All paths must be absolute. For single
|
||||
quotes in args like "I'm Groot", use escape syntax: e.g 'I'\''m Groot' (or double-quote if
|
||||
possible: "I'm Groot").
|
||||
|
||||
2. **Check checklists status** (if FEATURE_DIR/checklists/ exists):
|
||||
- Treat checklist markers as a read-only gate: scan checkbox state, report status, and ask
|
||||
before proceeding when needed; do NOT modify checklist files or markers
|
||||
- `checklists/requirements.md` is the built-in spec-quality checklist maintained by
|
||||
`/speckit.specify` and `/speckit.clarify`; custom checklists generated by `/speckit.checklist`
|
||||
are reviewer-owned requirements-quality review artifacts
|
||||
- For custom checklists, `[x]` means the reviewer determined the requirements-quality criterion
|
||||
is satisfied; it does NOT mean implementation work is complete
|
||||
- Scan all checklist files in the checklists/ directory
|
||||
- For each checklist, count:
|
||||
- Total items: All lines matching `- [ ]` or `- [X]` or `- [x]`
|
||||
- Checked items: Lines matching `- [X]` or `- [x]`
|
||||
- Unchecked items: Lines matching `- [ ]`
|
||||
- Create a status table:
|
||||
|
||||
```text
|
||||
| Checklist | Total | Checked | Unchecked | Status |
|
||||
|-----------|-------|---------|-----------|--------|
|
||||
| ux.md | 12 | 12 | 0 | ✓ PASS |
|
||||
| test.md | 8 | 5 | 3 | ✗ FAIL |
|
||||
| security.md | 6 | 6 | 0 | ✓ PASS |
|
||||
```
|
||||
|
||||
- Calculate overall status:
|
||||
- **PASS**: All checklists have 0 unchecked items
|
||||
- **FAIL**: One or more checklists have unchecked items
|
||||
|
||||
- **If any checklist has unchecked items**:
|
||||
- Display the table with unchecked item counts
|
||||
- **STOP** and ask: "Some checklists have unchecked items. Do you want to proceed with
|
||||
implementation anyway? (yes/no)"
|
||||
- Wait for user response before continuing
|
||||
- If user says "no" or "wait" or "stop", halt execution
|
||||
- If user says "yes" or "proceed" or "continue", proceed to step 3
|
||||
|
||||
- **If all checklists are checked**:
|
||||
- Display the table showing all checklists passed
|
||||
- Automatically proceed to step 3
|
||||
|
||||
3. Load and analyze the implementation context:
|
||||
- **REQUIRED**: Read tasks.md for the complete task list and execution plan
|
||||
- **REQUIRED**: Read plan.md for tech stack, architecture, and file structure
|
||||
- **IF EXISTS**: Read data-model.md for entities and relationships
|
||||
- **IF EXISTS**: Read contracts/ for API specifications and test requirements
|
||||
- **IF EXISTS**: Read research.md for technical decisions and constraints
|
||||
- **IF EXISTS**: Read .specify/memory/constitution.md for governance constraints
|
||||
- **IF EXISTS**: Read quickstart.md for integration scenarios
|
||||
|
||||
4. **Project Setup Verification**:
|
||||
- **REQUIRED**: Create/verify ignore files based on actual project setup:
|
||||
|
||||
**Detection & Creation Logic**:
|
||||
- Check if the following command succeeds to determine if the repository is a git repo
|
||||
(create/verify .gitignore if so):
|
||||
|
||||
```sh
|
||||
git rev-parse --git-dir 2>/dev/null
|
||||
```
|
||||
|
||||
- Check if Dockerfile\* exists or Docker in plan.md → create/verify .dockerignore
|
||||
- Check if .eslintrc\* exists → create/verify .eslintignore
|
||||
- Check if eslint.config.\* exists → ensure the config's `ignores` entries cover required
|
||||
patterns
|
||||
- Check if .prettierrc\* exists → create/verify .prettierignore
|
||||
- Check if .npmrc or package.json exists → create/verify .npmignore (if publishing)
|
||||
- Check if terraform files (\*.tf) exist → create/verify .terraformignore
|
||||
- Check if .helmignore needed (helm charts present) → create/verify .helmignore
|
||||
|
||||
**If ignore file already exists**: Verify it contains essential patterns, append missing
|
||||
critical patterns only **If ignore file missing**: Create with full pattern set for detected
|
||||
technology
|
||||
|
||||
**Common Patterns by Technology** (from plan.md tech stack):
|
||||
- **Node.js/JavaScript/TypeScript**: `node_modules/`, `dist/`, `build/`, `*.log`, `.env*`
|
||||
- **Python**: `__pycache__/`, `*.pyc`, `.venv/`, `venv/`, `dist/`, `*.egg-info/`
|
||||
- **Java**: `target/`, `*.class`, `*.jar`, `.gradle/`, `build/`
|
||||
- **C#/.NET**: `bin/`, `obj/`, `*.user`, `*.suo`, `packages/`
|
||||
- **Go**: `*.exe`, `*.test`, `vendor/`, `*.out`
|
||||
- **Ruby**: `.bundle/`, `log/`, `tmp/`, `*.gem`, `vendor/bundle/`
|
||||
- **PHP**: `vendor/`, `*.log`, `*.cache`, `*.env`
|
||||
- **Rust**: `target/`, `debug/`, `release/`, `*.rs.bk`, `*.rlib`, `*.prof*`, `.idea/`, `*.log`,
|
||||
`.env*`
|
||||
- **Kotlin**: `build/`, `out/`, `.gradle/`, `.idea/`, `*.class`, `*.jar`, `*.iml`, `*.log`,
|
||||
`.env*`
|
||||
- **C++**: `build/`, `bin/`, `obj/`, `out/`, `*.o`, `*.so`, `*.a`, `*.exe`, `*.dll`, `.idea/`,
|
||||
`*.log`, `.env*`
|
||||
- **C**: `build/`, `bin/`, `obj/`, `out/`, `*.o`, `*.a`, `*.so`, `*.exe`, `*.dll`,
|
||||
`autom4te.cache/`, `config.status`, `config.log`, `.idea/`, `*.log`, `.env*`
|
||||
- **Swift**: `.build/`, `DerivedData/`, `*.swiftpm/`, `Packages/`
|
||||
- **R**: `.Rproj.user/`, `.Rhistory`, `.RData`, `.Ruserdata`, `*.Rproj`, `packrat/`, `renv/`
|
||||
- **Universal**: `.DS_Store`, `Thumbs.db`, `*.tmp`, `*.swp`, `.vscode/`, `.idea/`
|
||||
|
||||
**Tool-Specific Patterns**:
|
||||
- **Docker**: `node_modules/`, `.git/`, `Dockerfile*`, `.dockerignore`, `*.log*`, `.env*`,
|
||||
`coverage/`
|
||||
- **ESLint**: `node_modules/`, `dist/`, `build/`, `coverage/`, `*.min.js`
|
||||
- **Prettier**: `node_modules/`, `dist/`, `build/`, `coverage/`, `package-lock.json`,
|
||||
`yarn.lock`, `pnpm-lock.yaml`
|
||||
- **Terraform**: `.terraform/`, `*.tfstate*`, `*.tfvars`, `.terraform.lock.hcl`
|
||||
- **Kubernetes/k8s**: `*.secret.yaml`, `secrets/`, `.kube/`, `kubeconfig*`, `*.key`, `*.crt`
|
||||
|
||||
5. Parse tasks.md structure and extract:
|
||||
- **Task phases**: Setup, Tests, Core, Integration, Polish
|
||||
- **Task dependencies**: Sequential vs parallel execution rules
|
||||
- **Task details**: ID, description, file paths, parallel markers [P]
|
||||
- **Execution flow**: Order and dependency requirements
|
||||
|
||||
6. Execute implementation following the task plan:
|
||||
- **Phase-by-phase execution**: Complete each phase before moving to the next
|
||||
- **Respect dependencies**: Run sequential tasks in order, parallel tasks [P] can run together
|
||||
- **Follow TDD approach**: Execute test tasks before their corresponding implementation tasks
|
||||
- **File-based coordination**: Tasks affecting the same files must run sequentially
|
||||
- **Validation checkpoints**: Verify each phase completion before proceeding
|
||||
|
||||
7. Implementation execution rules:
|
||||
- **Setup first**: Initialize project structure, dependencies, configuration
|
||||
- **Tests before code**: If you need to write tests for contracts, entities, and integration
|
||||
scenarios
|
||||
- **Core development**: Implement models, services, CLI commands, endpoints
|
||||
- **Integration work**: Database connections, middleware, logging, external services
|
||||
- **Polish and validation**: Unit tests, performance optimization, documentation
|
||||
|
||||
8. Progress tracking and error handling:
|
||||
- Report progress after each completed task
|
||||
- Halt execution if any non-parallel task fails
|
||||
- For parallel tasks [P], continue with successful tasks, report failed ones
|
||||
- Provide clear error messages with context for debugging
|
||||
- Suggest next steps if implementation cannot proceed
|
||||
- **IMPORTANT** For completed tasks, make sure to mark the task off as [X] in the tasks file.
|
||||
|
||||
9. Completion validation:
|
||||
- Verify all required tasks are completed
|
||||
- Check that implemented features match the original specification
|
||||
- Validate that tests pass and coverage meets requirements
|
||||
- Confirm the implementation follows the technical plan
|
||||
|
||||
Note: This command assumes a complete task breakdown exists in tasks.md. If tasks are incomplete or
|
||||
missing, suggest running `/speckit.tasks` first to regenerate the task list.
|
||||
|
||||
## Mandatory Post-Execution Hooks
|
||||
|
||||
**You MUST complete this section before reporting completion to the user.**
|
||||
|
||||
Check if `.specify/extensions.yml` exists in the project root.
|
||||
|
||||
- If it does not exist, or no hooks are registered under `hooks.after_implement`, skip to the
|
||||
Completion Report.
|
||||
- If it exists, read it and look for entries under the `hooks.after_implement` key.
|
||||
- If the YAML cannot be parsed or is invalid, do not skip silently: tell the user that
|
||||
`.specify/extensions.yml` could not be read (include the parser error) and that no hooks were
|
||||
checked, including any mandatory (`optional: false`) hooks registered there, then continue to the
|
||||
Completion Report.
|
||||
- Filter out hooks where `enabled` is explicitly `false`. Treat hooks without an `enabled` field as
|
||||
enabled by default.
|
||||
- For each remaining hook, do **not** attempt to interpret or evaluate hook `condition` expressions:
|
||||
- If the hook has no `condition` field, or it is null/empty, treat the hook as executable
|
||||
- If the hook defines a non-empty `condition`, skip the hook and leave condition evaluation to
|
||||
the HookExecutor implementation
|
||||
- For each executable hook, output the following based on its `optional` flag:
|
||||
- **Mandatory hook** (`optional: false`) — **You MUST emit `EXECUTE_COMMAND:` for each mandatory
|
||||
hook**:
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Automatic Hook**: {extension}
|
||||
Executing: `/{command}`
|
||||
EXECUTE_COMMAND: {command}
|
||||
```
|
||||
|
||||
After emitting the block above you MUST actually invoke the hook and wait for it to finish
|
||||
before continuing. Run it the same way you would run the command yourself in this
|
||||
agent/session (the invocation may differ from the literal `{command}` id shown above, e.g. a
|
||||
skills-mode agent runs it as `/skill:speckit-...` or `$speckit-...`). Emitting the block
|
||||
alone does not run the hook.
|
||||
|
||||
- **Optional hook** (`optional: true`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Optional Hook**: {extension}
|
||||
Command: `/{command}`
|
||||
Description: {description}
|
||||
|
||||
Prompt: {prompt}
|
||||
To execute: `/{command}`
|
||||
```
|
||||
|
||||
## Completion Report
|
||||
|
||||
Report final status with summary of completed work.
|
||||
|
||||
## Done When
|
||||
|
||||
- [ ] All tasks in tasks.md completed and marked `[X]`
|
||||
- [ ] Implementation validated against specification, plan, and test coverage
|
||||
- [ ] Extension hooks dispatched or skipped according to the rules in Mandatory Post-Execution Hooks
|
||||
above
|
||||
- [ ] Completion reported to user with summary of completed work
|
||||
@@ -0,0 +1,207 @@
|
||||
---
|
||||
description:
|
||||
Execute the implementation planning workflow using the plan template to generate design
|
||||
artifacts.
|
||||
handoffs:
|
||||
- label: Create Tasks
|
||||
agent: speckit.tasks
|
||||
prompt: Break the plan into tasks
|
||||
send: true
|
||||
- label: Create Checklist
|
||||
agent: speckit.checklist
|
||||
prompt: Create a checklist for the following domain...
|
||||
---
|
||||
|
||||
## User Input
|
||||
|
||||
```text
|
||||
$ARGUMENTS
|
||||
```
|
||||
|
||||
You **MUST** consider the user input before proceeding (if not empty).
|
||||
|
||||
## Pre-Execution Checks
|
||||
|
||||
**Check for extension hooks (before planning)**:
|
||||
|
||||
- Check if `.specify/extensions.yml` exists in the project root.
|
||||
- If it exists, read it and look for entries under the `hooks.before_plan` key
|
||||
- If the YAML cannot be parsed or is invalid, do not skip silently: tell the user that
|
||||
`.specify/extensions.yml` could not be read (include the parser error) and that no hooks were
|
||||
checked, including any mandatory (`optional: false`) hooks registered there, then continue
|
||||
normally
|
||||
- Filter out hooks where `enabled` is explicitly `false`. Treat hooks without an `enabled` field as
|
||||
enabled by default.
|
||||
- For each remaining hook, do **not** attempt to interpret or evaluate hook `condition` expressions:
|
||||
- If the hook has no `condition` field, or it is null/empty, treat the hook as executable
|
||||
- If the hook defines a non-empty `condition`, skip the hook and leave condition evaluation to
|
||||
the HookExecutor implementation
|
||||
- For each executable hook, output the following based on its `optional` flag:
|
||||
- **Optional hook** (`optional: true`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Optional Pre-Hook**: {extension}
|
||||
Command: `/{command}`
|
||||
Description: {description}
|
||||
|
||||
Prompt: {prompt}
|
||||
To execute: `/{command}`
|
||||
```
|
||||
|
||||
- **Mandatory hook** (`optional: false`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Automatic Pre-Hook**: {extension}
|
||||
Executing: `/{command}`
|
||||
EXECUTE_COMMAND: {command}
|
||||
|
||||
Wait for the result of the hook command before proceeding to the Outline.
|
||||
```
|
||||
|
||||
After emitting the block above you MUST actually invoke the hook and wait for it to finish
|
||||
before continuing. Run it the same way you would run the command yourself in this
|
||||
agent/session (the invocation may differ from the literal `{command}` id shown above, e.g. a
|
||||
skills-mode agent runs it as `/skill:speckit-...` or `$speckit-...`). Emitting the block
|
||||
alone does not run the hook.
|
||||
|
||||
- If no hooks are registered or `.specify/extensions.yml` does not exist, skip silently
|
||||
|
||||
## Outline
|
||||
|
||||
1. **Setup**: Run `.specify/scripts/bash/setup-plan.sh --json` from repo root and parse JSON for
|
||||
FEATURE_SPEC, IMPL_PLAN, FEATURE_DIR, BRANCH. For single quotes in args like "I'm Groot", use
|
||||
escape syntax: e.g 'I'\''m Groot' (or double-quote if possible: "I'm Groot").
|
||||
|
||||
2. **Load context**: Read FEATURE_SPEC and `.specify/memory/constitution.md`. Load IMPL_PLAN
|
||||
template (already copied).
|
||||
|
||||
3. **Execute plan workflow**: Follow the structure in IMPL_PLAN template to:
|
||||
- Fill Technical Context (mark unknowns as "NEEDS CLARIFICATION")
|
||||
- Fill Constitution Check section from constitution
|
||||
- Evaluate gates (ERROR if violations unjustified)
|
||||
- Phase 0: Generate research.md (resolve all NEEDS CLARIFICATION)
|
||||
- Phase 1: Generate data-model.md, contracts/, quickstart.md
|
||||
- Re-evaluate Constitution Check post-design
|
||||
|
||||
## Mandatory Post-Execution Hooks
|
||||
|
||||
**You MUST complete this section before reporting completion to the user.**
|
||||
|
||||
Check if `.specify/extensions.yml` exists in the project root.
|
||||
|
||||
- If it does not exist, or no hooks are registered under `hooks.after_plan`, skip to the Completion
|
||||
Report.
|
||||
- If it exists, read it and look for entries under the `hooks.after_plan` key.
|
||||
- If the YAML cannot be parsed or is invalid, do not skip silently: tell the user that
|
||||
`.specify/extensions.yml` could not be read (include the parser error) and that no hooks were
|
||||
checked, including any mandatory (`optional: false`) hooks registered there, then continue to the
|
||||
Completion Report.
|
||||
- Filter out hooks where `enabled` is explicitly `false`. Treat hooks without an `enabled` field as
|
||||
enabled by default.
|
||||
- For each remaining hook, do **not** attempt to interpret or evaluate hook `condition` expressions:
|
||||
- If the hook has no `condition` field, or it is null/empty, treat the hook as executable
|
||||
- If the hook defines a non-empty `condition`, skip the hook and leave condition evaluation to
|
||||
the HookExecutor implementation
|
||||
- For each executable hook, output the following based on its `optional` flag:
|
||||
- **Mandatory hook** (`optional: false`) — **You MUST emit `EXECUTE_COMMAND:` for each mandatory
|
||||
hook**:
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Automatic Hook**: {extension}
|
||||
Executing: `/{command}`
|
||||
EXECUTE_COMMAND: {command}
|
||||
```
|
||||
|
||||
After emitting the block above you MUST actually invoke the hook and wait for it to finish
|
||||
before continuing. Run it the same way you would run the command yourself in this
|
||||
agent/session (the invocation may differ from the literal `{command}` id shown above, e.g. a
|
||||
skills-mode agent runs it as `/skill:speckit-...` or `$speckit-...`). Emitting the block
|
||||
alone does not run the hook.
|
||||
|
||||
- **Optional hook** (`optional: true`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Optional Hook**: {extension}
|
||||
Command: `/{command}`
|
||||
Description: {description}
|
||||
|
||||
Prompt: {prompt}
|
||||
To execute: `/{command}`
|
||||
```
|
||||
|
||||
## Completion Report
|
||||
|
||||
Command ends after Phase 1 design. Report branch, IMPL_PLAN path, and generated artifacts.
|
||||
|
||||
## Phases
|
||||
|
||||
### Phase 0: Outline & Research
|
||||
|
||||
1. **Extract unknowns from Technical Context** above:
|
||||
- For each NEEDS CLARIFICATION → research task
|
||||
- For each dependency → best practices task
|
||||
- For each integration → patterns task
|
||||
|
||||
2. **Generate and dispatch research agents**:
|
||||
|
||||
```text
|
||||
For each unknown in Technical Context:
|
||||
Task: "Research {unknown} for {feature context}"
|
||||
For each technology choice:
|
||||
Task: "Find best practices for {tech} in {domain}"
|
||||
```
|
||||
|
||||
3. **Consolidate findings** in `research.md` using format:
|
||||
- Decision: [what was chosen]
|
||||
- Rationale: [why chosen]
|
||||
- Alternatives considered: [what else evaluated]
|
||||
|
||||
**Output**: research.md with all NEEDS CLARIFICATION resolved
|
||||
|
||||
### Phase 1: Design & Contracts
|
||||
|
||||
**Prerequisites:** `research.md` complete
|
||||
|
||||
1. **Extract entities from feature spec** → `data-model.md`:
|
||||
- Entity name, fields, relationships
|
||||
- Validation rules from requirements
|
||||
- State transitions if applicable
|
||||
|
||||
2. **Define interface contracts** (if project has external interfaces) → `/contracts/`:
|
||||
- Identify what interfaces the project exposes to users or other systems
|
||||
- Document the contract format appropriate for the project type
|
||||
- Examples: public APIs for libraries, command schemas for CLI tools, endpoints for web
|
||||
services, grammars for parsers, UI contracts for applications
|
||||
- Skip if project is purely internal (build scripts, one-off tools, etc.)
|
||||
|
||||
3. **Create quickstart validation guide** → `quickstart.md`:
|
||||
- Document runnable validation scenarios that prove the feature works end-to-end
|
||||
- Include prerequisites, setup commands, test/run commands, and expected outcomes
|
||||
- Use links or references to contracts and data model details instead of duplicating them
|
||||
- Do not include full implementation code, model/service/controller bodies, migrations, or
|
||||
complete test suites
|
||||
- Keep this artifact as a validation/run guide; implementation details belong in `tasks.md` and
|
||||
the implementation phase
|
||||
|
||||
**Output**: data-model.md, /contracts/\*, quickstart.md
|
||||
|
||||
## Key rules
|
||||
|
||||
- Use absolute paths for filesystem operations; use project-relative paths for references in
|
||||
documentation
|
||||
- ERROR on gate failures or unresolved clarifications
|
||||
|
||||
## Done When
|
||||
|
||||
- [ ] Plan workflow executed and design artifacts generated
|
||||
- [ ] Extension hooks dispatched or skipped according to the rules in Mandatory Post-Execution Hooks
|
||||
above
|
||||
- [ ] Completion reported to user with branch, plan path, and generated artifacts
|
||||
@@ -0,0 +1,411 @@
|
||||
---
|
||||
description: Create or update the feature specification from a natural language feature description.
|
||||
handoffs:
|
||||
- label: Build Technical Plan
|
||||
agent: speckit.plan
|
||||
prompt: Create a plan for the spec. I am building with...
|
||||
- label: Clarify Spec Requirements
|
||||
agent: speckit.clarify
|
||||
prompt: Clarify specification requirements
|
||||
send: true
|
||||
---
|
||||
|
||||
## User Input
|
||||
|
||||
```text
|
||||
$ARGUMENTS
|
||||
```
|
||||
|
||||
You **MUST** consider the user input before proceeding (if not empty).
|
||||
|
||||
## Pre-Execution Checks
|
||||
|
||||
**Check for extension hooks (before specification)**:
|
||||
|
||||
- Check if `.specify/extensions.yml` exists in the project root.
|
||||
- If it exists, read it and look for entries under the `hooks.before_specify` key
|
||||
- If the YAML cannot be parsed or is invalid, do not skip silently: tell the user that
|
||||
`.specify/extensions.yml` could not be read (include the parser error) and that no hooks were
|
||||
checked, including any mandatory (`optional: false`) hooks registered there, then continue
|
||||
normally
|
||||
- Filter out hooks where `enabled` is explicitly `false`. Treat hooks without an `enabled` field as
|
||||
enabled by default.
|
||||
- For each remaining hook, do **not** attempt to interpret or evaluate hook `condition` expressions:
|
||||
- If the hook has no `condition` field, or it is null/empty, treat the hook as executable
|
||||
- If the hook defines a non-empty `condition`, skip the hook and leave condition evaluation to
|
||||
the HookExecutor implementation
|
||||
- For each executable hook, output the following based on its `optional` flag:
|
||||
- **Optional hook** (`optional: true`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Optional Pre-Hook**: {extension}
|
||||
Command: `/{command}`
|
||||
Description: {description}
|
||||
|
||||
Prompt: {prompt}
|
||||
To execute: `/{command}`
|
||||
```
|
||||
|
||||
- **Mandatory hook** (`optional: false`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Automatic Pre-Hook**: {extension}
|
||||
Executing: `/{command}`
|
||||
EXECUTE_COMMAND: {command}
|
||||
|
||||
Wait for the result of the hook command before proceeding to the Outline.
|
||||
```
|
||||
|
||||
After emitting the block above you MUST actually invoke the hook and wait for it to finish
|
||||
before continuing. Run it the same way you would run the command yourself in this
|
||||
agent/session (the invocation may differ from the literal `{command}` id shown above, e.g. a
|
||||
skills-mode agent runs it as `/skill:speckit-...` or `$speckit-...`). Emitting the block
|
||||
alone does not run the hook.
|
||||
|
||||
- If no hooks are registered or `.specify/extensions.yml` does not exist, skip silently
|
||||
|
||||
## Outline
|
||||
|
||||
The text the user typed after `/speckit.specify` in the triggering message **is** the feature
|
||||
description. Assume you always have it available in this conversation even if `$ARGUMENTS` appears
|
||||
literally below. Do not ask the user to repeat it unless they provided an empty command.
|
||||
|
||||
Given that feature description, do this:
|
||||
|
||||
1. **Generate a concise short name** (2-4 words) for the feature:
|
||||
- Analyze the feature description and extract the most meaningful keywords
|
||||
- Create a 2-4 word short name that captures the essence of the feature
|
||||
- Use action-noun format when possible (e.g., "add-user-auth", "fix-payment-bug")
|
||||
- Preserve technical terms and acronyms (OAuth2, API, JWT, etc.)
|
||||
- Keep it concise but descriptive enough to understand the feature at a glance
|
||||
- Examples:
|
||||
- "I want to add user authentication" → "user-auth"
|
||||
- "Implement OAuth2 integration for the API" → "oauth2-api-integration"
|
||||
- "Create a dashboard for analytics" → "analytics-dashboard"
|
||||
- "Fix payment processing timeout bug" → "fix-payment-timeout"
|
||||
|
||||
2. **Branch creation** (optional, via hook):
|
||||
|
||||
If a `before_specify` hook ran successfully in the Pre-Execution Checks above, it will have
|
||||
created/switched to a git branch and output JSON containing `BRANCH_NAME` and `FEATURE_NUM`.
|
||||
Note these values for reference, but the branch name does **not** dictate the spec directory
|
||||
name.
|
||||
|
||||
If the user explicitly provided `GIT_BRANCH_NAME`, pass it through to the hook so the branch
|
||||
script uses the exact value as the branch name (bypassing all prefix/suffix generation).
|
||||
|
||||
3. **Create the spec feature directory**:
|
||||
|
||||
Specs live under the default `specs/` directory unless the user explicitly provides
|
||||
`SPECIFY_FEATURE_DIRECTORY`.
|
||||
|
||||
**Resolution order for `SPECIFY_FEATURE_DIRECTORY`**:
|
||||
1. If the user explicitly provided `SPECIFY_FEATURE_DIRECTORY` (e.g., via environment variable,
|
||||
argument, or configuration), use it as-is
|
||||
2. Otherwise, auto-generate it under `specs/`:
|
||||
- Check `.specify/init-options.json` for `feature_numbering` (preferred) or
|
||||
`branch_numbering` (deprecated, migration only — will be removed in a future release)
|
||||
- If `"timestamp"`: prefix is `YYYYMMDD-HHMMSS` (current timestamp)
|
||||
- If `"sequential"` or absent: prefix is `NNN` (next available 3-digit number after scanning
|
||||
existing directories in `specs/`)
|
||||
- Construct the directory name: `<prefix>-<short-name>` (e.g., `003-user-auth` or
|
||||
`20260319-143022-user-auth`)
|
||||
- Set `SPECIFY_FEATURE_DIRECTORY` to `specs/<directory-name>`
|
||||
- If `branch_numbering` was used (and `feature_numbering` was absent), emit a one-line
|
||||
warning: "⚠️ `branch_numbering` in init-options.json is deprecated. Rename to
|
||||
`feature_numbering`."
|
||||
|
||||
**Create the directory and spec file**:
|
||||
- Run `.specify/scripts/bash/resolve-template.sh spec-template --json` from the repository root
|
||||
and parse `TEMPLATE_CONTENT` as the active `spec-template`. The shared resolver composes
|
||||
project overrides, preset layers, and extension layers over the core template, including
|
||||
`append`, `prepend`, and `wrap` strategies. If it fails, stop and report the resolution error;
|
||||
do not continue with only one contributing template layer.
|
||||
- `mkdir -p SPECIFY_FEATURE_DIRECTORY`
|
||||
- Write `TEMPLATE_CONTENT` to `SPECIFY_FEATURE_DIRECTORY/spec.md` as the starting point. Do not
|
||||
copy a template file from disk instead: when a preset composes `spec-template`, no single file
|
||||
holds the full template.
|
||||
- Set `SPEC_FILE` to `SPECIFY_FEATURE_DIRECTORY/spec.md`
|
||||
- Persist the resolved path to `.specify/feature.json`:
|
||||
```json
|
||||
{
|
||||
"feature_directory": "<resolved feature dir>"
|
||||
}
|
||||
```
|
||||
Write the actual resolved directory path value (for example, `specs/003-user-auth`), not the
|
||||
literal string `SPECIFY_FEATURE_DIRECTORY`. This allows downstream commands
|
||||
(`/speckit.plan`, `/speckit.tasks`, etc.) to locate the feature directory without relying on
|
||||
git branch name conventions.
|
||||
|
||||
**IMPORTANT**:
|
||||
- You must only create one feature per `/speckit.specify` invocation
|
||||
- The spec directory name and the git branch name are independent — they may be the same but
|
||||
that is the user's choice
|
||||
- The spec directory and file are always created by this command, never by the hook
|
||||
|
||||
4. Use `TEMPLATE_CONTENT` to understand required sections.
|
||||
|
||||
5. **IF EXISTS**: Load `.specify/memory/constitution.md` for project principles and governance
|
||||
constraints.
|
||||
|
||||
6. Follow this execution flow:
|
||||
1. Parse user description from arguments If empty: ERROR "No feature description provided"
|
||||
2. Extract key concepts from description Identify: actors, actions, data, constraints
|
||||
3. For unclear aspects:
|
||||
- Make informed guesses based on context and industry standards
|
||||
- Only mark with [NEEDS CLARIFICATION: specific question] if:
|
||||
- The choice significantly impacts feature scope or user experience
|
||||
- Multiple reasonable interpretations exist with different implications
|
||||
- No reasonable default exists
|
||||
- **LIMIT: Maximum 3 [NEEDS CLARIFICATION] markers total**
|
||||
- Prioritize clarifications by impact: scope > security/privacy > user experience >
|
||||
technical details
|
||||
4. Fill User Scenarios & Testing section If no clear user flow: ERROR "Cannot determine user
|
||||
scenarios"
|
||||
5. Generate Functional Requirements Each requirement must be testable Use reasonable defaults
|
||||
for unspecified details (document assumptions in Assumptions section)
|
||||
6. Define Success Criteria Create measurable, technology-agnostic outcomes Include both
|
||||
quantitative metrics (time, performance, volume) and qualitative measures (user satisfaction,
|
||||
task completion) Each criterion must be verifiable without implementation details
|
||||
7. Identify Key Entities (if data involved)
|
||||
8. Return: SUCCESS (spec ready for planning)
|
||||
|
||||
7. Write the specification to SPEC_FILE using the template structure, replacing placeholders with
|
||||
concrete details derived from the feature description (arguments) while preserving section order
|
||||
and headings.
|
||||
|
||||
8. **Specification Quality Validation**: After writing the initial spec, validate it against quality
|
||||
criteria:
|
||||
|
||||
a. **Create Spec Quality Checklist**: Generate a checklist file at
|
||||
`SPECIFY_FEATURE_DIRECTORY/checklists/requirements.md` using the checklist template structure
|
||||
with these validation items:
|
||||
|
||||
```markdown
|
||||
# Specification Quality Checklist: [FEATURE NAME]
|
||||
|
||||
**Purpose**: Validate specification completeness and quality before proceeding to planning
|
||||
**Created**: [DATE] **Feature**: [Link to spec.md]
|
||||
|
||||
## Content Quality
|
||||
|
||||
- [ ] No implementation details (languages, frameworks, APIs)
|
||||
- [ ] Focused on user value and business needs
|
||||
- [ ] Written for non-technical stakeholders
|
||||
- [ ] All mandatory sections completed
|
||||
|
||||
## Requirement Completeness
|
||||
|
||||
- [ ] No [NEEDS CLARIFICATION] markers remain
|
||||
- [ ] Requirements are testable and unambiguous
|
||||
- [ ] Success criteria are measurable
|
||||
- [ ] Success criteria are technology-agnostic (no implementation details)
|
||||
- [ ] All acceptance scenarios are defined
|
||||
- [ ] Edge cases are identified
|
||||
- [ ] Scope is clearly bounded
|
||||
- [ ] Dependencies and assumptions identified
|
||||
|
||||
## Feature Readiness
|
||||
|
||||
- [ ] All functional requirements have clear acceptance criteria
|
||||
- [ ] User scenarios cover primary flows
|
||||
- [ ] Feature meets measurable outcomes defined in Success Criteria
|
||||
- [ ] No implementation details leak into specification
|
||||
|
||||
## Notes
|
||||
|
||||
- Items marked incomplete require spec updates before `/speckit.clarify` or `/speckit.plan`
|
||||
```
|
||||
|
||||
b. **Run Validation Check**: Review the spec against each checklist item:
|
||||
- For each item, determine if it passes or fails
|
||||
- Document specific issues found (quote relevant spec sections)
|
||||
|
||||
c. **Handle Validation Results**:
|
||||
- **If all items pass**: Mark checklist complete and proceed to the Mandatory Post-Execution
|
||||
Hooks section
|
||||
|
||||
- **If items fail (excluding [NEEDS CLARIFICATION])**:
|
||||
1. List the failing items and specific issues
|
||||
2. Update the spec to address each issue
|
||||
3. Re-run validation until all items pass (max 3 iterations)
|
||||
4. If still failing after 3 iterations, document remaining issues in checklist notes and
|
||||
warn user
|
||||
|
||||
- **If [NEEDS CLARIFICATION] markers remain**:
|
||||
1. Extract all [NEEDS CLARIFICATION: ...] markers from the spec
|
||||
2. **LIMIT CHECK**: If more than 3 markers exist, keep only the 3 most critical (by
|
||||
scope/security/UX impact) and make informed guesses for the rest
|
||||
3. For each clarification needed (max 3), present options to user in this format:
|
||||
|
||||
```markdown
|
||||
## Question [N]: [Topic]
|
||||
|
||||
**Context**: [Quote relevant spec section]
|
||||
|
||||
**What we need to know**: [Specific question from NEEDS CLARIFICATION marker]
|
||||
|
||||
**Suggested Answers**:
|
||||
|
||||
| Option | Answer | Implications |
|
||||
| ------ | ------------------------- | ------------------------------------- |
|
||||
| A | [First suggested answer] | [What this means for the feature] |
|
||||
| B | [Second suggested answer] | [What this means for the feature] |
|
||||
| C | [Third suggested answer] | [What this means for the feature] |
|
||||
| Custom | Provide your own answer | [Explain how to provide custom input] |
|
||||
|
||||
**Your choice**: _[Wait for user response]_
|
||||
```
|
||||
|
||||
4. **CRITICAL - Table Formatting**: Ensure markdown tables are properly formatted:
|
||||
- Use consistent spacing with pipes aligned
|
||||
- Each cell should have spaces around content: `| Content |` not `|Content|`
|
||||
- Header separator must have at least 3 dashes: `|--------|`
|
||||
- Test that the table renders correctly in markdown preview
|
||||
5. Number questions sequentially (Q1, Q2, Q3 - max 3 total)
|
||||
6. Present all questions together before waiting for responses
|
||||
7. Wait for user to respond with their choices for all questions (e.g., "Q1: A, Q2: Custom -
|
||||
[details], Q3: B")
|
||||
8. Update the spec by replacing each [NEEDS CLARIFICATION] marker with the user's selected
|
||||
or provided answer
|
||||
9. Re-run validation after all clarifications are resolved
|
||||
|
||||
d. **Update Checklist**: After each validation iteration, update the checklist file with current
|
||||
pass/fail status
|
||||
|
||||
## Mandatory Post-Execution Hooks
|
||||
|
||||
**You MUST complete this section before reporting completion to the user.**
|
||||
|
||||
Check if `.specify/extensions.yml` exists in the project root.
|
||||
|
||||
- If it does not exist, or no hooks are registered under `hooks.after_specify`, skip to the
|
||||
Completion Report.
|
||||
- If it exists, read it and look for entries under the `hooks.after_specify` key.
|
||||
- If the YAML cannot be parsed or is invalid, do not skip silently: tell the user that
|
||||
`.specify/extensions.yml` could not be read (include the parser error) and that no hooks were
|
||||
checked, including any mandatory (`optional: false`) hooks registered there, then continue to the
|
||||
Completion Report.
|
||||
- Filter out hooks where `enabled` is explicitly `false`. Treat hooks without an `enabled` field as
|
||||
enabled by default.
|
||||
- For each remaining hook, do **not** attempt to interpret or evaluate hook `condition` expressions:
|
||||
- If the hook has no `condition` field, or it is null/empty, treat the hook as executable
|
||||
- If the hook defines a non-empty `condition`, skip the hook and leave condition evaluation to
|
||||
the HookExecutor implementation
|
||||
- For each executable hook, output the following based on its `optional` flag:
|
||||
- **Mandatory hook** (`optional: false`) — **You MUST emit `EXECUTE_COMMAND:` for each mandatory
|
||||
hook**:
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Automatic Hook**: {extension}
|
||||
Executing: `/{command}`
|
||||
EXECUTE_COMMAND: {command}
|
||||
```
|
||||
|
||||
After emitting the block above you MUST actually invoke the hook and wait for it to finish
|
||||
before continuing. Run it the same way you would run the command yourself in this
|
||||
agent/session (the invocation may differ from the literal `{command}` id shown above, e.g. a
|
||||
skills-mode agent runs it as `/skill:speckit-...` or `$speckit-...`). Emitting the block
|
||||
alone does not run the hook.
|
||||
|
||||
- **Optional hook** (`optional: true`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Optional Hook**: {extension}
|
||||
Command: `/{command}`
|
||||
Description: {description}
|
||||
|
||||
Prompt: {prompt}
|
||||
To execute: `/{command}`
|
||||
```
|
||||
|
||||
## Completion Report
|
||||
|
||||
Report completion to the user with:
|
||||
|
||||
- `SPECIFY_FEATURE_DIRECTORY` — the feature directory path
|
||||
- `SPEC_FILE` — the spec file path
|
||||
- Checklist results summary
|
||||
- Readiness for the next phase (`/speckit.clarify` or `/speckit.plan`)
|
||||
|
||||
**NOTE:** Branch creation is handled by the `before_specify` hook (git extension). Spec directory
|
||||
and file creation are always handled by this core command.
|
||||
|
||||
## Quick Guidelines
|
||||
|
||||
- Focus on **WHAT** users need and **WHY**.
|
||||
- Avoid HOW to implement (no tech stack, APIs, code structure).
|
||||
- Written for business stakeholders, not developers.
|
||||
- DO NOT create any checklists that are embedded in the spec. That will be a separate command.
|
||||
|
||||
### Section Requirements
|
||||
|
||||
- **Mandatory sections**: Must be completed for every feature
|
||||
- **Optional sections**: Include only when relevant to the feature
|
||||
- When a section doesn't apply, remove it entirely (don't leave as "N/A")
|
||||
|
||||
### For AI Generation
|
||||
|
||||
When creating this spec from a user prompt:
|
||||
|
||||
1. **Make informed guesses**: Use context, industry standards, and common patterns to fill gaps
|
||||
2. **Document assumptions**: Record reasonable defaults in the Assumptions section
|
||||
3. **Limit clarifications**: Maximum 3 [NEEDS CLARIFICATION] markers - use only for critical
|
||||
decisions that:
|
||||
- Significantly impact feature scope or user experience
|
||||
- Have multiple reasonable interpretations with different implications
|
||||
- Lack any reasonable default
|
||||
4. **Prioritize clarifications**: scope > security/privacy > user experience > technical details
|
||||
5. **Think like a tester**: Every vague requirement should fail the "testable and unambiguous"
|
||||
checklist item
|
||||
6. **Common areas needing clarification** (only if no reasonable default exists):
|
||||
- Feature scope and boundaries (include/exclude specific use cases)
|
||||
- User types and permissions (if multiple conflicting interpretations possible)
|
||||
- Security/compliance requirements (when legally/financially significant)
|
||||
|
||||
**Examples of reasonable defaults** (don't ask about these):
|
||||
|
||||
- Data retention: Industry-standard practices for the domain
|
||||
- Performance targets: Standard web/mobile app expectations unless specified
|
||||
- Error handling: User-friendly messages with appropriate fallbacks
|
||||
- Authentication method: Standard session-based or OAuth2 for web apps
|
||||
- Integration patterns: Use project-appropriate patterns (REST/GraphQL for web services, function
|
||||
calls for libraries, CLI args for tools, etc.)
|
||||
|
||||
### Success Criteria Guidelines
|
||||
|
||||
Success criteria must be:
|
||||
|
||||
1. **Measurable**: Include specific metrics (time, percentage, count, rate)
|
||||
2. **Technology-agnostic**: No mention of frameworks, languages, databases, or tools
|
||||
3. **User-focused**: Describe outcomes from user/business perspective, not system internals
|
||||
4. **Verifiable**: Can be tested/validated without knowing implementation details
|
||||
|
||||
**Good examples**:
|
||||
|
||||
- "Users can complete checkout in under 3 minutes"
|
||||
- "System supports 10,000 concurrent users"
|
||||
- "95% of searches return results in under 1 second"
|
||||
- "Task completion rate improves by 40%"
|
||||
|
||||
**Bad examples** (implementation-focused):
|
||||
|
||||
- "API response time is under 200ms" (too technical, use "Users see results instantly")
|
||||
- "Database can handle 1000 TPS" (implementation detail, use user-facing metric)
|
||||
- "React components render efficiently" (framework-specific)
|
||||
- "Redis cache hit rate above 80%" (technology-specific)
|
||||
|
||||
## Done When
|
||||
|
||||
- [ ] Specification written to `SPEC_FILE` and validated against quality checklist
|
||||
- [ ] Extension hooks dispatched or skipped according to the rules in Mandatory Post-Execution Hooks
|
||||
above
|
||||
- [ ] Completion reported to user with feature directory, spec file path, and checklist results
|
||||
@@ -0,0 +1,270 @@
|
||||
---
|
||||
description:
|
||||
Generate an actionable, dependency-ordered tasks.md for the feature based on available design
|
||||
artifacts.
|
||||
handoffs:
|
||||
- label: Analyze For Consistency
|
||||
agent: speckit.analyze
|
||||
prompt: Run a project analysis for consistency
|
||||
send: true
|
||||
- label: Implement Project
|
||||
agent: speckit.implement
|
||||
prompt: Start the implementation in phases
|
||||
send: true
|
||||
---
|
||||
|
||||
## User Input
|
||||
|
||||
```text
|
||||
$ARGUMENTS
|
||||
```
|
||||
|
||||
You **MUST** consider the user input before proceeding (if not empty).
|
||||
|
||||
## Pre-Execution Checks
|
||||
|
||||
**Check for extension hooks (before tasks generation)**:
|
||||
|
||||
- Check if `.specify/extensions.yml` exists in the project root.
|
||||
- If it exists, read it and look for entries under the `hooks.before_tasks` key
|
||||
- If the YAML cannot be parsed or is invalid, do not skip silently: tell the user that
|
||||
`.specify/extensions.yml` could not be read (include the parser error) and that no hooks were
|
||||
checked, including any mandatory (`optional: false`) hooks registered there, then continue
|
||||
normally
|
||||
- Filter out hooks where `enabled` is explicitly `false`. Treat hooks without an `enabled` field as
|
||||
enabled by default.
|
||||
- For each remaining hook, do **not** attempt to interpret or evaluate hook `condition` expressions:
|
||||
- If the hook has no `condition` field, or it is null/empty, treat the hook as executable
|
||||
- If the hook defines a non-empty `condition`, skip the hook and leave condition evaluation to
|
||||
the HookExecutor implementation
|
||||
- For each executable hook, output the following based on its `optional` flag:
|
||||
- **Optional hook** (`optional: true`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Optional Pre-Hook**: {extension}
|
||||
Command: `/{command}`
|
||||
Description: {description}
|
||||
|
||||
Prompt: {prompt}
|
||||
To execute: `/{command}`
|
||||
```
|
||||
|
||||
- **Mandatory hook** (`optional: false`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Automatic Pre-Hook**: {extension}
|
||||
Executing: `/{command}`
|
||||
EXECUTE_COMMAND: {command}
|
||||
|
||||
Wait for the result of the hook command before proceeding to the Outline.
|
||||
```
|
||||
|
||||
After emitting the block above you MUST actually invoke the hook and wait for it to finish
|
||||
before continuing. Run it the same way you would run the command yourself in this
|
||||
agent/session (the invocation may differ from the literal `{command}` id shown above, e.g. a
|
||||
skills-mode agent runs it as `/skill:speckit-...` or `$speckit-...`). Emitting the block
|
||||
alone does not run the hook.
|
||||
|
||||
- If no hooks are registered or `.specify/extensions.yml` does not exist, skip silently
|
||||
|
||||
## Outline
|
||||
|
||||
1. **Setup**: Run `.specify/scripts/bash/setup-tasks.sh --json` from repo root and parse
|
||||
FEATURE_DIR, TASKS_TEMPLATE_CONTENT, TASKS_TEMPLATE, and AVAILABLE_DOCS list. `FEATURE_DIR` and
|
||||
`TASKS_TEMPLATE` must be absolute paths when provided. `AVAILABLE_DOCS` is a list of document
|
||||
names/relative paths available under `FEATURE_DIR` (for example `research.md` or `contracts/`).
|
||||
For single quotes in args like "I'm Groot", use escape syntax: e.g 'I'\''m Groot' (or
|
||||
double-quote if possible: "I'm Groot").
|
||||
|
||||
2. **Load design documents**: Read from FEATURE_DIR:
|
||||
- **Required**: plan.md (tech stack, libraries, structure), spec.md (user stories with
|
||||
priorities)
|
||||
- **Optional**: data-model.md (entities), contracts/ (interface contracts), research.md
|
||||
(decisions), quickstart.md (test scenarios)
|
||||
- **IF EXISTS**: Load `.specify/memory/constitution.md` for project principles and governance
|
||||
constraints
|
||||
- Note: Not all projects have all documents. Generate tasks based on what's available.
|
||||
|
||||
3. **Execute task generation workflow**:
|
||||
- Load plan.md and extract tech stack, libraries, project structure
|
||||
- Load spec.md and extract user stories with their priorities (P1, P2, P3, etc.)
|
||||
- If data-model.md exists: Extract entities and map to user stories
|
||||
- If contracts/ exists: Map interface contracts to user stories
|
||||
- If research.md exists: Extract decisions for setup tasks
|
||||
- Generate tasks organized by user story (see Task Generation Rules below)
|
||||
- Generate dependency graph showing user story completion order
|
||||
- Create parallel execution examples per user story
|
||||
- Validate task completeness (each user story has all needed tasks, independently testable)
|
||||
|
||||
4. **Generate tasks.md**: Use TASKS_TEMPLATE_CONTENT (from the JSON output above) as the structure.
|
||||
For compatibility with older setup scripts that omit TASKS_TEMPLATE_CONTENT, read TASKS_TEMPLATE
|
||||
instead. Fill with:
|
||||
- Correct feature name from plan.md
|
||||
- Phase 1: Setup tasks (project initialization)
|
||||
- Phase 2: Foundational tasks (blocking prerequisites for all user stories)
|
||||
- Phase 3+: One phase per user story (in priority order from spec.md)
|
||||
- Each phase includes: story goal, independent test criteria, tests (if requested),
|
||||
implementation tasks
|
||||
- Final Phase: Polish & cross-cutting concerns
|
||||
- All tasks must follow the strict checklist format (see Task Generation Rules below)
|
||||
- Clear file paths for each task
|
||||
- Dependencies section showing story completion order
|
||||
- Parallel execution examples per story
|
||||
- Implementation strategy section (MVP first, incremental delivery)
|
||||
|
||||
## Mandatory Post-Execution Hooks
|
||||
|
||||
**You MUST complete this section before reporting completion to the user.**
|
||||
|
||||
Check if `.specify/extensions.yml` exists in the project root.
|
||||
|
||||
- If it does not exist, or no hooks are registered under `hooks.after_tasks`, skip to the Completion
|
||||
Report.
|
||||
- If it exists, read it and look for entries under the `hooks.after_tasks` key.
|
||||
- If the YAML cannot be parsed or is invalid, do not skip silently: tell the user that
|
||||
`.specify/extensions.yml` could not be read (include the parser error) and that no hooks were
|
||||
checked, including any mandatory (`optional: false`) hooks registered there, then continue to the
|
||||
Completion Report.
|
||||
- Filter out hooks where `enabled` is explicitly `false`. Treat hooks without an `enabled` field as
|
||||
enabled by default.
|
||||
- For each remaining hook, do **not** attempt to interpret or evaluate hook `condition` expressions:
|
||||
- If the hook has no `condition` field, or it is null/empty, treat the hook as executable
|
||||
- If the hook defines a non-empty `condition`, skip the hook and leave condition evaluation to
|
||||
the HookExecutor implementation
|
||||
- For each executable hook, output the following based on its `optional` flag:
|
||||
- **Mandatory hook** (`optional: false`) — **You MUST emit `EXECUTE_COMMAND:` for each mandatory
|
||||
hook**:
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Automatic Hook**: {extension}
|
||||
Executing: `/{command}`
|
||||
EXECUTE_COMMAND: {command}
|
||||
```
|
||||
|
||||
After emitting the block above you MUST actually invoke the hook and wait for it to finish
|
||||
before continuing. Run it the same way you would run the command yourself in this
|
||||
agent/session (the invocation may differ from the literal `{command}` id shown above, e.g. a
|
||||
skills-mode agent runs it as `/skill:speckit-...` or `$speckit-...`). Emitting the block
|
||||
alone does not run the hook.
|
||||
|
||||
- **Optional hook** (`optional: true`):
|
||||
|
||||
```
|
||||
## Extension Hooks
|
||||
|
||||
**Optional Hook**: {extension}
|
||||
Command: `/{command}`
|
||||
Description: {description}
|
||||
|
||||
Prompt: {prompt}
|
||||
To execute: `/{command}`
|
||||
```
|
||||
|
||||
## Completion Report
|
||||
|
||||
Output path to generated tasks.md and summary:
|
||||
|
||||
- Total task count
|
||||
- Task count per user story
|
||||
- Parallel opportunities identified
|
||||
- Independent test criteria for each story
|
||||
- Suggested MVP scope (typically just User Story 1)
|
||||
- Format validation: Confirm ALL tasks follow the checklist format (checkbox, ID, labels, file
|
||||
paths)
|
||||
|
||||
Context for task generation: $ARGUMENTS
|
||||
|
||||
The tasks.md should be immediately executable - each task must be specific enough that an LLM can
|
||||
complete it without additional context.
|
||||
|
||||
## Task Generation Rules
|
||||
|
||||
**CRITICAL**: Tasks MUST be organized by user story to enable independent implementation and
|
||||
testing.
|
||||
|
||||
**Tests are OPTIONAL**: Only generate test tasks if explicitly requested in the feature
|
||||
specification or if user requests TDD approach.
|
||||
|
||||
### Checklist Format (REQUIRED)
|
||||
|
||||
Every task MUST strictly follow this format:
|
||||
|
||||
```text
|
||||
- [ ] [TaskID] [P?] [Story?] Description with file path
|
||||
```
|
||||
|
||||
**Format Components**:
|
||||
|
||||
1. **Checkbox**: ALWAYS start with `- [ ]` (markdown checkbox)
|
||||
2. **Task ID**: Sequential number (T001, T002, T003...) in execution order
|
||||
3. **[P] marker**: Include ONLY if task is parallelizable (different files, no dependencies on
|
||||
incomplete tasks)
|
||||
4. **[Story] label**: REQUIRED for user story phase tasks only
|
||||
- Format: [US1], [US2], [US3], etc. (maps to user stories from spec.md)
|
||||
- Setup phase: NO story label
|
||||
- Foundational phase: NO story label
|
||||
- User Story phases: MUST have story label
|
||||
- Polish phase: NO story label
|
||||
5. **Description**: Clear action with exact file path
|
||||
|
||||
**Examples**:
|
||||
|
||||
- ✅ CORRECT: `- [ ] T001 Create project structure per implementation plan`
|
||||
- ✅ CORRECT: `- [ ] T005 [P] Implement authentication middleware in src/middleware/auth.py`
|
||||
- ✅ CORRECT: `- [ ] T012 [P] [US1] Create User model in src/models/user.py`
|
||||
- ✅ CORRECT: `- [ ] T014 [US1] Implement UserService in src/services/user_service.py`
|
||||
- ❌ WRONG: `- [ ] Create User model` (missing ID and Story label)
|
||||
- ❌ WRONG: `T001 [US1] Create model` (missing checkbox)
|
||||
- ❌ WRONG: `- [ ] [US1] Create User model` (missing Task ID)
|
||||
- ❌ WRONG: `- [ ] T001 [US1] Create model` (missing file path)
|
||||
|
||||
### Task Organization
|
||||
|
||||
1. **From User Stories (spec.md)** - PRIMARY ORGANIZATION:
|
||||
- Each user story (P1, P2, P3...) gets its own phase
|
||||
- Map all related components to their story:
|
||||
- Models needed for that story
|
||||
- Services needed for that story
|
||||
- Interfaces/UI needed for that story
|
||||
- If tests requested: Tests specific to that story
|
||||
- Mark story dependencies (most stories should be independent)
|
||||
|
||||
2. **From Contracts**:
|
||||
- Map each interface contract → to the user story it serves
|
||||
- If tests requested: Each interface contract → contract test task [P] before implementation in
|
||||
that story's phase
|
||||
|
||||
3. **From Data Model**:
|
||||
- Map each entity to the user story(ies) that need it
|
||||
- If entity serves multiple stories: Put in earliest story or Setup phase
|
||||
- Relationships → service layer tasks in appropriate story phase
|
||||
- For each field with constraints in data-model.md (max length, nullable/required, enum values,
|
||||
validation rules), quote the constraint verbatim in the task description so it is not left to
|
||||
implementation-time discretion
|
||||
|
||||
4. **From Setup/Infrastructure**:
|
||||
- Shared infrastructure → Setup phase (Phase 1)
|
||||
- Foundational/blocking tasks → Foundational phase (Phase 2)
|
||||
- Story-specific setup → within that story's phase
|
||||
|
||||
### Phase Structure
|
||||
|
||||
- **Phase 1**: Setup (project initialization)
|
||||
- **Phase 2**: Foundational (blocking prerequisites - MUST complete before user stories)
|
||||
- **Phase 3+**: User Stories in priority order (P1, P2, P3...)
|
||||
- Within each story: Tests (if requested) → Models → Services → Endpoints → Integration
|
||||
- Each phase should be a complete, independently testable increment
|
||||
- **Final Phase**: Polish & Cross-Cutting Concerns
|
||||
|
||||
## Done When
|
||||
|
||||
- [ ] tasks.md generated with all phases, task IDs, and file paths
|
||||
- [ ] Extension hooks dispatched or skipped according to the rules in Mandatory Post-Execution Hooks
|
||||
above
|
||||
- [ ] Completion reported to user with task count, story breakdown, and MVP scope
|
||||
@@ -5,3 +5,4 @@
|
||||
/.nx/workspace-data
|
||||
.nx/self-healing
|
||||
/.claude
|
||||
/.agents
|
||||
@@ -0,0 +1,14 @@
|
||||
# Machine-local Spec Kit state — not meant to be shared.
|
||||
# Managed by the Specify CLI; safe to edit (your changes are preserved on refresh).
|
||||
|
||||
# Local pointer to the current feature directory. Rewritten every time you
|
||||
# switch features, so it is per-checkout state rather than something to share.
|
||||
feature.json
|
||||
|
||||
# Per-machine extension config overrides.
|
||||
extensions/*/local-config.yml
|
||||
|
||||
# Executable adapter packages and their per-checkout provenance registry.
|
||||
# Execution consent is stored separately in the user's local trust registry.
|
||||
integrations/packages/
|
||||
integrations/packages.json
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"ai": "omp",
|
||||
"allow_symlinks": false,
|
||||
"feature_numbering": "sequential",
|
||||
"here": true,
|
||||
"integration": "omp",
|
||||
"script": "sh",
|
||||
"speckit_version": "1.3.0"
|
||||
}
|
||||
@@ -0,0 +1,15 @@
|
||||
{
|
||||
"version": "1.3.0",
|
||||
"integration_state_schema": 1,
|
||||
"installed_integrations": [
|
||||
"omp"
|
||||
],
|
||||
"integration_settings": {
|
||||
"omp": {
|
||||
"script": "sh",
|
||||
"invoke_separator": "."
|
||||
}
|
||||
},
|
||||
"integration": "omp",
|
||||
"default_integration": "omp"
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"integration": "omp",
|
||||
"version": "1.3.0",
|
||||
"installed_at": "2026-11-10T07:36:38.106667+00:00",
|
||||
"files": {
|
||||
".omp/commands/speckit.analyze.md": "91fe16257ededdea9cc21d3cb27d539fcdd12d93ddcea52332cd4b68176b6a8d",
|
||||
".omp/commands/speckit.clarify.md": "dd11eb5b9759f7d3cd18c9d7f23a0ae2fe7973fc6ca2486dbfaf53a5569224b1",
|
||||
".omp/commands/speckit.constitution.md": "9a7e9296f0878cdf4ed011b0de74cfb3656938680b64e43e808553fdfd054efc",
|
||||
".omp/commands/speckit.implement.md": "e036ce63702db93e656e1c91ee6c02a8dc3d4a4f8624f8ba4adc69027fe68983",
|
||||
".omp/commands/speckit.converge.md": "3cb55244c9dc5b9bf52ee3127ba177c52cabd5e5e5197e1312497b3eaeb8b9a4",
|
||||
".omp/commands/speckit.plan.md": "3be8b011db9c6bb1cc77037f7d90756a6dbcbda1995cda2192818385732b27ff",
|
||||
".omp/commands/speckit.checklist.md": "fa58b19e2604ce56ff5f5427061f6ee94fd44d7194e740b874824d9bf21ee15b",
|
||||
".omp/commands/speckit.specify.md": "f187308807970a6da6df55c4ac6a5be992c14059e607eda950ffde1bd17531dd",
|
||||
".omp/commands/speckit.tasks.md": "6754ae39649c8e73a5ed376ad5cfcf04422e321a10e07c5ccd92fd1b9bccf776"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"integration": "pi",
|
||||
"version": "1.3.0",
|
||||
"installed_at": "2026-11-05T09:25:04.172921+00:00",
|
||||
"files": {
|
||||
".pi/prompts/speckit.analyze.md": "91fe16257ededdea9cc21d3cb27d539fcdd12d93ddcea52332cd4b68176b6a8d",
|
||||
".pi/prompts/speckit.clarify.md": "dd11eb5b9759f7d3cd18c9d7f23a0ae2fe7973fc6ca2486dbfaf53a5569224b1",
|
||||
".pi/prompts/speckit.constitution.md": "9a7e9296f0878cdf4ed011b0de74cfb3656938680b64e43e808553fdfd054efc",
|
||||
".pi/prompts/speckit.implement.md": "e036ce63702db93e656e1c91ee6c02a8dc3d4a4f8624f8ba4adc69027fe68983",
|
||||
".pi/prompts/speckit.converge.md": "3cb55244c9dc5b9bf52ee3127ba177c52cabd5e5e5197e1312497b3eaeb8b9a4",
|
||||
".pi/prompts/speckit.plan.md": "3be8b011db9c6bb1cc77037f7d90756a6dbcbda1995cda2192818385732b27ff",
|
||||
".pi/prompts/speckit.checklist.md": "fa58b19e2604ce56ff5f5427061f6ee94fd44d7194e740b874824d9bf21ee15b",
|
||||
".pi/prompts/speckit.specify.md": "f187308807970a6da6df55c4ac6a5be992c14059e607eda950ffde1bd17531dd",
|
||||
".pi/prompts/speckit.tasks.md": "6754ae39649c8e73a5ed376ad5cfcf04422e321a10e07c5ccd92fd1b9bccf776"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
{
|
||||
"integration": "speckit",
|
||||
"version": "1.3.0",
|
||||
"installed_at": "2026-11-05T09:25:04.202195+00:00",
|
||||
"files": {
|
||||
".specify/scripts/bash/check-prerequisites.sh": "ac3d9bfd836c4e873bfb8fb5d898ba4c1d2f80d3488c2298148408a3830ac8d1",
|
||||
".specify/scripts/bash/common.sh": "53cb1c23e349db4586c272436ce35c6e2f36a9c0b5351a85e0b216d9887a26b7",
|
||||
".specify/scripts/bash/create-new-feature.sh": "972f03ed8ca5ee17b7baad6d56d821d46269d77abc337496beafb0fe85a725f2",
|
||||
".specify/scripts/bash/setup-plan.sh": "d378ec66ba20d2da01c71dad8935062c1c27f0bba890be9a6d3dda52ea056a4e",
|
||||
".specify/scripts/bash/setup-tasks.sh": "cf6e99575a24b64ac01ffa3a50a40971ba95e3c1ec269b9a6dc3e35bbbb09191",
|
||||
".specify/scripts/bash/resolve-template.sh": "829e227096abc8bf0889889ec9f792f503ca5d395b7836a8a7eb739ee75214e7",
|
||||
".specify/templates/tasks-template.md": "c731575d8099b3f871861186fbd1a592b51b2ba57fb99e1a0dab439ff6d5608f",
|
||||
".specify/templates/checklist-template.md": "3f4124a13ffbc0c2d8e979d9a08248f29ce53cc6c324a8303a6ae0d231b78836",
|
||||
".specify/templates/plan-template.md": "5ef0e4c97b36e9f91372dc6eb8e5a7e515af8958cf1a9286e43a1ebd9bd48540",
|
||||
".specify/templates/constitution-template.md": "ce7549540fa45543cca797a150201d868e64495fdff39dc38246fb17bd4024b3",
|
||||
".specify/templates/spec-template.md": "3945437fc35cd30a5b2bf7beea680337c3516826d3efa5a6b92c4a7eca1ba28e",
|
||||
".specify/.gitignore": "0a61c5378b0bb2e0f85babff99c8b166f2170a2c12378cd17d929aa19296ec88"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"sha256": "ce7549540fa45543cca797a150201d868e64495fdff39dc38246fb17bd4024b3",
|
||||
"source": "core"
|
||||
}
|
||||
@@ -0,0 +1,283 @@
|
||||
# JT4D Constitution
|
||||
|
||||
## Core Principles
|
||||
|
||||
### I. Слои WELD на фронтенде (ОБЯЗАТЕЛЬНО)
|
||||
|
||||
Структура `apps/web` строится по методологии WELD (Well-Encapsulated Layered Design,
|
||||
https://jt4d-lab.github.io/weld/): состав и порядок слоёв задаёт проект схемой WELD, а импорт
|
||||
разрешён только из слоёв, стоящих ниже себя.
|
||||
|
||||
- Схема фронтенда: `layers: app, pages, @modules, common`, `moduleLayers: widgets, entities`.
|
||||
`@modules` — служебная метка места слоёв модулей в общей схеме, а не имя директории.
|
||||
- Слои проекта существуют в единственном экземпляре и лежат директориями в корне `src`. Слои модуля
|
||||
повторяются в каждом модуле на любой глубине; принадлежность к слою модуля задаёт первое имя на
|
||||
пути от корня модуля, глубже слой не ищется.
|
||||
- Назначение web-слоёв: `app` — точка входа, маршруты и их защита, глобальные провайдеры, оболочка и
|
||||
лейауты; `pages` — общий вид страницы, композиция виджетов и хлебные крошки; `widgets` —
|
||||
самостоятельный блок со своими данными и состоянием; `entities` — показ и форматирование доменного
|
||||
значения; `common` — UI-примитивы, вызовы API, типы, утилиты, переводы без знания о домене и
|
||||
сценарии.
|
||||
- `common` не импортирует никого, `app` не импортирует никто, слои модулей не видят `pages` и `app`.
|
||||
- Новый слой вводится тогда, когда появляется самостоятельная архитектурная граница, а не потому,
|
||||
что такой слой есть в другой методологии. Осознанное отступление от направления записывается
|
||||
повтором слоя в схеме WELD и не остаётся побочным результатом правок.
|
||||
|
||||
**Обоснование**: единственное направление зависимостей делает изменение локальным, а границу слоя и
|
||||
модуля — проверяемой линтером и на ревью без чтения всего графа кода.
|
||||
|
||||
### II. Слои API по WELD (ОБЯЗАТЕЛЬНО)
|
||||
|
||||
`apps/api` строится по той же методологии WELD со своей схемой: `layers: app, @modules, common`,
|
||||
`moduleLayers: controllers, services, dal, migrations, entities`. Импорт разрешён только вниз по
|
||||
схеме: `app` → `controllers` → `services` → `dal` → `migrations` → `entities` → `common`.
|
||||
|
||||
- `app` — точка входа и сборка приложения: bootstrap, глобальные настройки, корневой модуль. Другие
|
||||
слои его не импортируют.
|
||||
- `controllers` — контракт ручки; `services` — бизнес-правила, доменные ошибки и транзакции; `dal` —
|
||||
доступ к данным; `migrations` — миграции модуля; `entities` — описание таблиц.
|
||||
- Слой `migrations` модуль не экспортирует, а его каталог сканирует генератор списка миграций.
|
||||
- `common` — код, не принадлежащий ни одному домену: конфигурация, логирование, подключение к БД,
|
||||
типы, утилиты. Стоит ниже всех слоёв и не импортирует никого.
|
||||
- Контроллер тонкий: объявляет контракт ручки, проверяет формат входных данных и делегирует работу
|
||||
сервису. Бизнес-решения, транзакции и запросы к БД в нём отсутствуют.
|
||||
- Контроль доступа на уровне HTTP декларативен: guards и декораторы ролей. Валидация формата
|
||||
подключается пайпом на конкретный параметр, а не глобальным `ValidationPipe`.
|
||||
- Бизнес-правила, доменные ошибки и транзакции живут в сервисе. Сервис вызывает DAL своего модуля и
|
||||
публичные сервисы чужих модулей.
|
||||
- Модуль отдаёт наружу только явно перечисленное в `exports`. Доступ к данным чужого домена — только
|
||||
через публичный сервис модуля-владельца.
|
||||
- Сущность описывает таблицу: колонки, типы, связи, индексы, имя таблицы. Методов доступа к данным и
|
||||
бизнес-валидации в ней нет; Active Record не используется.
|
||||
- DTO описывает форму данных и валидацию формата. Собственных методов у него нет, кроме статической
|
||||
фабрики `from` у response-моделей.
|
||||
|
||||
**Обоснование**: слои API задают место бизнес-правилу и запросу, поэтому изменение не расползается
|
||||
по контроллерам и не требует знания всего модуля. Схема WELD делает то же правило проверяемым: место
|
||||
миграции, сущности и запроса задано слоем, а не договорённостью.
|
||||
|
||||
### III. Публичный API директории (ОБЯЗАТЕЛЬНО)
|
||||
|
||||
Директория, являющаяся границей — модуль, слой, сложный компонент из нескольких файлов, — объявляет
|
||||
публичный API через `index.ts` и только через него отдаёт содержимое наружу.
|
||||
|
||||
- Импорт из чужой границы идёт строго через её баррель; импорт внутренних файлов в обход барреля
|
||||
запрещён.
|
||||
- Баррель содержит явный список именованных реэкспортов. `export * from './...'` в нём не пишется:
|
||||
разрешён только реэкспорт из вложенной директории, у которой уже есть собственный `index.ts`.
|
||||
- Баррель не содержит исполняемого кода: ни импортов стилей, ни инициализации, ни оборачивания
|
||||
компонентов.
|
||||
- Импорт из своего или вышестоящего барреля запрещён. Внутри директории файлы импортируют друг друга
|
||||
только относительными путями.
|
||||
- Модуль с одной точкой входа имеет корневой `index.ts`. Модуль с несколькими точками входа
|
||||
корневого барреля не имеет, и его публичными точками входа становятся непосредственные файлы и
|
||||
каталоги — внутренние файлы и вложенные каталоги точками входа быть не могут.
|
||||
- Для тестов и вспомогательных файлов (сторибук, моки) импорт через баррель допустим: они сами не
|
||||
импортируются продуктовым кодом.
|
||||
|
||||
**Обоснование**: каждая строка барреля — обещание поддерживать имя, а любое расширение публичного
|
||||
API видно ревьюеру как правка одной строки в одном файле, поэтому детали реализации перестают быть
|
||||
публичным контрактом.
|
||||
|
||||
### IV. Модули и видимость в дереве (ОБЯЗАТЕЛЬНО)
|
||||
|
||||
Модуль собирает код функциональной области и является рамкой для слоёв `widgets` и `entities`.
|
||||
|
||||
- Модули верхнего уровня лежат в `src/modules/<domain>`. Вложенные модули лежат в контейнере
|
||||
`modules/` внутри родительского модуля; контейнер слоем не является и собственного публичного API
|
||||
не имеет.
|
||||
- Видимость определяется положением в дереве: модулю доступны его предки, братья, братья предков и
|
||||
непосредственные дочерние модули. Остальные модули дерева недоступны — доступ к «племянникам»
|
||||
запрещён, потому что раскрывает внутреннюю структуру ветки.
|
||||
- Правило порядка слоёв применяется ко всем модулям, включая вложенные. Единственное исключение:
|
||||
родительский модуль может обращаться к непосредственному дочернему модулю на том же слое, так как
|
||||
цикла по осям «модуль + слой» не образуется.
|
||||
- Модуль публикует наружу только свой публичный API; внутренние файлы чужого модуля не импортируются
|
||||
даже внутри модуля-владельца.
|
||||
- Дублирование логики между модулями не допускается: общая часть переносится в `common` или в
|
||||
модуль, доступный по дереву.
|
||||
|
||||
**Обоснование**: модули и слои — разные оси архитектуры. Дерево модулей ограничивает видимость, а
|
||||
слои задают направление зависимостей, поэтому цикл по модулям остаётся разрешённым, а по слоям —
|
||||
нет.
|
||||
|
||||
### V. Приватность частей директории (ОБЯЗАТЕЛЬНО)
|
||||
|
||||
Часть директории объявляется приватной явно, а не договорённостью на словах.
|
||||
|
||||
- Публичный API директории — её баррель: файл, который баррель не реэкспортирует, наружу не
|
||||
отдаётся, и импорт его из чужой границы запрещён.
|
||||
- Приватная группа файлов лежит в каталоге с точным именем `internal` (вместе со всем содержимым).
|
||||
- Приватное доступно только содержимому непосредственного родителя. Соседние и вышестоящие
|
||||
директории доступа не получают.
|
||||
- Владелец может опубликовать часть реализации через свой баррель, но путь приватной директории от
|
||||
этого не открывается.
|
||||
- Приватные границы вкладываются: внешняя закрывает каталог целиком, внутренняя сужает доступ ещё
|
||||
сильнее.
|
||||
|
||||
**Обоснование**: приватность даёт место для деталей реализации, которые не должны становиться
|
||||
контрактом, не требуя для этого отдельного модуля.
|
||||
|
||||
### VI. Доступ к данным только через DAL (ОБЯЗАТЕЛЬНО)
|
||||
|
||||
- `@InjectRepository`, `Repository`, `DataSource`, `QueryBuilder` и прочие API TypeORM допустимы
|
||||
только в `*.dal.ts`.
|
||||
- Исключение ровно одно: `DataSource` внедряется в сервис-владелец сценария и используется только
|
||||
ради `dataSource.transaction(...)`. Репозитории и `QueryBuilder` из него не берутся.
|
||||
- Транзакцию открывает сервис. DAL принимает `manager?: EntityManager` и работает с переданным
|
||||
контекстом; контекст передаётся явно, `AsyncLocalStorage` не вводится.
|
||||
- DAL приватен для модуля: не попадает в `exports`, `TypeOrmModule.forFeature` не реэкспортируется.
|
||||
- Мапперы не вводятся: DAL возвращает сущности как есть.
|
||||
- Методы DAL добавляются под конкретный запрос вызывающего кода. API «на будущее» не пишется.
|
||||
- Внешние вызовы — HTTP, SMTP, очереди — выполняются после коммита транзакции.
|
||||
- Логика, которую необходимо выполнять на стороне БД (агрегаты, массовые `UPDATE`/`upsert`, выборки
|
||||
с блокировкой, оконные функции), живёт в DAL.
|
||||
|
||||
**Обоснование**: сервис не зависит от способа выборки, поэтому замена запроса, добавление join'а или
|
||||
кэша остаётся в одном файле и не задевает бизнес-логику.
|
||||
|
||||
### VII. Схема БД меняется только миграцией (ОБЯЗАТЕЛЬНО)
|
||||
|
||||
- `synchronize: false`, `migrationsRun: false`. Единственный способ изменить схему — миграция.
|
||||
- Миграция лежит в слое `migrations` своего модуля (`apps/api/src/<module>/migrations/`). Имя файла
|
||||
начинается с 13-значного timestamp, имя класса оканчивается тем же timestamp.
|
||||
- `down` пишется всегда. Необратимая операция оформляется либо броском ошибки в `down`, либо откатом
|
||||
с потерей данных — выбор фиксируется комментарием.
|
||||
- DDL пишется методами `QueryRunner` (`Table`, `TableColumn`), а не строкой SQL.
|
||||
`queryRunner.query()` допустим там, где API TypeORM нужную конструкцию не выражает, и
|
||||
сопровождается комментарием.
|
||||
- Имя таблицы в миграции — строковый литерал, а не константа `*_TABLE_NAME`.
|
||||
- Изменение схемы и перенос данных — разные файлы.
|
||||
- Data-миграции не переносят секреты и персональные данные литералами: SQL миграций попадает в лог
|
||||
job деплоя.
|
||||
- После добавления или удаления миграции `apps/api/src/migrations.ts` перегенерируется и коммитится
|
||||
вместе с ней.
|
||||
- Миграция считается проверенной после цикла `db-migrate` → `db-revert` → `db-migrate`.
|
||||
|
||||
**Обоснование**: миграция — воспроизводимый и откатываемый снимок схемы; автозапуск и ручные правки
|
||||
БД оставляют прод и репозиторий в расхождении, которое следующий деплой только обостряет.
|
||||
|
||||
### VIII. Тесты рядом с кодом
|
||||
|
||||
- Юнит-тест лежит рядом с тестируемым файлом, отдельной папки под тесты нет. Расширение — `.test.ts`
|
||||
(`.test.tsx` для React-компонентов).
|
||||
- Тестируется бизнес-логика сервиса с замоканным DAL.
|
||||
- DAL не покрывается юнит-тестами: тест с замоканным репозиторием проверяет сам себя. Логика,
|
||||
выполняемая в БД, проверяется на реальной базе.
|
||||
- Тест может импортировать тестируемую границу через её баррель: это снижает зависимость от
|
||||
внутреннего расположения файлов.
|
||||
- Тесты запускаются через Nx: `yarn nx run api:test`, `yarn nx run web:test`,
|
||||
`yarn nx affected -t test`.
|
||||
|
||||
**Обоснование**: тест описывает контракт поведения, а не структуру вызовов, поэтому переезд деталей
|
||||
выборки внутрь DAL не требует переписывать тесты.
|
||||
|
||||
### IX. Документация — контракт
|
||||
|
||||
- `docs/` — источник истины для слоёв, модулей, БД, миграций, логирования и деплоя. Новый код
|
||||
соответствует документации.
|
||||
- Концепции WELD (публичный API директории, однонаправленность зависимостей, модули, вложенные
|
||||
модули) — источник истины для устройства слоёв и модулей; `docs/` описывает их применение к этому
|
||||
проекту и не переопределяет.
|
||||
- Изменение поведения, расходящееся с документацией, включает её правку в ту же задачу.
|
||||
- Документация в `docs/` компилируется как MDX: вне code fence и inline-кода `{...}` и `<` перед
|
||||
словом или небуквенным символом запрещены; сравнения пишутся через `≤` и `≥`.
|
||||
- Комментарий в коде сообщает только существенный факт, который нельзя вывести из кода рядом, имён,
|
||||
типов и сигнатур. Пересказ кода и обоснование принятого решения комментарием не оформляется.
|
||||
- `AGENTS.md` поддерживается в актуальном состоянии по командам, архитектуре и конвенциям.
|
||||
|
||||
**Обоснование**: документация и код изменяются одной задачей, иначе расхождение становится
|
||||
источником неверных решений у следующего автора.
|
||||
|
||||
### X. Задачи только через Nx
|
||||
|
||||
- Задачи (build, test, lint, serve, миграции) запускаются через `yarn nx run`, `run-many`,
|
||||
`affected`. Прямые вызовы jest, vitest, eslint, webpack и typeorm CLI допустимы только там, где
|
||||
это описано в документации (например, `migration:generate` с обязательными переменными окружения).
|
||||
- Границы слоёв и модулей проверяются правилами WELD в составе lint. Исключение не оформляется
|
||||
комментарием в коде и не отключается на месте: оно вносится в схему WELD как повтор слоя.
|
||||
- `yarn lint:check` проходит до коммита. Хуки pre-commit и pre-push не обходятся через
|
||||
`--no-verify`.
|
||||
- Имя ветки соответствует шаблону `i<номер>-<краткое-описание>`; проверка выполняется
|
||||
`validate-branch-name` на pre-push.
|
||||
- Сгенерированные файлы, от которых зависит сборка (`apps/api/src/migrations.ts`), коммитятся в том
|
||||
виде, в котором их создал генератор.
|
||||
|
||||
**Обоснование**: Nx знает граф зависимостей и кэш, поэтому обход Nx даёт локально зелёный результат,
|
||||
который падает в CI.
|
||||
|
||||
### XI. Структурное логирование с явным контекстом
|
||||
|
||||
- Логгер внедряется через dependency injection. Контекст задаётся явно через `setContext()`.
|
||||
- Контекст — имя модуля (`Brands`, `Users`); при уточнении добавляется второй уровень через
|
||||
двоеточие (`Brands:Passport`). Технические роли (`Service`, `Controller`) в контексте не
|
||||
употребляются.
|
||||
- Уровень выбирается по значимости события. В dev — человекочитаемый вывод и `debug`, в prod — JSON
|
||||
и `info`; переопределение через `LOG_LEVEL` и `LOG_PRETTY`.
|
||||
- Чувствительные данные в логи не попадают. `reqId` внутри HTTP-запроса не дублируется в `details`.
|
||||
|
||||
**Обоснование**: единый формат и стабильный контекст — условие того, что логи остаются пригодными
|
||||
для диагностики инцидента, а не только для отладки рядом с консолью.
|
||||
|
||||
## Constraints
|
||||
|
||||
- Стек фиксирован: Nx 22, yarn 1 workspaces, TypeScript 5.9, Node 24; `api` — NestJS 11 + TypeORM +
|
||||
PostgreSQL + webpack + Vitest; `web` — React 19 + Vite 7 + Tailwind 3.4 + Caddy, архитектура —
|
||||
WELD; e2e — Jest; логи — Pino через `nestjs-pino`.
|
||||
- UI-примитивы фронтенда — исходники shadcn/ui на Radix (`class-variance-authority`, `clsx`,
|
||||
`tailwind-merge`, `lucide-react`, `tailwindcss-animate`, `@radix-ui/react-*`), скопированные в
|
||||
`apps/web/src/common/ui`. Tailwind при этом остаётся 3.4.
|
||||
- Схемы слоёв WELD — `layers` и `moduleLayers` для фронтенда и для API — единственное место, где
|
||||
объявлены состав и порядок слоёв. Списки слоёв не дублируются в конфигурации ESLint и в правилах
|
||||
Nx. Добавление, разделение или удаление слоя — правка схемы WELD, а не набора исключений.
|
||||
- Введение WELD не отменяет ранее принятых правил: слои API (`Controller → Service → DAL`), доступ к
|
||||
данным только через DAL, миграции, тесты, документация, Nx и логирование действуют в полном
|
||||
объёме. Новый принцип применяется к своей части кода и не заменяет соседний.
|
||||
- Проверка границ: правила WELD из `eslint-plugin-weld` по схеме из `apps/web/weld.config.mjs`. Пока
|
||||
плагин не умеет проверять направление слоёв, направление держится ревью, а такое расхождение
|
||||
считается временным состоянием, а не альтернативной настройкой.
|
||||
- Замена или добавление элемента стека оформляется отдельным решением и обновлением этого раздела.
|
||||
- Общие библиотеки кладутся в `packages/`; дублирование логики между приложениями не допускается.
|
||||
- Настройки окружения читаются из `.env` и переменных окружения. Секреты и реальные данные в
|
||||
репозиторий не коммитятся.
|
||||
- Схема прод-БД не синхронизируется рантаймом, автоматического бэкапа перед миграцией нет: перед
|
||||
рискованной операцией снимается ручной дамп, и на свежую копию при разборе инцидента не
|
||||
рассчитывают.
|
||||
- Стейджинг и прод изменяются пайплайном (`.gitea/workflows/ci.yaml`, `production.yaml`,
|
||||
`cleanup.yaml`). Ручные правки схемы мимо миграций запрещены.
|
||||
- Изменения на удалённых окружениях выполняются после явного разрешения на конкретную правку:
|
||||
сначала показываются команды и дифф, затем применение. Разрешение на одну правку не
|
||||
распространяется на соседние и на повторный запуск.
|
||||
|
||||
## Development Workflow
|
||||
|
||||
- Изменение проходит путь specify → plan → tasks → implement. Соответствие конституции проверяется
|
||||
на шаге плана (Constitution Check).
|
||||
- Готовность задачи: `yarn lint:check` зелёный (включая проверку границ WELD), затронутые тесты
|
||||
проходят, при изменении схемы выполнен цикл накат → откат → накат, документация обновлена.
|
||||
- Изменение схемы слоёв или появление модуля — событие архитектуры: схема WELD и `docs/` правятся в
|
||||
той же задаче, что и код.
|
||||
- CI — обязательный шлюз. `Check migrations list` и `Check data-source` проходят до сборки образов;
|
||||
ветка с падающим CI не мержится.
|
||||
- Деплой применяет миграции автоматически (`migration:run -t each`). Ручное вмешательство в общую БД
|
||||
выполняется по runbook через `docker exec`, после решения о необходимости и с учётом того, что
|
||||
автоматического бэкапа нет.
|
||||
- Ревью PR включает проверку принципов; отклонение фиксируется в плане или решении с причиной и
|
||||
сроком устранения, а не молчаливым исключением.
|
||||
|
||||
## Governance
|
||||
|
||||
- Конституция выше остальных практик. Для нового кода приоритет у конституции; существующий код
|
||||
приводится к ней по мере того, как его затрагивают.
|
||||
- Поправка вносится так: предложение с формулировкой принципа и обоснованием → ревью владельцем
|
||||
репозитория → обновление этого файла и, при необходимости, `docs/`.
|
||||
- Версионирование по semantic versioning: MAJOR — удаление или переопределение принципа, MINOR —
|
||||
новый принцип или раздел, PATCH — уточнение формулировки без изменения смысла.
|
||||
- Каждая поправка обновляет строку версии, дату последней правки и Sync Impact Report. Отчёт —
|
||||
рабочий материал ревью, перед коммитом он удаляется.
|
||||
- Соответствие проверяется на ревью PR и в плане задачи. Нарушение без зафиксированного обоснования
|
||||
блокирует мерж.
|
||||
- Неоднозначный случай трактуется в пользу ограничения, а не обхода; принятое решение фиксируется в
|
||||
`docs/`.
|
||||
|
||||
**Version**: 1.0.0 | **Ratified**: 2026-11-05 | **Last Amended**: 2026-11-08
|
||||
Executable
+249
@@ -0,0 +1,249 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
# Consolidated prerequisite checking script
|
||||
#
|
||||
# This script provides unified prerequisite checking for Spec-Driven Development workflow.
|
||||
# It replaces the functionality previously spread across multiple scripts.
|
||||
#
|
||||
# Usage: ./check-prerequisites.sh [OPTIONS]
|
||||
#
|
||||
# OPTIONS:
|
||||
# --json Output in JSON format
|
||||
# --require-spec Require spec.md to exist (for analysis phase)
|
||||
# --require-tasks Require tasks.md to exist (for implementation phase)
|
||||
# --include-tasks Include tasks.md in AVAILABLE_DOCS list
|
||||
# --paths-only Only output path variables (no validation)
|
||||
# --template NAME Include composed template content in JSON output
|
||||
# --help, -h Show help message
|
||||
#
|
||||
# OUTPUTS:
|
||||
# JSON mode: {"FEATURE_DIR":"...", "AVAILABLE_DOCS":["..."]}
|
||||
# Text mode: FEATURE_DIR:... \n AVAILABLE_DOCS: \n ✓/✗ file.md
|
||||
# Paths only: REPO_ROOT: ... \n BRANCH: ... \n FEATURE_DIR: ... etc.
|
||||
|
||||
set -e
|
||||
|
||||
# Parse command line arguments
|
||||
JSON_MODE=false
|
||||
REQUIRE_SPEC=false
|
||||
REQUIRE_TASKS=false
|
||||
INCLUDE_TASKS=false
|
||||
PATHS_ONLY=false
|
||||
TEMPLATE_NAME=""
|
||||
|
||||
while [[ $# -gt 0 ]]; do
|
||||
case "$1" in
|
||||
--json)
|
||||
JSON_MODE=true
|
||||
;;
|
||||
--require-spec)
|
||||
REQUIRE_SPEC=true
|
||||
;;
|
||||
--require-tasks)
|
||||
REQUIRE_TASKS=true
|
||||
;;
|
||||
--include-tasks)
|
||||
INCLUDE_TASKS=true
|
||||
;;
|
||||
--paths-only)
|
||||
PATHS_ONLY=true
|
||||
;;
|
||||
--template)
|
||||
shift
|
||||
if [[ $# -eq 0 ]]; then
|
||||
echo "ERROR: --template requires a template name" >&2
|
||||
exit 1
|
||||
fi
|
||||
TEMPLATE_NAME="$1"
|
||||
;;
|
||||
--help|-h)
|
||||
cat << 'EOF'
|
||||
Usage: check-prerequisites.sh [OPTIONS]
|
||||
|
||||
Consolidated prerequisite checking for Spec-Driven Development workflow.
|
||||
|
||||
OPTIONS:
|
||||
--json Output in JSON format
|
||||
--require-spec Require spec.md to exist (for analysis phase)
|
||||
--require-tasks Require tasks.md to exist (for implementation phase)
|
||||
--include-tasks Include tasks.md in AVAILABLE_DOCS list
|
||||
--paths-only Only output path variables (no prerequisite validation)
|
||||
--template NAME Include composed template content in JSON output
|
||||
--help, -h Show this help message
|
||||
|
||||
EXAMPLES:
|
||||
# Check task prerequisites (plan.md required)
|
||||
./check-prerequisites.sh --json
|
||||
|
||||
# Check implementation prerequisites (plan.md + tasks.md required)
|
||||
./check-prerequisites.sh --json --require-tasks --include-tasks
|
||||
|
||||
# Get feature paths only (no validation)
|
||||
./check-prerequisites.sh --paths-only
|
||||
|
||||
EOF
|
||||
exit 0
|
||||
;;
|
||||
*)
|
||||
echo "ERROR: Unknown option '$1'. Use --help for usage information." >&2
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
# Source common functions
|
||||
SCRIPT_DIR="$(CDPATH="" cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
source "$SCRIPT_DIR/common.sh"
|
||||
|
||||
# Get feature paths.
|
||||
# In --paths-only mode this is pure resolution, so pass --no-persist to opt out
|
||||
# of the feature.json write side effect (issue #3025).
|
||||
if $PATHS_ONLY; then
|
||||
_paths_output=$(get_feature_paths --no-persist) || { echo "ERROR: Failed to resolve feature paths" >&2; exit 1; }
|
||||
else
|
||||
_paths_output=$(get_feature_paths) || { echo "ERROR: Failed to resolve feature paths" >&2; exit 1; }
|
||||
fi
|
||||
eval "$_paths_output"
|
||||
unset _paths_output
|
||||
|
||||
# If paths-only mode, output paths and exit (no validation)
|
||||
if $PATHS_ONLY; then
|
||||
if $JSON_MODE; then
|
||||
# Minimal JSON paths payload (no validation performed)
|
||||
if has_jq; then
|
||||
jq -cn \
|
||||
--arg repo_root "$REPO_ROOT" \
|
||||
--arg branch "$CURRENT_BRANCH" \
|
||||
--arg feature_dir "$FEATURE_DIR" \
|
||||
--arg feature_spec "$FEATURE_SPEC" \
|
||||
--arg impl_plan "$IMPL_PLAN" \
|
||||
--arg tasks "$TASKS" \
|
||||
'{REPO_ROOT:$repo_root,BRANCH:$branch,FEATURE_DIR:$feature_dir,FEATURE_SPEC:$feature_spec,IMPL_PLAN:$impl_plan,TASKS:$tasks}'
|
||||
else
|
||||
printf '{"REPO_ROOT":"%s","BRANCH":"%s","FEATURE_DIR":"%s","FEATURE_SPEC":"%s","IMPL_PLAN":"%s","TASKS":"%s"}\n' \
|
||||
"$(json_escape "$REPO_ROOT")" "$(json_escape "$CURRENT_BRANCH")" "$(json_escape "$FEATURE_DIR")" "$(json_escape "$FEATURE_SPEC")" "$(json_escape "$IMPL_PLAN")" "$(json_escape "$TASKS")"
|
||||
fi
|
||||
else
|
||||
echo "REPO_ROOT: $REPO_ROOT"
|
||||
echo "BRANCH: $CURRENT_BRANCH"
|
||||
echo "FEATURE_DIR: $FEATURE_DIR"
|
||||
echo "FEATURE_SPEC: $FEATURE_SPEC"
|
||||
echo "IMPL_PLAN: $IMPL_PLAN"
|
||||
echo "TASKS: $TASKS"
|
||||
fi
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Validate required directories and files
|
||||
if [[ ! -d "$FEATURE_DIR" ]]; then
|
||||
echo "ERROR: Feature directory not found: $FEATURE_DIR" >&2
|
||||
echo "Run /speckit.specify first to create the feature structure." >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [[ ! -f "$IMPL_PLAN" ]]; then
|
||||
echo "ERROR: plan.md not found in $FEATURE_DIR" >&2
|
||||
echo "Run /speckit.plan first to create the implementation plan." >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [[ ! -s "$IMPL_PLAN" ]]; then
|
||||
echo "ERROR: plan.md is empty in $FEATURE_DIR" >&2
|
||||
echo "Populate it, or remove the empty file and rerun /speckit.plan with a valid plan template." >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check for spec.md if required
|
||||
if $REQUIRE_SPEC && [[ ! -f "$FEATURE_SPEC" ]]; then
|
||||
echo "ERROR: spec.md not found in $FEATURE_DIR" >&2
|
||||
echo "Run /speckit.specify first to create the feature specification." >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check for tasks.md if required
|
||||
if $REQUIRE_TASKS && [[ ! -f "$TASKS" ]]; then
|
||||
echo "ERROR: tasks.md not found in $FEATURE_DIR" >&2
|
||||
echo "Run /speckit.tasks first to create the task list." >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Build list of available documents
|
||||
docs=()
|
||||
|
||||
# Always check these optional docs
|
||||
[[ -f "$RESEARCH" ]] && docs+=("research.md")
|
||||
[[ -f "$DATA_MODEL" ]] && docs+=("data-model.md")
|
||||
|
||||
# Check contracts directory (only if it exists and has files)
|
||||
if [[ -d "$CONTRACTS_DIR" ]] && [[ -n "$(ls -A "$CONTRACTS_DIR" 2>/dev/null)" ]]; then
|
||||
docs+=("contracts/")
|
||||
fi
|
||||
|
||||
[[ -f "$QUICKSTART" ]] && docs+=("quickstart.md")
|
||||
|
||||
# Include tasks.md if requested and it exists
|
||||
if $INCLUDE_TASKS && [[ -f "$TASKS" ]]; then
|
||||
docs+=("tasks.md")
|
||||
fi
|
||||
|
||||
TEMPLATE_CONTENT=""
|
||||
if [[ -n "$TEMPLATE_NAME" ]]; then
|
||||
if TEMPLATE_CONTENT=$(resolve_template_content "$TEMPLATE_NAME" "$REPO_ROOT"; status=$?; printf x; exit "$status"); then
|
||||
TEMPLATE_CONTENT="${TEMPLATE_CONTENT%x}"
|
||||
else
|
||||
echo "ERROR: Could not resolve required $TEMPLATE_NAME from the template override stack for $REPO_ROOT" >&2
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
# Output results
|
||||
if $JSON_MODE; then
|
||||
# Build JSON array of documents
|
||||
if has_jq; then
|
||||
if [[ ${#docs[@]} -eq 0 ]]; then
|
||||
json_docs="[]"
|
||||
else
|
||||
json_docs=$(printf '%s\n' "${docs[@]}" | jq -R . | jq -s .)
|
||||
fi
|
||||
if [[ -n "$TEMPLATE_NAME" ]]; then
|
||||
jq -cn \
|
||||
--arg feature_dir "$FEATURE_DIR" \
|
||||
--argjson docs "$json_docs" \
|
||||
--arg template_content "$TEMPLATE_CONTENT" \
|
||||
'{FEATURE_DIR:$feature_dir,AVAILABLE_DOCS:$docs,TEMPLATE_CONTENT:$template_content}'
|
||||
else
|
||||
jq -cn \
|
||||
--arg feature_dir "$FEATURE_DIR" \
|
||||
--argjson docs "$json_docs" \
|
||||
'{FEATURE_DIR:$feature_dir,AVAILABLE_DOCS:$docs}'
|
||||
fi
|
||||
else
|
||||
if [[ ${#docs[@]} -eq 0 ]]; then
|
||||
json_docs="[]"
|
||||
else
|
||||
json_docs=$(for d in "${docs[@]}"; do printf '"%s",' "$(json_escape "$d")"; done)
|
||||
json_docs="[${json_docs%,}]"
|
||||
fi
|
||||
if [[ -n "$TEMPLATE_NAME" ]]; then
|
||||
printf '{"FEATURE_DIR":"%s","AVAILABLE_DOCS":%s,"TEMPLATE_CONTENT":"%s"}\n' \
|
||||
"$(json_escape "$FEATURE_DIR")" "$json_docs" "$(json_escape "$TEMPLATE_CONTENT")"
|
||||
else
|
||||
printf '{"FEATURE_DIR":"%s","AVAILABLE_DOCS":%s}\n' "$(json_escape "$FEATURE_DIR")" "$json_docs"
|
||||
fi
|
||||
fi
|
||||
else
|
||||
# Text output
|
||||
echo "FEATURE_DIR:$FEATURE_DIR"
|
||||
echo "AVAILABLE_DOCS:"
|
||||
|
||||
# Show status of each potential document
|
||||
check_file "$RESEARCH" "research.md"
|
||||
check_file "$DATA_MODEL" "data-model.md"
|
||||
check_dir "$CONTRACTS_DIR" "contracts/"
|
||||
check_file "$QUICKSTART" "quickstart.md"
|
||||
|
||||
if $INCLUDE_TASKS; then
|
||||
check_file "$TASKS" "tasks.md"
|
||||
fi
|
||||
fi
|
||||
Executable
+942
@@ -0,0 +1,942 @@
|
||||
#!/usr/bin/env bash
|
||||
# Common functions and variables for all scripts
|
||||
|
||||
# Find repository root by searching upward for .specify directory
|
||||
# This is the primary marker for spec-kit projects
|
||||
find_specify_root() {
|
||||
local dir="${1:-$(pwd)}"
|
||||
# Normalize to absolute path to prevent infinite loop with relative paths
|
||||
# Use -- to handle paths starting with - (e.g., -P, -L)
|
||||
dir="$(cd -- "$dir" 2>/dev/null && pwd)" || return 1
|
||||
local prev_dir=""
|
||||
while true; do
|
||||
if [ -d "$dir/.specify" ]; then
|
||||
echo "$dir"
|
||||
return 0
|
||||
fi
|
||||
# Stop if we've reached filesystem root or dirname stops changing
|
||||
if [ "$dir" = "/" ] || [ "$dir" = "$prev_dir" ]; then
|
||||
break
|
||||
fi
|
||||
prev_dir="$dir"
|
||||
dir="$(dirname "$dir")"
|
||||
done
|
||||
return 1
|
||||
}
|
||||
|
||||
# Resolve an explicit SPECIFY_INIT_DIR project override (the directory that
|
||||
# *contains* .specify/), for non-interactive / CI use — e.g. running a Spec Kit
|
||||
# command against a member project from a monorepo root without cd.
|
||||
#
|
||||
# Precondition: SPECIFY_INIT_DIR is non-empty. Echoes the validated absolute
|
||||
# project root, or prints an error and returns 1. Strict by design: the path
|
||||
# must exist and contain .specify/, with no silent fallback to cwd or the
|
||||
# script-location default (which would silently write to the wrong project).
|
||||
#
|
||||
# This is the single resolver: bundled extensions inherit it by sourcing core
|
||||
# (e.g. the git extension's create-new-feature-branch) rather than duplicating it.
|
||||
resolve_specify_init_dir() {
|
||||
local init_root
|
||||
# Normalize: relative paths resolve against $(pwd); a trailing slash collapses.
|
||||
# CDPATH="" so a relative value cannot be resolved against the caller's CDPATH
|
||||
# (which would also echo to stdout and corrupt the captured path).
|
||||
if ! init_root="$(CDPATH="" cd -- "$SPECIFY_INIT_DIR" 2>/dev/null && pwd)"; then
|
||||
echo "ERROR: SPECIFY_INIT_DIR does not point to an existing directory: $SPECIFY_INIT_DIR" >&2
|
||||
return 1
|
||||
fi
|
||||
if [[ ! -d "$init_root/.specify" ]]; then
|
||||
echo "ERROR: SPECIFY_INIT_DIR is not a Spec Kit project (no .specify/ directory): $init_root" >&2
|
||||
return 1
|
||||
fi
|
||||
printf '%s\n' "$init_root"
|
||||
}
|
||||
|
||||
# Get repository root, prioritizing .specify directory
|
||||
# This prevents using a parent repository when spec-kit is initialized in a subdirectory
|
||||
get_repo_root() {
|
||||
# Explicit project override wins (see resolve_specify_init_dir).
|
||||
if [[ -n "${SPECIFY_INIT_DIR:-}" ]]; then
|
||||
resolve_specify_init_dir
|
||||
return
|
||||
fi
|
||||
|
||||
# First, look for .specify directory (spec-kit's own marker)
|
||||
local specify_root
|
||||
if specify_root=$(find_specify_root); then
|
||||
echo "$specify_root"
|
||||
return
|
||||
fi
|
||||
|
||||
# Final fallback to script location
|
||||
local script_dir="$(CDPATH="" cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
(cd "$script_dir/../../.." && pwd)
|
||||
}
|
||||
|
||||
# Get current feature name from explicit state only.
|
||||
# Returns the feature identifier or empty string if none is set.
|
||||
# Feature state is set by SPECIFY_FEATURE (from create-new-feature or
|
||||
# the git extension) or implicitly via .specify/feature.json.
|
||||
get_current_branch() {
|
||||
if [[ -n "${SPECIFY_FEATURE:-}" ]]; then
|
||||
echo "$SPECIFY_FEATURE"
|
||||
return
|
||||
fi
|
||||
|
||||
# No explicit feature set — caller must handle this via feature.json
|
||||
# in get_feature_paths(). Return empty to signal "unknown".
|
||||
echo ""
|
||||
}
|
||||
|
||||
# Safely read .specify/feature.json's "feature_directory" value.
|
||||
# Prints the raw value (possibly relative) to stdout, or empty string if the file
|
||||
# is missing, unparseable, or does not contain the key. Always returns 0 so callers
|
||||
# under `set -e` cannot be aborted by parser failure.
|
||||
# Parser order mirrors the historical get_feature_paths behavior: jq -> python3 -> grep/sed.
|
||||
read_feature_json_feature_directory() {
|
||||
local repo_root="$1"
|
||||
local fj="$repo_root/.specify/feature.json"
|
||||
[[ -f "$fj" ]] || { printf '%s' ''; return 0; }
|
||||
|
||||
# Try parsers in order (jq -> python3 -> grep/sed), falling through on
|
||||
# failure. Selection is by *parse success*, not mere availability: on
|
||||
# Windows `python3` commonly resolves to the Microsoft Store App Execution
|
||||
# Alias stub, which passes `command -v` but fails at runtime (exit 49), so
|
||||
# an availability-gated `elif` would pick python3, swallow its failure, and
|
||||
# never reach the grep/sed fallback -- leaving feature.json unreadable even
|
||||
# though it is valid (issue #3304).
|
||||
local _fd=''
|
||||
if command -v jq >/dev/null 2>&1; then
|
||||
if ! _fd=$(jq -r '.feature_directory // empty' "$fj" 2>/dev/null); then
|
||||
_fd=''
|
||||
fi
|
||||
fi
|
||||
if [[ -z "$_fd" ]] && command -v python3 >/dev/null 2>&1; then
|
||||
# Use Python so pretty-printed/multi-line JSON still parses correctly.
|
||||
if ! _fd=$(python3 -c "import json,sys; d=json.load(open(sys.argv[1], encoding='utf-8')); v=d.get('feature_directory'); print(v if v else '')" "$fj" 2>/dev/null); then
|
||||
_fd=''
|
||||
fi
|
||||
fi
|
||||
if [[ -z "$_fd" ]]; then
|
||||
# Last-resort single-line grep/sed fallback. The `|| true` guards against
|
||||
# grep returning 1 (no match) aborting under `set -e` / `pipefail`.
|
||||
_fd=$( { grep -E '"feature_directory"[[:space:]]*:' "$fj" 2>/dev/null || true; } \
|
||||
| head -n 1 \
|
||||
| sed -E 's/^[^:]*:[[:space:]]*"([^"]*)".*$/\1/' )
|
||||
fi
|
||||
|
||||
printf '%s' "$_fd"
|
||||
return 0
|
||||
}
|
||||
|
||||
# Persist a feature_directory value to .specify/feature.json.
|
||||
# Writes only when the file is missing or the value differs from what's stored.
|
||||
# Accepts the raw (possibly relative) path — callers should pass the original
|
||||
# user-supplied value, not the normalized absolute path.
|
||||
_persist_feature_json() {
|
||||
local repo_root="$1"
|
||||
local feature_dir_value="$2"
|
||||
local fj="$repo_root/.specify/feature.json"
|
||||
|
||||
# Strip repo_root prefix if the value is absolute and under repo_root
|
||||
if [[ "$feature_dir_value" == "$repo_root/"* ]]; then
|
||||
feature_dir_value="${feature_dir_value#"$repo_root/"}"
|
||||
fi
|
||||
|
||||
# Read current value (if any) and skip write when unchanged
|
||||
local current_val
|
||||
current_val=$(read_feature_json_feature_directory "$repo_root")
|
||||
if [[ "$current_val" == "$feature_dir_value" ]]; then
|
||||
return 0
|
||||
fi
|
||||
|
||||
# Ensure .specify/ directory exists
|
||||
mkdir -p "$repo_root/.specify"
|
||||
|
||||
# Write feature.json — prefer jq for safe JSON, fall back to printf
|
||||
if command -v jq >/dev/null 2>&1; then
|
||||
jq -cn --arg fd "$feature_dir_value" '{feature_directory:$fd}' > "$fj"
|
||||
else
|
||||
printf '{"feature_directory":"%s"}\n' "$(json_escape "$feature_dir_value")" > "$fj"
|
||||
fi
|
||||
}
|
||||
|
||||
get_feature_paths() {
|
||||
# Read-only callers (e.g. check-prerequisites.sh --paths-only) pass
|
||||
# --no-persist so pure path resolution never writes .specify/feature.json,
|
||||
# which would dirty the working tree or overwrite a pinned value (issue #3025).
|
||||
local no_persist=false
|
||||
if [[ "${1:-}" == "--no-persist" ]]; then
|
||||
no_persist=true
|
||||
shift
|
||||
fi
|
||||
# SPECIFY_FEATURE_NO_PERSIST is the environment-level equivalent of --no-persist,
|
||||
# letting an orchestrator (multi-agent runner, CI matrix) guarantee that no
|
||||
# script invocation in the process tree writes .specify/feature.json, even
|
||||
# scripts that don't pass --no-persist themselves (#4128).
|
||||
if [[ "${SPECIFY_FEATURE_NO_PERSIST:-}" == "1" || "${SPECIFY_FEATURE_NO_PERSIST:-}" == "true" ]]; then
|
||||
no_persist=true
|
||||
fi
|
||||
|
||||
# Split decl/assignment so a SPECIFY_INIT_DIR validation failure in
|
||||
# get_repo_root propagates as a hard error instead of being masked by `local`.
|
||||
local repo_root
|
||||
repo_root=$(get_repo_root) || return 1
|
||||
local current_branch
|
||||
current_branch=$(get_current_branch)
|
||||
|
||||
# Resolve feature directory. Priority:
|
||||
# 1. SPECIFY_FEATURE_DIRECTORY env var (explicit override)
|
||||
# 2. .specify/feature.json "feature_directory" key (persisted by specify command)
|
||||
# 3. Error — no feature context available
|
||||
local feature_dir
|
||||
if [[ -n "${SPECIFY_FEATURE_DIRECTORY:-}" ]]; then
|
||||
feature_dir="$SPECIFY_FEATURE_DIRECTORY"
|
||||
# Normalize relative paths to absolute under repo root
|
||||
[[ "$feature_dir" != /* ]] && feature_dir="$repo_root/$feature_dir"
|
||||
# Persist to feature.json so future sessions without the env var still
|
||||
# work — unless the caller opted out for read-only resolution (#3025).
|
||||
if [[ "$no_persist" != true ]]; then
|
||||
_persist_feature_json "$repo_root" "$SPECIFY_FEATURE_DIRECTORY"
|
||||
fi
|
||||
elif [[ -f "$repo_root/.specify/feature.json" ]]; then
|
||||
local _fd
|
||||
_fd=$(read_feature_json_feature_directory "$repo_root")
|
||||
if [[ -n "$_fd" ]]; then
|
||||
feature_dir="$_fd"
|
||||
# Normalize relative paths to absolute under repo root
|
||||
[[ "$feature_dir" != /* ]] && feature_dir="$repo_root/$feature_dir"
|
||||
else
|
||||
echo "ERROR: Feature directory not found. Set SPECIFY_FEATURE_DIRECTORY or ensure .specify/feature.json contains feature_directory." >&2
|
||||
return 1
|
||||
fi
|
||||
else
|
||||
echo "ERROR: Feature directory not found. Set SPECIFY_FEATURE_DIRECTORY or run the specify command to create .specify/feature.json." >&2
|
||||
return 1
|
||||
fi
|
||||
|
||||
# When no branch context exists (no SPECIFY_FEATURE, feature resolved via
|
||||
# SPECIFY_FEATURE_DIRECTORY or feature.json), fall back to the feature
|
||||
# directory basename so CURRENT_BRANCH is a usable identifier rather than
|
||||
# an empty, misleading value (issue #3026).
|
||||
if [[ -z "$current_branch" ]]; then
|
||||
local feature_dir_trimmed="${feature_dir%/}"
|
||||
current_branch="${feature_dir_trimmed##*/}"
|
||||
fi
|
||||
|
||||
# Use printf '%q' to safely quote values, preventing shell injection
|
||||
# via crafted branch names or paths containing special characters
|
||||
printf 'REPO_ROOT=%q\n' "$repo_root"
|
||||
printf 'CURRENT_BRANCH=%q\n' "$current_branch"
|
||||
printf 'FEATURE_DIR=%q\n' "$feature_dir"
|
||||
printf 'FEATURE_SPEC=%q\n' "$feature_dir/spec.md"
|
||||
printf 'IMPL_PLAN=%q\n' "$feature_dir/plan.md"
|
||||
printf 'TASKS=%q\n' "$feature_dir/tasks.md"
|
||||
printf 'RESEARCH=%q\n' "$feature_dir/research.md"
|
||||
printf 'DATA_MODEL=%q\n' "$feature_dir/data-model.md"
|
||||
printf 'QUICKSTART=%q\n' "$feature_dir/quickstart.md"
|
||||
printf 'CONTRACTS_DIR=%q\n' "$feature_dir/contracts"
|
||||
}
|
||||
|
||||
# Check if jq is available for safe JSON construction
|
||||
has_jq() {
|
||||
command -v jq >/dev/null 2>&1
|
||||
}
|
||||
|
||||
get_invoke_separator() {
|
||||
local repo_root="${1:-$(get_repo_root)}"
|
||||
if [[ "${_SPECIFY_INVOKE_SEPARATOR_CACHE_REPO_ROOT:-}" == "$repo_root" && -n "${_SPECIFY_INVOKE_SEPARATOR_CACHE_VALUE:-}" ]]; then
|
||||
printf '%s\n' "$_SPECIFY_INVOKE_SEPARATOR_CACHE_VALUE"
|
||||
return 0
|
||||
fi
|
||||
|
||||
local integration_json="$repo_root/.specify/integration.json"
|
||||
local separator="."
|
||||
local parsed=0
|
||||
|
||||
if [[ -f "$integration_json" ]]; then
|
||||
# Try parsers in order (jq -> python3 -> awk), falling through on
|
||||
# failure. Selection is by *parse success*, not mere availability: on
|
||||
# Windows `python3` commonly resolves to the Microsoft Store App
|
||||
# Execution Alias stub, which passes `command -v` but fails at runtime
|
||||
# (exit 49). An availability-gated branch would pick python3, swallow
|
||||
# its failure, and — because this function historically had no text
|
||||
# fallback — silently return "." even for `-`-separator integrations
|
||||
# (e.g. forge, cline), yielding wrong command hints (issue #3304).
|
||||
if command -v jq >/dev/null 2>&1; then
|
||||
local jq_separator
|
||||
if jq_separator=$(jq -r '(.default_integration // .integration // "") as $k | if $k == "" then "." else (.integration_settings[$k].invoke_separator // ".") end' "$integration_json" 2>/dev/null); then
|
||||
case "$jq_separator" in
|
||||
"."|"-") separator="$jq_separator"; parsed=1 ;;
|
||||
esac
|
||||
fi
|
||||
fi
|
||||
|
||||
if [[ "$parsed" -eq 0 ]] && command -v python3 >/dev/null 2>&1; then
|
||||
local py_separator
|
||||
if py_separator=$(python3 - "$integration_json" <<'PY' 2>/dev/null
|
||||
import json
|
||||
import sys
|
||||
|
||||
try:
|
||||
with open(sys.argv[1], encoding="utf-8") as fh:
|
||||
state = json.load(fh)
|
||||
key = state.get("default_integration") or state.get("integration") or ""
|
||||
settings = state.get("integration_settings")
|
||||
separator = "."
|
||||
if isinstance(key, str) and isinstance(settings, dict):
|
||||
entry = settings.get(key)
|
||||
if isinstance(entry, dict) and entry.get("invoke_separator") in {".", "-"}:
|
||||
separator = entry["invoke_separator"]
|
||||
print(separator)
|
||||
except Exception:
|
||||
sys.exit(1)
|
||||
PY
|
||||
); then
|
||||
case "$py_separator" in
|
||||
"."|"-") separator="$py_separator"; parsed=1 ;;
|
||||
esac
|
||||
fi
|
||||
fi
|
||||
|
||||
if [[ "$parsed" -eq 0 ]]; then
|
||||
# Last-resort text fallback for environments with neither jq nor a
|
||||
# working python3 (e.g. stock Windows + Git Bash). Reads the active
|
||||
# integration key (default_integration, else integration) and its
|
||||
# invoke_separator from within the integration_settings object.
|
||||
# Handles both pretty-printed (the written form) and compact JSON.
|
||||
# Accumulate all lines into one buffer in END rather than using
|
||||
# gawk-only whole-file slurp (RS="^$"), so this stays portable to
|
||||
# the BSD awk on macOS.
|
||||
local awk_separator
|
||||
awk_separator=$(awk '
|
||||
function keyval(d, name, v) {
|
||||
if (match(d, "\"" name "\"[ \t\r\n]*:[ \t\r\n]*\"[^\"]*\"")) {
|
||||
v=substr(d,RSTART,RLENGTH); sub(/^.*:[ \t\r\n]*"/,"",v); sub(/"$/,"",v); return v
|
||||
}
|
||||
return ""
|
||||
}
|
||||
{ doc = doc $0 "\n" }
|
||||
END {
|
||||
key=keyval(doc,"default_integration"); if (key=="") key=keyval(doc,"integration")
|
||||
sep="."
|
||||
if (key!="") {
|
||||
settings=doc
|
||||
if (match(doc, /"integration_settings"[ \t\r\n]*:[ \t\r\n]*[{]/)) {
|
||||
settings=substr(doc, RSTART+RLENGTH-1)
|
||||
}
|
||||
if (match(settings, "\"" key "\"[ \t\r\n]*:[ \t\r\n]*[{]")) {
|
||||
start=RSTART+RLENGTH-1
|
||||
depth=0
|
||||
obj=""
|
||||
for (i=start; i<=length(settings); i++) {
|
||||
c=substr(settings,i,1)
|
||||
obj=obj c
|
||||
if (c=="{") depth++
|
||||
else if (c=="}") { depth--; if (depth==0) break }
|
||||
}
|
||||
if (match(obj, /"invoke_separator"[ \t\r\n]*:[ \t\r\n]*"[-.]"/)) {
|
||||
tok=substr(obj,RSTART,RLENGTH); s=substr(tok,length(tok)-1,1)
|
||||
if (s=="." || s=="-") sep=s
|
||||
}
|
||||
}
|
||||
}
|
||||
print sep
|
||||
}
|
||||
' "$integration_json" 2>/dev/null)
|
||||
case "$awk_separator" in
|
||||
"."|"-") separator="$awk_separator" ;;
|
||||
esac
|
||||
fi
|
||||
fi
|
||||
|
||||
_SPECIFY_INVOKE_SEPARATOR_CACHE_REPO_ROOT="$repo_root"
|
||||
_SPECIFY_INVOKE_SEPARATOR_CACHE_VALUE="$separator"
|
||||
printf '%s\n' "$separator"
|
||||
}
|
||||
|
||||
format_speckit_command() {
|
||||
local command_name="$1"
|
||||
local repo_root="${2:-$(get_repo_root)}"
|
||||
local separator
|
||||
if [[ "${_SPECIFY_INVOKE_SEPARATOR_CACHE_REPO_ROOT:-}" == "$repo_root" && -n "${_SPECIFY_INVOKE_SEPARATOR_CACHE_VALUE:-}" ]]; then
|
||||
separator="$_SPECIFY_INVOKE_SEPARATOR_CACHE_VALUE"
|
||||
else
|
||||
separator=$(get_invoke_separator "$repo_root")
|
||||
_SPECIFY_INVOKE_SEPARATOR_CACHE_REPO_ROOT="$repo_root"
|
||||
_SPECIFY_INVOKE_SEPARATOR_CACHE_VALUE="$separator"
|
||||
fi
|
||||
|
||||
command_name="${command_name#/}"
|
||||
command_name="${command_name#speckit.}"
|
||||
command_name="${command_name#speckit-}"
|
||||
command_name="${command_name//./$separator}"
|
||||
|
||||
printf '/speckit%s%s\n' "$separator" "$command_name"
|
||||
}
|
||||
|
||||
# Escape a string for safe embedding in a JSON value (fallback when jq is unavailable).
|
||||
# Handles backslash, double-quote, and JSON-required control character escapes (RFC 8259).
|
||||
json_escape() {
|
||||
local s="$1"
|
||||
s="${s//\\/\\\\}"
|
||||
s="${s//\"/\\\"}"
|
||||
s="${s//$'\n'/\\n}"
|
||||
s="${s//$'\t'/\\t}"
|
||||
s="${s//$'\r'/\\r}"
|
||||
s="${s//$'\b'/\\b}"
|
||||
s="${s//$'\f'/\\f}"
|
||||
# Escape any remaining U+0001-U+001F control characters as \uXXXX.
|
||||
# (U+0000/NUL cannot appear in bash strings and is excluded.)
|
||||
# LC_ALL=C ensures ${#s} counts bytes and ${s:$i:1} yields single bytes,
|
||||
# so multi-byte UTF-8 sequences (first byte >= 0xC0) pass through intact.
|
||||
local LC_ALL=C
|
||||
local i char code
|
||||
for (( i=0; i<${#s}; i++ )); do
|
||||
char="${s:$i:1}"
|
||||
printf -v code '%d' "'$char" 2>/dev/null || code=256
|
||||
if (( code >= 1 && code <= 31 )); then
|
||||
printf '\\u%04x' "$code"
|
||||
else
|
||||
printf '%s' "$char"
|
||||
fi
|
||||
done
|
||||
}
|
||||
|
||||
check_file() { [[ -f "$1" ]] && echo " ✓ $2" || echo " ✗ $2"; }
|
||||
check_dir() { [[ -d "$1" && -n $(ls -A "$1" 2>/dev/null) ]] && echo " ✓ $2" || echo " ✗ $2"; }
|
||||
|
||||
_python3_command() {
|
||||
# SPECKIT_PYTHON_EXECUTABLE is the canonical override; SPECKIT_PYTHON is
|
||||
# kept as a deprecated fallback (still used by update-agent-context.sh).
|
||||
local override="${SPECKIT_PYTHON_EXECUTABLE:-${SPECKIT_PYTHON:-}}"
|
||||
if [[ -n "$override" ]] && command -v "$override" >/dev/null 2>&1 &&
|
||||
"$override" -c 'import sys; raise SystemExit(sys.version_info.major != 3)' >/dev/null 2>&1 &&
|
||||
"$override" -c 'import yaml' >/dev/null 2>&1; then
|
||||
printf '%s\n' "$override"
|
||||
elif command -v python3 >/dev/null 2>&1 &&
|
||||
python3 -c 'import sys; raise SystemExit(sys.version_info.major != 3)' >/dev/null 2>&1; then
|
||||
printf '%s\n' "python3"
|
||||
elif command -v python >/dev/null 2>&1 &&
|
||||
python -c 'import sys; raise SystemExit(sys.version_info.major != 3)' >/dev/null 2>&1; then
|
||||
printf '%s\n' "python"
|
||||
elif command -v py >/dev/null 2>&1 &&
|
||||
py -3 -c 'import sys' >/dev/null 2>&1; then
|
||||
printf '%s\n' "py" "-3"
|
||||
else
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
|
||||
_sorted_extension_ids() {
|
||||
local ext_dir="$1"
|
||||
local -a python_cmd=()
|
||||
local _python_cmd_line
|
||||
while IFS= read -r _python_cmd_line; do
|
||||
python_cmd+=("$_python_cmd_line")
|
||||
done < <(_python3_command)
|
||||
if [ "${#python_cmd[@]}" -gt 0 ]; then
|
||||
local py_stderr sorted_ids
|
||||
py_stderr=$(mktemp)
|
||||
if sorted_ids=$(SPECKIT_EXTENSIONS="$ext_dir" "${python_cmd[@]}" -c "
|
||||
import json, os, re, sys
|
||||
from pathlib import Path
|
||||
|
||||
root = Path(os.environ['SPECKIT_EXTENSIONS'])
|
||||
registered = {}
|
||||
registry = root / '.registry'
|
||||
if os.path.lexists(registry):
|
||||
if not registry.is_file():
|
||||
print('registry_invalid: not a regular file', file=sys.stderr)
|
||||
sys.exit(1)
|
||||
try:
|
||||
data = json.loads(registry.read_text(encoding='utf-8'))
|
||||
except Exception as exc:
|
||||
print('registry_invalid: ' + str(exc), file=sys.stderr)
|
||||
sys.exit(1)
|
||||
if not isinstance(data, dict):
|
||||
print('registry_invalid: root must be a mapping', file=sys.stderr)
|
||||
sys.exit(1)
|
||||
raw_extensions = data.get('extensions', {})
|
||||
if not isinstance(raw_extensions, dict):
|
||||
print('registry_invalid: extensions must be a mapping', file=sys.stderr)
|
||||
sys.exit(1)
|
||||
registered = raw_extensions
|
||||
|
||||
def priority(value):
|
||||
if isinstance(value, bool):
|
||||
return 10
|
||||
try:
|
||||
parsed = int(value)
|
||||
return parsed if parsed >= 1 else 10
|
||||
except (TypeError, ValueError, OverflowError):
|
||||
return 10
|
||||
|
||||
ranked = []
|
||||
for ext_id, meta in registered.items():
|
||||
if isinstance(ext_id, str) and re.fullmatch(r'[a-z0-9-]+', ext_id) and isinstance(meta, dict) and bool(meta.get('enabled', True)):
|
||||
ranked.append((priority(meta.get('priority')), ext_id))
|
||||
for path in root.iterdir():
|
||||
if path.is_dir() and re.fullmatch(r'[a-z0-9-]+', path.name) and path.name not in registered:
|
||||
ranked.append((10, path.name))
|
||||
for _, ext_id in sorted(ranked):
|
||||
print(ext_id)
|
||||
" 2>"$py_stderr"); then
|
||||
rm -f "$py_stderr"
|
||||
printf '%s\n' "$sorted_ids"
|
||||
return 0
|
||||
else
|
||||
echo "Error: invalid extension registry $ext_dir/.registry" >&2
|
||||
rm -f "$py_stderr"
|
||||
return 1
|
||||
fi
|
||||
fi
|
||||
|
||||
if [ -e "$ext_dir/.registry" ] || [ -L "$ext_dir/.registry" ]; then
|
||||
if [ ! -f "$ext_dir/.registry" ] || [ ! -r "$ext_dir/.registry" ]; then
|
||||
echo "Error: invalid extension registry $ext_dir/.registry" >&2
|
||||
return 1
|
||||
fi
|
||||
echo "Error: Python 3 is required to honor the extension registry" >&2
|
||||
return 2
|
||||
fi
|
||||
|
||||
local ext extension_id
|
||||
for ext in "$ext_dir"/*/; do
|
||||
[ -d "$ext" ] || continue
|
||||
extension_id=$(basename "$ext")
|
||||
case "$extension_id" in *[!a-z0-9-]*) continue ;; esac
|
||||
printf '%s\n' "$extension_id"
|
||||
done
|
||||
}
|
||||
|
||||
# Resolve a template name to a file path using the priority stack:
|
||||
# 1. .specify/templates/overrides/
|
||||
# 2. .specify/presets/<preset-id>/templates/ (sorted by priority from .registry)
|
||||
# 3. .specify/extensions/<ext-id>/templates/
|
||||
# 4. .specify/templates/ (core)
|
||||
resolve_template() {
|
||||
local template_name="$1"
|
||||
local repo_root="$2"
|
||||
local base="$repo_root/.specify/templates"
|
||||
|
||||
case "$template_name" in ""|*[!a-z0-9-]*) return 1 ;; esac
|
||||
|
||||
# Priority 1: Project overrides
|
||||
local override="$base/overrides/${template_name}.md"
|
||||
[ -f "$override" ] && echo "$override" && return 0
|
||||
|
||||
# Priority 2: Installed presets (sorted by priority from .registry)
|
||||
local presets_dir="$repo_root/.specify/presets"
|
||||
if [ -d "$presets_dir" ]; then
|
||||
local registry_file="$presets_dir/.registry"
|
||||
local -a python_cmd=()
|
||||
local _python_cmd_line
|
||||
while IFS= read -r _python_cmd_line; do
|
||||
python_cmd+=("$_python_cmd_line")
|
||||
done < <(_python3_command)
|
||||
if [ -f "$registry_file" ] && [ "${#python_cmd[@]}" -gt 0 ]; then
|
||||
# Read preset IDs sorted by priority (lower number = higher precedence).
|
||||
# The python3 call is wrapped in an if-condition so that set -e does not
|
||||
# abort the function when python3 exits non-zero (e.g. invalid JSON).
|
||||
local sorted_presets=""
|
||||
if sorted_presets=$(SPECKIT_REGISTRY="$registry_file" "${python_cmd[@]}" -c "
|
||||
import json, re, sys, os
|
||||
try:
|
||||
with open(os.environ['SPECKIT_REGISTRY'], encoding='utf-8') as f:
|
||||
data = json.load(f)
|
||||
presets = data.get('presets', {})
|
||||
def priority(meta):
|
||||
if not isinstance(meta, dict) or isinstance(meta.get('priority'), bool):
|
||||
return 10
|
||||
try:
|
||||
value = int(meta.get('priority', 10))
|
||||
return value if value >= 1 else 10
|
||||
except (TypeError, ValueError, OverflowError):
|
||||
return 10
|
||||
for pid, meta in sorted(presets.items(), key=lambda x: (priority(x[1]), x[0])):
|
||||
if isinstance(meta, dict) and bool(meta.get('enabled', True)) and re.fullmatch(r'[a-z0-9-]+', pid):
|
||||
print(pid)
|
||||
except Exception:
|
||||
sys.exit(1)
|
||||
" 2>/dev/null); then
|
||||
if [ -n "$sorted_presets" ]; then
|
||||
# python3 succeeded and returned preset IDs — search in priority order
|
||||
while IFS= read -r preset_id; do
|
||||
local candidate="$presets_dir/$preset_id/templates/${template_name}.md"
|
||||
[ -f "$candidate" ] && echo "$candidate" && return 0
|
||||
candidate="$presets_dir/$preset_id/${template_name}.md"
|
||||
[ -f "$candidate" ] && echo "$candidate" && return 0
|
||||
done <<< "$sorted_presets"
|
||||
fi
|
||||
# python3 succeeded but registry has no presets — nothing to search
|
||||
else
|
||||
# python3 failed (missing, or registry parse error) — fall back to unordered directory scan
|
||||
for preset in "$presets_dir"/*/; do
|
||||
[ -d "$preset" ] || continue
|
||||
local candidate="$preset/templates/${template_name}.md"
|
||||
[ -f "$candidate" ] && echo "$candidate" && return 0
|
||||
candidate="$preset/${template_name}.md"
|
||||
[ -f "$candidate" ] && echo "$candidate" && return 0
|
||||
done
|
||||
fi
|
||||
else
|
||||
# Fallback: alphabetical directory order (no python3 available)
|
||||
for preset in "$presets_dir"/*/; do
|
||||
[ -d "$preset" ] || continue
|
||||
local candidate="$preset/templates/${template_name}.md"
|
||||
[ -f "$candidate" ] && echo "$candidate" && return 0
|
||||
candidate="$preset/${template_name}.md"
|
||||
[ -f "$candidate" ] && echo "$candidate" && return 0
|
||||
done
|
||||
fi
|
||||
fi
|
||||
|
||||
# Priority 3: Extension-provided templates
|
||||
local ext_dir="$repo_root/.specify/extensions"
|
||||
if [ -d "$ext_dir" ]; then
|
||||
local sorted_extensions=""
|
||||
if ! sorted_extensions=$(_sorted_extension_ids "$ext_dir"); then
|
||||
return 2
|
||||
fi
|
||||
while IFS= read -r extension_id; do
|
||||
[ -n "$extension_id" ] || continue
|
||||
local ext="$ext_dir/$extension_id"
|
||||
local candidate="$ext/templates/${template_name}.md"
|
||||
[ -f "$candidate" ] || candidate="$ext/${template_name}.md"
|
||||
[ -f "$candidate" ] && echo "$candidate" && return 0
|
||||
done <<< "$sorted_extensions"
|
||||
fi
|
||||
|
||||
# Priority 4: Core templates
|
||||
local core="$base/${template_name}.md"
|
||||
[ -f "$core" ] && echo "$core" && return 0
|
||||
|
||||
# Template not found in any location.
|
||||
# Return 1 so callers can distinguish "not found" from "found".
|
||||
# Callers running under set -e should use: TEMPLATE=$(resolve_template ...) || true
|
||||
return 1
|
||||
}
|
||||
|
||||
# Resolve a template name to composed content using composition strategies.
|
||||
# Reads strategy metadata from preset manifests and composes content
|
||||
# from multiple layers using prepend, append, or wrap strategies.
|
||||
#
|
||||
# Usage: CONTENT=$(resolve_template_content "template-name" "$REPO_ROOT")
|
||||
# Returns composed content string on stdout; exit code 1 if not found.
|
||||
resolve_template_content() {
|
||||
local template_name="$1"
|
||||
local repo_root="$2"
|
||||
local base="$repo_root/.specify/templates"
|
||||
|
||||
case "$template_name" in ""|*[!a-z0-9-]*) return 1 ;; esac
|
||||
|
||||
# Collect all layers (highest priority first)
|
||||
local -a layer_paths=()
|
||||
local -a layer_strategies=()
|
||||
|
||||
# Priority 1: Project overrides (always "replace")
|
||||
local override="$base/overrides/${template_name}.md"
|
||||
if [ -f "$override" ]; then
|
||||
if ! cat "$override"; then
|
||||
echo "Error: failed to read template layer $override" >&2
|
||||
return 2
|
||||
fi
|
||||
return 0
|
||||
fi
|
||||
|
||||
local effective_base_found=false
|
||||
|
||||
# Priority 2: Installed presets (sorted by priority from .registry)
|
||||
local presets_dir="$repo_root/.specify/presets"
|
||||
if [ -d "$presets_dir" ]; then
|
||||
local registry_file="$presets_dir/.registry"
|
||||
local sorted_presets=""
|
||||
local registry_parsed=false
|
||||
local -a python_cmd=()
|
||||
local _python_cmd_line
|
||||
while IFS= read -r _python_cmd_line; do
|
||||
python_cmd+=("$_python_cmd_line")
|
||||
done < <(_python3_command)
|
||||
if [ -f "$registry_file" ] && [ "${#python_cmd[@]}" -gt 0 ]; then
|
||||
if sorted_presets=$(SPECKIT_REGISTRY="$registry_file" "${python_cmd[@]}" -c "
|
||||
import json, re, sys, os
|
||||
try:
|
||||
with open(os.environ['SPECKIT_REGISTRY'], encoding='utf-8') as f:
|
||||
data = json.load(f)
|
||||
presets = data.get('presets', {})
|
||||
def priority(meta):
|
||||
if not isinstance(meta, dict) or isinstance(meta.get('priority'), bool):
|
||||
return 10
|
||||
try:
|
||||
value = int(meta.get('priority', 10))
|
||||
return value if value >= 1 else 10
|
||||
except (TypeError, ValueError, OverflowError):
|
||||
return 10
|
||||
for pid, meta in sorted(presets.items(), key=lambda x: (priority(x[1]), x[0])):
|
||||
if isinstance(meta, dict) and bool(meta.get('enabled', True)) and re.fullmatch(r'[a-z0-9-]+', pid):
|
||||
print(pid)
|
||||
except Exception:
|
||||
sys.exit(1)
|
||||
" 2>/dev/null); then
|
||||
registry_parsed=true
|
||||
fi
|
||||
fi
|
||||
if [ "$registry_parsed" = false ]; then
|
||||
for preset in "$presets_dir"/*/; do
|
||||
[ -d "$preset" ] || continue
|
||||
local fallback_id
|
||||
fallback_id=$(basename "$preset")
|
||||
case "$fallback_id" in *[!a-z0-9-]*) continue ;; esac
|
||||
sorted_presets+="${sorted_presets:+$'\n'}$fallback_id"
|
||||
done
|
||||
fi
|
||||
|
||||
if [ -n "$sorted_presets" ]; then
|
||||
while IFS= read -r preset_id; do
|
||||
local strategy="replace"
|
||||
local manifest_file=""
|
||||
local manifest="$presets_dir/$preset_id/preset.yml"
|
||||
local manifest_declared=false
|
||||
if [ -f "$manifest" ]; then
|
||||
if [ "${#python_cmd[@]}" -eq 0 ]; then
|
||||
echo "Error: Python 3 and PyYAML are required to resolve preset template composition" >&2
|
||||
return 2
|
||||
fi
|
||||
local result
|
||||
local py_stderr
|
||||
local parse_status
|
||||
py_stderr=$(mktemp)
|
||||
if result=$(SPECKIT_MANIFEST="$manifest" SPECKIT_TMPL="$template_name" "${python_cmd[@]}" -c "
|
||||
import sys, os
|
||||
try:
|
||||
import yaml
|
||||
except ImportError:
|
||||
print('yaml_missing', file=sys.stderr)
|
||||
sys.exit(2)
|
||||
try:
|
||||
with open(os.environ['SPECKIT_MANIFEST'], encoding='utf-8') as f:
|
||||
data = yaml.safe_load(f)
|
||||
if not isinstance(data, dict):
|
||||
raise ValueError('manifest root must be a mapping')
|
||||
if 'provides' not in data:
|
||||
raise ValueError('manifest missing provides section')
|
||||
provides = data['provides']
|
||||
if not isinstance(provides, dict):
|
||||
raise ValueError('manifest provides must be a mapping')
|
||||
if 'templates' not in provides:
|
||||
raise ValueError('manifest provides missing templates')
|
||||
templates = provides['templates']
|
||||
if not isinstance(templates, list):
|
||||
raise ValueError('manifest templates must be a list')
|
||||
if not templates:
|
||||
raise ValueError('manifest must provide at least one template')
|
||||
valid_types = ('template', 'command', 'script')
|
||||
valid_strategies = ('replace', 'prepend', 'append', 'wrap')
|
||||
for t in templates:
|
||||
if not isinstance(t, dict):
|
||||
raise ValueError('manifest template entries must be mappings')
|
||||
if 'type' not in t or 'name' not in t or 'file' not in t:
|
||||
raise ValueError('manifest template entry missing type, name, or file')
|
||||
for field in ('type', 'name', 'file'):
|
||||
if not isinstance(t[field], str):
|
||||
raise ValueError('manifest template ' + field + ' must be a string')
|
||||
if t['type'] not in valid_types:
|
||||
raise ValueError('invalid manifest template type')
|
||||
strategy = t.get('strategy', 'replace')
|
||||
if not isinstance(strategy, str):
|
||||
raise ValueError('manifest template strategy must be a string')
|
||||
strategy = strategy.lower()
|
||||
if strategy not in valid_strategies:
|
||||
raise ValueError('invalid manifest template strategy')
|
||||
if t['type'] == 'script' and strategy not in ('replace', 'wrap'):
|
||||
raise ValueError('invalid manifest script strategy')
|
||||
for t in templates:
|
||||
if t.get('name') == os.environ['SPECKIT_TMPL'] and t.get('type', 'template') == 'template':
|
||||
file_value = t.get('file', '')
|
||||
strategy = t.get('strategy', 'replace')
|
||||
print('found\t' + strategy + '\t' + file_value)
|
||||
sys.exit(0)
|
||||
print('absent\treplace\t')
|
||||
except Exception as exc:
|
||||
print(f'manifest_invalid: {exc}', file=sys.stderr)
|
||||
sys.exit(3)
|
||||
" 2>"$py_stderr"); then
|
||||
parse_status=0
|
||||
else
|
||||
parse_status=$?
|
||||
fi
|
||||
if [ "$parse_status" -ne 0 ]; then
|
||||
if [ "$parse_status" -eq 2 ]; then
|
||||
echo "Error: PyYAML is required to resolve preset template composition" >&2
|
||||
else
|
||||
echo "Error: invalid preset manifest $manifest" >&2
|
||||
fi
|
||||
rm -f "$py_stderr"
|
||||
return 2
|
||||
fi
|
||||
if [ -n "$result" ]; then
|
||||
local declaration
|
||||
IFS=$'\t' read -r declaration strategy manifest_file <<< "$result"
|
||||
[ "$declaration" = "found" ] && manifest_declared=true
|
||||
strategy=$(printf '%s' "$strategy" | tr '[:upper:]' '[:lower:]')
|
||||
fi
|
||||
rm -f "$py_stderr"
|
||||
fi
|
||||
|
||||
local candidate=""
|
||||
if [ -n "$manifest_file" ]; then
|
||||
case "$manifest_file" in
|
||||
/*|*../*) manifest_file="" ;;
|
||||
esac
|
||||
fi
|
||||
if [ -n "$manifest_file" ]; then
|
||||
local mf="$presets_dir/$preset_id/$manifest_file"
|
||||
[ -f "$mf" ] && candidate="$mf"
|
||||
fi
|
||||
if [ -z "$candidate" ] && [ "$manifest_declared" = false ]; then
|
||||
local cf="$presets_dir/$preset_id/templates/${template_name}.md"
|
||||
[ -f "$cf" ] && candidate="$cf"
|
||||
if [ -z "$candidate" ]; then
|
||||
cf="$presets_dir/$preset_id/${template_name}.md"
|
||||
[ -f "$cf" ] && candidate="$cf"
|
||||
fi
|
||||
fi
|
||||
if [ -n "$candidate" ]; then
|
||||
layer_paths+=("$candidate")
|
||||
layer_strategies+=("$strategy")
|
||||
if [ "$strategy" = "replace" ]; then
|
||||
effective_base_found=true
|
||||
break
|
||||
fi
|
||||
fi
|
||||
done <<< "$sorted_presets"
|
||||
fi
|
||||
fi
|
||||
|
||||
# Priority 3: Extension-provided templates (always "replace")
|
||||
local ext_dir="$repo_root/.specify/extensions"
|
||||
if [ "$effective_base_found" = false ] && [ -d "$ext_dir" ]; then
|
||||
local sorted_extensions=""
|
||||
if ! sorted_extensions=$(_sorted_extension_ids "$ext_dir"); then
|
||||
return 2
|
||||
fi
|
||||
while IFS= read -r extension_id; do
|
||||
[ -n "$extension_id" ] || continue
|
||||
local ext="$ext_dir/$extension_id"
|
||||
local candidate="$ext/templates/${template_name}.md"
|
||||
[ -f "$candidate" ] || candidate="$ext/${template_name}.md"
|
||||
if [ -f "$candidate" ]; then
|
||||
layer_paths+=("$candidate")
|
||||
layer_strategies+=("replace")
|
||||
effective_base_found=true
|
||||
break
|
||||
fi
|
||||
done <<< "$sorted_extensions"
|
||||
fi
|
||||
|
||||
# Priority 4: Core templates (always "replace")
|
||||
local core="$base/${template_name}.md"
|
||||
if [ "$effective_base_found" = false ] && [ -f "$core" ]; then
|
||||
layer_paths+=("$core")
|
||||
layer_strategies+=("replace")
|
||||
fi
|
||||
|
||||
local count=${#layer_paths[@]}
|
||||
[ "$count" -eq 0 ] && return 1
|
||||
|
||||
# Check if any layer uses a non-replace strategy
|
||||
local has_composition=false
|
||||
for s in "${layer_strategies[@]}"; do
|
||||
[ "$s" != "replace" ] && has_composition=true && break
|
||||
done
|
||||
|
||||
# If the top (highest-priority) layer is replace, it wins entirely —
|
||||
# lower layers are irrelevant regardless of their strategies.
|
||||
if [ "${layer_strategies[0]}" = "replace" ]; then
|
||||
if ! cat "${layer_paths[0]}"; then
|
||||
echo "Error: failed to read template layer ${layer_paths[0]}" >&2
|
||||
return 2
|
||||
fi
|
||||
return 0
|
||||
fi
|
||||
|
||||
if [ "$has_composition" = false ]; then
|
||||
if ! cat "${layer_paths[0]}"; then
|
||||
echo "Error: failed to read template layer ${layer_paths[0]}" >&2
|
||||
return 2
|
||||
fi
|
||||
return 0
|
||||
fi
|
||||
|
||||
# Find the effective base: scan from highest priority (index 0) downward
|
||||
# to find the nearest replace layer. Only compose layers above that base.
|
||||
local base_idx=-1
|
||||
local i
|
||||
for (( i=0; i<count; i++ )); do
|
||||
if [ "${layer_strategies[$i]}" = "replace" ]; then
|
||||
base_idx=$i
|
||||
break
|
||||
fi
|
||||
done
|
||||
|
||||
if [ $base_idx -lt 0 ]; then
|
||||
echo "Error: template '$template_name' has composing layers but no replace base" >&2
|
||||
return 2
|
||||
fi
|
||||
|
||||
# Read the base content; compose layers above the base (higher priority)
|
||||
local content
|
||||
if ! content=$(cat "${layer_paths[$base_idx]}"; status=$?; printf x; exit "$status"); then
|
||||
echo "Error: failed to read template layer ${layer_paths[$base_idx]}" >&2
|
||||
return 2
|
||||
fi
|
||||
content="${content%x}"
|
||||
|
||||
for (( i=base_idx-1; i>=0; i-- )); do
|
||||
local path="${layer_paths[$i]}"
|
||||
local strat="${layer_strategies[$i]}"
|
||||
local layer_content
|
||||
# Preserve trailing newlines
|
||||
if ! layer_content=$(cat "$path"; status=$?; printf x; exit "$status"); then
|
||||
echo "Error: failed to read template layer $path" >&2
|
||||
return 2
|
||||
fi
|
||||
layer_content="${layer_content%x}"
|
||||
|
||||
case "$strat" in
|
||||
replace) content="$layer_content" ;;
|
||||
prepend)
|
||||
content=$(printf '%s\n\n%s' "$layer_content" "$content"; printf x)
|
||||
content="${content%x}"
|
||||
;;
|
||||
append)
|
||||
content=$(printf '%s\n\n%s' "$content" "$layer_content"; printf x)
|
||||
content="${content%x}"
|
||||
;;
|
||||
wrap)
|
||||
case "$layer_content" in
|
||||
*'{CORE_TEMPLATE}'*) ;;
|
||||
*) echo "Error: wrap strategy missing {CORE_TEMPLATE} placeholder" >&2; return 2 ;;
|
||||
esac
|
||||
# Consume the wrapper left to right instead of rewriting it in
|
||||
# place. Rewriting re-scanned the string just modified, so base
|
||||
# content holding a literal {CORE_TEMPLATE} reintroduced the
|
||||
# token every pass and the loop never terminated. Advancing over
|
||||
# ``rest`` bounds the work by the tokens in the original wrapper
|
||||
# and leaves inserted content untouched, matching the single-pass
|
||||
# semantics of .Replace()/.replace() in the PowerShell and Python
|
||||
# ports.
|
||||
local wrapped="" rest="$layer_content"
|
||||
while [[ "$rest" == *'{CORE_TEMPLATE}'* ]]; do
|
||||
wrapped="${wrapped}${rest%%\{CORE_TEMPLATE\}*}${content}"
|
||||
rest="${rest#*\{CORE_TEMPLATE\}}"
|
||||
done
|
||||
content="${wrapped}${rest}"
|
||||
;;
|
||||
*) echo "Error: unknown strategy '$strat'" >&2; return 2 ;;
|
||||
esac
|
||||
done
|
||||
|
||||
printf '%s' "$content"
|
||||
return 0
|
||||
}
|
||||
Executable
+504
@@ -0,0 +1,504 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
set -e
|
||||
|
||||
JSON_MODE=false
|
||||
DRY_RUN=false
|
||||
ALLOW_EXISTING=false
|
||||
SHORT_NAME=""
|
||||
BRANCH_NUMBER=""
|
||||
USE_TIMESTAMP=false
|
||||
NUMBER_EXPLICIT=false
|
||||
ARGS=()
|
||||
i=1
|
||||
while [ $i -le $# ]; do
|
||||
arg="${!i}"
|
||||
case "$arg" in
|
||||
--json)
|
||||
JSON_MODE=true
|
||||
;;
|
||||
--dry-run)
|
||||
DRY_RUN=true
|
||||
;;
|
||||
--allow-existing-branch)
|
||||
ALLOW_EXISTING=true
|
||||
;;
|
||||
--short-name)
|
||||
if [ $((i + 1)) -gt $# ]; then
|
||||
echo 'Error: --short-name requires a value' >&2
|
||||
exit 1
|
||||
fi
|
||||
i=$((i + 1))
|
||||
next_arg="${!i}"
|
||||
# Check if the next argument is another option (starts with --)
|
||||
if [[ "$next_arg" == --* ]]; then
|
||||
echo 'Error: --short-name requires a value' >&2
|
||||
exit 1
|
||||
fi
|
||||
SHORT_NAME="$next_arg"
|
||||
;;
|
||||
--number)
|
||||
if [ $((i + 1)) -gt $# ]; then
|
||||
echo 'Error: --number requires a value' >&2
|
||||
exit 1
|
||||
fi
|
||||
i=$((i + 1))
|
||||
next_arg="${!i}"
|
||||
if [[ "$next_arg" == --* ]]; then
|
||||
echo 'Error: --number requires a value' >&2
|
||||
exit 1
|
||||
fi
|
||||
BRANCH_NUMBER="$next_arg"
|
||||
if [ -n "$BRANCH_NUMBER" ]; then
|
||||
NUMBER_EXPLICIT=true
|
||||
fi
|
||||
;;
|
||||
--timestamp)
|
||||
USE_TIMESTAMP=true
|
||||
;;
|
||||
--help|-h)
|
||||
echo "Usage: $0 [--json] [--dry-run] [--allow-existing-branch] [--short-name <name>] [--number N] [--timestamp] <feature_description>"
|
||||
echo ""
|
||||
echo "Options:"
|
||||
echo " --json Output in JSON format"
|
||||
echo " --dry-run Compute feature name and paths without creating directories or files"
|
||||
echo " --allow-existing-branch Reuse an existing feature directory if it already exists"
|
||||
echo " --short-name <name> Provide a custom short name (2-4 words) for the feature"
|
||||
echo " --number N Prefer a feature number (auto-corrected if its specs prefix exists)"
|
||||
echo " --timestamp Use timestamp prefix (YYYYMMDD-HHMMSS) instead of sequential numbering"
|
||||
echo " --help, -h Show this help message"
|
||||
echo ""
|
||||
echo "Examples:"
|
||||
echo " $0 'Add user authentication system' --short-name 'user-auth'"
|
||||
echo " $0 'Implement OAuth2 integration for API' --number 5"
|
||||
echo " $0 --timestamp --short-name 'user-auth' 'Add user authentication'"
|
||||
exit 0
|
||||
;;
|
||||
*)
|
||||
ARGS+=("$arg")
|
||||
;;
|
||||
esac
|
||||
i=$((i + 1))
|
||||
done
|
||||
|
||||
FEATURE_DESCRIPTION="${ARGS[*]}"
|
||||
if [ -z "$FEATURE_DESCRIPTION" ]; then
|
||||
echo "Usage: $0 [--json] [--dry-run] [--allow-existing-branch] [--short-name <name>] [--number N] [--timestamp] <feature_description>" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Trim whitespace and validate description is not empty (e.g., user passed only whitespace)
|
||||
FEATURE_DESCRIPTION=$(echo "$FEATURE_DESCRIPTION" | sed -E 's/^[[:space:]]+|[[:space:]]+$//g')
|
||||
if [ -z "$FEATURE_DESCRIPTION" ]; then
|
||||
echo "Error: Feature description cannot be empty or contain only whitespace" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
MAX_FEATURE_NUMBER=9223372036854775807
|
||||
MAX_BRANCH_LENGTH=244
|
||||
|
||||
is_feature_number_in_range() {
|
||||
local value="$1"
|
||||
local normalized="${value#"${value%%[!0]*}"}"
|
||||
[ -n "$normalized" ] || normalized=0
|
||||
[ ${#normalized} -lt ${#MAX_FEATURE_NUMBER} ] && return 0
|
||||
[ ${#normalized} -gt ${#MAX_FEATURE_NUMBER} ] && return 1
|
||||
# Equal-length digit strings must be compared without arithmetic overflow.
|
||||
# shellcheck disable=SC2071
|
||||
[[ "$normalized" < "$MAX_FEATURE_NUMBER" || "$normalized" == "$MAX_FEATURE_NUMBER" ]]
|
||||
}
|
||||
|
||||
# Function to get highest number from specs directory
|
||||
get_highest_from_specs() {
|
||||
local specs_dir="$1"
|
||||
local highest=0
|
||||
|
||||
if [ -d "$specs_dir" ]; then
|
||||
for dir in "$specs_dir"/*; do
|
||||
[ -d "$dir" ] || continue
|
||||
dirname=$(basename "$dir")
|
||||
# Match sequential prefixes (>=3 digits), but skip timestamp dirs.
|
||||
if echo "$dirname" | grep -Eq '^[0-9]{3,}-' && ! echo "$dirname" | grep -Eq '^[0-9]{8}-[0-9]{6}-'; then
|
||||
number=$(echo "$dirname" | grep -Eo '^[0-9]+')
|
||||
if is_feature_number_in_range "$number"; then
|
||||
number=$((10#$number))
|
||||
if [ "$number" -gt "$highest" ]; then
|
||||
highest=$number
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
done
|
||||
fi
|
||||
|
||||
echo "$highest"
|
||||
}
|
||||
|
||||
# Return success when a spec directory owns the given numeric prefix.
|
||||
spec_prefix_exists() {
|
||||
local specs_dir="$1"
|
||||
local feature_num="$2"
|
||||
|
||||
for spec_path in "$specs_dir/${feature_num}-"*; do
|
||||
[ -d "$spec_path" ] && return 0
|
||||
done
|
||||
return 1
|
||||
}
|
||||
|
||||
# Function to clean and format a branch name
|
||||
#
|
||||
# Three details keep this consistent with the Python and PowerShell twins:
|
||||
# * Unicode classification uses Python: POSIX [:alnum:] differs by platform.
|
||||
# * `--*` instead of the GNU-only `\+`, which POSIX/BSD sed reads as a literal
|
||||
# '+', leaving repeated separators uncollapsed on macOS.
|
||||
# * printf instead of echo, so a name of "-n"/"-e"/"-E" is text, not options.
|
||||
contains_non_ascii() {
|
||||
LC_ALL=C grep -q '[^[:print:][:cntrl:]]'
|
||||
}
|
||||
|
||||
UNICODE_LOCALE=""
|
||||
locale_candidates=(C.UTF-8 C.utf8 en_US.UTF-8 en_US.utf8 "${LC_CTYPE:-${LANG:-}}")
|
||||
if [ -n "${LC_ALL:-}" ]; then
|
||||
locale_candidates=("$LC_ALL")
|
||||
fi
|
||||
for candidate in "${locale_candidates[@]}"; do
|
||||
if [ -n "$candidate" ] && [ "$(printf 'é。' | LC_ALL="$candidate" sed 's/[^[:alnum:]]/-/g' 2>/dev/null)" = 'é-' ]; then
|
||||
UNICODE_LOCALE="$candidate"
|
||||
break
|
||||
fi
|
||||
done
|
||||
|
||||
if [ -z "$UNICODE_LOCALE" ]; then
|
||||
UNICODE_LOCALE=C
|
||||
if printf '%s' "${SHORT_NAME:-$FEATURE_DESCRIPTION}" | contains_non_ascii; then
|
||||
if [ -n "${LC_ALL:-}" ]; then
|
||||
echo "Error: A UTF-8 locale is required to create a Unicode feature name; LC_ALL=$LC_ALL is not usable" >&2
|
||||
else
|
||||
echo "Error: A UTF-8 locale is required to create a Unicode feature name" >&2
|
||||
fi
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
unicode_words() {
|
||||
local name="${1//$'\n'/ }"
|
||||
local separator="$2"
|
||||
if printf '%s' "$name" | contains_non_ascii; then
|
||||
local -a python_cmd=()
|
||||
local override="${SPECKIT_PYTHON_EXECUTABLE:-${SPECKIT_PYTHON:-}}"
|
||||
if [ -n "$override" ] && command -v "$override" >/dev/null 2>&1 &&
|
||||
"$override" -c 'import sys; raise SystemExit(sys.version_info.major != 3)' >/dev/null 2>&1; then
|
||||
python_cmd=("$override")
|
||||
else
|
||||
local python_line
|
||||
while IFS= read -r python_line; do
|
||||
python_cmd+=("$python_line")
|
||||
done < <(_python3_command)
|
||||
fi
|
||||
if [ "${#python_cmd[@]}" -eq 0 ]; then
|
||||
echo "Error: Python 3 is required to create a Unicode feature name" >&2
|
||||
return 1
|
||||
fi
|
||||
printf '%s' "$name" | "${python_cmd[@]}" -c '
|
||||
import sys
|
||||
value = sys.stdin.buffer.read().decode("utf-8")
|
||||
lower = str.maketrans("ABCDEFGHIJKLMNOPQRSTUVWXYZ", "abcdefghijklmnopqrstuvwxyz")
|
||||
result = "".join(
|
||||
char if char.isalpha() or char.isdecimal() else sys.argv[1]
|
||||
for char in value.translate(lower)
|
||||
)
|
||||
sys.stdout.buffer.write(result.encode("utf-8"))
|
||||
' "$separator"
|
||||
else
|
||||
printf '%s' "$name" | LC_ALL=C tr '[:upper:]' '[:lower:]' | LC_ALL=C sed "s/[^a-z0-9]/$separator/g"
|
||||
fi
|
||||
}
|
||||
|
||||
clean_branch_name() {
|
||||
local name="$1"
|
||||
local cleaned
|
||||
cleaned=$(unicode_words "$name" '-') || return 1
|
||||
printf '%s\n' "$cleaned" | sed 's/--*/-/g' | sed 's/^-//' | sed 's/-$//'
|
||||
}
|
||||
|
||||
branch_byte_count() {
|
||||
printf '%s' "$1" | wc -c | tr -d '[:space:]'
|
||||
}
|
||||
|
||||
# Fit a feature prefix and suffix within GitHub's branch-name limit.
|
||||
fit_branch_name() {
|
||||
local feature_num="$1"
|
||||
local branch_suffix="$2"
|
||||
local branch_name="${feature_num}-${branch_suffix}"
|
||||
|
||||
if [ "$(branch_byte_count "$branch_name")" -gt "$MAX_BRANCH_LENGTH" ]; then
|
||||
local prefix_length=$(( ${#feature_num} + 1 ))
|
||||
local max_suffix_length=$((MAX_BRANCH_LENGTH - prefix_length))
|
||||
local truncated_suffix
|
||||
local -x LC_ALL="$UNICODE_LOCALE"
|
||||
local low=0 high=${#branch_suffix} mid
|
||||
if (( high > max_suffix_length )); then
|
||||
high=$max_suffix_length
|
||||
fi
|
||||
while (( low < high )); do
|
||||
mid=$(((low + high + 1) / 2))
|
||||
if [ "$(branch_byte_count "${branch_suffix:0:$mid}")" -le "$max_suffix_length" ]; then
|
||||
low=$mid
|
||||
else
|
||||
high=$((mid - 1))
|
||||
fi
|
||||
done
|
||||
truncated_suffix="${branch_suffix:0:$low}"
|
||||
truncated_suffix="${truncated_suffix%-}"
|
||||
branch_name="${feature_num}-${truncated_suffix}"
|
||||
fi
|
||||
|
||||
printf '%s' "$branch_name"
|
||||
}
|
||||
|
||||
# Quote a value for POSIX shell reuse, byte-identical to Python's shlex.quote
|
||||
# so the persistence hints match the Python variant exactly (printf %q output
|
||||
# differs between bash versions and from shlex.quote for spaces/metachars).
|
||||
shell_quote() {
|
||||
local value="$1" LC_ALL=C
|
||||
if [[ "$value" =~ ^[A-Za-z0-9_@%+=:,./-]+$ ]]; then
|
||||
printf '%s' "$value"
|
||||
else
|
||||
local q="'\"'\"'"
|
||||
printf "'%s'" "${value//\'/$q}"
|
||||
fi
|
||||
}
|
||||
|
||||
# Resolve repository root using common.sh functions which prioritize .specify
|
||||
SCRIPT_DIR="$(CDPATH="" cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
source "$SCRIPT_DIR/common.sh"
|
||||
|
||||
REPO_ROOT=$(get_repo_root) || exit 1
|
||||
|
||||
cd "$REPO_ROOT"
|
||||
|
||||
SPECS_DIR="$REPO_ROOT/specs"
|
||||
if [ "$DRY_RUN" != true ]; then
|
||||
mkdir -p "$SPECS_DIR"
|
||||
fi
|
||||
|
||||
# Function to generate branch name with stop word filtering and length filtering
|
||||
generate_branch_name() {
|
||||
local description="$1"
|
||||
|
||||
# Common stop words to filter out
|
||||
local stop_words="^(i|a|an|the|to|for|of|in|on|at|by|with|from|is|are|was|were|be|been|being|have|has|had|do|does|did|will|would|should|could|can|may|might|must|shall|this|that|these|those|my|your|our|their|want|need|add|get|set)$"
|
||||
|
||||
# Use a UTF-8 locale for character-safe length checks and split words.
|
||||
local -x LC_ALL="$UNICODE_LOCALE"
|
||||
local clean_name
|
||||
clean_name=$(unicode_words "$description" ' ') || return 1
|
||||
|
||||
# Filter words: remove stop words and words shorter than 3 chars (unless they're uppercase acronyms in original)
|
||||
local meaningful_words=()
|
||||
for word in $clean_name; do
|
||||
# Skip empty words
|
||||
[ -z "$word" ] && continue
|
||||
|
||||
# Retain non-ASCII words even when shorter than three characters.
|
||||
if ! printf '%s\n' "$word" | LC_ALL=C grep -qE "$stop_words"; then
|
||||
if [ ${#word} -ge 3 ] || printf '%s' "$word" | contains_non_ascii; then
|
||||
meaningful_words+=("$word")
|
||||
# Keep short words that appear as an uppercase acronym in the original.
|
||||
# Uppercase via tr and match with grep -w (both portable) rather than
|
||||
# bash's 4+ "^^" case expansion (breaks on macOS bash 3.2) and \b (non-POSIX).
|
||||
elif printf '%s' "$description" | LC_ALL=C grep -qw -- "$(printf '%s' "$word" | LC_ALL=C tr '[:lower:]' '[:upper:]')"; then
|
||||
meaningful_words+=("$word")
|
||||
fi
|
||||
fi
|
||||
done
|
||||
|
||||
# If we have meaningful words, use first 3-4 of them
|
||||
if [ ${#meaningful_words[@]} -gt 0 ]; then
|
||||
local max_words=3
|
||||
if [ ${#meaningful_words[@]} -eq 4 ]; then max_words=4; fi
|
||||
|
||||
local result=""
|
||||
local count=0
|
||||
for word in "${meaningful_words[@]}"; do
|
||||
if [ $count -ge $max_words ]; then break; fi
|
||||
if [ -n "$result" ]; then result="$result-"; fi
|
||||
result="$result$word"
|
||||
count=$((count + 1))
|
||||
done
|
||||
echo "$result"
|
||||
else
|
||||
# Fallback to original logic if no meaningful words found
|
||||
local cleaned=$(clean_branch_name "$description")
|
||||
echo "$cleaned" | tr '-' '\n' | grep -v '^$' | head -3 | tr '\n' '-' | sed 's/-$//'
|
||||
fi
|
||||
}
|
||||
|
||||
# Generate branch name
|
||||
if [ -n "$SHORT_NAME" ]; then
|
||||
# Use provided short name, just clean it up
|
||||
BRANCH_SUFFIX=$(clean_branch_name "$SHORT_NAME")
|
||||
else
|
||||
# Generate from description with smart filtering
|
||||
BRANCH_SUFFIX=$(generate_branch_name "$FEATURE_DESCRIPTION")
|
||||
fi
|
||||
|
||||
if [ -z "$BRANCH_SUFFIX" ]; then
|
||||
echo "[specify] Warning: Feature name is empty after removing unsupported characters. Use --short-name with letters or digits (for example, user-auth)." >&2
|
||||
fi
|
||||
|
||||
# Warn if --number and --timestamp are both specified
|
||||
if [ "$USE_TIMESTAMP" = true ] && [ -n "$BRANCH_NUMBER" ]; then
|
||||
>&2 echo "[specify] Warning: --number is ignored when --timestamp is used"
|
||||
BRANCH_NUMBER=""
|
||||
fi
|
||||
|
||||
# Determine branch prefix
|
||||
if [ "$USE_TIMESTAMP" = true ]; then
|
||||
FEATURE_NUM=$(date +%Y%m%d-%H%M%S)
|
||||
BRANCH_NAME="${FEATURE_NUM}-${BRANCH_SUFFIX}"
|
||||
else
|
||||
if [ -n "$BRANCH_NUMBER" ] && [[ ! "$BRANCH_NUMBER" =~ ^[0-9]+$ ]]; then
|
||||
echo "Error: --number must be an unsigned integer, got '$BRANCH_NUMBER'" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Bash arithmetic is signed 64-bit; reject digit strings that would wrap.
|
||||
if [ -n "$BRANCH_NUMBER" ] && ! is_feature_number_in_range "$BRANCH_NUMBER"; then
|
||||
echo "Error: --number must be between 0 and $MAX_FEATURE_NUMBER, got '$BRANCH_NUMBER'" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Determine branch number from existing feature directories
|
||||
if [ -z "$BRANCH_NUMBER" ]; then
|
||||
HIGHEST=$(get_highest_from_specs "$SPECS_DIR")
|
||||
if [ "$HIGHEST" -eq "$MAX_FEATURE_NUMBER" ]; then
|
||||
echo "Error: feature number must be between 0 and $MAX_FEATURE_NUMBER, got '9223372036854775808'" >&2
|
||||
exit 1
|
||||
fi
|
||||
BRANCH_NUMBER=$((HIGHEST + 1))
|
||||
fi
|
||||
|
||||
# Force base-10 interpretation to prevent octal conversion (e.g., 010 → 8 in octal, but should be 10 in decimal)
|
||||
FEATURE_NUM=$(printf "%03d" "$((10#$BRANCH_NUMBER))")
|
||||
|
||||
# Treat an explicit number as a preference when its prefix is already used
|
||||
# by a feature directory. Auto-detected numbers are already conflict-free.
|
||||
if [ "$NUMBER_EXPLICIT" = true ]; then
|
||||
SPEC_CONFLICT=false
|
||||
REQUESTED_BRANCH_NAME=$(fit_branch_name "$FEATURE_NUM" "$BRANCH_SUFFIX")
|
||||
REQUESTED_DIR="$SPECS_DIR/$REQUESTED_BRANCH_NAME"
|
||||
if [ "$ALLOW_EXISTING" != true ] || [ ! -d "$REQUESTED_DIR" ]; then
|
||||
spec_prefix_exists "$SPECS_DIR" "$FEATURE_NUM" && SPEC_CONFLICT=true
|
||||
fi
|
||||
|
||||
if [ "$SPEC_CONFLICT" = true ]; then
|
||||
REQUESTED_NUM="$FEATURE_NUM"
|
||||
HIGHEST=$(get_highest_from_specs "$SPECS_DIR")
|
||||
BRANCH_NUMBER=$HIGHEST
|
||||
while true; do
|
||||
if [ "$BRANCH_NUMBER" -eq "$MAX_FEATURE_NUMBER" ]; then
|
||||
echo "Error: feature number must be between 0 and $MAX_FEATURE_NUMBER, got '9223372036854775808'" >&2
|
||||
exit 1
|
||||
fi
|
||||
BRANCH_NUMBER=$((BRANCH_NUMBER + 1))
|
||||
FEATURE_NUM=$(printf "%03d" "$((10#$BRANCH_NUMBER))")
|
||||
spec_prefix_exists "$SPECS_DIR" "$FEATURE_NUM" || break
|
||||
done
|
||||
>&2 echo "[specify] Warning: --number $REQUESTED_NUM conflicts with an existing spec directory; using $FEATURE_NUM instead"
|
||||
fi
|
||||
fi
|
||||
|
||||
fi
|
||||
|
||||
# GitHub enforces a 244-byte limit on branch names
|
||||
# Validate and truncate if necessary
|
||||
ORIGINAL_BRANCH_NAME="${FEATURE_NUM}-${BRANCH_SUFFIX}"
|
||||
BRANCH_NAME=$(fit_branch_name "$FEATURE_NUM" "$BRANCH_SUFFIX")
|
||||
if [ "$BRANCH_NAME" != "$ORIGINAL_BRANCH_NAME" ]; then
|
||||
>&2 echo "[specify] Warning: Branch name exceeded GitHub's 244-byte limit"
|
||||
>&2 echo "[specify] Original: $ORIGINAL_BRANCH_NAME ($(branch_byte_count "$ORIGINAL_BRANCH_NAME") bytes)"
|
||||
>&2 echo "[specify] Truncated to: $BRANCH_NAME ($(branch_byte_count "$BRANCH_NAME") bytes)"
|
||||
fi
|
||||
|
||||
FEATURE_DIR="$SPECS_DIR/$BRANCH_NAME"
|
||||
SPEC_FILE="$FEATURE_DIR/spec.md"
|
||||
|
||||
if [ "$DRY_RUN" != true ]; then
|
||||
if [ -d "$FEATURE_DIR" ] && [ "$ALLOW_EXISTING" != true ]; then
|
||||
if [ "$USE_TIMESTAMP" = true ]; then
|
||||
>&2 echo "Error: Feature directory '$FEATURE_DIR' already exists. Rerun to get a new timestamp or use a different --short-name."
|
||||
else
|
||||
>&2 echo "Error: Feature directory '$FEATURE_DIR' already exists. Please use a different feature name or specify a different number with --number."
|
||||
fi
|
||||
exit 1
|
||||
fi
|
||||
|
||||
NEEDS_SPEC=false
|
||||
SPEC_TEMPLATE_FOUND=false
|
||||
SPEC_TEMPLATE_CONTENT=""
|
||||
if [ ! -f "$SPEC_FILE" ]; then
|
||||
NEEDS_SPEC=true
|
||||
if SPEC_TEMPLATE_CONTENT=$(resolve_template_content "spec-template" "$REPO_ROOT"; status=$?; printf x; exit "$status"); then
|
||||
SPEC_TEMPLATE_CONTENT="${SPEC_TEMPLATE_CONTENT%x}"
|
||||
SPEC_TEMPLATE_FOUND=true
|
||||
else
|
||||
resolve_status=$?
|
||||
if [ "$resolve_status" -ne 1 ]; then
|
||||
exit "$resolve_status"
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
|
||||
mkdir -p "$FEATURE_DIR"
|
||||
|
||||
if [ "$NEEDS_SPEC" = true ]; then
|
||||
if [ "$SPEC_TEMPLATE_FOUND" = true ]; then
|
||||
printf '%s' "$SPEC_TEMPLATE_CONTENT" > "$SPEC_FILE"
|
||||
else
|
||||
echo "Warning: Spec template not found; created empty spec file" >&2
|
||||
touch "$SPEC_FILE"
|
||||
fi
|
||||
fi
|
||||
|
||||
# Persist to .specify/feature.json so downstream commands can find the
|
||||
# feature, unless the orchestrator opted out via SPECIFY_FEATURE_NO_PERSIST (#4129).
|
||||
if [[ "${SPECIFY_FEATURE_NO_PERSIST:-}" != "1" && "${SPECIFY_FEATURE_NO_PERSIST:-}" != "true" ]]; then
|
||||
_persist_feature_json "$REPO_ROOT" "$FEATURE_DIR"
|
||||
fi
|
||||
|
||||
# Inform the user how to set feature state in their own shell
|
||||
printf '# To persist: export SPECIFY_FEATURE=%s\n' "$(shell_quote "$BRANCH_NAME")" >&2
|
||||
printf '# export SPECIFY_FEATURE_DIRECTORY=%s\n' "$(shell_quote "$FEATURE_DIR")" >&2
|
||||
fi
|
||||
|
||||
if $JSON_MODE; then
|
||||
if command -v jq >/dev/null 2>&1; then
|
||||
if [ "$DRY_RUN" = true ]; then
|
||||
jq -cn \
|
||||
--arg branch_name "$BRANCH_NAME" \
|
||||
--arg spec_file "$SPEC_FILE" \
|
||||
--arg feature_num "$FEATURE_NUM" \
|
||||
'{BRANCH_NAME:$branch_name,SPEC_FILE:$spec_file,FEATURE_NUM:$feature_num,DRY_RUN:true}'
|
||||
else
|
||||
jq -cn \
|
||||
--arg branch_name "$BRANCH_NAME" \
|
||||
--arg spec_file "$SPEC_FILE" \
|
||||
--arg feature_num "$FEATURE_NUM" \
|
||||
'{BRANCH_NAME:$branch_name,SPEC_FILE:$spec_file,FEATURE_NUM:$feature_num}'
|
||||
fi
|
||||
else
|
||||
if [ "$DRY_RUN" = true ]; then
|
||||
printf '{"BRANCH_NAME":"%s","SPEC_FILE":"%s","FEATURE_NUM":"%s","DRY_RUN":true}\n' "$(json_escape "$BRANCH_NAME")" "$(json_escape "$SPEC_FILE")" "$(json_escape "$FEATURE_NUM")"
|
||||
else
|
||||
printf '{"BRANCH_NAME":"%s","SPEC_FILE":"%s","FEATURE_NUM":"%s"}\n' "$(json_escape "$BRANCH_NAME")" "$(json_escape "$SPEC_FILE")" "$(json_escape "$FEATURE_NUM")"
|
||||
fi
|
||||
fi
|
||||
else
|
||||
echo "BRANCH_NAME: $BRANCH_NAME"
|
||||
echo "SPEC_FILE: $SPEC_FILE"
|
||||
echo "FEATURE_NUM: $FEATURE_NUM"
|
||||
if [ "$DRY_RUN" != true ]; then
|
||||
printf '# To persist in your shell: export SPECIFY_FEATURE=%s\n' "$(shell_quote "$BRANCH_NAME")"
|
||||
printf '# export SPECIFY_FEATURE_DIRECTORY=%s\n' "$(shell_quote "$FEATURE_DIR")"
|
||||
fi
|
||||
fi
|
||||
Executable
+57
@@ -0,0 +1,57 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
set -e
|
||||
|
||||
SCRIPT_DIR="$(CDPATH="" cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)"
|
||||
source "$SCRIPT_DIR/common.sh"
|
||||
|
||||
JSON_MODE=false
|
||||
TEMPLATE_NAME=""
|
||||
|
||||
for arg in "$@"; do
|
||||
case "$arg" in
|
||||
--json) JSON_MODE=true ;;
|
||||
--help|-h)
|
||||
echo "Usage: $0 <template-name> [--json]"
|
||||
exit 0
|
||||
;;
|
||||
-*)
|
||||
echo "ERROR: Unknown option '$arg'" >&2
|
||||
exit 1
|
||||
;;
|
||||
*)
|
||||
if [[ -n "$TEMPLATE_NAME" ]]; then
|
||||
echo "ERROR: Unexpected argument '$arg'" >&2
|
||||
exit 1
|
||||
fi
|
||||
TEMPLATE_NAME="$arg"
|
||||
;;
|
||||
esac
|
||||
done
|
||||
|
||||
if [[ -z "$TEMPLATE_NAME" ]]; then
|
||||
echo "ERROR: Template name is required" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
REPO_ROOT=$(get_repo_root)
|
||||
if TEMPLATE_CONTENT=$(resolve_template_content "$TEMPLATE_NAME" "$REPO_ROOT"; status=$?; printf x; exit "$status"); then
|
||||
TEMPLATE_CONTENT="${TEMPLATE_CONTENT%x}"
|
||||
else
|
||||
echo "ERROR: Could not resolve required $TEMPLATE_NAME from the template override stack for $REPO_ROOT" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if $JSON_MODE; then
|
||||
if has_jq; then
|
||||
jq -cn \
|
||||
--arg template_name "$TEMPLATE_NAME" \
|
||||
--arg template_content "$TEMPLATE_CONTENT" \
|
||||
'{TEMPLATE_NAME:$template_name,TEMPLATE_CONTENT:$template_content}'
|
||||
else
|
||||
printf '{"TEMPLATE_NAME":"%s","TEMPLATE_CONTENT":"%s"}\n' \
|
||||
"$(json_escape "$TEMPLATE_NAME")" "$(json_escape "$TEMPLATE_CONTENT")"
|
||||
fi
|
||||
else
|
||||
printf '%s' "$TEMPLATE_CONTENT"
|
||||
fi
|
||||
Executable
+89
@@ -0,0 +1,89 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
set -e
|
||||
|
||||
# Parse command line arguments
|
||||
JSON_MODE=false
|
||||
|
||||
for arg in "$@"; do
|
||||
case "$arg" in
|
||||
--json)
|
||||
JSON_MODE=true
|
||||
;;
|
||||
--help|-h)
|
||||
echo "Usage: $0 [--json]"
|
||||
echo " --json Output results in JSON format"
|
||||
echo " --help Show this help message"
|
||||
exit 0
|
||||
;;
|
||||
*)
|
||||
echo "ERROR: Unknown option '$arg'" >&2
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
done
|
||||
|
||||
# Get script directory and load common functions
|
||||
SCRIPT_DIR="$(CDPATH="" cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
source "$SCRIPT_DIR/common.sh"
|
||||
|
||||
# Get all paths and variables from common functions
|
||||
_paths_output=$(get_feature_paths) || { echo "ERROR: Failed to resolve feature paths" >&2; exit 1; }
|
||||
eval "$_paths_output"
|
||||
unset _paths_output
|
||||
|
||||
# Ensure the feature directory exists
|
||||
mkdir -p "$FEATURE_DIR"
|
||||
|
||||
# Copy plan template if plan doesn't already exist
|
||||
if [[ -f "$IMPL_PLAN" ]]; then
|
||||
if $JSON_MODE; then
|
||||
echo "Plan already exists at $IMPL_PLAN, skipping template copy" >&2
|
||||
else
|
||||
echo "Plan already exists at $IMPL_PLAN, skipping template copy"
|
||||
fi
|
||||
else
|
||||
template_file=$(mktemp)
|
||||
trap 'rm -f "$template_file"' EXIT
|
||||
if resolve_template_content "plan-template" "$REPO_ROOT" > "$template_file"; then
|
||||
if [[ ! -s "$template_file" ]]; then
|
||||
echo "ERROR: Plan template is empty; no new plan.md was created." >&2
|
||||
echo "Restore a valid plan template and rerun plan setup." >&2
|
||||
exit 1
|
||||
fi
|
||||
cat "$template_file" > "$IMPL_PLAN"
|
||||
if $JSON_MODE; then
|
||||
echo "Copied plan template to $IMPL_PLAN" >&2
|
||||
else
|
||||
echo "Copied plan template to $IMPL_PLAN"
|
||||
fi
|
||||
else
|
||||
resolve_status=$?
|
||||
if [ "$resolve_status" -ne 1 ]; then
|
||||
exit "$resolve_status"
|
||||
fi
|
||||
echo "ERROR: Plan template not found; no new plan.md was created." >&2
|
||||
echo "Restore a valid plan template and rerun plan setup." >&2
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
# Output results
|
||||
if $JSON_MODE; then
|
||||
if has_jq; then
|
||||
jq -cn \
|
||||
--arg feature_spec "$FEATURE_SPEC" \
|
||||
--arg impl_plan "$IMPL_PLAN" \
|
||||
--arg feature_dir "$FEATURE_DIR" \
|
||||
--arg branch "$CURRENT_BRANCH" \
|
||||
'{FEATURE_SPEC:$feature_spec,IMPL_PLAN:$impl_plan,FEATURE_DIR:$feature_dir,BRANCH:$branch}'
|
||||
else
|
||||
printf '{"FEATURE_SPEC":"%s","IMPL_PLAN":"%s","FEATURE_DIR":"%s","BRANCH":"%s"}\n' \
|
||||
"$(json_escape "$FEATURE_SPEC")" "$(json_escape "$IMPL_PLAN")" "$(json_escape "$FEATURE_DIR")" "$(json_escape "$CURRENT_BRANCH")"
|
||||
fi
|
||||
else
|
||||
echo "FEATURE_SPEC: $FEATURE_SPEC"
|
||||
echo "IMPL_PLAN: $IMPL_PLAN"
|
||||
echo "FEATURE_DIR: $FEATURE_DIR"
|
||||
echo "BRANCH: $CURRENT_BRANCH"
|
||||
fi
|
||||
Executable
+94
@@ -0,0 +1,94 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
set -e
|
||||
|
||||
# Parse command line arguments
|
||||
JSON_MODE=false
|
||||
|
||||
for arg in "$@"; do
|
||||
case "$arg" in
|
||||
--json) JSON_MODE=true ;;
|
||||
--help|-h)
|
||||
echo "Usage: $0 [--json]"
|
||||
echo " --json Output results in JSON format"
|
||||
echo " --help Show this help message"
|
||||
exit 0
|
||||
;;
|
||||
*) echo "ERROR: Unknown option '$arg'" >&2; exit 1 ;;
|
||||
esac
|
||||
done
|
||||
|
||||
# Source common functions
|
||||
SCRIPT_DIR="$(CDPATH="" cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
source "$SCRIPT_DIR/common.sh"
|
||||
|
||||
# Get feature paths
|
||||
_paths_output=$(get_feature_paths) || { echo "ERROR: Failed to resolve feature paths" >&2; exit 1; }
|
||||
eval "$_paths_output"
|
||||
unset _paths_output
|
||||
|
||||
# Validate required files
|
||||
if [[ ! -f "$IMPL_PLAN" ]]; then
|
||||
echo "ERROR: plan.md not found in $FEATURE_DIR" >&2
|
||||
echo "Run /speckit.plan first to create the implementation plan." >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [[ ! -f "$FEATURE_SPEC" ]]; then
|
||||
echo "ERROR: spec.md not found in $FEATURE_DIR" >&2
|
||||
echo "Run /speckit.specify first to create the feature structure." >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Build available docs list
|
||||
docs=()
|
||||
[[ -f "$RESEARCH" ]] && docs+=("research.md")
|
||||
[[ -f "$DATA_MODEL" ]] && docs+=("data-model.md")
|
||||
if [[ -d "$CONTRACTS_DIR" ]] && [[ -n "$(ls -A "$CONTRACTS_DIR" 2>/dev/null)" ]]; then
|
||||
docs+=("contracts/")
|
||||
fi
|
||||
[[ -f "$QUICKSTART" ]] && docs+=("quickstart.md")
|
||||
|
||||
# Resolve tasks template through override stack
|
||||
TASKS_TEMPLATE=$(resolve_template "tasks-template" "$REPO_ROOT") || true
|
||||
if TASKS_TEMPLATE_CONTENT=$(resolve_template_content "tasks-template" "$REPO_ROOT"; status=$?; printf x; exit "$status"); then
|
||||
TASKS_TEMPLATE_CONTENT="${TASKS_TEMPLATE_CONTENT%x}"
|
||||
else
|
||||
echo "ERROR: Could not resolve required tasks-template from the template override stack for $REPO_ROOT" >&2
|
||||
echo "Template 'tasks-template' was not found in any supported location (overrides, presets, extensions, or shared core). Add an override at .specify/templates/overrides/tasks-template.md, or run 'specify init' / reinstall shared infra to restore the core .specify/templates/tasks-template.md template." >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Output results
|
||||
if $JSON_MODE; then
|
||||
if has_jq; then
|
||||
if [[ ${#docs[@]} -eq 0 ]]; then
|
||||
json_docs="[]"
|
||||
else
|
||||
json_docs=$(printf '%s\n' "${docs[@]}" | jq -R . | jq -s .)
|
||||
fi
|
||||
jq -cn \
|
||||
--arg feature_dir "$FEATURE_DIR" \
|
||||
--argjson docs "$json_docs" \
|
||||
--arg tasks_template "${TASKS_TEMPLATE:-}" \
|
||||
--arg tasks_template_content "$TASKS_TEMPLATE_CONTENT" \
|
||||
'{FEATURE_DIR:$feature_dir,AVAILABLE_DOCS:$docs,TASKS_TEMPLATE:$tasks_template,TASKS_TEMPLATE_CONTENT:$tasks_template_content}'
|
||||
else
|
||||
if [[ ${#docs[@]} -eq 0 ]]; then
|
||||
json_docs="[]"
|
||||
else
|
||||
json_docs=$(for d in "${docs[@]}"; do printf '"%s",' "$(json_escape "$d")"; done)
|
||||
json_docs="[${json_docs%,}]"
|
||||
fi
|
||||
printf '{"FEATURE_DIR":"%s","AVAILABLE_DOCS":%s,"TASKS_TEMPLATE":"%s","TASKS_TEMPLATE_CONTENT":"%s"}\n' \
|
||||
"$(json_escape "$FEATURE_DIR")" "$json_docs" "$(json_escape "${TASKS_TEMPLATE:-}")" "$(json_escape "$TASKS_TEMPLATE_CONTENT")"
|
||||
fi
|
||||
else
|
||||
echo "FEATURE_DIR: $FEATURE_DIR"
|
||||
echo "TASKS_TEMPLATE: ${TASKS_TEMPLATE:-not found}"
|
||||
echo "AVAILABLE_DOCS:"
|
||||
check_file "$RESEARCH" "research.md"
|
||||
check_file "$DATA_MODEL" "data-model.md"
|
||||
check_dir "$CONTRACTS_DIR" "contracts/"
|
||||
check_file "$QUICKSTART" "quickstart.md"
|
||||
fi
|
||||
@@ -0,0 +1,48 @@
|
||||
# [CHECKLIST TYPE] Checklist: [FEATURE NAME]
|
||||
|
||||
**Purpose**: [Brief description of what this checklist covers] **Created**: [DATE] **Feature**:
|
||||
[Link to spec.md or relevant documentation]
|
||||
|
||||
**Note**: This custom checklist is generated by the `/speckit.checklist` command based on feature
|
||||
context and requirements. **Review Ownership**: This checklist is a reviewer-owned
|
||||
requirements-quality review artifact. Mark an item `[x]` only when the reviewer determines the
|
||||
requirements-quality criterion is satisfied. **Marker Semantics**: `[x]` means the criterion has
|
||||
been reviewed and satisfied for requirements quality. It does not mean implementation work is
|
||||
complete.
|
||||
|
||||
<!--
|
||||
============================================================================
|
||||
IMPORTANT: The checklist items below are SAMPLE ITEMS for illustration only.
|
||||
|
||||
The /speckit.checklist command MUST replace these with actual items based on:
|
||||
- User's specific checklist request
|
||||
- Feature requirements from spec.md
|
||||
- Technical context from plan.md
|
||||
- Implementation details from tasks.md
|
||||
|
||||
DO NOT keep these sample items in the generated checklist file.
|
||||
============================================================================
|
||||
-->
|
||||
|
||||
## [Category 1]
|
||||
|
||||
- [ ] CHK001 First checklist item with clear action
|
||||
- [ ] CHK002 Second checklist item
|
||||
- [ ] CHK003 Third checklist item
|
||||
|
||||
## [Category 2]
|
||||
|
||||
- [ ] CHK004 Another category item
|
||||
- [ ] CHK005 Item with specific criteria
|
||||
- [ ] CHK006 Final item in this category
|
||||
|
||||
## Notes
|
||||
|
||||
- Mark items `[x]` only after review confirms the requirement-quality criterion is satisfied
|
||||
- Leave items unchecked when they still require clarification, correction, or reviewer evaluation
|
||||
- `/speckit.implement` reads checklist checkbox state as a gate and must not modify markers
|
||||
- `checklists/requirements.md` has a separate built-in lifecycle maintained by `/speckit.specify`
|
||||
and `/speckit.clarify`
|
||||
- Add comments or findings inline
|
||||
- Link to relevant resources or documentation
|
||||
- Items are numbered sequentially for easy reference
|
||||
@@ -0,0 +1,74 @@
|
||||
# [PROJECT_NAME] Constitution
|
||||
|
||||
<!-- Example: Spec Constitution, TaskFlow Constitution, etc. -->
|
||||
|
||||
## Core Principles
|
||||
|
||||
### [PRINCIPLE_1_NAME]
|
||||
|
||||
<!-- Example: I. Library-First -->
|
||||
|
||||
[PRINCIPLE_1_DESCRIPTION]
|
||||
|
||||
<!-- Example: Every feature starts as a standalone library; Libraries must be self-contained, independently testable, documented; Clear purpose required - no organizational-only libraries -->
|
||||
|
||||
### [PRINCIPLE_2_NAME]
|
||||
|
||||
<!-- Example: II. CLI Interface -->
|
||||
|
||||
[PRINCIPLE_2_DESCRIPTION]
|
||||
|
||||
<!-- Example: Every library exposes functionality via CLI; Text in/out protocol: stdin/args → stdout, errors → stderr; Support JSON + human-readable formats -->
|
||||
|
||||
### [PRINCIPLE_3_NAME]
|
||||
|
||||
<!-- Example: III. Test-First (NON-NEGOTIABLE) -->
|
||||
|
||||
[PRINCIPLE_3_DESCRIPTION]
|
||||
|
||||
<!-- Example: TDD mandatory: Tests written → User approved → Tests fail → Then implement; Red-Green-Refactor cycle strictly enforced -->
|
||||
|
||||
### [PRINCIPLE_4_NAME]
|
||||
|
||||
<!-- Example: IV. Integration Testing -->
|
||||
|
||||
[PRINCIPLE_4_DESCRIPTION]
|
||||
|
||||
<!-- Example: Focus areas requiring integration tests: New library contract tests, Contract changes, Inter-service communication, Shared schemas -->
|
||||
|
||||
### [PRINCIPLE_5_NAME]
|
||||
|
||||
<!-- Example: V. Observability, VI. Versioning & Breaking Changes, VII. Simplicity -->
|
||||
|
||||
[PRINCIPLE_5_DESCRIPTION]
|
||||
|
||||
<!-- Example: Text I/O ensures debuggability; Structured logging required; Or: MAJOR.MINOR.BUILD format; Or: Start simple, YAGNI principles -->
|
||||
|
||||
## [SECTION_2_NAME]
|
||||
|
||||
<!-- Example: Additional Constraints, Security Requirements, Performance Standards, etc. -->
|
||||
|
||||
[SECTION_2_CONTENT]
|
||||
|
||||
<!-- Example: Technology stack requirements, compliance standards, deployment policies, etc. -->
|
||||
|
||||
## [SECTION_3_NAME]
|
||||
|
||||
<!-- Example: Development Workflow, Review Process, Quality Gates, etc. -->
|
||||
|
||||
[SECTION_3_CONTENT]
|
||||
|
||||
<!-- Example: Code review requirements, testing gates, deployment approval process, etc. -->
|
||||
|
||||
## Governance
|
||||
|
||||
<!-- Example: Constitution supersedes all other practices; Amendments require documentation, approval, migration plan -->
|
||||
|
||||
[GOVERNANCE_RULES]
|
||||
|
||||
<!-- Example: All PRs/reviews must verify compliance; Complexity must be justified; Use [GUIDANCE_FILE] for runtime development guidance -->
|
||||
|
||||
**Version**: [CONSTITUTION_VERSION] | **Ratified**: [RATIFICATION_DATE] | **Last Amended**:
|
||||
[LAST_AMENDED_DATE]
|
||||
|
||||
<!-- Example: Version: 2.1.1 | Ratified: 2025-06-13 | Last Amended: 2025-07-16 -->
|
||||
@@ -0,0 +1,118 @@
|
||||
# Implementation Plan: [FEATURE]
|
||||
|
||||
**Branch**: `[###-feature-name]` | **Date**: [DATE] | **Spec**: [link]
|
||||
|
||||
**Input**: Feature specification from `/specs/[###-feature-name]/spec.md`
|
||||
|
||||
**Note**: This template is filled in by the `/speckit.plan` command; its definition describes the
|
||||
execution workflow.
|
||||
|
||||
## Summary
|
||||
|
||||
[Extract from feature spec: primary requirement + technical approach from research]
|
||||
|
||||
## Technical Context
|
||||
|
||||
<!--
|
||||
ACTION REQUIRED: Replace the content in this section with the technical details
|
||||
for the project. The structure here is presented in advisory capacity to guide
|
||||
the iteration process.
|
||||
-->
|
||||
|
||||
**Language/Version**: [e.g., Python 3.11, Swift 5.9, Rust 1.75 or NEEDS CLARIFICATION]
|
||||
|
||||
**Primary Dependencies**: [e.g., FastAPI, UIKit, LLVM or NEEDS CLARIFICATION]
|
||||
|
||||
**Storage**: [if applicable, e.g., PostgreSQL, CoreData, files or N/A]
|
||||
|
||||
**Testing**: [e.g., pytest, XCTest, cargo test or NEEDS CLARIFICATION]
|
||||
|
||||
**Target Platform**: [e.g., Linux server, iOS 15+, WASM or NEEDS CLARIFICATION]
|
||||
|
||||
**Project Type**: [e.g., library/cli/web-service/mobile-app/compiler/desktop-app or NEEDS
|
||||
CLARIFICATION]
|
||||
|
||||
**Performance Goals**: [domain-specific, e.g., 1000 req/s, 10k lines/sec, 60 fps or NEEDS
|
||||
CLARIFICATION]
|
||||
|
||||
**Constraints**: [domain-specific, e.g., <200ms p95, <100MB memory, offline-capable or NEEDS
|
||||
CLARIFICATION]
|
||||
|
||||
**Scale/Scope**: [domain-specific, e.g., 10k users, 1M LOC, 50 screens or NEEDS CLARIFICATION]
|
||||
|
||||
## Constitution Check
|
||||
|
||||
_GATE: Must pass before Phase 0 research. Re-check after Phase 1 design._
|
||||
|
||||
[Gates determined based on constitution file]
|
||||
|
||||
## Project Structure
|
||||
|
||||
### Documentation (this feature)
|
||||
|
||||
```text
|
||||
specs/[###-feature]/
|
||||
├── plan.md # This file (/speckit.plan command output)
|
||||
├── research.md # Phase 0 output (/speckit.plan command)
|
||||
├── data-model.md # Phase 1 output (/speckit.plan command)
|
||||
├── quickstart.md # Phase 1 output (/speckit.plan command)
|
||||
├── contracts/ # Phase 1 output (/speckit.plan command)
|
||||
└── tasks.md # Phase 2 output (/speckit.tasks command - NOT created by /speckit.plan)
|
||||
```
|
||||
|
||||
### Source Code (repository root)
|
||||
|
||||
<!--
|
||||
ACTION REQUIRED: Replace the placeholder tree below with the concrete layout
|
||||
for this feature. Delete unused options and expand the chosen structure with
|
||||
real paths (e.g., apps/admin, packages/something). The delivered plan must
|
||||
not include Option labels.
|
||||
-->
|
||||
|
||||
```text
|
||||
# [REMOVE IF UNUSED] Option 1: Single project (DEFAULT)
|
||||
src/
|
||||
├── models/
|
||||
├── services/
|
||||
├── cli/
|
||||
└── lib/
|
||||
|
||||
tests/
|
||||
├── contract/
|
||||
├── integration/
|
||||
└── unit/
|
||||
|
||||
# [REMOVE IF UNUSED] Option 2: Web application (when "frontend" + "backend" detected)
|
||||
backend/
|
||||
├── src/
|
||||
│ ├── models/
|
||||
│ ├── services/
|
||||
│ └── api/
|
||||
└── tests/
|
||||
|
||||
frontend/
|
||||
├── src/
|
||||
│ ├── components/
|
||||
│ ├── pages/
|
||||
│ └── services/
|
||||
└── tests/
|
||||
|
||||
# [REMOVE IF UNUSED] Option 3: Mobile + API (when "iOS/Android" detected)
|
||||
api/
|
||||
└── [same as backend above]
|
||||
|
||||
ios/ or android/
|
||||
└── [platform-specific structure: feature modules, UI flows, platform tests]
|
||||
```
|
||||
|
||||
**Structure Decision**: [Document the selected structure and reference the real directories captured
|
||||
above]
|
||||
|
||||
## Complexity Tracking
|
||||
|
||||
> **Fill ONLY if Constitution Check has violations that must be justified**
|
||||
|
||||
| Violation | Why Needed | Simpler Alternative Rejected Because |
|
||||
| -------------------------- | ------------------ | ------------------------------------ |
|
||||
| [e.g., 4th project] | [current need] | [why 3 projects insufficient] |
|
||||
| [e.g., Repository pattern] | [specific problem] | [why direct DB access insufficient] |
|
||||
@@ -0,0 +1,134 @@
|
||||
# Feature Specification: [FEATURE NAME]
|
||||
|
||||
**Feature Branch**: `[###-feature-name]`
|
||||
|
||||
**Created**: [DATE]
|
||||
|
||||
**Status**: Draft
|
||||
|
||||
**Input**: User description: "$ARGUMENTS"
|
||||
|
||||
## User Scenarios & Testing _(mandatory)_
|
||||
|
||||
<!--
|
||||
IMPORTANT: User stories should be PRIORITIZED as user journeys ordered by importance.
|
||||
Each user story/journey must be INDEPENDENTLY TESTABLE - meaning if you implement just ONE of them,
|
||||
you should still have a viable MVP (Minimum Viable Product) that delivers value.
|
||||
|
||||
Assign priorities (P1, P2, P3, etc.) to each story, where P1 is the most critical.
|
||||
Think of each story as a standalone slice of functionality that can be:
|
||||
- Developed independently
|
||||
- Tested independently
|
||||
- Deployed independently
|
||||
- Demonstrated to users independently
|
||||
-->
|
||||
|
||||
### User Story 1 - [Brief Title] (Priority: P1)
|
||||
|
||||
[Describe this user journey in plain language]
|
||||
|
||||
**Why this priority**: [Explain the value and why it has this priority level]
|
||||
|
||||
**Independent Test**: [Describe how this can be tested independently - e.g., "Can be fully tested by
|
||||
[specific action] and delivers [specific value]"]
|
||||
|
||||
**Acceptance Scenarios**:
|
||||
|
||||
1. **Given** [initial state], **When** [action], **Then** [expected outcome]
|
||||
2. **Given** [initial state], **When** [action], **Then** [expected outcome]
|
||||
|
||||
---
|
||||
|
||||
### User Story 2 - [Brief Title] (Priority: P2)
|
||||
|
||||
[Describe this user journey in plain language]
|
||||
|
||||
**Why this priority**: [Explain the value and why it has this priority level]
|
||||
|
||||
**Independent Test**: [Describe how this can be tested independently]
|
||||
|
||||
**Acceptance Scenarios**:
|
||||
|
||||
1. **Given** [initial state], **When** [action], **Then** [expected outcome]
|
||||
|
||||
---
|
||||
|
||||
### User Story 3 - [Brief Title] (Priority: P3)
|
||||
|
||||
[Describe this user journey in plain language]
|
||||
|
||||
**Why this priority**: [Explain the value and why it has this priority level]
|
||||
|
||||
**Independent Test**: [Describe how this can be tested independently]
|
||||
|
||||
**Acceptance Scenarios**:
|
||||
|
||||
1. **Given** [initial state], **When** [action], **Then** [expected outcome]
|
||||
|
||||
---
|
||||
|
||||
[Add more user stories as needed, each with an assigned priority]
|
||||
|
||||
### Edge Cases
|
||||
|
||||
<!--
|
||||
ACTION REQUIRED: The content in this section represents placeholders.
|
||||
Fill them out with the right edge cases.
|
||||
-->
|
||||
|
||||
- What happens when [boundary condition]?
|
||||
- How does system handle [error scenario]?
|
||||
|
||||
## Requirements _(mandatory)_
|
||||
|
||||
<!--
|
||||
ACTION REQUIRED: The content in this section represents placeholders.
|
||||
Fill them out with the right functional requirements.
|
||||
-->
|
||||
|
||||
### Functional Requirements
|
||||
|
||||
- **FR-001**: System MUST [specific capability, e.g., "allow users to create accounts"]
|
||||
- **FR-002**: System MUST [specific capability, e.g., "validate email addresses"]
|
||||
- **FR-003**: Users MUST be able to [key interaction, e.g., "reset their password"]
|
||||
- **FR-004**: System MUST [data requirement, e.g., "persist user preferences"]
|
||||
- **FR-005**: System MUST [behavior, e.g., "log all security events"]
|
||||
|
||||
_Example of marking unclear requirements:_
|
||||
|
||||
- **FR-006**: System MUST authenticate users via [NEEDS CLARIFICATION: auth method not specified -
|
||||
email/password, SSO, OAuth?]
|
||||
- **FR-007**: System MUST retain user data for [NEEDS CLARIFICATION: retention period not specified]
|
||||
|
||||
### Key Entities _(include if feature involves data)_
|
||||
|
||||
- **[Entity 1]**: [What it represents, key attributes without implementation]
|
||||
- **[Entity 2]**: [What it represents, relationships to other entities]
|
||||
|
||||
## Success Criteria _(mandatory)_
|
||||
|
||||
<!--
|
||||
ACTION REQUIRED: Define measurable success criteria.
|
||||
These must be technology-agnostic and measurable.
|
||||
-->
|
||||
|
||||
### Measurable Outcomes
|
||||
|
||||
- **SC-001**: [Measurable metric, e.g., "Users can complete account creation in under 2 minutes"]
|
||||
- **SC-002**: [Measurable metric, e.g., "System handles 1000 concurrent users without degradation"]
|
||||
- **SC-003**: [User satisfaction metric, e.g., "90% of users successfully complete primary task on
|
||||
first attempt"]
|
||||
- **SC-004**: [Business metric, e.g., "Reduce support tickets related to [X] by 50%"]
|
||||
|
||||
## Assumptions
|
||||
|
||||
<!--
|
||||
ACTION REQUIRED: The content in this section represents placeholders.
|
||||
Fill them out with the right assumptions based on reasonable defaults
|
||||
chosen when the feature description did not specify certain details.
|
||||
-->
|
||||
|
||||
- [Assumption about target users, e.g., "Users have stable internet connectivity"]
|
||||
- [Assumption about scope boundaries, e.g., "Mobile support is out of scope for v1"]
|
||||
- [Assumption about data/environment, e.g., "Existing authentication system will be reused"]
|
||||
- [Dependency on existing system/service, e.g., "Requires access to the existing user profile API"]
|
||||
@@ -0,0 +1,257 @@
|
||||
---
|
||||
description: 'Task list template for feature implementation'
|
||||
---
|
||||
|
||||
# Tasks: [FEATURE NAME]
|
||||
|
||||
**Input**: Design documents from `/specs/[###-feature-name]/`
|
||||
|
||||
**Prerequisites**: plan.md (required), spec.md (required for user stories), research.md,
|
||||
data-model.md, contracts/
|
||||
|
||||
**Tests**: The examples below include test tasks. Tests are OPTIONAL - only include them if
|
||||
explicitly requested in the feature specification.
|
||||
|
||||
**Organization**: Tasks are grouped by user story to enable independent implementation and testing
|
||||
of each story.
|
||||
|
||||
## Format: `[ID] [P?] [Story] Description`
|
||||
|
||||
- **[P]**: Can run in parallel (different files, no dependencies)
|
||||
- **[Story]**: Which user story this task belongs to (e.g., US1, US2, US3)
|
||||
- Include exact file paths in descriptions
|
||||
|
||||
## Path Conventions
|
||||
|
||||
- **Single project**: `src/`, `tests/` at repository root
|
||||
- **Web app**: `backend/src/`, `frontend/src/`
|
||||
- **Mobile**: `api/src/`, `ios/src/` or `android/src/`
|
||||
- Paths shown below assume single project - adjust based on plan.md structure
|
||||
|
||||
<!--
|
||||
============================================================================
|
||||
IMPORTANT: The tasks below are SAMPLE TASKS for illustration purposes only.
|
||||
|
||||
The /speckit.tasks command MUST replace these with actual tasks based on:
|
||||
- User stories from spec.md (with their priorities P1, P2, P3...)
|
||||
- Feature requirements from plan.md
|
||||
- Entities from data-model.md
|
||||
- Endpoints from contracts/
|
||||
|
||||
Tasks MUST be organized by user story so each story can be:
|
||||
- Implemented independently
|
||||
- Tested independently
|
||||
- Delivered as an MVP increment
|
||||
|
||||
DO NOT keep these sample tasks in the generated tasks.md file.
|
||||
============================================================================
|
||||
-->
|
||||
|
||||
## Phase 1: Setup (Shared Infrastructure)
|
||||
|
||||
**Purpose**: Project initialization and basic structure
|
||||
|
||||
- [ ] T001 Create project structure per implementation plan
|
||||
- [ ] T002 Initialize [language] project with [framework] dependencies
|
||||
- [ ] T003 [P] Configure linting and formatting tools
|
||||
|
||||
---
|
||||
|
||||
## Phase 2: Foundational (Blocking Prerequisites)
|
||||
|
||||
**Purpose**: Core infrastructure that MUST be complete before ANY user story can be implemented
|
||||
|
||||
**⚠️ CRITICAL**: No user story work can begin until this phase is complete
|
||||
|
||||
Examples of foundational tasks (adjust based on your project):
|
||||
|
||||
- [ ] T004 Setup database schema and migrations framework
|
||||
- [ ] T005 [P] Implement authentication/authorization framework
|
||||
- [ ] T006 [P] Setup API routing and middleware structure
|
||||
- [ ] T007 Create base models/entities that all stories depend on
|
||||
- [ ] T008 Configure error handling and logging infrastructure
|
||||
- [ ] T009 Setup environment configuration management
|
||||
|
||||
**Checkpoint**: Foundation ready - user story implementation can now begin in parallel
|
||||
|
||||
---
|
||||
|
||||
## Phase 3: User Story 1 - [Title] (Priority: P1) 🎯 MVP
|
||||
|
||||
**Goal**: [Brief description of what this story delivers]
|
||||
|
||||
**Independent Test**: [How to verify this story works on its own]
|
||||
|
||||
### Tests for User Story 1 (OPTIONAL - only if tests requested) ⚠️
|
||||
|
||||
> **NOTE: Write these tests FIRST, ensure they FAIL before implementation**
|
||||
|
||||
- [ ] T010 [P] [US1] Contract test for [endpoint] in tests/contract/test\_[name].py
|
||||
- [ ] T011 [P] [US1] Integration test for [user journey] in tests/integration/test\_[name].py
|
||||
|
||||
### Implementation for User Story 1
|
||||
|
||||
- [ ] T012 [P] [US1] Create [Entity1] model in src/models/[entity1].py
|
||||
- [ ] T013 [P] [US1] Create [Entity2] model in src/models/[entity2].py
|
||||
- [ ] T014 [US1] Implement [Service] in src/services/[service].py (depends on T012, T013)
|
||||
- [ ] T015 [US1] Implement [endpoint/feature] in src/[location]/[file].py
|
||||
- [ ] T016 [US1] Add validation and error handling
|
||||
- [ ] T017 [US1] Add logging for user story 1 operations
|
||||
|
||||
**Checkpoint**: At this point, User Story 1 should be fully functional and testable independently
|
||||
|
||||
---
|
||||
|
||||
## Phase 4: User Story 2 - [Title] (Priority: P2)
|
||||
|
||||
**Goal**: [Brief description of what this story delivers]
|
||||
|
||||
**Independent Test**: [How to verify this story works on its own]
|
||||
|
||||
### Tests for User Story 2 (OPTIONAL - only if tests requested) ⚠️
|
||||
|
||||
- [ ] T018 [P] [US2] Contract test for [endpoint] in tests/contract/test\_[name].py
|
||||
- [ ] T019 [P] [US2] Integration test for [user journey] in tests/integration/test\_[name].py
|
||||
|
||||
### Implementation for User Story 2
|
||||
|
||||
- [ ] T020 [P] [US2] Create [Entity] model in src/models/[entity].py
|
||||
- [ ] T021 [US2] Implement [Service] in src/services/[service].py
|
||||
- [ ] T022 [US2] Implement [endpoint/feature] in src/[location]/[file].py
|
||||
- [ ] T023 [US2] Integrate with User Story 1 components (if needed)
|
||||
|
||||
**Checkpoint**: At this point, User Stories 1 AND 2 should both work independently
|
||||
|
||||
---
|
||||
|
||||
## Phase 5: User Story 3 - [Title] (Priority: P3)
|
||||
|
||||
**Goal**: [Brief description of what this story delivers]
|
||||
|
||||
**Independent Test**: [How to verify this story works on its own]
|
||||
|
||||
### Tests for User Story 3 (OPTIONAL - only if tests requested) ⚠️
|
||||
|
||||
- [ ] T024 [P] [US3] Contract test for [endpoint] in tests/contract/test\_[name].py
|
||||
- [ ] T025 [P] [US3] Integration test for [user journey] in tests/integration/test\_[name].py
|
||||
|
||||
### Implementation for User Story 3
|
||||
|
||||
- [ ] T026 [P] [US3] Create [Entity] model in src/models/[entity].py
|
||||
- [ ] T027 [US3] Implement [Service] in src/services/[service].py
|
||||
- [ ] T028 [US3] Implement [endpoint/feature] in src/[location]/[file].py
|
||||
|
||||
**Checkpoint**: All user stories should now be independently functional
|
||||
|
||||
---
|
||||
|
||||
[Add more user story phases as needed, following the same pattern]
|
||||
|
||||
---
|
||||
|
||||
## Phase N: Polish & Cross-Cutting Concerns
|
||||
|
||||
**Purpose**: Improvements that affect multiple user stories
|
||||
|
||||
- [ ] TXXX [P] Documentation updates in docs/
|
||||
- [ ] TXXX Code cleanup and refactoring
|
||||
- [ ] TXXX Performance optimization across all stories
|
||||
- [ ] TXXX [P] Additional unit tests (if requested) in tests/unit/
|
||||
- [ ] TXXX Security hardening
|
||||
- [ ] TXXX Run quickstart.md validation
|
||||
|
||||
---
|
||||
|
||||
## Dependencies & Execution Order
|
||||
|
||||
### Phase Dependencies
|
||||
|
||||
- **Setup (Phase 1)**: No dependencies - can start immediately
|
||||
- **Foundational (Phase 2)**: Depends on Setup completion - BLOCKS all user stories
|
||||
- **User Stories (Phase 3+)**: All depend on Foundational phase completion
|
||||
- User stories can then proceed in parallel (if staffed)
|
||||
- Or sequentially in priority order (P1 → P2 → P3)
|
||||
- **Polish (Final Phase)**: Depends on all desired user stories being complete
|
||||
|
||||
### User Story Dependencies
|
||||
|
||||
- **User Story 1 (P1)**: Can start after Foundational (Phase 2) - No dependencies on other stories
|
||||
- **User Story 2 (P2)**: Can start after Foundational (Phase 2) - May integrate with US1 but should
|
||||
be independently testable
|
||||
- **User Story 3 (P3)**: Can start after Foundational (Phase 2) - May integrate with US1/US2 but
|
||||
should be independently testable
|
||||
|
||||
### Within Each User Story
|
||||
|
||||
- Tests (if included) MUST be written and FAIL before implementation
|
||||
- Models before services
|
||||
- Services before endpoints
|
||||
- Core implementation before integration
|
||||
- Story complete before moving to next priority
|
||||
|
||||
### Parallel Opportunities
|
||||
|
||||
- All Setup tasks marked [P] can run in parallel
|
||||
- All Foundational tasks marked [P] can run in parallel (within Phase 2)
|
||||
- Once Foundational phase completes, all user stories can start in parallel (if team capacity
|
||||
allows)
|
||||
- All tests for a user story marked [P] can run in parallel
|
||||
- Models within a story marked [P] can run in parallel
|
||||
- Different user stories can be worked on in parallel by different team members
|
||||
|
||||
---
|
||||
|
||||
## Parallel Example: User Story 1
|
||||
|
||||
```bash
|
||||
# Launch all tests for User Story 1 together (if tests requested):
|
||||
Task: "Contract test for [endpoint] in tests/contract/test_[name].py"
|
||||
Task: "Integration test for [user journey] in tests/integration/test_[name].py"
|
||||
|
||||
# Launch all models for User Story 1 together:
|
||||
Task: "Create [Entity1] model in src/models/[entity1].py"
|
||||
Task: "Create [Entity2] model in src/models/[entity2].py"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Implementation Strategy
|
||||
|
||||
### MVP First (User Story 1 Only)
|
||||
|
||||
1. Complete Phase 1: Setup
|
||||
2. Complete Phase 2: Foundational (CRITICAL - blocks all stories)
|
||||
3. Complete Phase 3: User Story 1
|
||||
4. **STOP and VALIDATE**: Test User Story 1 independently
|
||||
5. Deploy/demo if ready
|
||||
|
||||
### Incremental Delivery
|
||||
|
||||
1. Complete Setup + Foundational → Foundation ready
|
||||
2. Add User Story 1 → Test independently → Deploy/Demo (MVP!)
|
||||
3. Add User Story 2 → Test independently → Deploy/Demo
|
||||
4. Add User Story 3 → Test independently → Deploy/Demo
|
||||
5. Each story adds value without breaking previous stories
|
||||
|
||||
### Parallel Team Strategy
|
||||
|
||||
With multiple developers:
|
||||
|
||||
1. Team completes Setup + Foundational together
|
||||
2. Once Foundational is done:
|
||||
- Developer A: User Story 1
|
||||
- Developer B: User Story 2
|
||||
- Developer C: User Story 3
|
||||
3. Stories complete and integrate independently
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
|
||||
- [P] tasks = different files, no dependencies
|
||||
- [Story] label maps task to specific user story for traceability
|
||||
- Each user story should be independently completable and testable
|
||||
- Verify tests fail before implementing
|
||||
- Commit after each task or logical group
|
||||
- Stop at any checkpoint to validate story independently
|
||||
- Avoid: vague tasks, same file conflicts, cross-story dependencies that break independence
|
||||
@@ -0,0 +1,74 @@
|
||||
schema_version: '1.0'
|
||||
workflow:
|
||||
id: 'speckit'
|
||||
name: 'Full SDD Cycle'
|
||||
version: '1.0.1'
|
||||
author: 'GitHub'
|
||||
description: 'Runs specify → plan → tasks → implement with review gates'
|
||||
|
||||
requires:
|
||||
# 0.8.5 is the first release with engine-side resolution of the
|
||||
# ``integration: "auto"`` default. Older versions would treat "auto"
|
||||
# as a literal integration key and fail at dispatch.
|
||||
speckit_version: '>=0.8.5'
|
||||
integrations:
|
||||
# The four commands below (specify, plan, tasks, implement) are core
|
||||
# spec-kit commands provided by every integration. The list here is an
|
||||
# advisory, non-exhaustive compatibility hint following the documented
|
||||
# ``any: [...]`` schema -- it is NOT a closed set. The workflow runs
|
||||
# against any integration the project was initialized with, including
|
||||
# ones not listed below, as long as that integration provides the four
|
||||
# core commands referenced in ``steps``.
|
||||
any:
|
||||
- 'alquimia'
|
||||
- 'claude'
|
||||
- 'copilot'
|
||||
- 'gemini'
|
||||
- 'opencode'
|
||||
|
||||
inputs:
|
||||
spec:
|
||||
type: string
|
||||
required: true
|
||||
prompt: 'Describe what you want to build'
|
||||
integration:
|
||||
type: string
|
||||
default: 'auto'
|
||||
prompt: "Integration to use (e.g. claude, copilot, gemini; 'auto' uses the project's initialized integration)"
|
||||
|
||||
steps:
|
||||
- id: specify
|
||||
command: speckit.specify
|
||||
integration: '{{ inputs.integration }}'
|
||||
input:
|
||||
args: '{{ inputs.spec }}'
|
||||
|
||||
- id: review-spec
|
||||
type: gate
|
||||
message: 'Review the generated spec before planning.'
|
||||
options: [approve, reject]
|
||||
on_reject: abort
|
||||
|
||||
- id: plan
|
||||
command: speckit.plan
|
||||
integration: '{{ inputs.integration }}'
|
||||
input:
|
||||
args: '{{ inputs.spec }}'
|
||||
|
||||
- id: review-plan
|
||||
type: gate
|
||||
message: 'Review the plan before generating tasks.'
|
||||
options: [approve, reject]
|
||||
on_reject: abort
|
||||
|
||||
- id: tasks
|
||||
command: speckit.tasks
|
||||
integration: '{{ inputs.integration }}'
|
||||
input:
|
||||
args: '{{ inputs.spec }}'
|
||||
|
||||
- id: implement
|
||||
command: speckit.implement
|
||||
integration: '{{ inputs.integration }}'
|
||||
input:
|
||||
args: '{{ inputs.spec }}'
|
||||
@@ -0,0 +1,13 @@
|
||||
{
|
||||
"schema_version": "1.0",
|
||||
"workflows": {
|
||||
"speckit": {
|
||||
"name": "Full SDD Cycle",
|
||||
"version": "1.0.1",
|
||||
"description": "Runs specify \u2192 plan \u2192 tasks \u2192 implement with review gates",
|
||||
"source": "bundled",
|
||||
"installed_at": "2026-11-05T09:25:04.219034+00:00",
|
||||
"updated_at": "2026-11-05T09:25:04.219052+00:00"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -56,14 +56,15 @@ yarn nx run api:db-migrations-list # Перегенерировать спис
|
||||
|
||||
#### Миграции БД
|
||||
|
||||
- Миграции лежат в `apps/api/src/database/migrations/`
|
||||
- Список миграций **генерируется статически** (`tools/buildDataSource.ts` →
|
||||
`apps/api/src/database/migrations.ts`), потому что webpack не умеет runtime-glob
|
||||
- Миграции лежат по модулям: `apps/api/src/<module>/migrations/`
|
||||
- Список миграций **генерируется статически** (`tools/buildDataSource.ts` сканирует
|
||||
`apps/api/src/**/migrations/` → `apps/api/src/migrations.ts`), потому что webpack не умеет
|
||||
runtime-glob
|
||||
- Имя файла обязано начинаться с **13-значного** timestamp, а имя класса — оканчиваться тем же
|
||||
timestamp: TypeORM берёт его как `parseInt(className.substr(-13))`. Расхождение валит сборку
|
||||
- **После добавления или удаления миграции список нужно перегенерировать и закоммитить**
|
||||
(`yarn nx run api:db-migrations-list`, либо это сделает `yarn nx run api:build` через
|
||||
`dependsOn`). Иначе CI упадёт на шаге `Check migrations list` (`git diff --exit-code`)
|
||||
`dependsOn`). Иначе CI упадёт на шаге `Check migrations list`
|
||||
- Деплой применяет миграции автоматически (`migration:run -t each` через `docker exec` на проде /
|
||||
`docker compose exec` на стейджинге) — на каждый тег на проде и на каждый push/PR на стейджинге.
|
||||
Автоматического бэкапа перед миграцией нет. Подробнее: `docs/90-deploy/10-migrations.md`
|
||||
@@ -86,16 +87,18 @@ yarn nx run api:db-migrations-list # Перегенерировать спис
|
||||
### Frontend (apps/web)
|
||||
|
||||
- React + Vite + React Router; стили — Tailwind CSS
|
||||
- Слои идут строго в одну сторону: `app → pages → widgets → entities → shared`, обратные зависимости
|
||||
запрещены. Подробности — `docs/50-developing/02-web-layers.md`
|
||||
- Слои идут строго в одну сторону: `app → pages → @modules → common`; `widgets` и `entities`
|
||||
существуют только внутри модуля, обратные зависимости запрещены. Границы объявляются баррелями,
|
||||
схема слоёв — в `apps/web/weld.config.mjs`. Подробности — `docs/50-developing/02-web-layers.md`
|
||||
- Оболочка, шапка и тема — `docs/50-developing/04-ui-shell.md`
|
||||
- Тесты: Vitest с jsdom
|
||||
|
||||
### TypeScript Paths
|
||||
|
||||
Определены в `tsconfig.base.json`:
|
||||
|
||||
- `@geo-platform/api/*` → `apps/api/src/*`
|
||||
- `@geo-platform/web/*` → `apps/web/src/*`
|
||||
- `@jt4d-platform/api/*` → `apps/api/src/*`
|
||||
- `@jt4d-platform/web/*` → `apps/web/src/*`
|
||||
|
||||
При переименовании воркспейса правятся и `paths`, и `customConditions`.
|
||||
|
||||
|
||||
@@ -1,109 +1,131 @@
|
||||
# New Nx Repository
|
||||
# Nx-монорепозиторий — шаблон
|
||||
|
||||
<a alt="Nx logo" href="https://nx.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="45"></a>
|
||||
Стартовый репозиторий для нового веб-проекта: Nx 22 + yarn workspaces, бэкенд на NestJS с TypeORM и
|
||||
PostgreSQL, фронтенд на React + Vite, e2e-тесты, единый линт, миграции, CI/CD в Gitea Actions со
|
||||
стендом на каждую ветку и документация в MDX.
|
||||
|
||||
✨ Your new, shiny [Nx workspace](https://nx.dev) is ready ✨.
|
||||
Шаблон содержит пустой каркас приложений (health-check и демо-страница) и полностью рабочую
|
||||
инфраструктуру: сборку, миграции, проверки, деплой и документацию. Новый проект начинается с
|
||||
клонирования репозитория и чек-листа из раздела «Новый проект из шаблона».
|
||||
|
||||
[Learn more about this workspace setup and its capabilities](https://nx.dev/docs/technologies/typescript/introduction?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) or run `npx nx graph` to visually explore what was created. Now, let's get you up to speed!
|
||||
## Что уже настроено
|
||||
|
||||
🚀 If you haven't connected to Nx Cloud yet, [complete your setup here](https://cloud.nx.app/get-started). Get faster builds with remote caching, distributed task execution, and self-healing CI. [See how your workspace can benefit](#nx-cloud).
|
||||
- **Монорепозиторий.** Nx 22 управляет задачами, yarn workspaces — зависимостями приложений и
|
||||
пакетов; общие библиотеки добавляются в `packages/`.
|
||||
- **Приложения.** `api` (NestJS 11, глобальный префикс `/api`, Swagger на `/api/docs`), `web` (React
|
||||
19 + Vite 7 + Tailwind, раздача статики через Caddy), `api-e2e` (Jest).
|
||||
- **Линт и форматирование.** ESLint flat config, Prettier, Stylelint, `tsc --noEmit`; одна команда
|
||||
`yarn lint` чинит, `yarn lint:check` — проверяет как в CI.
|
||||
- **Хуки git.** Husky запускает `lint-staged` на pre-commit и проверку имени ветки на pre-push.
|
||||
- **Миграции TypeORM.** Статический список миграций генерируется скриптом (webpack не умеет
|
||||
runtime-glob), есть снимок данных БД в JSON и восстановление из снимка.
|
||||
- **CI/CD.** Gitea Actions: ветка → Docker-образы + стенд, удаление ветки → удаление стенда, тег
|
||||
`v*` → прод. Деплой применяет миграции автоматически.
|
||||
- **Документация.** MDX в `docs/`, публикуется через Docuservix.
|
||||
- **Шаблоны задач.** `bug`, `issue`, `epic`, `user-story` в `.gitea/issue_template/`.
|
||||
- **Инструкции для ИИ-агентов.** `AGENTS.md` — обзор, команды, архитектура и конвенции; плюс конфиги
|
||||
для Cursor, GitHub Copilot, Gemini, Codex, OpenCode.
|
||||
|
||||
## Generate a library
|
||||
## Стек
|
||||
|
||||
```sh
|
||||
npx nx g @nx/js:lib packages/pkg1 --publishable --importPath=@my-org/pkg1
|
||||
| Слой | Технологии |
|
||||
| -------- | --------------------------------------------------- |
|
||||
| Сборка | Nx 22, yarn 1 (workspaces), TypeScript 5.9, Node 24 |
|
||||
| Бэкенд | NestJS 11, TypeORM, PostgreSQL, webpack, Vitest |
|
||||
| Фронтенд | React 19, Vite 7, Tailwind, Caddy |
|
||||
| E2E | Jest |
|
||||
| Качество | ESLint, Prettier, Stylelint, Husky, lint-staged |
|
||||
| Доставка | Gitea Actions, Docker, docker compose, Docuservix |
|
||||
|
||||
## Структура
|
||||
|
||||
| Путь | Назначение |
|
||||
| ------------------------ | ----------------------------------------------------------------------------- |
|
||||
| `apps/api` | NestJS-бэкенд: TypeORM + PostgreSQL, сборка webpack, тесты Vitest |
|
||||
| `apps/web` | React + Vite + Tailwind, Caddy раздаёт статику и проксирует `/api` |
|
||||
| `apps/api-e2e` | e2e-тесты API на Jest |
|
||||
| `packages/` | общие библиотеки воркспейса |
|
||||
| `tools/` | скрипты воркспейса: сборка и проверка data source, снимок и восстановление БД |
|
||||
| `docs/` | документация в MDX: слои приложений, БД, логирование, деплой |
|
||||
| `.gitea/workflows/` | CI/CD: `ci.yaml` (ветки), `production.yaml` (теги), `cleanup.yaml` |
|
||||
| `.gitea/issue_template/` | шаблоны задач Gitea |
|
||||
|
||||
## Быстрый старт
|
||||
|
||||
```bash
|
||||
yarn install
|
||||
yarn start # api на :5000 (Swagger — /api/docs), web на :5173
|
||||
```
|
||||
|
||||
## Run tasks
|
||||
Проверить, что всё поднялось: `http://localhost:5000/api/health` и `http://localhost:5173`. Задачи
|
||||
запускаются только через Nx:
|
||||
|
||||
To build the library use:
|
||||
|
||||
```sh
|
||||
npx nx run pkg1:build
|
||||
```bash
|
||||
yarn nx run <project>:<target> # одна задача
|
||||
yarn nx run-many -t <target> # по всем проектам
|
||||
yarn nx affected -t <target> # только по затронутым проектам
|
||||
```
|
||||
|
||||
To run any task with Nx use:
|
||||
## Команды
|
||||
|
||||
```sh
|
||||
npx nx run <project-name>:<target>
|
||||
```
|
||||
| Команда | Что делает |
|
||||
| -------------------------------------- | ------------------------------------------------------ |
|
||||
| `yarn start` | запуск всех приложений |
|
||||
| `yarn build` | сборка всех проектов |
|
||||
| `yarn rebuild` | очистка и сборка заново |
|
||||
| `yarn lint` | линт с автофиксом: eslint + prettier + stylelint + tsc |
|
||||
| `yarn lint:check` | те же проверки без автофикса (используется в CI) |
|
||||
| `yarn db-show` | статус миграций TypeORM |
|
||||
| `yarn db-migrate` / `yarn db-revert` | применить непримененные / откатить последнюю миграцию |
|
||||
| `yarn db-migrations-list` | перегенерировать статический список миграций |
|
||||
| `yarn db-snapshot` / `yarn db-restore` | снимок данных БД в JSON и восстановление из снимка |
|
||||
|
||||
These targets are either [inferred automatically](https://nx.dev/docs/concepts/inferred-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) or defined in the `project.json` or `package.json` files.
|
||||
Подключение к БД задаётся переменными `POSTGRES_HOST`, `POSTGRES_PORT`, `POSTGRES_USER`,
|
||||
`POSTGRES_PASSWORD`, `POSTGRES_DB` — в `.env` локально или в окружении контейнера.
|
||||
|
||||
[More about running tasks in the docs »](https://nx.dev/docs/features/run-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
|
||||
## Ветки и пайплайны
|
||||
|
||||
## Versioning and releasing
|
||||
- `master` — основная ветка.
|
||||
- Рабочие ветки — `i<номер>-краткое-описание`, только `a-z`, `0-9` и `-`; формат проверяют Husky на
|
||||
pre-push и CI.
|
||||
- Пуш в ветку или PR: сборка, проверка имени ветки, проверка списка миграций, сборка Docker-образов
|
||||
`api`/`web`, стенд на `<ветка>.<домен>`, линт, публикация документации.
|
||||
- Удаление ветки: стенд удаляется (`cleanup.yaml`).
|
||||
- Тег `v*`: сборка и выкладка в прод (`production.yaml`), миграции применяются автоматически.
|
||||
|
||||
To version and release the library use
|
||||
## Новый проект из шаблона
|
||||
|
||||
```
|
||||
npx nx release
|
||||
```
|
||||
1. **Переименовать воркспейс.** `package.json` (`@jt4d-platform/*`), `project.json`, `nx.json`,
|
||||
`tsconfig.base.json` (`paths` и `customConditions`), `apps/*/package.json`.
|
||||
2. **Настроить доставку.** Домен и registry в `.gitea/workflows/*.yaml`,
|
||||
`docker-compose.production.yml`, `docker-compose.staging.yml`, `.docuservix.yml`; домен в
|
||||
`apps/web/Caddyfile` и список CORS-origin в `apps/api/src/main.ts`.
|
||||
3. **Задать переменные и секреты репозитория в Gitea.** `vars.REGISTRY_USER`, `vars.STAGING_HOST`,
|
||||
`vars.STAGING_USER`, `vars.STAGING_PORT`; `secrets.REGISTRY_PASSWORD`,
|
||||
`secrets.STAGING_SSH_PRIVATE_KEY`.
|
||||
4. **Убрать демо-код.** `apps/web/src/app/nx-welcome.tsx` и демо-страница в `apps/web/src/app`,
|
||||
тестовый контроллер и сервис в `apps/api/src/app`.
|
||||
5. **Пересобрать миграции.** Удалить тестовую миграцию из `apps/api/src/database/migrations/` и
|
||||
выполнить `yarn db-migrations-list`; список `apps/api/src/migrations.ts` коммитится.
|
||||
6. **Обновить тексты под проект.** `docs/index.md`, документы в `docs/`, `AGENTS.md`, этот
|
||||
`README.md`.
|
||||
7. **Проверить ветку в CI.** Первый пуш должен пройти `yarn lint:check` и сборку, а стенд —
|
||||
открыться по своему адресу.
|
||||
|
||||
Pass `--dry-run` to see what would happen without actually releasing the library.
|
||||
## Документация
|
||||
|
||||
[Learn more about Nx release »](https://nx.dev/docs/features/manage-releases?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
|
||||
- [Оглавление](docs/index.md)
|
||||
- [Слои API](docs/50-developing/01-api-layers.md) и [слои web](docs/50-developing/02-web-layers.md)
|
||||
- [Работа с БД](docs/50-developing/10-persistence.md),
|
||||
[миграции](docs/50-developing/20-migrations.md),
|
||||
[доступ к данным](docs/50-developing/30-data-access.md), [тесты](docs/50-developing/40-testing.md)
|
||||
- [Ручное логирование](docs/55-logging/04-manual-logs.md)
|
||||
- [Миграции и деплой](docs/90-deploy/10-migrations.md)
|
||||
|
||||
## Keep TypeScript project references up to date
|
||||
Инструкции для ИИ-агентов (в том числе Claude Code) — в [AGENTS.md](AGENTS.md).
|
||||
|
||||
Nx automatically updates TypeScript [project references](https://www.typescriptlang.org/docs/handbook/project-references.html) in `tsconfig.json` files to ensure they remain accurate based on your project dependencies (`import` or `require` statements). This sync is automatically done when running tasks such as `build` or `typecheck`, which require updated references to function correctly.
|
||||
## Полезные ссылки
|
||||
|
||||
To manually trigger the process to sync the project graph dependencies information to the TypeScript project references, run the following command:
|
||||
|
||||
```sh
|
||||
npx nx sync
|
||||
```
|
||||
|
||||
You can enforce that the TypeScript project references are always in the correct state when running in CI by adding a step to your CI job configuration that runs the following command:
|
||||
|
||||
```sh
|
||||
npx nx sync:check
|
||||
```
|
||||
|
||||
[Learn more about nx sync](https://nx.dev/reference/nx-commands#sync)
|
||||
|
||||
## Nx Cloud
|
||||
|
||||
Nx Cloud ensures a [fast and scalable CI](https://nx.dev/nx-cloud?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) pipeline. It includes features such as:
|
||||
|
||||
- [Remote caching](https://nx.dev/docs/features/ci-features/remote-cache?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
|
||||
- [Task distribution across multiple machines](https://nx.dev/docs/features/ci-features/distribute-task-execution?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
|
||||
- [Automated e2e test splitting](https://nx.dev/docs/features/ci-features/split-e2e-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
|
||||
- [Task flakiness detection and rerunning](https://nx.dev/docs/features/ci-features/flaky-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
|
||||
|
||||
### Set up CI (non-Github Actions CI)
|
||||
|
||||
**Note:** This is only required if your CI provider is not GitHub Actions.
|
||||
|
||||
Use the following command to configure a CI workflow for your workspace:
|
||||
|
||||
```sh
|
||||
npx nx g ci-workflow
|
||||
```
|
||||
|
||||
[Learn more about Nx on CI](https://nx.dev/docs/features/ci-features?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
|
||||
|
||||
## Install Nx Console
|
||||
|
||||
Nx Console is an editor extension that enriches your developer experience. It lets you run tasks, generate code, and improves code autocompletion in your IDE. It is available for VSCode and IntelliJ.
|
||||
|
||||
[Install Nx Console »](https://nx.dev/docs/getting-started/editor-setup?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
|
||||
|
||||
## 🔗 Learn More
|
||||
|
||||
- [Nx Documentation](https://nx.dev/docs)
|
||||
- [Crafting Your Workspace Tutorial](https://nx.dev/docs/getting-started/tutorials/crafting-your-workspace)
|
||||
- [Module Boundaries](https://nx.dev/docs/features/enforce-module-boundaries)
|
||||
- [Releasing Packages](https://nx.dev/docs/features/manage-releases)
|
||||
- [Nx Plugins](https://nx.dev/docs/concepts/nx-plugins)
|
||||
- [Nx Cloud](https://nx.dev/nx-cloud)
|
||||
|
||||
## 💬 Community
|
||||
|
||||
Join the Nx community:
|
||||
|
||||
- [Discord](https://go.nx.dev/community)
|
||||
- [X (Twitter)](https://twitter.com/nxdevtools)
|
||||
- [LinkedIn](https://www.linkedin.com/company/nrwl)
|
||||
- [YouTube](https://www.youtube.com/@nxdevtools)
|
||||
- [Blog](https://nx.dev/blog)
|
||||
- [Документация Nx](https://nx.dev/getting-started/intro)
|
||||
- [Запуск задач в Nx](https://nx.dev/features/run-tasks)
|
||||
- [Nx Console](https://nx.dev/getting-started/editor-setup)
|
||||
@@ -1,3 +1,5 @@
|
||||
import { defineConfig } from 'eslint/config';
|
||||
|
||||
import baseConfig from '../../eslint.config.mjs';
|
||||
|
||||
export default [...baseConfig];
|
||||
export default defineConfig(baseConfig);
|
||||
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"name": "@geo-platform/api-e2e",
|
||||
"name": "@jt4d-platform/api-e2e",
|
||||
"version": "0.0.1",
|
||||
"private": true
|
||||
}
|
||||
@@ -1,5 +1,5 @@
|
||||
import axios from 'axios';
|
||||
import { describe, it } from 'vitest';
|
||||
import { describe, expect, it } from 'vitest';
|
||||
|
||||
describe.skip('GET /api', () => {
|
||||
it('should return a message', async () => {
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"extends": "../../tsconfig.base.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "out-tsc/@geo-platform/api-e2e",
|
||||
"outDir": "out-tsc/@jt4d-platform/api-e2e",
|
||||
"esModuleInterop": true,
|
||||
"noUnusedLocals": false,
|
||||
"noImplicitAny": false
|
||||
|
||||
@@ -15,7 +15,10 @@ COPY --from=deps /app/node_modules /app/node_modules
|
||||
COPY ./dist /app
|
||||
|
||||
EXPOSE 5000
|
||||
# Прод-режим по умолчанию: JSON-логи pino и никаких pino-pretty из devDependencies,
|
||||
# которые в образ не попадают. Переопределяется через docker-compose при необходимости.
|
||||
ENV PORT=5000
|
||||
ENV NODE_ENV=production
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ const nodeExternals = require('webpack-node-externals');
|
||||
*/
|
||||
module.exports.DenyExternalsPlugin = class DenyExternalsPlugin {
|
||||
constructor(skipExternalPackages) {
|
||||
// Массив строк-префиксов, например ['@geo-platform/']
|
||||
// Массив строк-префиксов, например ['@jt4d-platform/']
|
||||
this.skipExternalPackages = skipExternalPackages;
|
||||
}
|
||||
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
import { defineConfig } from 'eslint/config';
|
||||
|
||||
import baseConfig from '../../eslint.config.mjs';
|
||||
|
||||
export default [...baseConfig];
|
||||
export default defineConfig(baseConfig);
|
||||
+13
-2
@@ -1,18 +1,29 @@
|
||||
{
|
||||
"name": "@geo-platform/api",
|
||||
"name": "@jt4d-platform/api",
|
||||
"version": "0.0.1",
|
||||
"private": true,
|
||||
"dependencies": {
|
||||
"@nestjs/common": "^11.0.0",
|
||||
"@nestjs/core": "^11.0.0",
|
||||
"@nestjs/platform-express": "^11.0.0",
|
||||
"@nestjs/swagger": "^11.4.7",
|
||||
"@nestjs/terminus": "^11.1.1",
|
||||
"@nestjs/typeorm": "^11.0.0",
|
||||
"axios": "^1.6.0",
|
||||
"colorette": "^2.0.20",
|
||||
"dotenv": "^16.4.7",
|
||||
"nestjs-pino": "^4.4.1",
|
||||
"pg": "^8.20.0",
|
||||
"pino": "^9.11.0",
|
||||
"pino-http": "^10.5.0",
|
||||
"reflect-metadata": "^0.1.13",
|
||||
"rxjs": "^7.8.0"
|
||||
"rxjs": "^7.8.0",
|
||||
"typeorm": "^0.3.31"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@nestjs/schematics": "^11.0.0",
|
||||
"@nestjs/testing": "^11.0.0",
|
||||
"pino-pretty": "^13.1.1",
|
||||
"webpack-cli": "^5.1.4"
|
||||
}
|
||||
}
|
||||
@@ -1,4 +1,5 @@
|
||||
import { Controller, Get } from '@nestjs/common';
|
||||
|
||||
import { AppService } from './app.service';
|
||||
|
||||
@Controller()
|
||||
|
||||
@@ -1,10 +1,19 @@
|
||||
import { Module } from '@nestjs/common';
|
||||
import { Module, OnModuleDestroy } from '@nestjs/common';
|
||||
|
||||
import { DatabaseModule } from '../database/database.module';
|
||||
import { HealthModule } from '../health/health.module';
|
||||
import { LocalLoggerModule, Logger } from '../logger';
|
||||
|
||||
import { AppController } from './app.controller';
|
||||
import { AppService } from './app.service';
|
||||
|
||||
@Module({
|
||||
imports: [],
|
||||
imports: [LocalLoggerModule.forRoot(), DatabaseModule, HealthModule],
|
||||
controllers: [AppController],
|
||||
providers: [AppService],
|
||||
})
|
||||
export class AppModule {}
|
||||
export class AppModule implements OnModuleDestroy {
|
||||
onModuleDestroy() {
|
||||
new Logger('AppModule').warn('Backend is shutting down');
|
||||
}
|
||||
}
|
||||
@@ -1,8 +1,9 @@
|
||||
import { config } from 'dotenv';
|
||||
import * as path from 'path';
|
||||
|
||||
import { config } from 'dotenv';
|
||||
import { DataSource } from 'typeorm';
|
||||
|
||||
import { migrations } from '../database/migrations';
|
||||
import { migrations } from '../migrations';
|
||||
|
||||
// Загружаем env файлы в правильном порядке.
|
||||
// Внутри контейнера файлов нет — dotenv молча пропустит их, значения берутся из окружения.
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
import { Module } from '@nestjs/common';
|
||||
import { TypeOrmModule } from '@nestjs/typeorm';
|
||||
|
||||
import AppDataSource from '../config/typeorm.config';
|
||||
|
||||
/**
|
||||
* Подключение приложения к БД.
|
||||
*
|
||||
* Настройки берутся из того же `typeorm.config.ts`, что использует CLI миграций:
|
||||
* там же загружаются env-файлы, поэтому приложению не нужен второй набор
|
||||
* переменных окружения. Сущности модулей подключаются через
|
||||
* `TypeOrmModule.forFeature` (autoLoadEntities), статический список `entities`
|
||||
* остаётся нужен только CLI.
|
||||
*
|
||||
* Собственный логгер TypeORM выключен: логи приложения идут через pino
|
||||
* (docs/55-logging), иначе SQL-запросы печатаются мимо него.
|
||||
*/
|
||||
@Module({
|
||||
imports: [
|
||||
TypeOrmModule.forRoot({
|
||||
...AppDataSource.options,
|
||||
autoLoadEntities: true,
|
||||
logging: false,
|
||||
migrationsRun: false,
|
||||
}),
|
||||
],
|
||||
})
|
||||
export class DatabaseModule {}
|
||||
@@ -1,29 +0,0 @@
|
||||
// Файл сгенерирован автоматически (tools/buildDataSource.ts). Не редактировать вручную.
|
||||
|
||||
import { Migration1763288877894 } from './migrations/1763288877894-migration';
|
||||
import { AddPublicMetricRequests1764100000000 } from './migrations/1764100000000-add-public-metric-requests';
|
||||
import { Migration1764428518020 } from './migrations/1764428518020-migration';
|
||||
import { AddAdditionalInfoToProjectMetrics1764846475427 } from './migrations/1764846475427-add-additional-info-to-project-metrics';
|
||||
import { AddPublicSlugToProjects1765718859348 } from './migrations/1765718859348-add-public-slug-to-projects';
|
||||
import { Migration1770339322029 } from './migrations/1770339322029-migration';
|
||||
import { Migration1770341180992 } from './migrations/1770341180992-migration';
|
||||
import { AddUserMetricsMonthlyLimit1772362000000 } from './migrations/1772362000000-add-user-metrics-monthly-limit';
|
||||
import { AddDefaultUserAndAdminRoles1772363000000 } from './migrations/1772363000000-add-default-user-and-admin-roles';
|
||||
import { AddBrandQuestions1773000000000 } from './migrations/1773000000000-add-brand-questions';
|
||||
import { AddSubscriptionPlans1774000000000 } from './migrations/1774000000000-add-subscription-plans';
|
||||
import { FixSubscriptionPlanIdDefault1774001000000 } from './migrations/1774001000000-fix-subscription-plan-id-default';
|
||||
|
||||
export const migrations = [
|
||||
Migration1763288877894,
|
||||
AddPublicMetricRequests1764100000000,
|
||||
Migration1764428518020,
|
||||
AddAdditionalInfoToProjectMetrics1764846475427,
|
||||
AddPublicSlugToProjects1765718859348,
|
||||
Migration1770339322029,
|
||||
Migration1770341180992,
|
||||
AddUserMetricsMonthlyLimit1772362000000,
|
||||
AddDefaultUserAndAdminRoles1772363000000,
|
||||
AddBrandQuestions1773000000000,
|
||||
AddSubscriptionPlans1774000000000,
|
||||
FixSubscriptionPlanIdDefault1774001000000,
|
||||
];
|
||||
Whitespace-only changes.
@@ -0,0 +1,10 @@
|
||||
import { Module } from '@nestjs/common';
|
||||
import { TerminusModule } from '@nestjs/terminus';
|
||||
|
||||
import { HealthController } from './health.controller';
|
||||
|
||||
@Module({
|
||||
imports: [TerminusModule],
|
||||
controllers: [HealthController],
|
||||
})
|
||||
export class HealthModule {}
|
||||
@@ -0,0 +1,36 @@
|
||||
import pino, { Logger as PinoLogger } from 'pino';
|
||||
import type { PrettyOptions } from 'pino-pretty';
|
||||
|
||||
/**
|
||||
* В продакшене пишем машиночитаемый JSON, в остальных окружениях — человекочитаемый вывод.
|
||||
* LOG_PRETTY явно перекрывает определение по NODE_ENV (нужно, когда образ собран под прод,
|
||||
* а контейнер поднят локально).
|
||||
*/
|
||||
const isProduction = process.env.NODE_ENV === 'production' || process.env.LOG_PRETTY === 'false';
|
||||
|
||||
const baseLogger = pino({
|
||||
level: process.env.LOG_LEVEL ?? (isProduction ? 'info' : 'debug'),
|
||||
transport: isProduction
|
||||
? undefined
|
||||
: {
|
||||
target: 'pino-pretty',
|
||||
options: {
|
||||
colorize: true,
|
||||
translateTime: 'HH:MM:ss.l',
|
||||
ignore: 'pid,hostname,context,reqId,res,url,statusCode,responseTime',
|
||||
messageFormat: [
|
||||
'\x1b[36m{reqId}\x1b[0m',
|
||||
'\x1b[33m{context}\x1b[0m',
|
||||
'\x1b[34m{msg}\x1b[0m',
|
||||
].join(' '),
|
||||
} as PrettyOptions,
|
||||
},
|
||||
});
|
||||
|
||||
/**
|
||||
* Единственный экземпляр pino на процесс: и корневой логгер приложения, и pino-http
|
||||
* пишут через него, поэтому транспорт (воркер pino-pretty) создаётся один раз.
|
||||
*/
|
||||
export function getBaseLogger(): PinoLogger {
|
||||
return baseLogger;
|
||||
}
|
||||
@@ -0,0 +1,3 @@
|
||||
export * from './base';
|
||||
export * from './logger.class';
|
||||
export * from './logger.module';
|
||||
@@ -0,0 +1,167 @@
|
||||
import { Inject, Injectable, LoggerService, Scope } from '@nestjs/common';
|
||||
import { PinoLogger } from 'nestjs-pino';
|
||||
import { Bindings } from 'pino';
|
||||
|
||||
import { getBaseLogger } from './base';
|
||||
|
||||
export type LogLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal';
|
||||
|
||||
@Injectable({ scope: Scope.TRANSIENT })
|
||||
export class Logger implements LoggerService {
|
||||
private readonly logger: PinoLogger;
|
||||
|
||||
constructor();
|
||||
constructor(context: string);
|
||||
constructor(
|
||||
@Inject(PinoLogger)
|
||||
context?: string | PinoLogger,
|
||||
) {
|
||||
if (context && context instanceof PinoLogger) {
|
||||
this.logger = context;
|
||||
} else {
|
||||
const bindings: Bindings = context ? { context } : {};
|
||||
|
||||
this.logger = getBaseLogger().child(bindings) as unknown as PinoLogger;
|
||||
}
|
||||
}
|
||||
|
||||
setContext(context: string) {
|
||||
if (this.logger instanceof PinoLogger) {
|
||||
this.logger.setContext(context);
|
||||
} else {
|
||||
throw new Error('Cannot set context on child logger');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Трассировка, максимальная детализация
|
||||
*
|
||||
* Log level: 10
|
||||
*
|
||||
* Самый подробный уровень. Используется для сложных расследований и поиска причин ошибок.
|
||||
*
|
||||
* Примеры:
|
||||
* - пошаговое логирование алгоритма
|
||||
* - шаги в обработке запроса
|
||||
* - переходы между этапами обработки
|
||||
* - детали бизнес-логики
|
||||
*/
|
||||
trace(message: string, details?: object) {
|
||||
this.logInner('trace', message, details);
|
||||
}
|
||||
|
||||
/**
|
||||
* Отладка, подробности бизнес-логики
|
||||
*
|
||||
* Log level: 20
|
||||
*
|
||||
* Сообщения для разработчиков, полезные при разборе логики работы.
|
||||
*
|
||||
* Примеры:
|
||||
* - запрос разрешений
|
||||
* - ключевые шаги алгоритма
|
||||
* - получение данных из внешних сервисов
|
||||
* - события жизненного цикла приложения
|
||||
* - ответы от внешних сервисов
|
||||
*/
|
||||
debug(message: string, details?: object) {
|
||||
this.logInner('debug', message, details);
|
||||
}
|
||||
|
||||
/**
|
||||
* Ключевые события приложения
|
||||
*
|
||||
* Log level: 30
|
||||
*
|
||||
* Информационные сообщения о нормальной работе приложения.
|
||||
*
|
||||
* Примеры:
|
||||
* - запрос к API
|
||||
* - пользователь успешно вошёл в систему
|
||||
* - заявка создана
|
||||
* - бизнес-операция успешно выполнена
|
||||
*/
|
||||
log(message: string, details?: object) {
|
||||
this.logInner('info', message, details);
|
||||
}
|
||||
|
||||
/**
|
||||
* Потенциальная проблема, нестандартное поведение
|
||||
*
|
||||
* Log level: 40
|
||||
*
|
||||
* Предупреждения о нежелательных или подозрительных ситуациях, которые не приводят к немедленной поломке.
|
||||
*
|
||||
* Примеры:
|
||||
* - потенциально опасное поведение пользователя
|
||||
* - использование устаревшего API
|
||||
* - медленный запрос
|
||||
*/
|
||||
warn(message: string, details?: object) {
|
||||
this.logInner('warn', message, details);
|
||||
}
|
||||
|
||||
/**
|
||||
* Ошибка, требующая реакции
|
||||
*
|
||||
* Log level: 50
|
||||
*
|
||||
* Серьёзные ошибки в работе приложения, которые нужно обрабатывать.
|
||||
*
|
||||
* Примеры:
|
||||
* - API отдало 500
|
||||
* - не удалось выполнить бизнес-операцию.
|
||||
*/
|
||||
error(message: string, details?: object): void;
|
||||
/**
|
||||
* Ошибка, требующая реакции
|
||||
*
|
||||
* Log level: 50
|
||||
*
|
||||
* Серьёзные ошибки в работе приложения, которые нужно обрабатывать.
|
||||
*
|
||||
* Примеры:
|
||||
* - API отдало 500
|
||||
* - не удалось выполнить бизнес-операцию.
|
||||
*/
|
||||
error(message: string, trace?: string, details?: object): void;
|
||||
error(message: string, traceOrDetails?: string | object, details?: object | string) {
|
||||
if (typeof details === 'string') {
|
||||
details = { context: details };
|
||||
}
|
||||
|
||||
if (typeof traceOrDetails === 'string') {
|
||||
details = { ...details, trace: traceOrDetails };
|
||||
}
|
||||
|
||||
this.logInner('error', message, details);
|
||||
}
|
||||
|
||||
/**
|
||||
* Критическая ошибка, завершение работы
|
||||
*
|
||||
* Log level: 60
|
||||
*
|
||||
* Используется для ситуаций, после которых приложение не может продолжать работу.
|
||||
*
|
||||
* Примеры:
|
||||
* - падение основного процесса
|
||||
* - невозможность поднять сервер на указанном порту
|
||||
* - не корректная конфигурация
|
||||
* - не удалось подключиться к базе данных
|
||||
*/
|
||||
fatal(message: string, details?: object) {
|
||||
this.logInner('fatal', message, details);
|
||||
}
|
||||
|
||||
protected logInner(level: LogLevel, message: string, details?: object | string) {
|
||||
if (typeof details === 'object' && details !== null) {
|
||||
this.logger[level](details, message);
|
||||
} else if (typeof details === 'string') {
|
||||
// Для совместимости с логгером по умолчанию в NestJS
|
||||
this.logger[level]({ context: details }, message);
|
||||
} else {
|
||||
this.logger[level](message);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,113 @@
|
||||
import { IncomingMessage, ServerResponse } from 'http';
|
||||
|
||||
import { DynamicModule, INestApplication, Module } from '@nestjs/common';
|
||||
import { LoggerModule, PinoLogger } from 'nestjs-pino';
|
||||
|
||||
import { getBaseLogger } from './base';
|
||||
import { Logger } from './logger.class';
|
||||
import { MockLogger, TestingLogger } from './testing';
|
||||
|
||||
@Module({})
|
||||
export class LocalLoggerModule {
|
||||
/**
|
||||
* Рабочая конфигурация: наш pino (base.ts) + автоматические HTTP-логи через pino-http.
|
||||
*/
|
||||
public static forRoot(): DynamicModule {
|
||||
return {
|
||||
global: true,
|
||||
module: LocalLoggerModule,
|
||||
imports: [
|
||||
LoggerModule.forRoot({
|
||||
pinoHttp: {
|
||||
// важное место: используем наш СУЩЕСТВУЮЩИЙ pino, а не создаём новый
|
||||
logger: getBaseLogger(),
|
||||
|
||||
autoLogging: true,
|
||||
|
||||
customProps: (req: IncomingMessage) => ({
|
||||
url: req.method + ' ' + req.url,
|
||||
context: 'HTTP',
|
||||
}),
|
||||
quietReqLogger: true,
|
||||
quietResLogger: true,
|
||||
|
||||
customLogLevel: function (
|
||||
_req: IncomingMessage,
|
||||
res: ServerResponse,
|
||||
err?: Error,
|
||||
) {
|
||||
if (res.statusCode >= 500 || err) {
|
||||
return 'error';
|
||||
} else if (res.statusCode >= 300 && res.statusCode < 400) {
|
||||
return 'silent';
|
||||
}
|
||||
|
||||
return 'info';
|
||||
},
|
||||
customSuccessMessage(req: IncomingMessage, res: ServerResponse) {
|
||||
return `Request completed: ${res.statusCode} ${req.method} ${req.url}`;
|
||||
},
|
||||
customSuccessObject(
|
||||
_req: IncomingMessage,
|
||||
res: ServerResponse,
|
||||
val: { responseTime: number },
|
||||
) {
|
||||
return {
|
||||
statusCode: res.statusCode,
|
||||
responseTime: val.responseTime,
|
||||
};
|
||||
},
|
||||
customErrorMessage(req: IncomingMessage, res: ServerResponse, err: Error) {
|
||||
return `Request error: ${res.statusCode} ${req.method} ${req.url} ${err.message}`;
|
||||
},
|
||||
customErrorObject(
|
||||
req: IncomingMessage,
|
||||
res: ServerResponse,
|
||||
_err: Error,
|
||||
val: { responseTime: number },
|
||||
) {
|
||||
return {
|
||||
url: req.method + ' ' + req.url,
|
||||
statusCode: res.statusCode,
|
||||
responseTime: val.responseTime,
|
||||
};
|
||||
},
|
||||
},
|
||||
}),
|
||||
],
|
||||
providers: [Logger],
|
||||
exports: [Logger],
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Конфигурация для тестов: логи складываются в память и проверяются через TestingLogger.
|
||||
*/
|
||||
public static forTesting(): DynamicModule {
|
||||
return {
|
||||
global: true,
|
||||
module: LocalLoggerModule,
|
||||
providers: [
|
||||
TestingLogger,
|
||||
{
|
||||
provide: Logger,
|
||||
useFactory: (testingLogger: TestingLogger) => new MockLogger(testingLogger),
|
||||
inject: [TestingLogger],
|
||||
},
|
||||
{
|
||||
provide: PinoLogger,
|
||||
useValue: {},
|
||||
},
|
||||
],
|
||||
exports: [Logger, TestingLogger],
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Подмена логгера Nest нашим. Вызывать после NestFactory.create с bufferLogs: true —
|
||||
* useLogger сбрасывает буфер в наш логгер.
|
||||
*/
|
||||
public static setup(app: INestApplication) {
|
||||
app.useLogger(new Logger());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,2 @@
|
||||
export * from './logger.class';
|
||||
export * from './testing-logger.class';
|
||||
@@ -0,0 +1,19 @@
|
||||
import { Logger, LogLevel } from '../logger.class';
|
||||
|
||||
import { TestingLogger } from './testing-logger.class';
|
||||
|
||||
export class MockLogger extends Logger {
|
||||
private context: string;
|
||||
|
||||
constructor(private readonly testingLogger: TestingLogger) {
|
||||
super();
|
||||
}
|
||||
|
||||
override setContext(context: string) {
|
||||
this.context = context;
|
||||
}
|
||||
|
||||
protected override logInner(level: LogLevel, message: string, details?: object) {
|
||||
this.testingLogger.log(level, message, this.context, details);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,265 @@
|
||||
import * as colorette from 'colorette';
|
||||
|
||||
import { LogLevel } from '../logger.class';
|
||||
|
||||
import { fail, LogEntry, PrettifyStackTrace, showLogDetails, showLogObject } from './utils';
|
||||
|
||||
export type { LogEntry };
|
||||
|
||||
export class TestingLogger {
|
||||
private readonly entries: LogEntry[] = [];
|
||||
|
||||
/**
|
||||
* Добавление записи лога
|
||||
*/
|
||||
log(level: LogLevel, message: string, context: string, details?: object) {
|
||||
this.entries.push({
|
||||
level,
|
||||
message,
|
||||
context,
|
||||
...details,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Очистка всех записей логов
|
||||
*/
|
||||
clear() {
|
||||
this.entries.length = 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Любые логи (старт без фильтра)
|
||||
*/
|
||||
any(): TestingLoggerMatcher {
|
||||
return new TestingLoggerMatcher(this.entries, {});
|
||||
}
|
||||
|
||||
/**
|
||||
* Старт от фильтра по сообщению
|
||||
*/
|
||||
withMessage(message: string): TestingLoggerMatcher {
|
||||
return new TestingLoggerMatcher(this.entries, { message });
|
||||
}
|
||||
|
||||
/**
|
||||
* Старт от фильтра по уровню
|
||||
*/
|
||||
withLevel(level: LogLevel): TestingLoggerMatcher {
|
||||
return new TestingLoggerMatcher(this.entries, { level });
|
||||
}
|
||||
|
||||
/**
|
||||
* Старт от фильтра по контексту
|
||||
*/
|
||||
withContext(context: string): TestingLoggerMatcher {
|
||||
return new TestingLoggerMatcher(this.entries, { context });
|
||||
}
|
||||
}
|
||||
|
||||
const BASE_FIELDS: (keyof LogEntry)[] = ['level', 'message', 'context'];
|
||||
|
||||
export class TestingLoggerMatcher {
|
||||
constructor(
|
||||
private readonly entries: LogEntry[],
|
||||
private readonly filter: Partial<LogEntry>,
|
||||
private readonly strict = false,
|
||||
) {}
|
||||
|
||||
get logs() {
|
||||
// В режиме strict мы хотим строгое совпадение деталей: все ключи деталей должны совпадать
|
||||
// и не должно быть лишних ключей деталей у записи.
|
||||
if (this.strict) {
|
||||
return this.entries.filter((log) => {
|
||||
// проверяем базовые поля, если они заданы в фильтре
|
||||
for (const field of BASE_FIELDS) {
|
||||
if (this.filter[field] !== undefined && log[field] !== this.filter[field]) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
// ключи деталей в фильтре и в самой записи
|
||||
const detailFilterKeys = Object.keys(this.filter).filter((k) => {
|
||||
return !BASE_FIELDS.includes(k as keyof LogEntry);
|
||||
});
|
||||
const entryDetailKeys = Object.keys(log).filter((k) => {
|
||||
return !BASE_FIELDS.includes(k as keyof LogEntry);
|
||||
});
|
||||
|
||||
// размеры наборов деталей должны совпадать
|
||||
if (detailFilterKeys.length !== entryDetailKeys.length) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// все ключи из фильтра должны присутствовать и иметь одинаковые значения
|
||||
return detailFilterKeys.every((key) => {
|
||||
return log[key] === this.filter[key];
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
return this.entries.filter((log) => {
|
||||
for (const key in this.filter) {
|
||||
if (log[key] !== this.filter[key]) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
});
|
||||
}
|
||||
|
||||
showLogs(options: { hideFilter?: boolean; logs?: LogEntry[] } = {}): this {
|
||||
const { hideFilter = false, logs = this.logs } = options;
|
||||
|
||||
process.stdout.write(colorette.bold(colorette.white('--- Logs ---')) + '\n');
|
||||
|
||||
if (!hideFilter) {
|
||||
process.stdout.write(colorette.bold(colorette.cyan('Filter:')) + '\n');
|
||||
|
||||
if (Object.keys(this.filter).length === 0) {
|
||||
process.stdout.write(' (no filter, showing all logs)\n');
|
||||
} else {
|
||||
showLogDetails({
|
||||
level: this.filter.level,
|
||||
context: this.filter.context,
|
||||
message: this.filter.message,
|
||||
...this.filter,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
process.stdout.write(colorette.bold(colorette.white('Found logs:')) + '\n');
|
||||
|
||||
logs.forEach((log) => {
|
||||
showLogObject(log);
|
||||
process.stdout.write('\n'); // пустая строка между логами
|
||||
});
|
||||
|
||||
process.stdout.write(` Found ${logs.length} log(s) total\n\n`);
|
||||
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Фильтр по сообщению
|
||||
*/
|
||||
withMessage(message: string): TestingLoggerMatcher {
|
||||
return new TestingLoggerMatcher(this.entries, { ...this.filter, message }, this.strict);
|
||||
}
|
||||
|
||||
/**
|
||||
* Фильтр по уровню
|
||||
*/
|
||||
withLevel(level: LogLevel): TestingLoggerMatcher {
|
||||
return new TestingLoggerMatcher(this.entries, { ...this.filter, level }, this.strict);
|
||||
}
|
||||
|
||||
/**
|
||||
* Фильтр по контексту
|
||||
*/
|
||||
withContext(context: string): TestingLoggerMatcher {
|
||||
return new TestingLoggerMatcher(this.entries, { ...this.filter, context }, this.strict);
|
||||
}
|
||||
|
||||
/**
|
||||
* Фильтр по дополнительным деталям
|
||||
*/
|
||||
withDetails(obj: Record<string, boolean | number | string>): TestingLoggerMatcher {
|
||||
return new TestingLoggerMatcher(this.entries, { ...this.filter, ...obj }, this.strict);
|
||||
}
|
||||
|
||||
/**
|
||||
* Фильтр по дополнительным деталям - строгий (все детали должны совпадать, лишних быть не должно)
|
||||
*/
|
||||
strictDetails(): TestingLoggerMatcher {
|
||||
return new TestingLoggerMatcher(this.entries, { ...this.filter }, true);
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверка наличия логов
|
||||
*/
|
||||
@PrettifyStackTrace()
|
||||
toBeLogged(): void {
|
||||
if (this.logs.length === 0) {
|
||||
if (this.entries.length) {
|
||||
this.toBeLoggedTimes(1);
|
||||
} else {
|
||||
return fail('No logs recorded');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверка отсутствия логов
|
||||
*/
|
||||
@PrettifyStackTrace()
|
||||
toBeNotLogged(): void {
|
||||
this.toBeLoggedTimes(0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверка, что лог был записан ровно один раз
|
||||
*/
|
||||
@PrettifyStackTrace()
|
||||
toBeLoggedOnce(): void {
|
||||
this.toBeLoggedTimes(1);
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверка, что лог был записан ровно n раз
|
||||
*/
|
||||
@PrettifyStackTrace()
|
||||
toBeLoggedTimes(n: number): void {
|
||||
if (this.logs.length === n) {
|
||||
return;
|
||||
}
|
||||
|
||||
this.throwDiff(n);
|
||||
}
|
||||
|
||||
private throwDiff(n: number) {
|
||||
if (!this.entries.length) {
|
||||
return fail('No logs recorded');
|
||||
}
|
||||
|
||||
throw new Error(
|
||||
[
|
||||
`Expected ${n} log(s)` + describedFilter(this.filter),
|
||||
this.logs.length ? '\nFound:' : '',
|
||||
...this.logs.map((entry) => ` ${logEntryToString(this.filter)(entry)}`),
|
||||
this.logs.length ? '' : ' (none)',
|
||||
].join('\n'),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
function describedFilter(filter: Partial<LogEntry>): string {
|
||||
const keys = Object.keys(filter);
|
||||
|
||||
if (!keys.length) {
|
||||
return '';
|
||||
}
|
||||
|
||||
return ` matching ${keys.map((key) => `${key}=${String(filter[key])}`).join(', ')}`;
|
||||
}
|
||||
|
||||
function logEntryToString(filter: Partial<LogEntry>) {
|
||||
return (entry: LogEntry): string => {
|
||||
let result = '';
|
||||
|
||||
if (filter.context) {
|
||||
result += `${entry.context} `;
|
||||
}
|
||||
|
||||
if (filter.level) {
|
||||
result += `[${entry.level}] `;
|
||||
}
|
||||
|
||||
if (filter.message) {
|
||||
result += `${entry.message}`;
|
||||
}
|
||||
|
||||
return result;
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,567 @@
|
||||
import { Test } from '@nestjs/testing';
|
||||
import { beforeEach, describe, expect, it } from 'vitest';
|
||||
|
||||
import { Logger } from '../logger.class';
|
||||
import { LocalLoggerModule } from '../logger.module';
|
||||
|
||||
import { TestingLogger } from './testing-logger.class';
|
||||
|
||||
describe('TestingLogger', () => {
|
||||
let mockLogger: Logger;
|
||||
let logger: TestingLogger;
|
||||
|
||||
beforeEach(async () => {
|
||||
const module = await Test.createTestingModule({
|
||||
imports: [LocalLoggerModule.forTesting()],
|
||||
}).compile();
|
||||
|
||||
mockLogger = await module.resolve(Logger);
|
||||
logger = module.get(TestingLogger);
|
||||
});
|
||||
|
||||
it('complex test', () => {
|
||||
// Arrange
|
||||
mockLogger.setContext('RBAC');
|
||||
|
||||
// Act
|
||||
mockLogger.debug('Access granted', { user: 1, permissions: ['read'] });
|
||||
mockLogger.log('Access granted', { user: 2, permissions: ['read', 'write'] });
|
||||
mockLogger.warn('Access denied', { user: 1 });
|
||||
mockLogger.log('User logged in', { user: 1 });
|
||||
mockLogger.error('Unexpected error', { error: new Error('Test error') });
|
||||
|
||||
// Assert
|
||||
const rbacLogger = logger.withContext('RBAC');
|
||||
|
||||
rbacLogger.withMessage('Access denied').toBeLogged();
|
||||
|
||||
rbacLogger.withMessage('Access granted').withLevel('debug').toBeLogged();
|
||||
rbacLogger.withMessage('Access granted').withLevel('info').toBeLogged();
|
||||
rbacLogger.withMessage('User logged in').withLevel('info').toBeLogged();
|
||||
rbacLogger.withMessage('Unexpected error').withLevel('error').toBeLogged();
|
||||
|
||||
rbacLogger.toBeLoggedTimes(5);
|
||||
|
||||
rbacLogger.withMessage('Access granted').toBeLoggedTimes(2);
|
||||
rbacLogger.withMessage('Access denied').toBeLoggedOnce();
|
||||
rbacLogger.withMessage('User logged in').toBeLoggedOnce();
|
||||
rbacLogger.withMessage('Unexpected error').toBeLoggedOnce();
|
||||
|
||||
rbacLogger.withMessage('Access granted').withDetails({ user: 1 }).toBeLoggedOnce();
|
||||
});
|
||||
|
||||
describe('TestingLogger — базовые операции', () => {
|
||||
it('сохраняет запись через log() (все поля + details)', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'msg', 'CTX', { a: 1 });
|
||||
|
||||
// Act
|
||||
const matcher = logger.any();
|
||||
|
||||
// Assert
|
||||
matcher.toBeLoggedOnce();
|
||||
// Проверяем точное соответствие
|
||||
const entries = matcher.logs;
|
||||
|
||||
expect(entries[0]).toEqual({
|
||||
level: 'info',
|
||||
message: 'msg',
|
||||
context: 'CTX',
|
||||
a: 1,
|
||||
});
|
||||
});
|
||||
|
||||
it('log() без details не добавляет лишних ключей', () => {
|
||||
// Arrange
|
||||
logger.log('warn', 'msg', 'CTX');
|
||||
|
||||
// Act
|
||||
const matcher = logger.any();
|
||||
|
||||
matcher.toBeLoggedOnce();
|
||||
const entry = matcher.logs[0];
|
||||
|
||||
// Assert
|
||||
expect(entry).toEqual({
|
||||
level: 'warn',
|
||||
message: 'msg',
|
||||
context: 'CTX',
|
||||
});
|
||||
// Проверяем отсутствие произвольных ключей
|
||||
expect(entry.a).toBeUndefined();
|
||||
expect(entry.b).toBeUndefined();
|
||||
});
|
||||
|
||||
it('поля из details перекрывают базовые при совпадении ключей', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'base', 'CTX', {
|
||||
message: 'override',
|
||||
level: 'error',
|
||||
context: 'OVR',
|
||||
});
|
||||
|
||||
// Act
|
||||
const matcher = logger.any();
|
||||
|
||||
matcher.toBeLoggedOnce();
|
||||
const entry = matcher.logs[0];
|
||||
|
||||
// Assert
|
||||
expect(entry).toEqual({
|
||||
level: 'error',
|
||||
message: 'override',
|
||||
context: 'OVR',
|
||||
});
|
||||
});
|
||||
|
||||
it('clear() очищает все записи', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'A', 'CTX');
|
||||
logger.log('warn', 'B', 'CTX');
|
||||
|
||||
// Act
|
||||
logger.clear();
|
||||
const matcher = logger.any();
|
||||
|
||||
// Assert
|
||||
matcher.toBeNotLogged();
|
||||
});
|
||||
});
|
||||
|
||||
describe('TestingLogger — входные точки фильтрации', () => {
|
||||
it('any() возвращает матчёр со всеми текущими записями', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'A', 'CTX1');
|
||||
logger.log('warn', 'B', 'CTX2');
|
||||
logger.log('error', 'C', 'CTX3');
|
||||
|
||||
// Act & Assert
|
||||
logger.any().toBeLoggedTimes(3);
|
||||
});
|
||||
|
||||
it('withMessage("X") создаёт стартовый матчёр с фильтром по message', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'X', 'CTX1');
|
||||
logger.log('warn', 'Y', 'CTX2');
|
||||
logger.log('error', 'X', 'CTX3');
|
||||
|
||||
// Act & Assert
|
||||
logger.withMessage('X').toBeLoggedTimes(2);
|
||||
logger.withMessage('Y').toBeLoggedTimes(1);
|
||||
logger.withMessage('Z').toBeLoggedTimes(0);
|
||||
});
|
||||
|
||||
it('withLevel(L) создаёт стартовый матчёр с фильтром по level', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'A', 'CTX1');
|
||||
logger.log('error', 'B', 'CTX2');
|
||||
logger.log('error', 'C', 'CTX3');
|
||||
|
||||
// Act & Assert
|
||||
logger.withLevel('info').toBeLoggedTimes(1);
|
||||
logger.withLevel('error').toBeLoggedTimes(2);
|
||||
logger.withLevel('warn').toBeLoggedTimes(0);
|
||||
});
|
||||
|
||||
it('withContext("C") создаёт стартовый матчёр с фильтром по context', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'A', 'C');
|
||||
logger.log('warn', 'B', 'CTX2');
|
||||
logger.log('error', 'C', 'C');
|
||||
|
||||
// Act & Assert
|
||||
logger.withContext('C').toBeLoggedTimes(2);
|
||||
logger.withContext('CTX2').toBeLoggedTimes(1);
|
||||
logger.withContext('CTX3').toBeLoggedTimes(0);
|
||||
});
|
||||
|
||||
it('повторные вызовы стартовых фильтров независимы (каждый — новый матчёр)', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'A', 'CTX');
|
||||
logger.log('info', 'B', 'CTX');
|
||||
|
||||
// Act
|
||||
const mA = logger.withMessage('A');
|
||||
const mB = logger.withMessage('B');
|
||||
|
||||
// Assert
|
||||
mA.toBeLoggedTimes(1);
|
||||
mB.toBeLoggedTimes(1);
|
||||
// Проверяем, что фильтры независимы
|
||||
expect(mA.logs[0].message).toBe('A');
|
||||
expect(mB.logs[0].message).toBe('B');
|
||||
});
|
||||
});
|
||||
|
||||
describe('TestingLoggerMatcher — фильтры (локальные)', () => {
|
||||
it('withMessage("X") фильтрует текущий набор по message', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'X', 'CTX1');
|
||||
logger.log('warn', 'Y', 'CTX2');
|
||||
logger.log('error', 'X', 'CTX3');
|
||||
logger.log('debug', 'Z', 'CTX4');
|
||||
|
||||
// Act
|
||||
const filtered = logger.any().withMessage('X');
|
||||
|
||||
// Assert
|
||||
filtered.toBeLoggedTimes(2); // Должно остаться только 2 записи с message === 'X'
|
||||
});
|
||||
|
||||
it('withLevel(L) фильтрует текущий набор по level', () => {
|
||||
// Arrange
|
||||
logger.log('warn', 'A', 'CTX1');
|
||||
logger.log('info', 'B', 'CTX2');
|
||||
logger.log('warn', 'C', 'CTX3');
|
||||
logger.log('error', 'D', 'CTX4');
|
||||
|
||||
// Act
|
||||
const filtered = logger.any().withLevel('warn');
|
||||
|
||||
// Assert
|
||||
filtered.toBeLoggedTimes(2); // Должно остаться только 2 записи с level === 'warn'
|
||||
});
|
||||
|
||||
it('withContext("C") фильтрует текущий набор по context', () => {
|
||||
// Arrange
|
||||
logger.log('warn', 'A', 'C');
|
||||
logger.log('info', 'B', 'CTX2');
|
||||
logger.log('warn', 'C', 'C');
|
||||
logger.log('error', 'D', 'CTX4');
|
||||
|
||||
// Act
|
||||
const filtered = logger.any().withContext('C');
|
||||
|
||||
// Assert
|
||||
filtered.toBeLoggedTimes(2); // Должно остаться только 2 записи с context === 'C'
|
||||
});
|
||||
|
||||
it('withDetails({k:v}) оставляет записи, где все пары совпали (логическое И)', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'A', 'CTX', { a: 1, b: 'x' });
|
||||
logger.log('info', 'B', 'CTX', { a: 1 });
|
||||
logger.log('info', 'C', 'CTX', { b: 'x' });
|
||||
logger.log('info', 'D', 'CTX', { a: 1, b: 'x', c: true });
|
||||
|
||||
// Act
|
||||
const filtered = logger.any().withDetails({ a: 1, b: 'x' });
|
||||
|
||||
// Assert
|
||||
filtered.toBeLoggedTimes(2); // Должны остаться только записи, где одновременно a=1 и b='x'
|
||||
});
|
||||
|
||||
it('комбинация фильтров даёт пересечение условий', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'X', 'C', { a: 1 }); // подходит
|
||||
logger.log('info', 'X', 'C', { a: 2 }); // не подходит
|
||||
logger.log('info', 'Y', 'C', { a: 1 }); // не подходит
|
||||
logger.log('warn', 'X', 'C', { a: 1 }); // не подходит
|
||||
|
||||
// Act
|
||||
const filtered = logger
|
||||
.any()
|
||||
.withMessage('X')
|
||||
.withLevel('info')
|
||||
.withContext('C')
|
||||
.withDetails({ a: 1 });
|
||||
|
||||
// Assert
|
||||
filtered.toBeLoggedTimes(1); // Только одна запись удовлетворяет всем условиям
|
||||
});
|
||||
|
||||
it('порядок применения with* не влияет на результат (коммутативность)', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'X', 'C', { a: 1 }); // подходит
|
||||
logger.log('info', 'X', 'C', { a: 2 }); // не подходит
|
||||
logger.log('info', 'Y', 'C', { a: 1 }); // не подходит
|
||||
logger.log('warn', 'X', 'C', { a: 1 }); // не подходит
|
||||
|
||||
// Act
|
||||
const filtered1 = logger
|
||||
.any()
|
||||
.withMessage('X')
|
||||
.withLevel('info')
|
||||
.withContext('C')
|
||||
.withDetails({ a: 1 });
|
||||
const filtered2 = logger
|
||||
.any()
|
||||
.withDetails({ a: 1 })
|
||||
.withContext('C')
|
||||
.withLevel('info')
|
||||
.withMessage('X');
|
||||
|
||||
// Assert
|
||||
filtered1.toBeLoggedTimes(1);
|
||||
filtered2.toBeLoggedTimes(1);
|
||||
});
|
||||
|
||||
it('фильтры не мутируют исходный матчёр (иммутабельность)', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'X', 'CTX');
|
||||
logger.log('info', 'Y', 'CTX');
|
||||
|
||||
// Act
|
||||
const m0 = logger.any();
|
||||
const m1 = m0.withMessage('X');
|
||||
|
||||
// Assert
|
||||
m0.toBeLoggedTimes(2); // исходный набор
|
||||
m1.toBeLoggedTimes(1); // отфильтрованный
|
||||
m0.toBeLoggedTimes(2); // повторно исходный набор
|
||||
});
|
||||
|
||||
it('фильтр на пустом наборе остаётся пустым', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'A', 'CTX');
|
||||
|
||||
// Act & Assert
|
||||
logger
|
||||
.any()
|
||||
.withMessage('non-existent')
|
||||
.withLevel('warn')
|
||||
.withContext('none')
|
||||
.toBeLoggedTimes(0);
|
||||
});
|
||||
|
||||
it('через withDetails можно проверять и другие поля', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'A', 'CTX');
|
||||
|
||||
// Act & Assert
|
||||
logger
|
||||
.any()
|
||||
.withMessage('A')
|
||||
.withDetails({ level: 'info', context: 'CTX' })
|
||||
.toBeLoggedOnce();
|
||||
});
|
||||
});
|
||||
|
||||
describe('Паритет фильтров в обоих классах', () => {
|
||||
it('старт с TestingLogger.withX(...).withY(...).withZ(...) == any().withX(...).withY(...).withZ(...)', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'X', 'C', { a: 1 }); // подходит
|
||||
logger.log('info', 'X', 'C', { a: 2 }); // не подходит
|
||||
logger.log('info', 'Y', 'C', { a: 1 }); // не подходит
|
||||
logger.log('warn', 'X', 'C', { a: 1 }); // не подходит
|
||||
|
||||
// Act
|
||||
const fromStart = logger
|
||||
.withMessage('X')
|
||||
.withLevel('info')
|
||||
.withContext('C')
|
||||
.withDetails({ a: 1 });
|
||||
const fromAny = logger
|
||||
.any()
|
||||
.withMessage('X')
|
||||
.withLevel('info')
|
||||
.withContext('C')
|
||||
.withDetails({ a: 1 });
|
||||
|
||||
// Assert
|
||||
fromStart.toBeLoggedTimes(1);
|
||||
fromAny.toBeLoggedTimes(1);
|
||||
// Проверяем, что состав совпадает
|
||||
expect(JSON.stringify(fromStart.logs)).toBe(JSON.stringify(fromAny.logs));
|
||||
});
|
||||
});
|
||||
|
||||
describe('Матчеры наличия/отсутствия', () => {
|
||||
it('toBeLogged() проходит при >= 1 записи', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'A', 'CTX');
|
||||
|
||||
// Act & Assert
|
||||
expect(() => logger.any().toBeLogged()).not.toThrow();
|
||||
});
|
||||
|
||||
it('toBeLogged() падает на пустом наборе', () => {
|
||||
// Arrange: ничего не добавляем
|
||||
|
||||
// Act & Assert
|
||||
expect(() => logger.any().toBeLogged()).toThrowError('No logs recorded');
|
||||
});
|
||||
|
||||
it('toBeNotLogged() проходит при 0 записях', () => {
|
||||
// Arrange: ничего не добавляем
|
||||
|
||||
// Act & Assert
|
||||
expect(() => logger.any().toBeNotLogged()).not.toThrow();
|
||||
});
|
||||
|
||||
it('toBeNotLogged() падает при >= 1 записи', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'A', 'CTX');
|
||||
logger.log('warn', 'B', 'CTX');
|
||||
|
||||
// Act & Assert
|
||||
expect(() => logger.any().toBeNotLogged()).toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('Матчеры количества', () => {
|
||||
it('toBeLoggedOnce() проходит при ровно 1 записи', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'A', 'CTX');
|
||||
|
||||
// Act & Assert
|
||||
expect(() => logger.any().toBeLoggedOnce()).not.toThrow();
|
||||
});
|
||||
|
||||
it('toBeLoggedOnce() падает при 0', () => {
|
||||
// Сценарий A: 0 записей
|
||||
expect(() => logger.any().toBeLoggedOnce()).toThrow();
|
||||
});
|
||||
|
||||
it('toBeLoggedOnce() падает при >1, сообщение содержит count и JSON', () => {
|
||||
// Сценарий B: >1 записей
|
||||
logger.log('info', 'A', 'CTX');
|
||||
logger.log('info', 'B', 'CTX');
|
||||
|
||||
expect(() => logger.any().toBeLoggedOnce()).toThrow();
|
||||
});
|
||||
|
||||
it('toBeLoggedTimes(n) проходит при точном совпадении количества', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'A', 'CTX');
|
||||
logger.log('info', 'B', 'CTX');
|
||||
|
||||
// Act & Assert
|
||||
expect(() => logger.any().toBeLoggedTimes(2)).not.toThrow();
|
||||
});
|
||||
|
||||
it('toBeLoggedTimes(n) падает при несовпадении (сообщение: ожидаемое и фактическое)', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'A', 'CTX');
|
||||
|
||||
// Act & Assert
|
||||
expect(() => logger.any().toBeLoggedTimes(2)).toThrow();
|
||||
});
|
||||
|
||||
it('toBeLoggedTimes(0) проходит на пустом наборе', () => {
|
||||
// Arrange: ничего не добавляем
|
||||
|
||||
// Act & Assert
|
||||
expect(() => logger.any().toBeLoggedTimes(0)).not.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('Детали и типы значений (withDetails / details)', () => {
|
||||
it('совпадение по string/number/boolean', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'A', 'CTX', { a: 'x' });
|
||||
logger.log('info', 'B', 'CTX', { b: 1 });
|
||||
logger.log('info', 'C', 'CTX', { c: true });
|
||||
|
||||
// Act & Assert
|
||||
logger.any().withDetails({ a: 'x' }).toBeLoggedOnce();
|
||||
logger.any().withDetails({ b: 1 }).toBeLoggedOnce();
|
||||
logger.any().withDetails({ c: true }).toBeLoggedOnce();
|
||||
});
|
||||
|
||||
it('несуществующий ключ в фильтре исключает запись', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'A', 'CTX', { a: 1 });
|
||||
|
||||
// Act & Assert
|
||||
logger.any().withDetails({ d: 42 }).toBeLoggedTimes(0);
|
||||
});
|
||||
|
||||
it('частичное несоответствие по одному из ключей исключает запись', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'A', 'CTX', { a: 1, b: 2 });
|
||||
|
||||
// Act & Assert
|
||||
logger.any().withDetails({ a: 1, b: 999 }).toBeLoggedTimes(0);
|
||||
});
|
||||
|
||||
it('различие по типу (число vs строка) не считается совпадением', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'A', 'CTX', { a: 1 });
|
||||
|
||||
// Act & Assert
|
||||
logger
|
||||
.any()
|
||||
.withDetails({ a: '1' as unknown as number })
|
||||
.toBeLoggedTimes(0);
|
||||
});
|
||||
|
||||
it('дополнительные поля в записи не мешают совпадению (подмножество)', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'A', 'CTX', { a: 1, b: 2, c: 3 });
|
||||
|
||||
// Act & Assert
|
||||
logger.any().withDetails({ a: 1 }).toBeLoggedOnce();
|
||||
});
|
||||
|
||||
it('strictDetails требует точного совпадения ключей деталей (не допускает лишних полей)', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'X', 'CTX', { a: 1, b: 2 });
|
||||
|
||||
// Act & Assert
|
||||
// Обычный withDetails допускает совпадение по подмножеству
|
||||
logger.any().withDetails({ a: 1 }).toBeLoggedOnce();
|
||||
|
||||
// strictDetails требует точного совпадения — запись с лишним полем не должна подходить
|
||||
logger.any().withDetails({ a: 1 }).strictDetails().toBeLoggedTimes(0);
|
||||
});
|
||||
|
||||
it('strictDetails проходит при полном совпадении деталей', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'Y', 'CTX', { a: 1 });
|
||||
|
||||
// Act & Assert
|
||||
logger.any().withDetails({ a: 1 }).strictDetails().toBeLoggedOnce();
|
||||
});
|
||||
});
|
||||
|
||||
describe('Граничные случаи', () => {
|
||||
it('дубликаты идентичных логов учитываются поштучно в подсчёте', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'A', 'CTX', { a: 1 });
|
||||
logger.log('info', 'A', 'CTX', { a: 1 });
|
||||
logger.log('info', 'A', 'CTX', { a: 1 });
|
||||
|
||||
// Act & Assert
|
||||
logger.any().withDetails({ a: 1 }).toBeLoggedTimes(3);
|
||||
});
|
||||
|
||||
it('одинаковые level/message/context, но разные details различаются withDetails', () => {
|
||||
// Arrange
|
||||
logger.log('info', 'A', 'CTX', { a: 1 });
|
||||
logger.log('info', 'A', 'CTX', { a: 2 });
|
||||
|
||||
// Act & Assert
|
||||
logger.any().withDetails({ a: 1 }).toBeLoggedOnce();
|
||||
logger.any().withDetails({ a: 2 }).toBeLoggedOnce();
|
||||
});
|
||||
|
||||
it('пустые строки корректно фильтруются: withMessage("") / withContext("")', () => {
|
||||
// Arrange
|
||||
logger.log('info', '', 'CTX', { a: 1 });
|
||||
logger.log('info', 'A', '', { a: 2 });
|
||||
logger.log('info', '', '', { a: 3 });
|
||||
|
||||
// Act & Assert
|
||||
logger.withMessage('').toBeLoggedTimes(2); // две записи с пустым message
|
||||
logger.withContext('').toBeLoggedTimes(2); // две записи с пустым context
|
||||
});
|
||||
|
||||
it('smoke: большое количество записей не ломает фильтры', () => {
|
||||
// Arrange
|
||||
const N = 1000;
|
||||
|
||||
for (let i = 0; i < N; i++) {
|
||||
logger.log('info', `msg${i % 10}`, `CTX${i % 5}`, { a: i % 3, b: i });
|
||||
}
|
||||
|
||||
// Act & Assert
|
||||
logger.withMessage('msg1').toBeLoggedTimes(100);
|
||||
logger.withContext('CTX2').toBeLoggedTimes(200);
|
||||
logger
|
||||
.any()
|
||||
.withDetails({ a: 0 })
|
||||
.toBeLoggedTimes(Math.floor(N / 3) + (N % 3 > 0 ? 1 : 0));
|
||||
logger.any().withDetails({ b: 42 }).toBeLoggedOnce();
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,65 @@
|
||||
import * as colorette from 'colorette';
|
||||
|
||||
import { LogLevel } from '../logger.class';
|
||||
|
||||
export interface LogEntry {
|
||||
level: LogLevel;
|
||||
message: string;
|
||||
context: string;
|
||||
[extra: string]: unknown;
|
||||
}
|
||||
|
||||
export function fail(message: string): void {
|
||||
throw new Error(message);
|
||||
}
|
||||
|
||||
type ErrorConstructorWithCapture = ErrorConstructor & {
|
||||
captureStackTrace?: (targetObject: object, constructorOpt?: unknown) => void;
|
||||
};
|
||||
|
||||
/**
|
||||
* Декоратор для методов матчеров:
|
||||
* Если метод бросил ошибку — стек "подрезается" так,
|
||||
* чтобы указать на строку вызова матчера в тесте (а не внутрь реализации).
|
||||
*/
|
||||
export function PrettifyStackTrace(): MethodDecorator {
|
||||
return (_target, _key, descriptor: PropertyDescriptor) => {
|
||||
const original = descriptor.value as (...args: unknown[]) => unknown;
|
||||
|
||||
function wrap(this: unknown, ...args: unknown[]) {
|
||||
try {
|
||||
return original.apply(this, args);
|
||||
} catch (err) {
|
||||
(Error as ErrorConstructorWithCapture).captureStackTrace?.(err as object, wrap);
|
||||
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
|
||||
descriptor.value = wrap;
|
||||
|
||||
return descriptor;
|
||||
};
|
||||
}
|
||||
|
||||
export function showLogObject({ level, context, message, ...details }: LogEntry) {
|
||||
const l = colorette.blue(level);
|
||||
const c = colorette.bold(colorette.magenta(context));
|
||||
const m = colorette.underline(colorette.white(message));
|
||||
|
||||
process.stdout.write(` ${l} ${c} ${m}\n`);
|
||||
|
||||
showLogDetails(details);
|
||||
}
|
||||
|
||||
export function showLogDetails(details: Record<string, unknown>) {
|
||||
Object.keys(details).forEach((key) => {
|
||||
if (details[key] === undefined) {
|
||||
return;
|
||||
}
|
||||
|
||||
process.stdout.write(
|
||||
` ${colorette.blue(key)}: ${colorette.yellow(String(details[key]))}\n`,
|
||||
);
|
||||
});
|
||||
}
|
||||
+18
-2
@@ -2,11 +2,24 @@ import { NestFactory } from '@nestjs/core';
|
||||
import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
|
||||
|
||||
import { AppModule } from './app/app.module';
|
||||
import { getBaseLogger, LocalLoggerModule, Logger } from './logger';
|
||||
|
||||
async function start() {
|
||||
const PORT = process.env.PORT || 5000;
|
||||
|
||||
const app = await NestFactory.create(AppModule);
|
||||
const app = await NestFactory.create(AppModule, {
|
||||
bufferLogs: true,
|
||||
});
|
||||
|
||||
// Подменяем логгер Nest на pino; накопленный в буфере вывод сбрасывается в него же
|
||||
LocalLoggerModule.setup(app);
|
||||
|
||||
const logger = new Logger('Bootstrap');
|
||||
|
||||
logger.log('Logging started', {
|
||||
level: getBaseLogger().level,
|
||||
pretty: process.env.NODE_ENV !== 'production' && process.env.LOG_PRETTY !== 'false',
|
||||
});
|
||||
|
||||
// настройка swaggera
|
||||
const config = new DocumentBuilder()
|
||||
@@ -41,6 +54,9 @@ async function start() {
|
||||
allowedHeaders: 'Content-Type, Authorization',
|
||||
credentials: true,
|
||||
});
|
||||
await app.listen(PORT, () => console.log(`Server started on ${PORT}`));
|
||||
|
||||
await app.listen(PORT);
|
||||
|
||||
logger.log('Server started', { port: PORT });
|
||||
}
|
||||
start();
|
||||
@@ -0,0 +1,3 @@
|
||||
// Файл сгенерирован автоматически (tools/buildDataSource.ts). Не редактировать вручную.
|
||||
|
||||
export const migrations = [];
|
||||
@@ -19,6 +19,7 @@
|
||||
"eslint.config.js",
|
||||
"eslint.config.cjs",
|
||||
"eslint.config.mjs",
|
||||
"src/**/*.spec.ts"
|
||||
"src/**/*.spec.ts",
|
||||
"src/**/*.test.ts"
|
||||
]
|
||||
}
|
||||
@@ -18,14 +18,14 @@ export default defineConfig({
|
||||
],
|
||||
resolve: {
|
||||
alias: {
|
||||
'@geo-platform/api': resolve(import.meta.dirname, 'src'),
|
||||
'@jt4d-platform/api': resolve(import.meta.dirname, 'src'),
|
||||
},
|
||||
},
|
||||
test: {
|
||||
name: '@geo-platform/api',
|
||||
name: '@jt4d-platform/api',
|
||||
globals: true,
|
||||
environment: 'node',
|
||||
include: ['src/**/*.spec.ts'],
|
||||
include: ['src/**/*.{test,spec}.ts'],
|
||||
setupFiles: ['src/test-setup.ts'],
|
||||
coverage: {
|
||||
reportsDirectory: './test-output/vitest/coverage',
|
||||
|
||||
@@ -25,7 +25,7 @@ function createApiWebpackConfig({ output, nxPlugin, plugins = [] }) {
|
||||
},
|
||||
resolve: {
|
||||
alias: {
|
||||
'@geo-platform/api': join(__dirname, 'src'),
|
||||
'@jt4d-platform/api': join(__dirname, 'src'),
|
||||
},
|
||||
extensions: ['.ts', '.tsx', '.js', '.jsx', '.json'],
|
||||
},
|
||||
@@ -42,7 +42,7 @@ function createApiWebpackConfig({ output, nxPlugin, plugins = [] }) {
|
||||
// Обязательно в паре с externalDependencies: 'none'. Без плагина webpack
|
||||
// вкомпилирует второй экземпляр typeorm, и он перестанет быть тем же
|
||||
// модулем, что грузит CLI.
|
||||
new DenyExternalsPlugin(['@geo-platform/']),
|
||||
new DenyExternalsPlugin(['@jt4d-platform/']),
|
||||
...plugins,
|
||||
],
|
||||
};
|
||||
|
||||
+2
-3
@@ -1,11 +1,10 @@
|
||||
:80 {
|
||||
respond /health 200 {
|
||||
body "OK"
|
||||
respond /health "OK" {
|
||||
close
|
||||
}
|
||||
}
|
||||
|
||||
app.igeo.pro {
|
||||
jt4d.ru, http://*.jt4d.jt4d.ru.net {
|
||||
root * /app
|
||||
encode gzip
|
||||
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
:80 {
|
||||
root * /app
|
||||
encode gzip
|
||||
|
||||
handle /api/* {
|
||||
reverse_proxy api:5000
|
||||
}
|
||||
|
||||
handle {
|
||||
try_files {path} /index.html
|
||||
file_server
|
||||
|
||||
@static path *.js *.css *.woff *.woff2 *.svg *.png *.jpg *.jpeg *.gif *.ico
|
||||
header @static Cache-Control "public, max-age=31536000, immutable"
|
||||
}
|
||||
}
|
||||
+3
-1
@@ -1,10 +1,12 @@
|
||||
FROM git.jt4d.ru/jt4d/caddy:2-alpine
|
||||
|
||||
ARG CADDYFILE=Caddyfile
|
||||
|
||||
COPY ./dist /app
|
||||
|
||||
EXPOSE 80 443
|
||||
|
||||
COPY Caddyfile /etc/caddy/Caddyfile
|
||||
COPY ${CADDYFILE} /etc/caddy/Caddyfile
|
||||
|
||||
HEALTHCHECK --interval=10s --timeout=3s --retries=3 \
|
||||
CMD curl -f http://localhost:80/health || exit 1
|
||||
@@ -1,4 +1,20 @@
|
||||
import nx from '@nx/eslint-plugin';
|
||||
import weld from 'eslint-plugin-weld';
|
||||
import { defineConfig } from 'eslint/config';
|
||||
|
||||
import baseConfig from '../../eslint.config.mjs';
|
||||
|
||||
export default [...nx.configs['flat/react'], ...baseConfig];
|
||||
export default defineConfig([
|
||||
...nx.configs['flat/react'],
|
||||
...baseConfig,
|
||||
{
|
||||
name: 'weld',
|
||||
extends: [weld.configs.recommended],
|
||||
settings: {
|
||||
weld: {
|
||||
layers: ['app', 'pages', '@modules', 'common'],
|
||||
moduleLayers: ['widgets', 'entities'],
|
||||
},
|
||||
},
|
||||
},
|
||||
]);
|
||||
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"name": "@geo-platform/web",
|
||||
"name": "@jt4d-platform/web",
|
||||
"version": "0.0.1",
|
||||
"private": true,
|
||||
"dependencies": {
|
||||
|
||||
@@ -19,6 +19,6 @@ describe('App', () => {
|
||||
<App />
|
||||
</BrowserRouter>,
|
||||
);
|
||||
expect(getAllByText(new RegExp('Welcome @geo-platform/web', 'gi')).length > 0).toBeTruthy();
|
||||
expect(getAllByText(/Hello @jt4d-platform\/web/i).length > 0).toBeTruthy();
|
||||
});
|
||||
});
|
||||
+15
-22
@@ -1,19 +1,13 @@
|
||||
import NxWelcome from './nx-welcome';
|
||||
import { Link, Route, Routes } from 'react-router-dom';
|
||||
|
||||
import { Route, Routes, Link } from 'react-router-dom';
|
||||
import { HealthPage } from '../pages/HealthPage';
|
||||
|
||||
export function App() {
|
||||
return (
|
||||
<div>
|
||||
<NxWelcome title="@geo-platform/web" />
|
||||
<h1 className="text-2xl font-bold">Hello @jt4d-platform/web</h1>
|
||||
|
||||
{/* START: routes */}
|
||||
{/* These routes and navigation have been generated for you */}
|
||||
{/* Feel free to move and update them to fit your needs */}
|
||||
<br />
|
||||
<hr />
|
||||
<br />
|
||||
<div role="navigation">
|
||||
<nav role="navigation">
|
||||
<ul>
|
||||
<li>
|
||||
<Link to="/">Home</Link>
|
||||
@@ -21,27 +15,26 @@ export function App() {
|
||||
<li>
|
||||
<Link to="/page-2">Page 2</Link>
|
||||
</li>
|
||||
<li>
|
||||
<Link to="/health">Health</Link>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<Routes>
|
||||
<Route
|
||||
path="/"
|
||||
element={
|
||||
<div>
|
||||
This is the generated root route. <Link to="/page-2">Click here for page 2.</Link>
|
||||
</div>
|
||||
}
|
||||
element={<div>This is the generated root route.</div>}
|
||||
/>
|
||||
<Route
|
||||
path="/health"
|
||||
element={<HealthPage />}
|
||||
/>
|
||||
<Route
|
||||
path="/page-2"
|
||||
element={
|
||||
<div>
|
||||
<Link to="/">Click here to go back to root page.</Link>
|
||||
</div>
|
||||
}
|
||||
element={<div>Page 2</div>}
|
||||
/>
|
||||
</Routes>
|
||||
{/* END: routes */}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
@@ -1,836 +0,0 @@
|
||||
/*
|
||||
* * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
||||
This is a starter component and can be deleted.
|
||||
* * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
||||
Delete this file and get started with your project!
|
||||
* * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
||||
*/
|
||||
export function NxWelcome({ title }: { title: string }) {
|
||||
return (
|
||||
<>
|
||||
<style
|
||||
dangerouslySetInnerHTML={{
|
||||
__html: `
|
||||
html {
|
||||
-webkit-text-size-adjust: 100%;
|
||||
font-family: ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont,
|
||||
'Segoe UI', Roboto, 'Helvetica Neue', Arial, 'Noto Sans', sans-serif,
|
||||
'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol',
|
||||
'Noto Color Emoji';
|
||||
line-height: 1.5;
|
||||
tab-size: 4;
|
||||
scroll-behavior: smooth;
|
||||
}
|
||||
body {
|
||||
font-family: inherit;
|
||||
line-height: inherit;
|
||||
margin: 0;
|
||||
}
|
||||
h1,
|
||||
h2,
|
||||
p,
|
||||
pre {
|
||||
margin: 0;
|
||||
}
|
||||
*,
|
||||
::before,
|
||||
::after {
|
||||
box-sizing: border-box;
|
||||
border-width: 0;
|
||||
border-style: solid;
|
||||
border-color: currentColor;
|
||||
}
|
||||
h1,
|
||||
h2 {
|
||||
font-size: inherit;
|
||||
font-weight: inherit;
|
||||
}
|
||||
a {
|
||||
color: inherit;
|
||||
text-decoration: inherit;
|
||||
}
|
||||
pre {
|
||||
font-family: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas,
|
||||
'Liberation Mono', 'Courier New', monospace;
|
||||
}
|
||||
svg {
|
||||
display: block;
|
||||
vertical-align: middle;
|
||||
shape-rendering: auto;
|
||||
text-rendering: optimizeLegibility;
|
||||
}
|
||||
pre {
|
||||
background-color: rgba(55, 65, 81, 1);
|
||||
border-radius: 0.25rem;
|
||||
color: rgba(229, 231, 235, 1);
|
||||
font-family: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas,
|
||||
'Liberation Mono', 'Courier New', monospace;
|
||||
overflow: auto;
|
||||
padding: 0.5rem 0.75rem;
|
||||
}
|
||||
|
||||
.shadow {
|
||||
box-shadow: 0 0 #0000, 0 0 #0000, 0 10px 15px -3px rgba(0, 0, 0, 0.1),
|
||||
0 4px 6px -2px rgba(0, 0, 0, 0.05);
|
||||
}
|
||||
.rounded {
|
||||
border-radius: 1.5rem;
|
||||
}
|
||||
.wrapper {
|
||||
width: 100%;
|
||||
}
|
||||
.container {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
max-width: 768px;
|
||||
padding-bottom: 3rem;
|
||||
padding-left: 1rem;
|
||||
padding-right: 1rem;
|
||||
color: rgba(55, 65, 81, 1);
|
||||
width: 100%;
|
||||
}
|
||||
#welcome {
|
||||
margin-top: 2.5rem;
|
||||
}
|
||||
#welcome h1 {
|
||||
font-size: 3rem;
|
||||
font-weight: 500;
|
||||
letter-spacing: -0.025em;
|
||||
line-height: 1;
|
||||
}
|
||||
#welcome span {
|
||||
display: block;
|
||||
font-size: 1.875rem;
|
||||
font-weight: 300;
|
||||
line-height: 2.25rem;
|
||||
margin-bottom: 0.5rem;
|
||||
}
|
||||
#hero {
|
||||
align-items: center;
|
||||
background-color: hsla(214, 62%, 21%, 1);
|
||||
border: none;
|
||||
box-sizing: border-box;
|
||||
color: rgba(55, 65, 81, 1);
|
||||
display: grid;
|
||||
grid-template-columns: 1fr;
|
||||
margin-top: 3.5rem;
|
||||
}
|
||||
#hero .text-container {
|
||||
color: rgba(255, 255, 255, 1);
|
||||
padding: 3rem 2rem;
|
||||
}
|
||||
#hero .text-container h2 {
|
||||
font-size: 1.5rem;
|
||||
line-height: 2rem;
|
||||
position: relative;
|
||||
}
|
||||
#hero .text-container h2 svg {
|
||||
color: hsla(162, 47%, 50%, 1);
|
||||
height: 2rem;
|
||||
left: -0.25rem;
|
||||
position: absolute;
|
||||
top: 0;
|
||||
width: 2rem;
|
||||
}
|
||||
#hero .text-container h2 span {
|
||||
margin-left: 2.5rem;
|
||||
}
|
||||
#hero .text-container a {
|
||||
background-color: rgba(255, 255, 255, 1);
|
||||
border-radius: 0.75rem;
|
||||
color: rgba(55, 65, 81, 1);
|
||||
display: inline-block;
|
||||
margin-top: 1.5rem;
|
||||
padding: 1rem 2rem;
|
||||
text-decoration: inherit;
|
||||
}
|
||||
#hero .logo-container {
|
||||
display: none;
|
||||
justify-content: center;
|
||||
padding-left: 2rem;
|
||||
padding-right: 2rem;
|
||||
}
|
||||
#hero .logo-container svg {
|
||||
color: rgba(255, 255, 255, 1);
|
||||
width: 66.666667%;
|
||||
}
|
||||
#middle-content {
|
||||
align-items: flex-start;
|
||||
display: grid;
|
||||
grid-template-columns: 1fr;
|
||||
margin-top: 3.5rem;
|
||||
}
|
||||
|
||||
#middle-content #middle-content-container {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 2rem;
|
||||
}
|
||||
#learning-materials {
|
||||
padding: 2.5rem 2rem;
|
||||
}
|
||||
#learning-materials h2 {
|
||||
font-weight: 500;
|
||||
font-size: 1.25rem;
|
||||
letter-spacing: -0.025em;
|
||||
line-height: 1.75rem;
|
||||
padding-left: 1rem;
|
||||
padding-right: 1rem;
|
||||
}
|
||||
.list-item-link {
|
||||
align-items: center;
|
||||
border-radius: 0.75rem;
|
||||
display: flex;
|
||||
margin-top: 1rem;
|
||||
padding: 1rem;
|
||||
transition-property: background-color, border-color, color, fill, stroke,
|
||||
opacity, box-shadow, transform, filter, backdrop-filter,
|
||||
-webkit-backdrop-filter;
|
||||
transition-timing-function: cubic-bezier(0.4, 0, 0.2, 1);
|
||||
transition-duration: 150ms;
|
||||
width: 100%;
|
||||
}
|
||||
.list-item-link svg:first-child {
|
||||
margin-right: 1rem;
|
||||
height: 1.5rem;
|
||||
transition-property: background-color, border-color, color, fill, stroke,
|
||||
opacity, box-shadow, transform, filter, backdrop-filter,
|
||||
-webkit-backdrop-filter;
|
||||
transition-timing-function: cubic-bezier(0.4, 0, 0.2, 1);
|
||||
transition-duration: 150ms;
|
||||
width: 1.5rem;
|
||||
}
|
||||
.list-item-link > span {
|
||||
flex-grow: 1;
|
||||
font-weight: 400;
|
||||
transition-property: background-color, border-color, color, fill, stroke,
|
||||
opacity, box-shadow, transform, filter, backdrop-filter,
|
||||
-webkit-backdrop-filter;
|
||||
transition-timing-function: cubic-bezier(0.4, 0, 0.2, 1);
|
||||
}
|
||||
.list-item-link > span > span {
|
||||
color: rgba(107, 114, 128, 1);
|
||||
display: block;
|
||||
flex-grow: 1;
|
||||
font-size: 0.75rem;
|
||||
font-weight: 300;
|
||||
line-height: 1rem;
|
||||
transition-property: background-color, border-color, color, fill, stroke,
|
||||
opacity, box-shadow, transform, filter, backdrop-filter,
|
||||
-webkit-backdrop-filter;
|
||||
transition-timing-function: cubic-bezier(0.4, 0, 0.2, 1);
|
||||
}
|
||||
.list-item-link svg:last-child {
|
||||
height: 1rem;
|
||||
transition-property: all;
|
||||
transition-timing-function: cubic-bezier(0.4, 0, 0.2, 1);
|
||||
transition-duration: 150ms;
|
||||
width: 1rem;
|
||||
}
|
||||
.list-item-link:hover {
|
||||
color: rgba(255, 255, 255, 1);
|
||||
background-color: hsla(162, 55%, 33%, 1);
|
||||
}
|
||||
.list-item-link:hover > span {}
|
||||
.list-item-link:hover > span > span {
|
||||
color: rgba(243, 244, 246, 1);
|
||||
}
|
||||
.list-item-link:hover svg:last-child {
|
||||
transform: translateX(0.25rem);
|
||||
}
|
||||
#other-links {}
|
||||
.button-pill {
|
||||
padding: 1.5rem 2rem;
|
||||
margin-bottom: 2rem;
|
||||
transition-duration: 300ms;
|
||||
transition-property: background-color, border-color, color, fill, stroke,
|
||||
opacity, box-shadow, transform, filter, backdrop-filter,
|
||||
-webkit-backdrop-filter;
|
||||
transition-timing-function: cubic-bezier(0.4, 0, 0.2, 1);
|
||||
align-items: center;
|
||||
display: flex;
|
||||
}
|
||||
.button-pill svg {
|
||||
transition-property: background-color, border-color, color, fill, stroke,
|
||||
opacity, box-shadow, transform, filter, backdrop-filter,
|
||||
-webkit-backdrop-filter;
|
||||
transition-timing-function: cubic-bezier(0.4, 0, 0.2, 1);
|
||||
transition-duration: 150ms;
|
||||
flex-shrink: 0;
|
||||
width: 3rem;
|
||||
}
|
||||
.button-pill > span {
|
||||
letter-spacing: -0.025em;
|
||||
font-weight: 400;
|
||||
font-size: 1.125rem;
|
||||
line-height: 1.75rem;
|
||||
padding-left: 1rem;
|
||||
padding-right: 1rem;
|
||||
}
|
||||
.button-pill span span {
|
||||
display: block;
|
||||
font-size: 0.875rem;
|
||||
font-weight: 300;
|
||||
line-height: 1.25rem;
|
||||
}
|
||||
.button-pill:hover svg,
|
||||
.button-pill:hover {
|
||||
color: rgba(255, 255, 255, 1) !important;
|
||||
}
|
||||
#nx-console:hover {
|
||||
background-color: rgba(0, 122, 204, 1);
|
||||
}
|
||||
#nx-console svg {
|
||||
color: rgba(0, 122, 204, 1);
|
||||
}
|
||||
#nx-console-jetbrains {
|
||||
margin-top: 2rem;
|
||||
}
|
||||
#nx-console-jetbrains:hover {
|
||||
background-color: rgba(255, 49, 140, 1);
|
||||
}
|
||||
#nx-console-jetbrains svg {
|
||||
color: rgba(255, 49, 140, 1);
|
||||
}
|
||||
#nx-repo:hover {
|
||||
background-color: rgba(24, 23, 23, 1);
|
||||
}
|
||||
#nx-repo svg {
|
||||
color: rgba(24, 23, 23, 1);
|
||||
}
|
||||
#nx-cloud {
|
||||
margin-bottom: 2rem;
|
||||
margin-top: 2rem;
|
||||
padding: 2.5rem 2rem;
|
||||
}
|
||||
#nx-cloud > div {
|
||||
align-items: center;
|
||||
display: flex;
|
||||
}
|
||||
#nx-cloud > div svg {
|
||||
border-radius: 0.375rem;
|
||||
flex-shrink: 0;
|
||||
width: 3rem;
|
||||
}
|
||||
#nx-cloud > div h2 {
|
||||
font-size: 1.125rem;
|
||||
font-weight: 400;
|
||||
letter-spacing: -0.025em;
|
||||
line-height: 1.75rem;
|
||||
padding-left: 1rem;
|
||||
padding-right: 1rem;
|
||||
}
|
||||
#nx-cloud > div h2 span {
|
||||
display: block;
|
||||
font-size: 0.875rem;
|
||||
font-weight: 300;
|
||||
line-height: 1.25rem;
|
||||
}
|
||||
#nx-cloud p {
|
||||
font-size: 1rem;
|
||||
line-height: 1.5rem;
|
||||
margin-top: 1rem;
|
||||
}
|
||||
#nx-cloud pre {
|
||||
margin-top: 1rem;
|
||||
}
|
||||
#nx-cloud a {
|
||||
color: rgba(107, 114, 128, 1);
|
||||
display: block;
|
||||
font-size: 0.875rem;
|
||||
line-height: 1.25rem;
|
||||
margin-top: 1.5rem;
|
||||
text-align: right;
|
||||
}
|
||||
#nx-cloud a:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
#commands {
|
||||
padding: 2.5rem 2rem;
|
||||
margin-top: 3.5rem;
|
||||
}
|
||||
#commands h2 {
|
||||
font-size: 1.25rem;
|
||||
font-weight: 400;
|
||||
letter-spacing: -0.025em;
|
||||
line-height: 1.75rem;
|
||||
padding-left: 1rem;
|
||||
padding-right: 1rem;
|
||||
}
|
||||
#commands p {
|
||||
font-size: 1rem;
|
||||
font-weight: 300;
|
||||
line-height: 1.5rem;
|
||||
margin-top: 1rem;
|
||||
padding-left: 1rem;
|
||||
padding-right: 1rem;
|
||||
}
|
||||
details {
|
||||
align-items: center;
|
||||
display: flex;
|
||||
margin-top: 1rem;
|
||||
padding-left: 1rem;
|
||||
padding-right: 1rem;
|
||||
width: 100%;
|
||||
}
|
||||
details pre > span {
|
||||
color: rgba(181, 181, 181, 1);
|
||||
display: block;
|
||||
}
|
||||
summary {
|
||||
border-radius: 0.5rem;
|
||||
display: flex;
|
||||
font-weight: 400;
|
||||
padding: 0.5rem;
|
||||
cursor: pointer;
|
||||
transition-property: background-color, border-color, color, fill, stroke,
|
||||
opacity, box-shadow, transform, filter, backdrop-filter,
|
||||
-webkit-backdrop-filter;
|
||||
transition-timing-function: cubic-bezier(0.4, 0, 0.2, 1);
|
||||
transition-duration: 150ms;
|
||||
}
|
||||
summary:hover {
|
||||
background-color: rgba(243, 244, 246, 1);
|
||||
}
|
||||
summary svg {
|
||||
height: 1.5rem;
|
||||
margin-right: 1rem;
|
||||
width: 1.5rem;
|
||||
}
|
||||
#love {
|
||||
color: rgba(107, 114, 128, 1);
|
||||
font-size: 0.875rem;
|
||||
line-height: 1.25rem;
|
||||
margin-top: 3.5rem;
|
||||
opacity: 0.6;
|
||||
text-align: center;
|
||||
}
|
||||
#love svg {
|
||||
color: rgba(252, 165, 165, 1);
|
||||
width: 1.25rem;
|
||||
height: 1.25rem;
|
||||
display: inline;
|
||||
margin-top: -0.25rem;
|
||||
}
|
||||
@media screen and (min-width: 768px) {
|
||||
#hero {
|
||||
grid-template-columns: repeat(2, minmax(0, 1fr));
|
||||
}
|
||||
#hero .logo-container {
|
||||
display: flex;
|
||||
}
|
||||
#middle-content {
|
||||
grid-template-columns: repeat(2, minmax(0, 1fr));
|
||||
gap: 4rem;
|
||||
}
|
||||
}
|
||||
`,
|
||||
}}
|
||||
/>
|
||||
<div className="wrapper">
|
||||
<div className="container">
|
||||
<div id="welcome">
|
||||
<h1>
|
||||
<span> Hello there, </span>
|
||||
Welcome {title} 👋
|
||||
</h1>
|
||||
</div>
|
||||
|
||||
<div id="hero" className="rounded">
|
||||
<div className="text-container">
|
||||
<h2>
|
||||
<svg
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
viewBox="0 0 24 24"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<path
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
strokeWidth="2"
|
||||
d="M9 12l2 2 4-4M7.835 4.697a3.42 3.42 0 001.946-.806 3.42 3.42 0 014.438 0 3.42 3.42 0 001.946.806 3.42 3.42 0 013.138 3.138 3.42 3.42 0 00.806 1.946 3.42 3.42 0 010 4.438 3.42 3.42 0 00-.806 1.946 3.42 3.42 0 01-3.138 3.138 3.42 3.42 0 00-1.946.806 3.42 3.42 0 01-4.438 0 3.42 3.42 0 00-1.946-.806 3.42 3.42 0 01-3.138-3.138 3.42 3.42 0 00-.806-1.946 3.42 3.42 0 010-4.438 3.42 3.42 0 00.806-1.946 3.42 3.42 0 013.138-3.138z"
|
||||
/>
|
||||
</svg>
|
||||
<span>You're up and running</span>
|
||||
</h2>
|
||||
<a href="#commands"> What's next? </a>
|
||||
</div>
|
||||
<div className="logo-container">
|
||||
<svg fill="currentColor" role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M11.987 14.138l-3.132 4.923-5.193-8.427-.012 8.822H0V4.544h3.691l5.247 8.833.005-3.998 3.044 4.759zm.601-5.761c.024-.048 0-3.784.008-3.833h-3.65c.002.059-.005 3.776-.003 3.833h3.645zm5.634 4.134a2.061 2.061 0 0 0-1.969 1.336 1.963 1.963 0 0 1 2.343-.739c.396.161.917.422 1.33.283a2.1 2.1 0 0 0-1.704-.88zm3.39 1.061c-.375-.13-.8-.277-1.109-.681-.06-.08-.116-.17-.176-.265a2.143 2.143 0 0 0-.533-.642c-.294-.216-.68-.322-1.18-.322a2.482 2.482 0 0 0-2.294 1.536 2.325 2.325 0 0 1 4.002.388.75.75 0 0 0 .836.334c.493-.105.46.36 1.203.518v-.133c-.003-.446-.246-.55-.75-.733zm2.024 1.266a.723.723 0 0 0 .347-.638c-.01-2.957-2.41-5.487-5.37-5.487a5.364 5.364 0 0 0-4.487 2.418c-.01-.026-1.522-2.39-1.538-2.418H8.943l3.463 5.423-3.379 5.32h3.54l1.54-2.366 1.568 2.366h3.541l-3.21-5.052a.7.7 0 0 1-.084-.32 2.69 2.69 0 0 1 2.69-2.691h.001c1.488 0 1.736.89 2.057 1.308.634.826 1.9.464 1.9 1.541a.707.707 0 0 0 1.066.596zm.35.133c-.173.372-.56.338-.755.639-.176.271.114.412.114.412s.337.156.538-.311c.104-.231.14-.488.103-.74z" />
|
||||
</svg>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="middle-content">
|
||||
<div id="middle-content-container">
|
||||
<div id="learning-materials" className="rounded shadow">
|
||||
<h2>Learning materials</h2>
|
||||
<a
|
||||
href="https://nx.dev/getting-started/intro?utm_source=nx-project"
|
||||
target="_blank"
|
||||
rel="noreferrer"
|
||||
className="list-item-link"
|
||||
>
|
||||
<svg
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
viewBox="0 0 24 24"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<path
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
strokeWidth="2"
|
||||
d="M12 6.253v13m0-13C10.832 5.477 9.246 5 7.5 5S4.168 5.477 3 6.253v13C4.168 18.477 5.754 18 7.5 18s3.332.477 4.5 1.253m0-13C13.168 5.477 14.754 5 16.5 5c1.747 0 3.332.477 4.5 1.253v13C19.832 18.477 18.247 18 16.5 18c-1.746 0-3.332.477-4.5 1.253"
|
||||
/>
|
||||
</svg>
|
||||
<span>
|
||||
Documentation
|
||||
<span> Everything is in there </span>
|
||||
</span>
|
||||
<svg
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
viewBox="0 0 24 24"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<path
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
strokeWidth="2"
|
||||
d="M9 5l7 7-7 7"
|
||||
/>
|
||||
</svg>
|
||||
</a>
|
||||
<a
|
||||
href="https://nx.dev/blog/?utm_source=nx-project"
|
||||
target="_blank"
|
||||
rel="noreferrer"
|
||||
className="list-item-link"
|
||||
>
|
||||
<svg
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
viewBox="0 0 24 24"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<path
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
strokeWidth="2"
|
||||
d="M19 20H5a2 2 0 01-2-2V6a2 2 0 012-2h10a2 2 0 012 2v1m2 13a2 2 0 01-2-2V7m2 13a2 2 0 002-2V9a2 2 0 00-2-2h-2m-4-3H9M7 16h6M7 8h6v4H7V8z"
|
||||
/>
|
||||
</svg>
|
||||
<span>
|
||||
Blog
|
||||
<span> Changelog, features & events </span>
|
||||
</span>
|
||||
<svg
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
viewBox="0 0 24 24"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<path
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
strokeWidth="2"
|
||||
d="M9 5l7 7-7 7"
|
||||
/>
|
||||
</svg>
|
||||
</a>
|
||||
<a
|
||||
href="https://www.youtube.com/@NxDevtools/videos?utm_source=nx-project&sub_confirmation=1"
|
||||
target="_blank"
|
||||
rel="noreferrer"
|
||||
className="list-item-link"
|
||||
>
|
||||
<svg
|
||||
role="img"
|
||||
viewBox="0 0 24 24"
|
||||
fill="currentColor"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<title>YouTube</title>
|
||||
<path d="M23.498 6.186a3.016 3.016 0 0 0-2.122-2.136C19.505 3.545 12 3.545 12 3.545s-7.505 0-9.377.505A3.017 3.017 0 0 0 .502 6.186C0 8.07 0 12 0 12s0 3.93.502 5.814a3.016 3.016 0 0 0 2.122 2.136c1.871.505 9.376.505 9.376.505s7.505 0 9.377-.505a3.015 3.015 0 0 0 2.122-2.136C24 15.93 24 12 24 12s0-3.93-.502-5.814zM9.545 15.568V8.432L15.818 12l-6.273 3.568z" />
|
||||
</svg>
|
||||
<span>
|
||||
YouTube channel
|
||||
<span> Nx Show, talks & tutorials </span>
|
||||
</span>
|
||||
<svg
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
viewBox="0 0 24 24"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<path
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
strokeWidth="2"
|
||||
d="M9 5l7 7-7 7"
|
||||
/>
|
||||
</svg>
|
||||
</a>
|
||||
<a
|
||||
href="https://nx.dev/react-tutorial/1-code-generation?utm_source=nx-project"
|
||||
target="_blank"
|
||||
rel="noreferrer"
|
||||
className="list-item-link"
|
||||
>
|
||||
<svg
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
viewBox="0 0 24 24"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<path
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
strokeWidth="2"
|
||||
d="M15 15l-2 5L9 9l11 4-5 2zm0 0l5 5M7.188 2.239l.777 2.897M5.136 7.965l-2.898-.777M13.95 4.05l-2.122 2.122m-5.657 5.656l-2.12 2.122"
|
||||
/>
|
||||
</svg>
|
||||
<span>
|
||||
Interactive tutorials
|
||||
<span> Create an app, step-by-step </span>
|
||||
</span>
|
||||
<svg
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
viewBox="0 0 24 24"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<path
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
strokeWidth="2"
|
||||
d="M9 5l7 7-7 7"
|
||||
/>
|
||||
</svg>
|
||||
</a>
|
||||
</div>
|
||||
<a
|
||||
id="nx-repo"
|
||||
className="button-pill rounded shadow"
|
||||
href="https://github.com/nrwl/nx?utm_source=nx-project"
|
||||
target="_blank"
|
||||
rel="noreferrer"
|
||||
>
|
||||
<svg
|
||||
fill="currentColor"
|
||||
role="img"
|
||||
viewBox="0 0 24 24"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12" />
|
||||
</svg>
|
||||
<span>
|
||||
Nx is open source
|
||||
<span> Love Nx? Give us a star! </span>
|
||||
</span>
|
||||
</a>
|
||||
</div>
|
||||
<div id="other-links">
|
||||
<a
|
||||
id="nx-console"
|
||||
className="button-pill rounded shadow"
|
||||
href="https://marketplace.visualstudio.com/items?itemName=nrwl.angular-console&utm_source=nx-project"
|
||||
target="_blank"
|
||||
rel="noreferrer"
|
||||
>
|
||||
<svg
|
||||
fill="currentColor"
|
||||
role="img"
|
||||
viewBox="0 0 24 24"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<title>Visual Studio Code</title>
|
||||
<path d="M23.15 2.587L18.21.21a1.494 1.494 0 0 0-1.705.29l-9.46 8.63-4.12-3.128a.999.999 0 0 0-1.276.057L.327 7.261A1 1 0 0 0 .326 8.74L3.899 12 .326 15.26a1 1 0 0 0 .001 1.479L1.65 17.94a.999.999 0 0 0 1.276.057l4.12-3.128 9.46 8.63a1.492 1.492 0 0 0 1.704.29l4.942-2.377A1.5 1.5 0 0 0 24 20.06V3.939a1.5 1.5 0 0 0-.85-1.352zm-5.146 14.861L10.826 12l7.178-5.448v10.896z" />
|
||||
</svg>
|
||||
<span>
|
||||
Install Nx Console for VSCode
|
||||
<span>The official VSCode extension for Nx.</span>
|
||||
</span>
|
||||
</a>
|
||||
<a
|
||||
id="nx-console-jetbrains"
|
||||
className="button-pill rounded shadow"
|
||||
href="https://plugins.jetbrains.com/plugin/21060-nx-console"
|
||||
target="_blank"
|
||||
rel="noreferrer"
|
||||
>
|
||||
<svg height="48" width="48" viewBox="20 20 60 60" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="m22.5 22.5h60v60h-60z" />
|
||||
<g fill="#fff">
|
||||
<path d="m29.03 71.25h22.5v3.75h-22.5z" />
|
||||
<path d="m28.09 38 1.67-1.58a1.88 1.88 0 0 0 1.47.87c.64 0 1.06-.44 1.06-1.31v-5.98h2.58v6a3.48 3.48 0 0 1 -.87 2.6 3.56 3.56 0 0 1 -2.57.95 3.84 3.84 0 0 1 -3.34-1.55z" />
|
||||
<path d="m36 30h7.53v2.19h-5v1.44h4.49v2h-4.42v1.49h5v2.21h-7.6z" />
|
||||
<path d="m47.23 32.29h-2.8v-2.29h8.21v2.27h-2.81v7.1h-2.6z" />
|
||||
<path d="m29.13 43.08h4.42a3.53 3.53 0 0 1 2.55.83 2.09 2.09 0 0 1 .6 1.53 2.16 2.16 0 0 1 -1.44 2.09 2.27 2.27 0 0 1 1.86 2.29c0 1.61-1.31 2.59-3.55 2.59h-4.44zm5 2.89c0-.52-.42-.8-1.18-.8h-1.29v1.64h1.24c.79 0 1.25-.26 1.25-.81zm-.9 2.66h-1.57v1.73h1.62c.8 0 1.24-.31 1.24-.86 0-.5-.4-.87-1.27-.87z" />
|
||||
<path d="m38 43.08h4.1a4.19 4.19 0 0 1 3 1 2.93 2.93 0 0 1 .9 2.19 3 3 0 0 1 -1.93 2.89l2.24 3.27h-3l-1.88-2.84h-.87v2.84h-2.56zm4 4.5c.87 0 1.39-.43 1.39-1.11 0-.75-.54-1.12-1.4-1.12h-1.44v2.26z" />
|
||||
<path d="m49.59 43h2.5l4 9.44h-2.79l-.67-1.69h-3.63l-.67 1.69h-2.71zm2.27 5.73-1-2.65-1.06 2.65z" />
|
||||
<path d="m56.46 43.05h2.6v9.37h-2.6z" />
|
||||
<path d="m60.06 43.05h2.42l3.37 5v-5h2.57v9.37h-2.26l-3.53-5.14v5.14h-2.57z" />
|
||||
<path d="m68.86 51 1.45-1.73a4.84 4.84 0 0 0 3 1.13c.71 0 1.08-.24 1.08-.65 0-.4-.31-.6-1.59-.91-2-.46-3.53-1-3.53-2.93 0-1.74 1.37-3 3.62-3a5.89 5.89 0 0 1 3.86 1.25l-1.26 1.84a4.63 4.63 0 0 0 -2.62-.92c-.63 0-.94.25-.94.6 0 .42.32.61 1.63.91 2.14.46 3.44 1.16 3.44 2.91 0 1.91-1.51 3-3.79 3a6.58 6.58 0 0 1 -4.35-1.5z" />
|
||||
</g>
|
||||
</svg>
|
||||
<span>
|
||||
Install Nx Console for JetBrains
|
||||
<span>Available for WebStorm, Intellij IDEA Ultimate and more!</span>
|
||||
</span>
|
||||
</a>
|
||||
<div id="nx-cloud" className="rounded shadow">
|
||||
<div>
|
||||
<svg
|
||||
id="nx-cloud-logo"
|
||||
role="img"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
stroke="currentColor"
|
||||
fill="transparent"
|
||||
viewBox="0 0 24 24"
|
||||
>
|
||||
<path
|
||||
strokeWidth="2"
|
||||
d="M23 3.75V6.5c-3.036 0-5.5 2.464-5.5 5.5s-2.464 5.5-5.5 5.5-5.5 2.464-5.5 5.5H3.75C2.232 23 1 21.768 1 20.25V3.75C1 2.232 2.232 1 3.75 1h16.5C21.768 1 23 2.232 23 3.75Z"
|
||||
/>
|
||||
<path
|
||||
strokeWidth="2"
|
||||
d="M23 6v14.1667C23 21.7307 21.7307 23 20.1667 23H6c0-3.128 2.53867-5.6667 5.6667-5.6667 3.128 0 5.6666-2.5386 5.6666-5.6666C17.3333 8.53867 19.872 6 23 6Z"
|
||||
/>
|
||||
</svg>
|
||||
<h2>
|
||||
Nx Cloud
|
||||
<span>Enable faster CI & better DX</span>
|
||||
</h2>
|
||||
</div>
|
||||
<p>You can activate distributed tasks executions and caching by running:</p>
|
||||
<pre>nx connect</pre>
|
||||
<a
|
||||
href="https://nx.dev/nx-cloud?utm_source=nx-project"
|
||||
target="_blank"
|
||||
rel="noreferrer"
|
||||
>
|
||||
{' '}
|
||||
What is Nx Cloud?{' '}
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="commands" className="rounded shadow">
|
||||
<h2>Next steps</h2>
|
||||
<p>Here are some things you can do with Nx:</p>
|
||||
<details>
|
||||
<summary>
|
||||
<svg
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
viewBox="0 0 24 24"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<path
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
strokeWidth="2"
|
||||
d="M8 9l3 3-3 3m5 0h3M5 20h14a2 2 0 002-2V6a2 2 0 00-2-2H5a2 2 0 00-2 2v12a2 2 0 002 2z"
|
||||
/>
|
||||
</svg>
|
||||
Build, test and lint your app
|
||||
</summary>
|
||||
<pre>
|
||||
<span># Build</span>
|
||||
nx build {title}
|
||||
<span># Test</span>
|
||||
nx test {title}
|
||||
<span># Lint</span>
|
||||
nx lint {title}
|
||||
<span># Run them together!</span>
|
||||
nx run-many -p {title} -t build test lint
|
||||
</pre>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
<svg
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
viewBox="0 0 24 24"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<path
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
strokeWidth="2"
|
||||
d="M8 9l3 3-3 3m5 0h3M5 20h14a2 2 0 002-2V6a2 2 0 00-2-2H5a2 2 0 00-2 2v12a2 2 0 002 2z"
|
||||
/>
|
||||
</svg>
|
||||
View project details
|
||||
</summary>
|
||||
<pre>nx show project {title}</pre>
|
||||
</details>
|
||||
<details>
|
||||
<summary>
|
||||
<svg
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
viewBox="0 0 24 24"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<path
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
strokeWidth="2"
|
||||
d="M8 9l3 3-3 3m5 0h3M5 20h14a2 2 0 002-2V6a2 2 0 00-2-2H5a2 2 0 00-2 2v12a2 2 0 002 2z"
|
||||
/>
|
||||
</svg>
|
||||
View interactive project graph
|
||||
</summary>
|
||||
<pre>nx graph</pre>
|
||||
</details>
|
||||
<details>
|
||||
<summary>
|
||||
<svg
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
viewBox="0 0 24 24"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<path
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
strokeWidth="2"
|
||||
d="M8 9l3 3-3 3m5 0h3M5 20h14a2 2 0 002-2V6a2 2 0 00-2-2H5a2 2 0 00-2 2v12a2 2 0 002 2z"
|
||||
/>
|
||||
</svg>
|
||||
Add UI library
|
||||
</summary>
|
||||
<pre>
|
||||
<span># Generate UI lib</span>
|
||||
nx g @nx/react:lib ui
|
||||
<span># Add a component</span>
|
||||
nx g @nx/react:component ui/src/lib/button
|
||||
</pre>
|
||||
</details>
|
||||
</div>
|
||||
|
||||
<p id="love">
|
||||
Carefully crafted with
|
||||
<svg fill="currentColor" stroke="none" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
|
||||
<path
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
strokeWidth="2"
|
||||
d="M4.318 6.318a4.5 4.5 0 000 6.364L12 20.364l7.682-7.682a4.5 4.5 0 00-6.364-6.364L12 7.636l-1.318-1.318a4.5 4.5 0 00-6.364 0z"
|
||||
/>
|
||||
</svg>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</>
|
||||
);
|
||||
}
|
||||
|
||||
export default NxWelcome;
|
||||
@@ -1,6 +1,8 @@
|
||||
import { StrictMode } from 'react';
|
||||
import { BrowserRouter } from 'react-router-dom';
|
||||
|
||||
import * as ReactDOM from 'react-dom/client';
|
||||
import { BrowserRouter } from 'react-router-dom';
|
||||
|
||||
import App from './app/app';
|
||||
|
||||
const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement);
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
import { render, screen } from '@testing-library/react';
|
||||
|
||||
import { HealthPage } from './HealthPage';
|
||||
|
||||
describe('HealthPage', () => {
|
||||
afterEach(() => {
|
||||
vi.unstubAllGlobals();
|
||||
});
|
||||
|
||||
it('показывает версию API из ответа сервера', async () => {
|
||||
const fetchMock = vi.fn().mockResolvedValue({
|
||||
ok: true,
|
||||
json: () => Promise.resolve({ status: 'ok', version: 'v1.2.3' }),
|
||||
});
|
||||
vi.stubGlobal('fetch', fetchMock);
|
||||
|
||||
render(<HealthPage />);
|
||||
|
||||
expect(await screen.findByText('v1.2.3')).toBeTruthy();
|
||||
expect(fetchMock).toHaveBeenCalledWith('/api/health');
|
||||
});
|
||||
|
||||
it('показывает, что API недоступен, если запрос упал', async () => {
|
||||
vi.stubGlobal('fetch', vi.fn().mockRejectedValue(new Error('network')));
|
||||
|
||||
render(<HealthPage />);
|
||||
|
||||
expect(await screen.findByText('down')).toBeTruthy();
|
||||
});
|
||||
});
|
||||
@@ -11,38 +11,62 @@ export function HealthPage() {
|
||||
if (!r.ok) throw new Error(String(r.status));
|
||||
return r.json();
|
||||
})
|
||||
.then((d) => setApiVersion(d?.data?.version ?? 'unknown'))
|
||||
.then((d) => setApiVersion(d?.version ?? 'unknown'))
|
||||
.catch(() => setApiError(true));
|
||||
}, []);
|
||||
|
||||
return (
|
||||
<div className="min-h-screen" style={{ backgroundColor: 'var(--bg-primary)' }}>
|
||||
<div
|
||||
className="min-h-screen"
|
||||
style={{ backgroundColor: 'var(--bg-primary)' }}
|
||||
>
|
||||
<div className="max-w-lg mx-auto px-4 py-16">
|
||||
<h1 className="text-2xl font-bold mb-8" style={{ color: 'var(--text-primary)' }}>
|
||||
<h1
|
||||
className="text-2xl font-bold mb-8"
|
||||
style={{ color: 'var(--text-primary)' }}
|
||||
>
|
||||
Health
|
||||
</h1>
|
||||
<div
|
||||
className="rounded-lg border p-6 space-y-4"
|
||||
style={{ backgroundColor: 'var(--bg-secondary)', borderColor: 'var(--border-color)' }}
|
||||
style={{
|
||||
backgroundColor: 'var(--bg-secondary)',
|
||||
borderColor: 'var(--border-color)',
|
||||
}}
|
||||
>
|
||||
<div className="flex justify-between items-center">
|
||||
<span className="text-sm font-medium" style={{ color: 'var(--text-secondary)' }}>
|
||||
<span
|
||||
className="text-sm font-medium"
|
||||
style={{ color: 'var(--text-secondary)' }}
|
||||
>
|
||||
Web version
|
||||
</span>
|
||||
<span className="text-sm font-mono" style={{ color: 'var(--text-primary)' }}>
|
||||
<span
|
||||
className="text-sm font-mono"
|
||||
style={{ color: 'var(--text-primary)' }}
|
||||
>
|
||||
{webVersion}
|
||||
</span>
|
||||
</div>
|
||||
<div className="flex justify-between items-center">
|
||||
<span className="text-sm font-medium" style={{ color: 'var(--text-secondary)' }}>
|
||||
<span
|
||||
className="text-sm font-medium"
|
||||
style={{ color: 'var(--text-secondary)' }}
|
||||
>
|
||||
API version
|
||||
</span>
|
||||
{apiError ? (
|
||||
<span className="text-sm font-mono" style={{ color: 'var(--color-error, #ef4444)' }}>
|
||||
<span
|
||||
className="text-sm font-mono"
|
||||
style={{ color: 'var(--color-error, #ef4444)' }}
|
||||
>
|
||||
down
|
||||
</span>
|
||||
) : (
|
||||
<span className="text-sm font-mono" style={{ color: 'var(--text-primary)' }}>
|
||||
<span
|
||||
className="text-sm font-mono"
|
||||
style={{ color: 'var(--text-primary)' }}
|
||||
>
|
||||
{apiVersion ?? '...'}
|
||||
</span>
|
||||
)}
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
@tailwind base;
|
||||
@tailwind components;
|
||||
@tailwind utilities;
|
||||
|
||||
/* You can add global styles to this file, and also import other style files */
|
||||
@@ -3,6 +3,7 @@
|
||||
"compilerOptions": {
|
||||
"outDir": "./out-tsc/vitest",
|
||||
"types": [
|
||||
"vitest/globals",
|
||||
"vitest/importMeta",
|
||||
"vite/client",
|
||||
"node",
|
||||
|
||||
@@ -34,7 +34,7 @@ export default defineConfig(() => ({
|
||||
},
|
||||
},
|
||||
test: {
|
||||
name: '@geo-platform/web',
|
||||
name: '@jt4d-platform/web',
|
||||
watch: false,
|
||||
globals: true,
|
||||
environment: 'jsdom',
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
services:
|
||||
web:
|
||||
container_name: geo-platform_web
|
||||
image: git.jt4d.ru/geo-helm/geo-platform/web:${VERSION}
|
||||
container_name: jt4d_web
|
||||
image: git.jt4d.ru/jt4d/jt4d/web:${VERSION}
|
||||
restart: unless-stopped
|
||||
ports:
|
||||
- '80:80'
|
||||
@@ -11,8 +11,8 @@ services:
|
||||
- caddy_config:/config
|
||||
|
||||
api:
|
||||
container_name: geo-platform_api
|
||||
image: git.jt4d.ru/geo-helm/geo-platform/api:${VERSION}
|
||||
container_name: jt4d_api
|
||||
image: git.jt4d.ru/jt4d/jt4d/api:${VERSION}
|
||||
restart: unless-stopped
|
||||
depends_on:
|
||||
postgres:
|
||||
@@ -30,7 +30,7 @@ services:
|
||||
POSTGRES_DB: aigeo
|
||||
|
||||
postgres:
|
||||
container_name: geo-platform_postgres
|
||||
container_name: jt4d_postgres
|
||||
image: postgres:16
|
||||
restart: unless-stopped
|
||||
env_file:
|
||||
|
||||
+16
-17
@@ -1,29 +1,28 @@
|
||||
services:
|
||||
web:
|
||||
container_name: geo-helm_${BRANCH}_web
|
||||
image: git.jt4d.ru/geo-helm/geo-platform/web:${BRANCH}
|
||||
environment:
|
||||
VIRTUAL_PORT: 80
|
||||
VIRTUAL_HOST: ${BRANCH}.geo-platform.geo-helm.jt4d.ru.net
|
||||
HTTPS_METHOD: noredirect
|
||||
container_name: jt4d_${BRANCH}_web
|
||||
image: git.jt4d.ru/jt4d/jt4d/web:${BRANCH}
|
||||
labels:
|
||||
caddy: ${BRANCH}.jt4d.jt4d.ru.net
|
||||
caddy.reverse_proxy: '{{upstreams 80}}'
|
||||
restart: always
|
||||
init: true
|
||||
networks:
|
||||
- 'net'
|
||||
|
||||
api:
|
||||
container_name: geo-helm_${BRANCH}_api
|
||||
image: git.jt4d.ru/geo-helm/geo-platform/api:${BRANCH}
|
||||
container_name: jt4d_${BRANCH}_api
|
||||
image: git.jt4d.ru/jt4d/jt4d/api:${BRANCH}
|
||||
environment:
|
||||
# Приложение и typeorm CLI читают только POSTGRES_*; в .env каталога
|
||||
# деплоя переменные исторически называются DB_*. Синтаксис ${X:-}
|
||||
# намеренно необязательный, заданность проверяет ci.yaml (job
|
||||
# deploy-staging, шаг "Deploy via SSH"): docs/90-deploy/10-migrations.md
|
||||
POSTGRES_USER: ${DB_USERNAME:-}
|
||||
POSTGRES_PASSWORD: ${DB_PASSWORD:-}
|
||||
POSTGRES_DB: ${DB_DATABASE:-}
|
||||
POSTGRES_HOST: ${DB_HOST:-}
|
||||
POSTGRES_PORT: ${DB_PORT:-5432}
|
||||
# POSTGRES_* пишет staging-db-postgres в .env каталога деплоя.
|
||||
# Синтаксис ${X:-} намеренно необязательный: ${X:?} валит и pull, и down.
|
||||
POSTGRES_USER: ${POSTGRES_USER:-}
|
||||
POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-}
|
||||
POSTGRES_DB: ${POSTGRES_DB:-}
|
||||
POSTGRES_HOST: ${POSTGRES_HOST:-}
|
||||
POSTGRES_PORT: ${POSTGRES_PORT:-5432}
|
||||
restart: always
|
||||
init: true
|
||||
networks:
|
||||
- 'net'
|
||||
|
||||
|
||||
@@ -0,0 +1,167 @@
|
||||
# Слои API
|
||||
|
||||
Модуль — единица организации кода в `apps/api`: внутри него код разложен по слоям, а наружу он
|
||||
поставляет только то, что осознанно экспортирует.
|
||||
|
||||
Слоёв три, и зависимости между ними идут строго в одну сторону:
|
||||
|
||||
```
|
||||
Controller → Service → Data Access Layer
|
||||
```
|
||||
|
||||
Сквозь все три слоя проходят два **контракта данных**:
|
||||
|
||||
- **DTO** — форма данных на границе HTTP: что приходит в запросе и что уходит в ответе.
|
||||
- **Entities** — форма данных на границе БД: из чего состоит таблица.
|
||||
|
||||
Модуль — не слой, а рамка, которая собирает эти части и определяет, что из них видно снаружи.
|
||||
|
||||
## Controllers
|
||||
|
||||
**Тонкий контроллер.**
|
||||
|
||||
Контроллер — точка входа HTTP. Он принимает запрос, объявляет контракт ручки для Swagger, проверяет
|
||||
формат входных данных и делегирует работу сервису. При этом контроллер не принимает доменных
|
||||
решений, не вычисляет и не агрегирует данные: почти всё тело метода занимает объявление API.
|
||||
|
||||
Контроль доступа на этом уровне **декларативный**: `JwtAuthGuard`, `RolesGuard` с `@Roles(...)`,
|
||||
`ProjectAccessGuard` с декоратором роли в проекте. Проверка «пользователь — админ?» или «есть ли
|
||||
доступ к проекту?» читается из декораторов, а не вычисляется в теле метода. Валидация формата
|
||||
подключается пайпом **на конкретный параметр** (`@Body(...)`, `@Query(...)`), а не на весь метод: у
|
||||
проекта нет глобального `ValidationPipe`.
|
||||
|
||||
**Входит:**
|
||||
|
||||
- Контроль доступа на основе декларативных систем (guards, роли, декораторы)
|
||||
- Описание API (Swagger-декораторы, HTTP-статусы ответов)
|
||||
- Проверка формата входных данных (пайпы, DTO)
|
||||
|
||||
**Не входит:**
|
||||
|
||||
- Бизнес-логика
|
||||
- Проверка входных данных на основе бизнес-правил
|
||||
- Транзакции
|
||||
- Запросы к БД
|
||||
|
||||
## Services
|
||||
|
||||
**Бизнес-логика и оркестрация.**
|
||||
|
||||
Сервис — место, где принимаются решения. Здесь проверяются бизнес-правила, бросаются доменные
|
||||
ошибки, оркестрируются вызовы DAL и публичных сервисов других модулей, открываются транзакции и
|
||||
пишутся бизнес-события. Сложный домен делится на вложенные модули — по одному на поддомен (пример —
|
||||
`billing/modules/*`), а не разрастается в один сервис на весь домен.
|
||||
|
||||
В публичный API модуля попадают сервисы, но не обязательно все: `exports` перечисляет их явно.
|
||||
Другие модули импортируют только сервисы, поэтому правило «доступ к данным чужого домена — через его
|
||||
публичный сервис» выполняется именно здесь, на уровне сервисов.
|
||||
|
||||
**Входит:**
|
||||
|
||||
- Бизнес-логика
|
||||
- Оркестрация: вызовы своего DAL и публичных сервисов других модулей
|
||||
- Транзакции (через `DataSource` — единственное исключение из правила «TypeORM только в DAL»)
|
||||
- Контроль доступа на основе сложных бизнес-правил
|
||||
- Проверка входных данных на основе бизнес-правил
|
||||
- Логирование бизнес-событий
|
||||
- Вызовы внешних систем — после коммита транзакции
|
||||
|
||||
**Не входит:**
|
||||
|
||||
- Выполнение запросов к БД
|
||||
- Прямой доступ к репозиториям и `QueryBuilder` TypeORM
|
||||
- HTTP-специфика (объекты `Request`/`Response`, HTTP-статусы)
|
||||
|
||||
## Data Access Layer
|
||||
|
||||
**Абстракция над БД.**
|
||||
|
||||
DAL знает о бизнес-сущностях и предоставляет к ним удобный API. Сервис вызывает осмысленный метод и
|
||||
получает данные, не зная, как именно они достаются. DAL возвращает сущности как есть — отдельного
|
||||
слоя доменных моделей и мапперов в проекте нет.
|
||||
|
||||
Минимум бизнес-логики: решения принимает сервис. Исключение — логика, которую **необходимо выполнять
|
||||
на стороне БД**: агрегаты, массовые `UPDATE`/`upsert`, выборки с блокировкой, оконные функции. Ради
|
||||
них DAL может выполнять чужую таблицу через join вместо похода в чужой сервис.
|
||||
|
||||
DAL — **приватная часть модуля**: он не попадает в `exports` и недоступен другим модулям ни при
|
||||
каких условиях, даже родительскому модулю. Доступ к данным чужого домена — только через публичные
|
||||
сервисы модуля-владельца.
|
||||
|
||||
Высокоуровневый API к данным выглядит так: `findById`, `getActiveProjects`, `softRemoveComment`,
|
||||
`getCommentsWithAuthors` — за именем стоит намерение, а не способ выборки (имена условные, они
|
||||
показывают уровень абстракции, а не конкретный модуль). Методы добавляются по мере необходимости, а
|
||||
не заранее «чтобы было». Метод принимает опциональный `manager?: EntityManager`: открывать
|
||||
транзакцию или нет — решает вызывающий, DAL лишь работает с тем контекстом, который ему передали.
|
||||
|
||||
Транзакции, приватность модуля и логика на стороне БД разобраны подробно в
|
||||
[слое доступа к данным](30-data-access.md).
|
||||
|
||||
**Входит:**
|
||||
|
||||
- Выполнение запросов
|
||||
- Логика, которую необходимо выполнять на стороне БД
|
||||
|
||||
**Не входит:**
|
||||
|
||||
- Бизнес-логика (кроме логики, выполняемой в БД)
|
||||
- Открытие транзакций
|
||||
- Знание о HTTP и о том, кто его вызвал
|
||||
|
||||
## DTO
|
||||
|
||||
**Контракт входа и валидация формата.**
|
||||
|
||||
DTO описывает форму данных на границе HTTP: тело запроса, query-параметры, тело ответа. В нём
|
||||
объявлены поля, Swagger-описание (`@ApiProperty`) и class-validator-декораторы формата. Это описание
|
||||
данных, а не поведение: своих методов у DTO нет, кроме статической фабрики `from` — она переводит в
|
||||
форму ответа то, что вернул сервис, и держит белый список полей рядом с контрактом. Один DTO — один
|
||||
контракт ручки.
|
||||
|
||||
Валидация формата (тип, обязательность, диапазон, формат строки) живёт здесь; проверка на основе
|
||||
бизнес-правил — уже в сервисе. DTO описывает и вход, и выход: response-модели вроде
|
||||
`*-response.dto.ts` кладутся в те же `dto/` и подставляются в `@ApiOkResponse({ type: ... })`.
|
||||
Отдельного слоя ответов нет; часть модулей держит свои read-модели плоскими интерфейсами в
|
||||
`*.types.ts`.
|
||||
|
||||
**Входит:**
|
||||
|
||||
- Форма входных и выходных данных
|
||||
- Валидация формата
|
||||
- Swagger-описание полей
|
||||
- Перевод данных в форму ответа — статическая фабрика `from` у response-моделей
|
||||
|
||||
**Не входит:**
|
||||
|
||||
- Бизнес-логика
|
||||
- Обращения к БД
|
||||
- Решения на основе бизнес-правил
|
||||
- Собственные методы, кроме `from`: входной DTO заполняет `ValidationPipe`, а не код самого DTO, а
|
||||
считать и решать, что отдавать, — дело сервиса
|
||||
|
||||
## Entities
|
||||
|
||||
**Схема таблицы, а не модель поведения.**
|
||||
|
||||
TypeORM-сущность описывает таблицу: колонки, типы, связи, индексы и имя таблицы. Имя таблицы —
|
||||
константа `*_TABLE_NAME`, объявленная рядом с сущностью и используемая в коде приложения. Сущность
|
||||
содержит только поля и связи — `Active Record` не используется, методов сохранения или поиска на ней
|
||||
нет.
|
||||
|
||||
Бизнес-логики и валидации в сущности тоже нет: и то, и другое живёт в сервисе, а структура таблицы —
|
||||
здесь. Соглашения об именовании, расположении и связях описаны в
|
||||
[сущностях, таблицах и колонках](10-persistence.md).
|
||||
|
||||
**Входит:**
|
||||
|
||||
- Схема таблицы: колонки и типы
|
||||
- Связи и правила `onDelete`
|
||||
- Индексы
|
||||
- Имя таблицы
|
||||
|
||||
**Не входит:**
|
||||
|
||||
- Бизнес-логика
|
||||
- Методы `save`/`find` и любой доступ к данным
|
||||
- Валидация входных данных
|
||||
- Правила доступа
|
||||
@@ -0,0 +1,224 @@
|
||||
# Слои web
|
||||
|
||||
`apps/web` — React-приложение. Его код разложен по слоям, и зависимости между слоями идут строго в
|
||||
одну сторону:
|
||||
|
||||
```
|
||||
app → pages → @modules → common
|
||||
```
|
||||
|
||||
Слой слева знает о слоях справа и пользуется ими. Обратное запрещено: `common` не знает, где
|
||||
применён и по чьей воле вызван, а `pages` не знает о `app`.
|
||||
|
||||
Слой — это директория: имя слоя и есть имя директории. Одни слои существуют в проекте в одном
|
||||
экземпляре, других — столько, сколько модулей.
|
||||
|
||||
```
|
||||
src/
|
||||
├── app/
|
||||
├── pages/
|
||||
├── modules/
|
||||
│ └── <домен>/
|
||||
│ ├── widgets/
|
||||
│ ├── entities/
|
||||
│ └── modules/
|
||||
└── common/
|
||||
```
|
||||
|
||||
`@modules` — служебная метка места слоёв модулей в общей схеме, а не имя директории. Слои модулей
|
||||
(`widgets`, `entities`) повторяются в каждом модуле на любой глубине; принадлежность к слою модуля
|
||||
задаёт первое имя на пути от корня модуля.
|
||||
|
||||
**Модуль** — не слой, а рамка. `modules/<домен>` собирает свои `widgets` и `entities` и определяет,
|
||||
что из них видно снаружи, — тем же способом, каким это делает модуль в
|
||||
[слоях API](01-api-layers.md). Поддомен — такая же рамка, вложенная внутрь модуля.
|
||||
|
||||
## app
|
||||
|
||||
**Точка входа и оболочка.**
|
||||
|
||||
`app` — внешний край приложения. Он монтирует React, объявляет маршруты и их защиту, держит
|
||||
глобальные провайдеры и рисует оболочку: шапку, подвал, лейауты, общие для целой группы страниц.
|
||||
|
||||
Сюда попадает всё, что относится к приложению целиком, а не к отдельному экрану: например, баннер
|
||||
согласия на cookie. `app` — единственный слой, который видит приложение снизу доверху, и его самого
|
||||
не импортирует никто.
|
||||
|
||||
**Входит:**
|
||||
|
||||
- Точка входа приложения
|
||||
- Маршруты и их защита
|
||||
- Глобальные провайдеры
|
||||
- Оболочка и лейауты страниц
|
||||
- Элементы, относящиеся к приложению целиком
|
||||
|
||||
**Не входит:**
|
||||
|
||||
- Конкретные страницы и их содержимое
|
||||
- Доменные данные и сценарии
|
||||
- Формы, модалки и прочие блоки интерфейса
|
||||
|
||||
## pages
|
||||
|
||||
**Общий вид страницы и расстановка блоков.**
|
||||
|
||||
`pages` отвечает за то, как страница выглядит целиком, и объявляет **хлебные крошки**. Страница
|
||||
решает, какие виджеты на ней стоят, в каком они порядке и как расположены, — и задаёт каждому
|
||||
начальные данные: идентификатор из маршрута, стартовое значение фильтра, активную вкладку.
|
||||
|
||||
Собственное состояние страницы допустимо ровно одно — то, которым страница **связывает виджеты**
|
||||
между собой. Виджеты друг о друге не знают, поэтому место их встречи — страница. Всё, что является
|
||||
бизнес-логикой или передачей сообщений между виджетами, странице не принадлежит.
|
||||
|
||||
**Входит:**
|
||||
|
||||
- Композиция виджетов и их расположение на странице
|
||||
- Хлебные крошки
|
||||
- Начальные данные виджетов
|
||||
- Состояние страницы как связь между виджетами
|
||||
|
||||
**Не входит:**
|
||||
|
||||
- Бизнес-логика
|
||||
- Собственное отображение доменных данных — это дело виджетов
|
||||
- Передача сообщений между виджетами
|
||||
- Работа с API
|
||||
|
||||
## @modules: widgets
|
||||
|
||||
**Самостоятельный блок интерфейса.**
|
||||
|
||||
Виджет сам добывает свои данные и сам держит своё состояние: открытие модалок, активную вкладку,
|
||||
раскрытые строки, значения полей формы. Наружу он поставляет готовый блок, а внутрь принимает только
|
||||
параметры — идентификаторы и начальные значения, — поэтому страница может поставить виджет, ничего
|
||||
не зная о том, что внутри.
|
||||
|
||||
Один виджет — один законченный участок работы: форма входа модуля `auth` проверяет поле, держит
|
||||
ошибку и статус отправки, а страница передаёт ей только различающиеся тексты.
|
||||
|
||||
Виджет собирается из `entities` и `common` и о других виджетах на странице не знает: связать два
|
||||
виджета — задача `pages`. Слои выше модуля — `pages` и `app` — виджету недоступны.
|
||||
|
||||
**Входит:**
|
||||
|
||||
- Загрузка своих данных
|
||||
- Своё состояние: модалки, вкладки, раскрытия, промежуточные значения форм
|
||||
- Композиция `entities` и `common`
|
||||
- Действия пользователя в границах блока
|
||||
|
||||
**Не входит:**
|
||||
|
||||
- Хлебные крошки и общая раскладка страницы
|
||||
- Знание о других виджетах
|
||||
- Доменные правила
|
||||
|
||||
## @modules: entities
|
||||
|
||||
**Показ доменной сущности.**
|
||||
|
||||
Entity отвечает за то, как выглядит одна доменная сущность или одно значение: `TokenValue`
|
||||
показывает значение токенов, `SummaryRow` — строку сводки. Данные приходят пропсами; entity ничего
|
||||
не загружает и ничего не меняет. Она отвечает только за вид и форматирование того, что ей передали:
|
||||
числа, даты, статусы.
|
||||
|
||||
**Входит:**
|
||||
|
||||
- Показ одной доменной сущности или значения
|
||||
- Форматирование значения: числа, даты, статусы
|
||||
- Локальное состояние отображения
|
||||
|
||||
**Не входит:**
|
||||
|
||||
- Загрузка данных
|
||||
- Действия над сущностью: создание, изменение, удаление
|
||||
- Композиция нескольких сущностей
|
||||
- Знание о странице и о том, где entity показана
|
||||
|
||||
## common
|
||||
|
||||
**Общий слой.**
|
||||
|
||||
`common` — фундамент: UI-примитивы (кнопка, диалог, таблица), вызовы API, типы, утилиты
|
||||
форматирования, переводы. Всё это переиспользуется слоями выше и не принадлежит ни одному сценарию.
|
||||
|
||||
Слой ничего не знает о том, где и для чего его применили. Примитив интерфейса не подписывается на
|
||||
домен, а модуль API не решает, что показать пользователю при ошибке: решение принимает тот, кто его
|
||||
вызвал.
|
||||
|
||||
`common` — нижний слой: его берут все, он не берёт никого.
|
||||
|
||||
**Входит:**
|
||||
|
||||
- UI-примитивы
|
||||
- Вызовы API
|
||||
- Типы и утилиты
|
||||
- Переводы
|
||||
- Форматирование значений
|
||||
|
||||
**Не входит:**
|
||||
|
||||
- Знание о том, где и в каком сценарии он применён
|
||||
- Композиция доменного интерфейса
|
||||
- Решения о том, что показать и что сделать при ошибке
|
||||
|
||||
## Баррели: публичный API границы
|
||||
|
||||
Граница — модуль, слой, сложный компонент из нескольких файлов — объявляет публичный API через
|
||||
`index.ts` и только через него отдаёт содержимое наружу. Импорт внутреннего файла в обход барреля
|
||||
запрещён.
|
||||
|
||||
```ts
|
||||
// apps/web/src/common/index.ts
|
||||
export * from './lib';
|
||||
export * from './ui';
|
||||
|
||||
// apps/web/src/common/lib/index.ts
|
||||
export { applyTheme, getTheme, subscribeToTheme, toggleTheme, type Theme } from './theme';
|
||||
export { cn } from './utils';
|
||||
```
|
||||
|
||||
Правила барреля:
|
||||
|
||||
- Только явный список именованных реэкспортов. `export *` допустим лишь от вложенной директории, у
|
||||
которой уже есть собственный `index.ts`.
|
||||
- Никакого исполняемого кода: ни импортов стилей, ни инициализации, ни оборачивания компонентов.
|
||||
- Импорт из своего или вышестоящего барреля запрещён; внутри директории файлы импортируют друг друга
|
||||
относительными путями.
|
||||
|
||||
Межграничный импорт идёт через алиас `@jt4d-platform/web/*`, который объявлен в `tsconfig.base.json`
|
||||
и разрешается в `vite.config.ts` через `resolve.alias`:
|
||||
|
||||
```ts
|
||||
import { Button, usePageBreadcrumbs } from '@jt4d-platform/web/common';
|
||||
import { AuthForm } from '@jt4d-platform/web/modules/auth';
|
||||
import { HealthPage } from '@jt4d-platform/web/pages';
|
||||
```
|
||||
|
||||
Обход барреля ловится линтером правилом `weld/no-barrel-bypass` из `eslint-plugin-weld`; оно
|
||||
включено в `apps/web/eslint.config.mjs`.
|
||||
|
||||
## Приватность частей директории
|
||||
|
||||
Часть директории объявляется приватной явно, а не договорённостью на словах:
|
||||
|
||||
- публичный API директории — её баррель: файл, который баррель не реэкспортирует, наружу не
|
||||
отдаётся;
|
||||
- приватная группа файлов лежит в каталоге с точным именем `internal` вместе со всем содержимым;
|
||||
- приватное доступно только содержимому непосредственного родителя;
|
||||
- владелец может опубликовать часть реализации через свой баррель, но путь приватной директории от
|
||||
этого не открывается.
|
||||
|
||||
Пример — хук формы входа: `modules/auth/widgets/auth-form/useAuthForm.ts`. Он используется
|
||||
компонентом `AuthForm.tsx` из той же директории и не попадает в баррель виджета.
|
||||
|
||||
## Модули и видимость
|
||||
|
||||
Модули верхнего уровня лежат в `src/modules/<домен>`, вложенные — в контейнере `modules/` внутри
|
||||
родительского модуля. Контейнер слоем не является и собственного публичного API не имеет.
|
||||
|
||||
Видимость определяется положением в дереве: модулю доступны его предки, братья, братья предков и
|
||||
непосредственные дочерние модули. Доступ к «племянникам» запрещён: он раскрывает внутреннюю
|
||||
структуру ветки. Дублирование логики между модулями не допускается — общая часть переносится в
|
||||
`common` или в модуль, доступный по дереву.
|
||||
|
||||
Пример: `modules/auth` отдаёт наружу только `AuthForm`, страницы берут его из барреля модуля.
|
||||
@@ -0,0 +1,99 @@
|
||||
# Сущности, таблицы и колонки
|
||||
|
||||
## Расположение сущностей
|
||||
|
||||
Все TypeORM-сущности модуля лежат в подпапке `entities/` в корне модуля:
|
||||
|
||||
```
|
||||
apps/api/src/contests/
|
||||
├── dto/
|
||||
├── entities/
|
||||
│ └── contest.entity.ts
|
||||
├── contests.controller.ts
|
||||
├── contests.module.ts
|
||||
└── contests.service.ts
|
||||
```
|
||||
|
||||
- Правило без исключений: даже если сущность в модуле одна, она всё равно в `entities/`. Иначе при
|
||||
добавлении второй сущности пришлось бы переносить первую и править все её импорты.
|
||||
- Имя файла — `<сущность>.entity.ts` в kebab-case (`project-member.entity.ts`).
|
||||
- Один файл — одна сущность.
|
||||
|
||||
## Имя таблицы — единая точка правды
|
||||
|
||||
Рядом с сущностью, в том же файле, объявляется экспортируемая константа с именем таблицы, и
|
||||
`@Entity` использует её:
|
||||
|
||||
```ts
|
||||
export const CONTESTS_TABLE_NAME = 'contests';
|
||||
|
||||
@Entity({ name: CONTESTS_TABLE_NAME })
|
||||
export class Contest {
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
- Константа именуется `<СУЩНОСТЬ>_TABLE_NAME` в SCREAMING_SNAKE_CASE.
|
||||
- Значение — `snake_case`, множественное число (`contests`, `project_members`).
|
||||
- `@Entity()` без явного `name` не используется: имя таблицы не должно выводиться из имени класса —
|
||||
переименование класса тогда молча меняет схему.
|
||||
|
||||
Константа — единая точка правды об имени таблицы для кода приложения: `@Entity`, DAL, raw-SQL,
|
||||
алиасы `createQueryBuilder`, утилиты очистки в тестах. Строковый литерал с именем таблицы за
|
||||
пределами объявления константы в коде приложения не пишется.
|
||||
|
||||
### Миграции константу не используют
|
||||
|
||||
Миграция — снимок схемы на момент, когда её написали, и она обязана оставаться рабочей независимо от
|
||||
того, что стало с кодом дальше. Поэтому **в миграции имя таблицы пишется строковым литералом**.
|
||||
|
||||
Пример из репозитория: коммит `b710c1b9` удалил модуль подписок вместе с файлом
|
||||
`subscriptions/subscription-plan.entity.ts` — а миграции `1774000000000-add-subscription-plans.ts` и
|
||||
`1788825600000-drop-subscriptions-and-metrics-limits.ts` никуда не делись и по-прежнему создают и
|
||||
удаляют таблицу `subscription_plans`. Импортируй они константу из удалённого файла — сборка встала
|
||||
бы целиком: миграции попадают в бандл `data-source.js` статическими импортами.
|
||||
|
||||
Обратная сторона того же правила: значение константы менять **можно**, миграции на него не смотрят.
|
||||
Переименование таблицы — это новое значение константы плюс миграция с двумя литералами:
|
||||
|
||||
```ts
|
||||
await queryRunner.renameTable('contests', 'brand_contests');
|
||||
```
|
||||
|
||||
## Имена колонок
|
||||
|
||||
Колонки — `camelCase` (`logoId`, `totalBudget`, `createdAt`), в отличие от `snake_case` у таблиц.
|
||||
Это не разнобой, а следствие дефолтной стратегии именования TypeORM: имя колонки выводится из имени
|
||||
свойства как есть, и в `@Column()` его не дублируют. С таблицей так нельзя — её имя выводилось бы из
|
||||
имени класса, — поэтому она и задаётся явно.
|
||||
|
||||
Практическое следствие: Postgres приводит неэкранированный идентификатор к нижнему регистру, так что
|
||||
в raw-SQL такая колонка пишется только в двойных кавычках:
|
||||
|
||||
```sql
|
||||
ALTER TABLE "contests" DROP COLUMN IF EXISTS "totalBudget";
|
||||
```
|
||||
|
||||
## Nullable-колонки — явный `type`
|
||||
|
||||
Если тип свойства — объединение с `null`, тип колонки задаётся в декораторе явно:
|
||||
|
||||
```ts
|
||||
@Column({ type: 'varchar', nullable: true })
|
||||
banReason: string | null;
|
||||
|
||||
@Column({ type: 'timestamp', nullable: true })
|
||||
emailVerificationTokenExpires: Date | null;
|
||||
```
|
||||
|
||||
Без `type` TypeORM выводит тип колонки из метаданных декоратора (`design:type`), а для объединения
|
||||
`string | null` TypeScript отдаёт `Object` — вывести из него тип колонки нельзя, и приложение падает
|
||||
на старте с `ColumnTypeUndefinedError` ещё до первого запроса. Ошибка вылезает только при реальном
|
||||
поднятии контекста: юнит-тесты сервиса метаданные сущностей не строят и остаются зелёными.
|
||||
|
||||
Само объявление `string | null` при этом предпочтительнее, чем `string` у nullable-колонки: тип
|
||||
сущности должен отражать то, что лежит в базе, иначе «пустое» значение приходится проверять вопреки
|
||||
типу. Схему явный `type` не меняет — `varchar` без длины это то же `character varying`, что и в
|
||||
миграции, — так что переход на `| null` у уже существующей колонки миграции не требует.
|
||||
|
||||
Как писать сами миграции — [Написание миграций](20-migrations.md).
|
||||
@@ -0,0 +1,131 @@
|
||||
# Написание миграций
|
||||
|
||||
Здесь — как **писать** миграцию. Про то, как список миграций собирается, как они применяются на
|
||||
деплое и какие есть команды, см. [Миграции базы данных](../90-deploy/10-migrations.md).
|
||||
|
||||
## DDL пишется через API TypeORM, а не строкой SQL
|
||||
|
||||
Схема меняется методами `QueryRunner` с объектами `Table` / `TableColumn`. Строка SQL в
|
||||
`queryRunner.query()` — крайняя мера, а не способ по умолчанию.
|
||||
|
||||
```ts
|
||||
import { MigrationInterface, QueryRunner, Table } from 'typeorm';
|
||||
|
||||
export class AddContests1790000000000 implements MigrationInterface {
|
||||
name = 'AddContests1790000000000';
|
||||
|
||||
public async up(queryRunner: QueryRunner): Promise<void> {
|
||||
await queryRunner.createTable(
|
||||
new Table({
|
||||
name: 'contests',
|
||||
columns: [
|
||||
{
|
||||
name: 'id',
|
||||
type: 'int',
|
||||
isPrimary: true,
|
||||
isGenerated: true,
|
||||
generationStrategy: 'increment',
|
||||
},
|
||||
{ name: 'title', type: 'varchar', length: '255', isUnique: true },
|
||||
{ name: 'logoId', type: 'varchar', length: '64', isNullable: true },
|
||||
{ name: 'description', type: 'text' },
|
||||
{ name: 'totalBudget', type: 'int' },
|
||||
{ name: 'createdAt', type: 'timestamp', default: 'now()' },
|
||||
{ name: 'updatedAt', type: 'timestamp', default: 'now()' },
|
||||
],
|
||||
}),
|
||||
);
|
||||
}
|
||||
|
||||
public async down(queryRunner: QueryRunner): Promise<void> {
|
||||
await queryRunner.dropTable('contests');
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
У `createTable` есть второй аргумент `ifNotExist`, и ставить его в `true` не надо: он глушит ровно
|
||||
ту ошибку, ради которой существует [проверка перед коммитом](#проверка-перед-коммитом) — если `down`
|
||||
отработал не полностью и оставил таблицу, повторный `up` с `ifNotExist: true` пройдёт мимо дефекта
|
||||
молча. Дважды одна и та же миграция не применяется и без флага, за этим следит таблица `migrations`.
|
||||
|
||||
Имя таблицы — строковый литерал: константа `*_TABLE_NAME` из файла сущности в миграциях не
|
||||
используется, см.
|
||||
[Миграции константу не используют](10-persistence.md#миграции-константу-не-используют).
|
||||
|
||||
### `migration:generate` — это черновик
|
||||
|
||||
`typeorm migration:generate` (запуск — в
|
||||
[Как добавить миграцию](../90-deploy/10-migrations.md#как-добавить-миграцию)) всегда выдаёт тело из
|
||||
строк `queryRunner.query(...)`, иначе он не умеет. Генератор полезен тем, что показывает полный
|
||||
список расхождений схемы с сущностями — руками их легко не заметить. Но сгенерированный файл
|
||||
дописывается до конца: DDL переписывается на методы `QueryRunner`, строкой SQL остаётся только то,
|
||||
что под них не подходит.
|
||||
|
||||
### Когда допустим `queryRunner.query()`
|
||||
|
||||
Там, где API TypeORM нужную конструкцию не выражает. Типичные случаи: частичные и функциональные
|
||||
индексы (`WHERE`, `lower(...)`), `ALTER COLUMN TYPE ... USING`, `CREATE INDEX CONCURRENTLY`,
|
||||
`CREATE EXTENSION`, любые запросы к данным. В таком месте ставится комментарий, почему используется
|
||||
строка SQL.
|
||||
|
||||
## `down` пишется всегда
|
||||
|
||||
Обратный метод обязателен для каждой миграции: `db-revert` — штатная команда проекта, и откат должен
|
||||
работать не только на бумаге.
|
||||
|
||||
Если операция необратима по природе (удаление колонки с данными, добавление значения в enum-тип), у
|
||||
`down` есть два варианта: упасть с ошибкой либо откатить схему с потерей данных. Что из этого
|
||||
уместно, решается при написании конкретной миграции и фиксируется комментарием.
|
||||
|
||||
Первый вариант — откат запрещён:
|
||||
|
||||
```ts
|
||||
export class DropContestDescription1790000001000 implements MigrationInterface {
|
||||
name = 'DropContestDescription1790000001000';
|
||||
|
||||
public async up(queryRunner: QueryRunner): Promise<void> {
|
||||
await queryRunner.dropColumn('contests', 'description');
|
||||
}
|
||||
|
||||
public async down(): Promise<void> {
|
||||
// откат невозможен: значения удалённой колонки восстановить неоткуда
|
||||
throw new Error('DropContestDescription1790000001000 необратима');
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Второй — та же миграция, но откат разрешён с потерей данных:
|
||||
|
||||
```ts
|
||||
public async down(queryRunner: QueryRunner): Promise<void> {
|
||||
// колонка возвращается пустой: прежние значения теряются
|
||||
await queryRunner.addColumn(
|
||||
'contests',
|
||||
new TableColumn({ name: 'description', type: 'text', isNullable: true }),
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
## Проверка перед коммитом
|
||||
|
||||
Миграция считается проверенной, только если на локальной БД прошёл полный цикл:
|
||||
|
||||
```bash
|
||||
yarn nx run api:db-migrate # накатить
|
||||
yarn nx run api:db-revert # откатить
|
||||
yarn nx run api:db-migrate # накатить снова
|
||||
```
|
||||
|
||||
Все три шага должны отработать без ошибок. Второй накат ловит самый частый дефект — `down`, который
|
||||
отработал не полностью и оставил в базе объект, на который потом спотыкается `up`.
|
||||
|
||||
Исключение — миграция, `down` которой намеренно падает: для неё проверяется только накат.
|
||||
|
||||
## Data-миграции — отдельным файлом
|
||||
|
||||
Изменение схемы и перенос/заполнение данных не смешиваются в одной миграции. Причина: миграция схемы
|
||||
откатывается механически, а data-миграция часто необратима в принципе; в одном файле необратимой
|
||||
становится вся пара.
|
||||
|
||||
Порядок для задачи «добавить колонку и заполнить её»: сначала миграция схемы, затем отдельной
|
||||
миграцией — бэкфилл данных.
|
||||
@@ -0,0 +1,188 @@
|
||||
# Слой доступа к данным (DAL)
|
||||
|
||||
## Зачем
|
||||
|
||||
Цель — не абстракция «на случай смены СУБД», а независимость бизнес-кода **от методов работы с
|
||||
базой**. Сервис не должен знать, что данные достаются через `Repository.findOne`, `save` или
|
||||
`QueryBuilder`: он вызывает осмысленный метод и получает данные. Тогда изменение способа выборки —
|
||||
добавление join'а, замена двух запросов одним, кэш — остаётся внутри одного файла и не требует
|
||||
трогать бизнес-логику.
|
||||
|
||||
## Как устроено
|
||||
|
||||
DAL — это обычный Nest-провайдер, технически такой же сервис, но с суффиксом `Dal`:
|
||||
|
||||
```
|
||||
apps/api/src/contests/
|
||||
├── entities/
|
||||
│ └── contest.entity.ts
|
||||
├── contests.dal.ts
|
||||
├── contests.service.ts
|
||||
├── contests.controller.ts
|
||||
└── contests.module.ts
|
||||
```
|
||||
|
||||
```ts
|
||||
@Injectable()
|
||||
export class ContestsDal {
|
||||
constructor(
|
||||
@InjectRepository(Contest)
|
||||
private readonly repository: Repository<Contest>,
|
||||
) {}
|
||||
|
||||
public findById(id: number): Promise<Contest | null> {
|
||||
return this.repository.findOne({ where: { id } });
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- `@InjectRepository`, `Repository`, `DataSource`, `QueryBuilder` и любые прочие API TypeORM
|
||||
допустимы **только внутри DAL**. Сервисы, контроллеры, guard'ы и интерцепторы к ним не обращаются.
|
||||
- **Active Record не используется**: сущность содержит только поля и связи, никаких методов
|
||||
сохранения/поиска на ней не появляется.
|
||||
- **Мапперы не нужны.** DAL возвращает сущности как есть; отдельный слой доменных моделей не
|
||||
вводится.
|
||||
- Методы добавляются **по мере необходимости** — под конкретный запрос вызывающего кода. Заранее,
|
||||
«чтобы было», API не пишется.
|
||||
- Типы TypeORM в сигнатурах (`FindOptionsWhere`, `FindManyOptions` и подобные) — допустимое зло:
|
||||
ради них не городится собственный язык запросов.
|
||||
|
||||
## Бизнес-логики в DAL нет
|
||||
|
||||
DAL отвечает за «достать и положить», решения принимает сервис.
|
||||
|
||||
Единственное исключение — логика, которую **необходимо выполнять на стороне БД**: агрегаты, массовые
|
||||
`UPDATE`, `upsert`, выборки с блокировками, оконные функции. Абстрагироваться от них без потери
|
||||
смысла (и производительности) нельзя, поэтому такая логика живёт в DAL.
|
||||
|
||||
## DAL — приватная часть модуля
|
||||
|
||||
DAL не попадает в `exports` модуля и **недоступен другим модулям ни при каких условиях**.
|
||||
`TypeOrmModule.forFeature([...])` регистрируется в модуле-владельце и наружу не реэкспортируется.
|
||||
|
||||
Доступ к данным чужого модуля — только через его **публичные сервисы**.
|
||||
|
||||
Исключение — тот самый случай, когда бизнес-логика реализована в DAL (выполняется в БД). Тогда
|
||||
детали схемы одного модуля могут протечь в другой: например, запрос с join'ом на чужую таблицу
|
||||
вместо похода в чужой сервис. Это допустимо, но нежелательно — так делают, когда обход через
|
||||
публичный сервис обходится дорого (N+1, выборка заведомо лишних данных), а не по умолчанию.
|
||||
|
||||
## Транзакции
|
||||
|
||||
Транзакцию открывает **сервис — владелец сценария**, а не DAL: одна транзакция накрывает вызовы
|
||||
нескольких DAL, и ни один из них не знает о соседях.
|
||||
|
||||
Ради этого сервису разрешено внедрять `DataSource` — **зафиксированное исключение** из правила «API
|
||||
TypeORM только внутри DAL». Исключение узкое: `DataSource` в сервисе используется **исключительно**
|
||||
ради `dataSource.transaction(...)`. Репозитории и `QueryBuilder` из него не берутся — вся работа с
|
||||
данными остаётся в DAL, а `manager` передаётся в его методы параметром.
|
||||
|
||||
Так устроено создание пользователя: владелец сценария `UsersService`
|
||||
(`apps/api/src/users/users.service.ts`) открывает транзакцию, а участвует в ней чужой модуль —
|
||||
`BillingAccountService` → `AccountsService` → `AccountsDal` (`apps/api/src/billing/`).
|
||||
|
||||
Дальше — схематичные примеры на вымышленном модуле конкурсов: такого кода в репозитории нет, он
|
||||
показывает форму записи, а не место. Сервис-владелец сценария:
|
||||
|
||||
```ts
|
||||
@Injectable()
|
||||
export class ContestsService {
|
||||
constructor(
|
||||
private readonly contests: ContestsDal,
|
||||
private readonly reviews: ReviewsDal,
|
||||
// Исключение: `DataSource` здесь нужен только ради `transaction`.
|
||||
@InjectDataSource()
|
||||
private readonly dataSource: DataSource,
|
||||
) {}
|
||||
|
||||
public launch(input: LaunchContestInput): Promise<Contest> {
|
||||
return this.dataSource.transaction(async (manager) => {
|
||||
await this.reviews.closeOpen(input.contestId, manager);
|
||||
|
||||
return this.contests.markLaunched(input.contestId, manager);
|
||||
});
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
DAL принимает `manager` опциональным параметром и по нему выбирает репозиторий:
|
||||
|
||||
```ts
|
||||
@Injectable()
|
||||
export class ContestsDal {
|
||||
constructor(
|
||||
@InjectRepository(Contest)
|
||||
private readonly contests: Repository<Contest>,
|
||||
) {}
|
||||
|
||||
public findById(id: number, manager?: EntityManager): Promise<Contest | null> {
|
||||
return this.repository(manager).findOne({ where: { id } });
|
||||
}
|
||||
|
||||
private repository(manager?: EntityManager): Repository<Contest> {
|
||||
return manager?.getRepository(Contest) ?? this.contests;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Параметр опционален у любого метода — и у чтения, и у записи. Выполнять операцию в транзакции или
|
||||
нет — ответственность вызывающей стороны: метод работает с тем `manager`, который ему передали, а
|
||||
без него — вне транзакции. Так один и тот же `AccountsDal.findRegionByCode` читает справочник
|
||||
регионов и в транзакции создания пользователя (из `AccountsService.create`), и без неё — на
|
||||
стартовой проверке `BillingModule`. Выборка с блокировкой (`SELECT ... FOR UPDATE`) устроена так же:
|
||||
блокировка держится только внутри транзакции, и открыть её — забота вызывающего.
|
||||
|
||||
Публичный метод сервиса, который может участвовать в чужой транзакции, тоже принимает
|
||||
`manager?: EntityManager` и пробрасывает его дальше. Контекст передаётся явно, `AsyncLocalStorage`
|
||||
не вводится.
|
||||
|
||||
Внешние вызовы — HTTP, SMTP, очереди — внутрь транзакции не заводятся: письмо верификации
|
||||
`AuthService.registration` отправляет **после** возврата из `UsersService.createUser`, то есть после
|
||||
коммита. Иначе транзакция держит соединение с базой на время сетевого таймаута, а откат письмо уже
|
||||
не отзовёт.
|
||||
|
||||
### Модуль без своего DAL
|
||||
|
||||
Пока модуль на DAL не переведён (сегодня это `users`), внутри `dataSource.transaction(...)` все
|
||||
операции с его сущностями идут через `manager.getRepository(...)` **прямо в сервисе**. Внедрённый
|
||||
`this.userRepository` работает вне транзакции — он берёт собственное соединение, и откат его записи
|
||||
не отменит.
|
||||
|
||||
```ts
|
||||
// Сервис модуля без DAL, которому нужна транзакция:
|
||||
return this.dataSource.transaction(async (manager) => {
|
||||
// Именно `manager.getRepository`, а не внедрённый `this.userRepository`.
|
||||
const users = manager.getRepository(User);
|
||||
// Только анкетные поля: `create(dto)` перенёс бы на сущность любую пришедшую колонку и связь.
|
||||
const user = users.create({
|
||||
email: dto.email,
|
||||
password: dto.password,
|
||||
firstName: dto.firstName,
|
||||
lastName: dto.lastName,
|
||||
});
|
||||
|
||||
// Чужая операция вызывается тем же `manager`: аккаунт и строка пользователя пишутся одной
|
||||
// транзакцией. Регион резолвит сам биллинг — `users` про его конфигурацию не знает.
|
||||
const account = await this.billingAccount.create({ name: user.email }, manager);
|
||||
|
||||
user.billingAccountId = account.id;
|
||||
|
||||
return users.save(user);
|
||||
});
|
||||
```
|
||||
|
||||
Строка собирается из явного перечня анкетных полей, а не из `dto` целиком: у
|
||||
`POST /auth/registration` валидирующего пайпа нет, поэтому в воронку уезжает сырое тело анонимного
|
||||
запроса, а `create(dto)` (typeorm 0.3.x) перенёс бы на сущность и служебные колонки (`id`,
|
||||
`emailVerified`, `banned`, `refreshToken`), и связь `roles`. Перечень — основная защита воронки,
|
||||
поэтому расширяется осознанно (докблок `UsersService.createWithBillingAccount`).
|
||||
|
||||
Аккаунт заводится **до** вставки пользователя, чтобы строка сразу писалась со ссылкой
|
||||
`users.billingAccountId`, а не догонялась вторым `save`. Такой порядок возможен потому, что
|
||||
`billing_accounts` на `users` не ссылается.
|
||||
|
||||
Вне транзакции тот же сервис пишет через внедрённый `this.userRepository` — так устроены одиночные
|
||||
записи вроде `UsersService.setUserEmailVerified` и `saveRefreshToken`, где менять нечего, кроме
|
||||
одной строки `users`.
|
||||
|
||||
Оговорка временная: с появлением `users.dal.ts` этот код уезжает в DAL по общему правилу.
|
||||
@@ -0,0 +1,31 @@
|
||||
# Тесты
|
||||
|
||||
## Расположение и имя
|
||||
|
||||
Юнит-тест лежит **рядом с тестируемым файлом**, отдельной папки под тесты нет:
|
||||
|
||||
```
|
||||
apps/api/src/contests/
|
||||
├── contests.service.ts
|
||||
└── contests.service.test.ts
|
||||
```
|
||||
|
||||
Расширение — `.test.ts` (`.test.tsx` для React-компонентов).
|
||||
|
||||
В репозитории встречается и `.spec.ts` — vitest подхватывает оба паттерна.
|
||||
|
||||
## DAL тестами не покрывается
|
||||
|
||||
Юнит-тест DAL с замоканным репозиторием проверял бы сам себя: что `findOne` вызван с теми
|
||||
аргументами, с которыми его вызвали. Такие тесты не пишутся.
|
||||
|
||||
Логика, ради которой стоит писать тест, живёт в сервисе — там она и тестируется, с замоканным DAL.
|
||||
Исключение — [БД-логика внутри DAL](30-data-access.md#бизнес-логики-в-dal-нет): её корректность
|
||||
проверяется на реальной базе, а не моками.
|
||||
|
||||
## Запуск
|
||||
|
||||
```bash
|
||||
yarn nx run api:test
|
||||
yarn nx run web:test
|
||||
```
|
||||
@@ -0,0 +1 @@
|
||||
label: 'Разработка'
|
||||
@@ -0,0 +1,75 @@
|
||||
# Введение
|
||||
|
||||
## Зачем нужно логирование
|
||||
|
||||
### Цель
|
||||
|
||||
Логирование — это ключевой инструмент диагностики и анализа поведения системы. Оно фиксирует
|
||||
**действия, ошибки и события**, позволяя:
|
||||
|
||||
- анализировать поведение приложения;
|
||||
- находить причины ошибок и сбоев;
|
||||
- отслеживать бизнес-процессы (например, запуск аудита бренда или генерацию JSON-LD);
|
||||
- проводить аудит действий пользователей;
|
||||
- контролировать производительность и стабильность работы.
|
||||
|
||||
Хорошее логирование даёт **контекст и доказательства** — кто, когда и что сделал, с каким
|
||||
результатом.
|
||||
|
||||
### Основные задачи логирования
|
||||
|
||||
Логирование решает как **технические**, так и **организационные** задачи.
|
||||
|
||||
**Технические:**
|
||||
|
||||
- **Диагностика:** восстановление хода событий при сбое.
|
||||
- **Аналитика:** понимание того, как система используется.
|
||||
- **Поддержка:** ускорение поиска причин ошибок в эксплуатации.
|
||||
|
||||
**Организационные:**
|
||||
|
||||
- **Аудит:** фиксация действий пользователей и администраторов.
|
||||
- **Безопасность:** выявление попыток несанкционированного доступа.
|
||||
|
||||
## Уровни логирования
|
||||
|
||||
В системе используется библиотека **Pino**, интегрированная через `nestjs-pino`. Она поддерживает
|
||||
стандартные уровни логирования, отражающие важность события.
|
||||
|
||||
| Уровень | Метод | Когда использовать | Пример |
|
||||
| --------- | --------- | --------------------------------------------------- | -------------------------------- |
|
||||
| **TRACE** | `trace()` | Максимальная детализация, пошаговая трассировка | Проверка цепочки вызовов |
|
||||
| **DEBUG** | `debug()` | Отладочная информация о логике работы | Вывод промежуточных данных |
|
||||
| **INFO** | `log()` | Обычные события нормальной работы | Бренд создан |
|
||||
| **WARN** | `warn()` | Нежелательные, но некритичные ситуации | Отказ в доступе |
|
||||
| **ERROR** | `error()` | Ошибки, требующие внимания и реакции | Исключение при сохранении |
|
||||
| **FATAL** | `fatal()` | Критические сбои, приводящие к остановке приложения | Потеря соединения с базой данных |
|
||||
|
||||
> 💡 Все уровни логов фиксируются одинаково по структуре данных — различается только их
|
||||
> **важность**.
|
||||
|
||||
## Различие между dev и prod
|
||||
|
||||
Логирование настроено так, чтобы быть **удобным в разработке** и **эффективным в продакшене**.
|
||||
|
||||
| Среда | Формат | Уровень по умолчанию | Особенности |
|
||||
| --------------- | ----------------- | -------------------- | --------------------------------------------------------------------- |
|
||||
| **Development** | человеко-читаемый | `debug` | Цвета, отступы, подробные данные — удобно для чтения в консоли. |
|
||||
| **Production** | JSON | `info` | Машиночитаемый формат для централизованной агрегации и анализа логов. |
|
||||
|
||||
> Состав данных в логе всегда одинаков — меняется только способ отображения. Уровень логирования
|
||||
> можно переопределить через переменные окружения.
|
||||
|
||||
Таким образом:
|
||||
|
||||
- в **разработке** акцент на удобство восприятия и диагностику;
|
||||
- в **продакшене** — на структурированные данные и интеграцию с системами мониторинга (например,
|
||||
Loki или ELK).
|
||||
|
||||
## Где живёт настройка
|
||||
|
||||
- `apps/api/src/logger/base.ts` — единственный экземпляр pino, выбор уровня и формата вывода;
|
||||
- `apps/api/src/logger/logger.class.ts` — класс `Logger`, через который логирует код приложения;
|
||||
- `apps/api/src/logger/logger.module.ts` — модуль `LocalLoggerModule`: HTTP-логи (`pino-http`) в
|
||||
`forRoot()` и подмена логгера Nest в `setup()`;
|
||||
- `apps/api/src/logger/testing/` — логгер для тестов, `LocalLoggerModule.forTesting()`.
|
||||
@@ -0,0 +1,103 @@
|
||||
# Подключение и использование
|
||||
|
||||
## Получение логгера
|
||||
|
||||
Логгер внедряется в любой сервис, контроллер или компонент через **dependency injection**. После
|
||||
внедрения требуется указать **контекст**, чтобы логи было проще анализировать.
|
||||
|
||||
```ts
|
||||
@Injectable()
|
||||
export class BrandService {
|
||||
constructor(private readonly logger: Logger) {
|
||||
this.logger.setContext('Brands');
|
||||
}
|
||||
|
||||
async createBrand(data: CreateBrandDto) {
|
||||
this.logger.log('Brand created', { brand: 42, user: data.ownerId });
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Модуль, в котором объявлен сервис, должен импортировать `LocalLoggerModule.forRoot()` (он помечен
|
||||
`global: true`, поэтому достаточно один раз в `AppModule`).
|
||||
|
||||
## Контекст логгера
|
||||
|
||||
Контекст указывает, **к какому модулю или бизнес-процессу относится лог**. Он помогает группировать
|
||||
события и быстрее понимать источник при анализе системы.
|
||||
|
||||
Контекст задаётся вручную при инициализации логгера:
|
||||
|
||||
```ts
|
||||
constructor(private readonly logger: Logger) {
|
||||
this.logger.setContext('Evaluation');
|
||||
}
|
||||
```
|
||||
|
||||
Вне DI (в `main.ts`, в bootstrap-сценариях) логгер создаётся с контекстом в конструкторе:
|
||||
|
||||
```ts
|
||||
const logger = new Logger('Bootstrap');
|
||||
```
|
||||
|
||||
## Правила именования контекста
|
||||
|
||||
Хорошие контексты делают логи самодокументируемыми. Чтобы они оставались единообразными, следуйте
|
||||
правилам:
|
||||
|
||||
1. **Основой контекста является название модуля**, отражающее область бизнес-логики. Примеры:
|
||||
- `Brands` — работа с карточками брендов;
|
||||
- `JsonLd` — генерация структурированных данных;
|
||||
- `Users` — работа с пользователями.
|
||||
|
||||
2. **При необходимости уточнения** добавляется второй уровень через двоеточие:
|
||||
- `Brands:Passport` — паспорт бренда;
|
||||
- `Audit:History` — журнал изменений.
|
||||
|
||||
3. **Технические роли** (`Service`, `Controller` и т. п.) в названии **не используются**, так как
|
||||
контекст должен отражать **бизнес-смысл**, а не структуру кода.
|
||||
|
||||
> 💬 Контекст — часть “языка логирования” проекта. Он должен быть **стабильным, понятным и
|
||||
> единообразным** во всех модулях.
|
||||
|
||||
## Контекст запроса
|
||||
|
||||
При логировании внутри HTTP-запроса `pino-http` автоматически добавляет поля:
|
||||
|
||||
- `reqId` — идентификатор запроса;
|
||||
- `url` — метод и адрес текущего запроса.
|
||||
|
||||
Это позволяет связывать бизнес-события с конкретными запросами и упрощает анализ логов. Ручные логи
|
||||
внутри запроса достаточно писать через инжектированный `Logger` — связывать их с запросом вручную не
|
||||
нужно, но и `reqId` в `details` дублировать не следует.
|
||||
|
||||
## Переменные окружения
|
||||
|
||||
Настройки логирования задаются через `.env` или переменные окружения.
|
||||
|
||||
| Переменная | Назначение | Пример значения |
|
||||
| ------------ | ------------------------------------------------- | -------------------------------- |
|
||||
| `LOG_LEVEL` | Минимальный уровень логирования. | `debug`, `info`, `warn`, `error` |
|
||||
| `LOG_PRETTY` | Включает человеко-читаемый формат (обычно в dev). | `true` |
|
||||
|
||||
Если переменные не заданы, применяются значения по умолчанию:
|
||||
|
||||
| Окружение | Значения по умолчанию |
|
||||
| --------- | ------------------------------------ |
|
||||
| **dev** | `LOG_LEVEL=debug`, `LOG_PRETTY=true` |
|
||||
| **prod** | `LOG_LEVEL=info`, `LOG_PRETTY=false` |
|
||||
|
||||
Прод определяется как `NODE_ENV=production` (в образе api это значение выставлено в `Dockerfile`)
|
||||
или явным `LOG_PRETTY=false`. Образ api ставит только production-зависимости, а `pino-pretty` —
|
||||
dev-зависимость: если запустить контейнер без `NODE_ENV=production`, воркер pretty-транспорта не
|
||||
найдётся.
|
||||
|
||||
> 🔧 Уровень логирования можно переопределить без релиза — через переменные окружения при запуске
|
||||
> приложения.
|
||||
|
||||
## Чек-лист перед ревью
|
||||
|
||||
- [ ] Логгер подключён через dependency injection.
|
||||
- [ ] Контекст задан явно через `setContext()`.
|
||||
- [ ] Уровень логирования соответствует окружению.
|
||||
- [ ] Логи не содержат чувствительных данных.
|
||||
@@ -0,0 +1,68 @@
|
||||
# Автоматическое логирование
|
||||
|
||||
Автоматическое логирование фиксирует системные события **без участия разработчика**. Оно
|
||||
обеспечивает единый формат сообщений и полное покрытие ключевых операций платформы.
|
||||
|
||||
> 💡 Автоматические логи всегда присутствуют и формируются системой независимо от действий
|
||||
> разработчика.
|
||||
|
||||
## HTTP-запросы
|
||||
|
||||
### Общие принципы
|
||||
|
||||
- Каждый HTTP-запрос логируется **после завершения обработки**.
|
||||
- Лог формирует middleware `pino-http`, который подключается в `LocalLoggerModule.forRoot()`
|
||||
(`apps/api/src/logger/logger.module.ts`).
|
||||
- Разработчику не нужно добавлять логи вручную — они создаются автоматически.
|
||||
|
||||
Каждая запись содержит:
|
||||
|
||||
- HTTP-метод (`GET`, `POST`, `PATCH` и т. д.);
|
||||
- путь запроса (`/api/...`);
|
||||
- код ответа (`200`, `403`, `500` и т. д.);
|
||||
- время выполнения в миллисекундах (`responseTime`);
|
||||
- идентификатор запроса (`reqId`);
|
||||
- контекст `HTTP` — по нему HTTP-логи отличаются от логов приложения.
|
||||
|
||||
### Уровни логирования
|
||||
|
||||
| Категория ответа | Пример кода | Уровень |
|
||||
| ---------------- | ----------- | -------- |
|
||||
| Успешный ответ | `2xx` | `info` |
|
||||
| Ошибка клиента | `4xx` | `info` |
|
||||
| Ошибка сервера | `5xx` | `error` |
|
||||
| Редирект | `3xx` | `silent` |
|
||||
|
||||
> Уровень `warn` для HTTP-логов не используется — это предотвращает появление ложных предупреждений
|
||||
> при корректных отказах.
|
||||
|
||||
### Что не попадает в HTTP-логи
|
||||
|
||||
Middleware смонтирован на `/api/*`, поэтому есть два исключения:
|
||||
|
||||
- запрос ровно на `/api` (без слеша после префикса) — шаблон `/api/*` его не матчит;
|
||||
- всё, что обслуживает Swagger: `SwaggerModule.setup` регистрирует свои обработчики на Express
|
||||
раньше middleware `pino-http`, поэтому `/api/docs` и его статика в лог не попадают.
|
||||
|
||||
Всё остальное, включая 404 по неизвестным путям, логируется.
|
||||
|
||||
### Задачи HTTP-логов
|
||||
|
||||
- Отслеживание активности API.
|
||||
- Измерение времени обработки запросов.
|
||||
- Анализ причин ошибок и неудачных вызовов.
|
||||
- Связь действий пользователей с конкретными маршрутами.
|
||||
|
||||
## Проверки доступа и исключения
|
||||
|
||||
Логирование проверок доступа (RBAC) и необработанных исключений появится вместе с модулями, которые
|
||||
эти события порождают. До этого момента такие события в лог не попадают, и ручные логи в местах
|
||||
отказа — единственный способ их зафиксировать.
|
||||
|
||||
## Рекомендации
|
||||
|
||||
- Не дублируйте автоматические логи вручную.
|
||||
- Если требуется зафиксировать **дополнительный** контекст, добавляйте отдельный лог рядом с
|
||||
бизнес-событием — но не повторяйте уже зарегистрированные HTTP-запросы.
|
||||
- При анализе проблем **начинайте с автоматических логов** — они формируются всегда и имеют единый
|
||||
формат.
|
||||
@@ -0,0 +1,143 @@
|
||||
# Ручное логирование и бизнес-события
|
||||
|
||||
Автоматическое логирование фиксирует системные события (HTTP-запросы, ошибки), но не отражает
|
||||
**внутреннюю бизнес-логику** приложения.
|
||||
|
||||
Ручное логирование используется для фиксации действий и изменений, важных **с точки зрения
|
||||
продукта** — того, что видит или делает пользователь.
|
||||
|
||||
## Назначение
|
||||
|
||||
Ручные логи применяются для описания событий, которые отражают состояние системы и бизнес-процессы:
|
||||
|
||||
- создание, изменение и удаление сущностей;
|
||||
- начало и завершение процессов;
|
||||
- изменение статуса или состояния;
|
||||
- ошибки бизнес-операций;
|
||||
- любые другие действия, значимые для анализа и аудита.
|
||||
|
||||
> Такое логирование помогает понять, **что происходило внутри системы**, даже без включённой отладки
|
||||
> или доступа к базе данных.
|
||||
|
||||
## Правила оформления логов
|
||||
|
||||
### Общие принципы
|
||||
|
||||
Сообщения должны быть:
|
||||
|
||||
- **краткими** — не длиннее одной фразы;
|
||||
- **человеко-читаемыми** — понятными без знания кода;
|
||||
- **однозначными** — описывать факт, а не процесс;
|
||||
- **на английском**, **в прошедшем времени**, **без артиклей и пунктуации**.
|
||||
|
||||
Если операция завершилась неудачей, сообщение должно оканчиваться на `failed`.
|
||||
|
||||
Логирование выполняется **после завершения** операции — независимо от результата.
|
||||
|
||||
### Примеры сообщений
|
||||
|
||||
**Успешные операции:**
|
||||
|
||||
- `Brand created`
|
||||
- `Passport filled`
|
||||
- `JsonLd generated`
|
||||
- `Audit completed`
|
||||
|
||||
**Ошибки и неудачи:**
|
||||
|
||||
- `Brand update failed`
|
||||
- `File upload failed`
|
||||
- `JsonLd generation failed`
|
||||
|
||||
**Неправильные формулировки:**
|
||||
|
||||
- `Creating brand...` — отражает процесс, а не факт.
|
||||
- `Brand ${id} created` — содержит шаблон и динамику.
|
||||
- `Brand created successfully!` — избыточно и разговорно.
|
||||
|
||||
### Дополнительные данные
|
||||
|
||||
Контекст события передаётся отдельным объектом (`details`). Включайте только данные, которые
|
||||
действительно помогают при анализе.
|
||||
|
||||
**Рекомендации:**
|
||||
|
||||
- Всегда указывайте **идентификаторы** (`brand`, `audit`, `user` и т. д.).
|
||||
- В идентификаторах избегайте суфиксов `id` (пример: `brand` вместо `brandId`).
|
||||
- Добавляйте **причину** (`reason`) при ошибках или отказах.
|
||||
- Указывайте **новое состояние** (`status`, `result`) при изменениях.
|
||||
- Не включайте чувствительные данные — токены, e-mail, пароли, персональные сведения.
|
||||
|
||||
`details` передаются вторым аргументом на всех уровнях: `trace`, `debug`, `log`, `warn`, `error`,
|
||||
`fatal`. Логгер сам раскладывает объект в поля JSON-записи, поэтому сериализовать его в строку не
|
||||
нужно — наоборот, строка в `details` попадёт в лог как текст и потеряет структуру.
|
||||
|
||||
**Пример:**
|
||||
|
||||
```ts
|
||||
logger.log('Brand created', { brand: 42, user: 7 });
|
||||
logger.error('Brand update failed', { brand: 42, reason: 'invalid_status' });
|
||||
```
|
||||
|
||||
Ошибку со стеком можно передать третьим аргументом — тогда он попадёт в лог как `trace`:
|
||||
|
||||
```ts
|
||||
logger.error('JsonLd generation failed', error.stack, { brand: 42 });
|
||||
```
|
||||
|
||||
### Как объект попадает в запись
|
||||
|
||||
Сигнатура `LoggerService` в Nest описывает `error(message, stack, context)`, а
|
||||
`log(message, ...optionalParams)` — без отдельного места под объект. Наш `Logger`
|
||||
(`logger.class.ts`) приводит вызов к форме pino: `logger[level](details, message)`. Поэтому:
|
||||
|
||||
- `details` — обычный объект, не JSON-строка;
|
||||
- для `error()` второй аргумент со строковым стеком уезжает в поле `trace`, а объект `details` можно
|
||||
передать вторым или третьим аргументом.
|
||||
|
||||
## Бизнес-события
|
||||
|
||||
### Что считается бизнес-событием
|
||||
|
||||
Бизнес-события описывают **действия и изменения на уровне предметной области**, например:
|
||||
|
||||
- `Brand created` — бренд заведён;
|
||||
- `Passport filled` — паспорт бренда заполнен;
|
||||
- `JsonLd exported` — структурированные данные выгружены;
|
||||
- `Audit completed` — NAP-аудит завершён.
|
||||
|
||||
> Все бизнес-события логируются на уровне `info` (`logger.log()`), а ошибки бизнес-операций — на
|
||||
> уровне `error`.
|
||||
|
||||
### Длительные процессы
|
||||
|
||||
Для долгих операций допускается логирование **двух фаз**:
|
||||
|
||||
- начало — `<Action> started`;
|
||||
- завершение — `<Action>` (применяются обычные правила оформления сообщений).
|
||||
|
||||
**Пример:**
|
||||
|
||||
```ts
|
||||
logger.log('JsonLd export started', { brand: 3 });
|
||||
logger.log('JsonLd exported', { brand: 3, durationMs: 14250 });
|
||||
logger.error('JsonLd export failed', { brand: 3, reason: 'timeout' });
|
||||
```
|
||||
|
||||
Такой подход позволяет отслеживать прогресс и измерять длительность операций.
|
||||
|
||||
### Зачем нужны бизнес-события
|
||||
|
||||
- Повышают прозрачность бизнес-процессов.
|
||||
- Используются при анализе и аудите.
|
||||
- Позволяют отследить жизненный цикл сущностей — от создания до завершения.
|
||||
- Упрощают поиск причин ошибок на уровне сценариев пользователей.
|
||||
|
||||
## Чек-лист перед ревью
|
||||
|
||||
- [ ] Контекст логгера задан.
|
||||
- [ ] Сообщение короткое, на английском и в прошедшем времени.
|
||||
- [ ] В `details` указаны идентификаторы и причина (если применимо).
|
||||
- [ ] Уровень логирования выбран корректно (`info` или `error`).
|
||||
- [ ] Лог не дублирует автоматические записи (HTTP).
|
||||
- [ ] Отсутствуют конфиденциальные данные.
|
||||
@@ -0,0 +1,159 @@
|
||||
# Тестирование логирования
|
||||
|
||||
## Подключение
|
||||
|
||||
Для тестов следует подключать специальный модуль — **`LocalLoggerModule.forTesting()`**. Он
|
||||
сохраняет логи в памяти и предоставляет к ним доступ через `TestingLogger`.
|
||||
|
||||
Это позволяет:
|
||||
|
||||
- перехватывать все вызовы логгера внутри тестируемого кода;
|
||||
- сохранять их в память вместо вывода в консоль;
|
||||
- проверять, какие именно логи были собраны за время теста.
|
||||
|
||||
Пример подключения через NestJS `TestingModule`:
|
||||
|
||||
```ts
|
||||
let logger: TestingLogger;
|
||||
|
||||
beforeEach(async () => {
|
||||
const module = await Test.createTestingModule({
|
||||
imports: [LocalLoggerModule.forTesting()],
|
||||
}).compile();
|
||||
|
||||
logger = module.get(TestingLogger);
|
||||
});
|
||||
```
|
||||
|
||||
После такого подключения любые вызовы вида:
|
||||
|
||||
```ts
|
||||
this.logger.log('Brand created');
|
||||
this.logger.error('Brand update failed');
|
||||
```
|
||||
|
||||
будут сохранены внутри `TestingLogger`, и вы сможете проверить их в тестах при помощи матчеров:
|
||||
|
||||
```ts
|
||||
logger.withMessage('Brand created').withLevel('info').toBeLoggedOnce();
|
||||
logger.withMessage('Brand update failed').withLevel('error').toBeLogged();
|
||||
```
|
||||
|
||||
## Цепочка фильтров
|
||||
|
||||
Методы фильтрации (`withMessage`, `withLevel`, `withContext`, `withDetails`) можно вызывать
|
||||
цепочкой, для более точного сопоставления логов:
|
||||
|
||||
```ts
|
||||
logger
|
||||
.withMessage('Brand created')
|
||||
.withLevel('info')
|
||||
.withContext('Brands')
|
||||
.withDetails({ user: 5 })
|
||||
.toBeLoggedOnce();
|
||||
```
|
||||
|
||||
Метод `withDetails` поддерживает частичное сравнение объекта, а также может проверять поля `level`,
|
||||
`context` и `message`:
|
||||
|
||||
```ts
|
||||
logger
|
||||
.withMessage('Brand created')
|
||||
.withDetails({
|
||||
level: 'info',
|
||||
context: 'Brands',
|
||||
user: 5,
|
||||
})
|
||||
.toBeLoggedOnce();
|
||||
```
|
||||
|
||||
Если нужны только поля из фильтра и ничего лишнего в `details`, к цепочке добавляется
|
||||
`strictDetails()`.
|
||||
|
||||
### Просмотр найденных записей
|
||||
|
||||
Если нужно отладить фильтр и просмотреть, какие записи были найдены по текущему фильтру, можно
|
||||
использовать метод `showLogs()`:
|
||||
|
||||
```ts
|
||||
logger.withLevel('error').showLogs().toBeLogged();
|
||||
```
|
||||
|
||||
### Методы проверки
|
||||
|
||||
| Метод | Описание |
|
||||
| -------------------- | --------------------------------------------------------- |
|
||||
| `toBeLogged()` | Проверяет, что хотя бы одна запись соответствует фильтру. |
|
||||
| `toBeNotLogged()` | Проверяет, что таких записей нет. |
|
||||
| `toBeLoggedOnce()` | Проверяет, что запись встречается ровно один раз. |
|
||||
| `toBeLoggedTimes(n)` | Проверяет, что запись встречается `n` раз. |
|
||||
|
||||
Все методы выбрасывают ошибку, если условие не выполняется.
|
||||
|
||||
> **Важно:** Методы проверки **обязательно** должны вызываться, иначе проверки так и не будет.
|
||||
|
||||
### Группирование проверок
|
||||
|
||||
Если в тесте нужно проверить несколько событий с общим набором полей, можно использовать такой
|
||||
приём:
|
||||
|
||||
```ts
|
||||
const brandsLogger = logger.withContext('Brands');
|
||||
|
||||
brandsLogger.withMessage('Brand created').toBeLoggedTimes(2);
|
||||
|
||||
brandsLogger.withMessage('Brand update failed').toBeLoggedOnce();
|
||||
```
|
||||
|
||||
Это удобно для группировки проверок по контексту или другим общим параметрам.
|
||||
|
||||
## Примеры использования
|
||||
|
||||
### Проверка бизнес-события
|
||||
|
||||
```ts
|
||||
it('должен логировать создание бренда', () => {
|
||||
service.createBrand({ user: 7 });
|
||||
|
||||
logger.withMessage('Brand created').withLevel('info').withDetails({ user: 7 }).toBeLoggedOnce();
|
||||
});
|
||||
```
|
||||
|
||||
### Проверка ошибок
|
||||
|
||||
```ts
|
||||
it('должен логировать ошибку при невалидном статусе', () => {
|
||||
service.updateBrandStatus(42, 'invalid');
|
||||
|
||||
logger.withMessage('Brand update failed').withLevel('error').toBeLogged();
|
||||
});
|
||||
```
|
||||
|
||||
### Проверка отсутствия логов
|
||||
|
||||
```ts
|
||||
it('не должен логировать ничего при успешном выполнении без событий', () => {
|
||||
service.doNothing();
|
||||
|
||||
logger.any().toBeNotLogged();
|
||||
});
|
||||
```
|
||||
|
||||
### Очистка
|
||||
|
||||
```ts
|
||||
beforeEach(() => {
|
||||
logger.clear();
|
||||
});
|
||||
```
|
||||
|
||||
Используйте `clear()` для сброса состояния между тестами, если экземпляр `TestingLogger`
|
||||
переиспользуется в нескольких сценариях.
|
||||
|
||||
## Рекомендации
|
||||
|
||||
- `TestingLogger` предназначен **только для тестов** — в рабочем коде используется обычный `Logger`.
|
||||
- Проверяйте **факт логирования**, а не реализацию — тесты должны оставаться устойчивыми к
|
||||
внутренним изменениям.
|
||||
- Используйте `toBeNotLogged()` для сценариев, где событие **не должно** быть зафиксировано.
|
||||
- Готовый пример работы с `TestingLogger` — `apps/api/src/logger/testing/testing-logger.spec.ts`.
|
||||
Loaded 100 of 109 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user