Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,11 @@ jobs:

- name: Run tests
run: go test -count=1 -race ./...
working-directory: tools

- name: Run vet
run: go vet ./...
working-directory: tools

- name: Check formatting
run: |
Expand All @@ -37,6 +39,7 @@ jobs:
gofmt -d .
exit 1
fi
working-directory: tools

- name: Build and run validator
env:
Expand All @@ -49,6 +52,7 @@ jobs:
"$RUNNER_TEMP/memory-bank" lint --json > "$RUNNER_TEMP/memory-bank.json"
"$RUNNER_TEMP/memory-bank-lint" --json > "$RUNNER_TEMP/memory-bank-lint.json"
cmp "$RUNNER_TEMP/memory-bank.json" "$RUNNER_TEMP/memory-bank-lint.json"
working-directory: tools

release-config:
runs-on: ubuntu-latest
Expand All @@ -68,3 +72,4 @@ jobs:
distribution: goreleaser
version: "~> v2"
args: check
workdir: tools
8 changes: 8 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,14 @@ jobs:
distribution: goreleaser
version: "~> v2"
args: release --clean
workdir: tools
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
HOMEBREW_TAP_GITHUB_TOKEN: ${{ secrets.HOMEBREW_TAP_GITHUB_TOKEN }}

- name: Publish Go module tag
env:
RELEASE_TAG: ${{ github.ref_name }}
run: |
git tag "tools/${RELEASE_TAG}"
git push origin "tools/${RELEASE_TAG}"
4 changes: 2 additions & 2 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@

- `rg --files memory-bank` для проверки структуры и имён файлов;
- `memory-bank lint` для аудита ссылок, reachability и expected README-индексов внутри `memory-bank/`;
- `go test -count=1 -race ./...` для проверки валидатора и его JSON-контракта без test cache;
- `go vet ./...` для статической проверки Go-кода;
- `go test -count=1 -race ./...` из `tools/` для проверки валидатора и его JSON-контракта без test cache;
- `go vet ./...` из `tools/` для статической проверки Go-кода;
- `git diff --check` для поиска лишних пробелов и conflict markers;
- `sed -n '1,120p' path/to/doc.md` для быстрой проверки frontmatter и заголовков;
- `rg -n "PROJECT_SPECIFIC_TERM" memory-bank` с реальными терминами downstream-проекта, чтобы убедиться, что project-specific детали не протекли обратно в шаблон.
Expand Down
8 changes: 4 additions & 4 deletions docs/adoption.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Внедрение Memory Bank в проект

Этот документ описывает, как подключить Memory Bank к существующему или новому проекту. В downstream-проект устанавливается каталог `memory-bank/`, а внутри него создаётся служебный `memory-bank/.lock`; dev-инфраструктура этого репозитория (`cmd/`, `.github/`, `.goreleaser.yml`, `go.mod`, `docs/`) не является частью шаблона приложения. Lock создаёт `memory-bank init`, а не upstream template. Его нужно коммитить: он хранит версию источника и ownership-границу для безопасных обновлений.
Этот документ описывает, как подключить Memory Bank к существующему или новому проекту. В downstream-проект устанавливается каталог `memory-bank/`, а внутри него создаётся служебный `memory-bank/.lock`; dev-инфраструктура этого репозитория (`tools/`, `.github/`, `docs/`) не является частью шаблона приложения. Lock создаёт `memory-bank init`, а не upstream template. Его нужно коммитить: он хранит версию источника и ownership-границу для безопасных обновлений.

## Что копировать

Expand Down Expand Up @@ -120,7 +120,7 @@ codex --search \
Для локального аудита установите `memory-bank` как внешний бинарник:

```bash
go install github.com/dapi/memory-bank/cmd/memory-bank@latest
go install github.com/dapi/memory-bank/tools/cmd/memory-bank@latest
```

После этого из любого места внутри downstream Git-репозитория:
Expand All @@ -133,7 +133,7 @@ memory-bank lint

## Подключить CI

CI-проверка Memory Bank должна быть opt-in в downstream-проекте. Не копируйте `.github/workflows/ci.yml` из этого репозитория: он предназначен для разработки самого шаблона и собирает локальный Go CLI из `cmd/memory-bank`.
CI-проверка Memory Bank должна быть opt-in в downstream-проекте. Не копируйте `.github/workflows/ci.yml` из этого репозитория: он предназначен для разработки самого шаблона и собирает локальный Go CLI из `tools/cmd/memory-bank`.

Перед подключением выберите конкретный release tag или commit CLI. Если оставить `@latest`, новая версия `memory-bank` сможет изменить результат проверки без изменений в downstream-репозитории.

Expand Down Expand Up @@ -167,7 +167,7 @@ jobs:
cache: false

- name: Install memory-bank
run: go install "github.com/dapi/memory-bank/cmd/memory-bank@${MEMORY_BANK_VERSION}"
run: go install "github.com/dapi/memory-bank/tools/cmd/memory-bank@${MEMORY_BANK_VERSION}"

- name: Audit Memory Bank
run: memory-bank lint
Expand Down
22 changes: 14 additions & 8 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,19 @@
CLI разделён на тонкие entrypoint'ы и переиспользуемые внутренние пакеты:

```text
cmd/memory-bank/ основной entrypoint
cmd/memory-bank-lint/ compatibility entrypoint
internal/cli/ subcommands, flags и общий output/error contract
internal/lint/ audit-движок, отчёт и testdata
internal/repository/ общий repo root discovery
tools/
go.mod самостоятельный Go-модуль CLI
cmd/memory-bank/ основной entrypoint
cmd/memory-bank-lint/ compatibility entrypoint
internal/cli/ subcommands, flags и общий output/error contract
internal/lint/ audit-движок, отчёт и testdata
internal/repository/ общий repo root discovery
```

Оба бинарника вызывают `internal/cli`; lint-семантика и JSON contract принадлежат `internal/lint`. Новые команды добавляются в общий dispatcher `memory-bank`, а не отдельными бинарниками.

CLI публикуется как вложенный Go-модуль `github.com/dapi/memory-bank/tools`. Release workflow запускается по обычному тегу `vX.Y.Z`, а после успешной публикации создаёт соответствующий module tag `tools/vX.Y.Z`, который требуется командам `go install` и `go run`.

## Локальная разработка

Требуется Go версии `1.21` или новее. `rg` используется для быстрой проверки структуры шаблона.
Expand All @@ -24,27 +28,29 @@ internal/repository/ общий repo root discovery

```bash
rg --files memory-bank
cd tools
gofmt -w $(rg --files cmd internal -g '*.go')
go test -count=1 -race ./...
go vet ./...
go run ./cmd/memory-bank lint
cd ..
git diff --check
```

Если проверка запускается не из Git-репозитория или нужно проверить другой checkout:

```bash
go run ./cmd/memory-bank lint --repo-root /path/to/repository
(cd tools && go run ./cmd/memory-bank lint --repo-root /path/to/repository)
```

## Изменение JSON-контракта

Golden report для CLI лежит в `internal/lint/testdata/expected-report.json`.
Golden report для CLI лежит в `tools/internal/lint/testdata/expected-report.json`.

Меняйте его только если contract отчёта изменился намеренно. После такого изменения проверьте:

```bash
go test ./...
(cd tools && go test ./...)
```

## Документационный шаблон
Expand Down
6 changes: 3 additions & 3 deletions docs/memory-bank-lint.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
Для регулярных проверок установите CLI один раз. Требуется Go версии `1.21` или новее:

```bash
go install github.com/dapi/memory-bank/cmd/memory-bank-lint@latest
go install github.com/dapi/memory-bank/tools/cmd/memory-bank-lint@latest
```

`go install` помещает бинарник в `GOBIN` или `GOPATH/bin`; этот каталог должен находиться в `PATH`. Повторите ту же команду, чтобы обновить CLI до актуальной версии.
Expand All @@ -33,7 +33,7 @@ command -v memory-bank-lint
Если репозиторий уже клонирован и нужно установить версию из текущего checkout:

```bash
go install ./cmd/memory-bank-lint
(cd tools && go install ./cmd/memory-bank-lint)
```

## Запуск
Expand Down Expand Up @@ -82,7 +82,7 @@ memory-bank-lint \
Для разовой проверки без установки CLI:

```bash
go run github.com/dapi/memory-bank/cmd/memory-bank-lint@latest
go run github.com/dapi/memory-bank/tools/cmd/memory-bank-lint@latest
```

Установку из GitHub Releases или через Homebrew используйте только после фактической публикации соответствующих release assets и Cask; если их ещё нет, используйте `go install`.
Expand Down
6 changes: 3 additions & 3 deletions docs/memory-bank.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Ownership-контракт, классы файлов и atomic update policy о
Для регулярных проверок установите CLI один раз. Требуется Go версии `1.21` или новее:

```bash
go install github.com/dapi/memory-bank/cmd/memory-bank@latest
go install github.com/dapi/memory-bank/tools/cmd/memory-bank@latest
```

`go install` помещает бинарник в `GOBIN` или `GOPATH/bin`; этот каталог должен находиться в `PATH`. Повторите ту же команду, чтобы обновить CLI до актуальной версии.
Expand All @@ -37,7 +37,7 @@ command -v memory-bank
Если репозиторий уже клонирован и нужно установить версию из текущего checkout:

```bash
go install ./cmd/memory-bank
(cd tools && go install ./cmd/memory-bank)
```

## Запуск
Expand Down Expand Up @@ -86,7 +86,7 @@ memory-bank lint \
Для разовой проверки без установки CLI:

```bash
go run github.com/dapi/memory-bank/cmd/memory-bank@latest lint
go run github.com/dapi/memory-bank/tools/cmd/memory-bank@latest lint
```

Установку из GitHub Releases или через Homebrew используйте только после фактической публикации соответствующих release assets и Cask; если их ещё нет, используйте `go install`.
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package main
import (
"os"

"github.com/dapi/memory-bank/internal/cli"
"github.com/dapi/memory-bank/tools/internal/cli"
)

var version = "dev"
Expand Down
2 changes: 1 addition & 1 deletion cmd/memory-bank/main.go → tools/cmd/memory-bank/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package main
import (
"os"

"github.com/dapi/memory-bank/internal/cli"
"github.com/dapi/memory-bank/tools/internal/cli"
)

var version = "dev"
Expand Down
2 changes: 1 addition & 1 deletion go.mod → tools/go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/dapi/memory-bank
module github.com/dapi/memory-bank/tools

go 1.21

Expand Down
File renamed without changes.
6 changes: 3 additions & 3 deletions internal/cli/cli.go → tools/internal/cli/cli.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ import (
"path/filepath"
"sort"

"github.com/dapi/memory-bank/internal/lint"
"github.com/dapi/memory-bank/internal/ownership"
"github.com/dapi/memory-bank/internal/repository"
"github.com/dapi/memory-bank/tools/internal/lint"
"github.com/dapi/memory-bank/tools/internal/ownership"
"github.com/dapi/memory-bank/tools/internal/repository"
)

const (
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (
"strings"
"testing"

"github.com/dapi/memory-bank/internal/lint"
"github.com/dapi/memory-bank/tools/internal/lint"
)

func testRepository(t *testing.T) string {
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading