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
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Removed (BREAKING)

- **post-commit hook removed from the product** (GH #167). Refresh policy
belongs to the orchestrator/consumer, not the generator: `loomgraph index`
already re-exports on every run for the graph path, and README_AI refresh
is release-time or manual (`codeindex scan-all`). Removed with it:
`hooks install post-commit`, the hidden `hooks run`, `hooks rerun`, the
`hooks.post_commit` config section (modes auto/disabled/async/sync/prompt),
and the GH #87 install-time enabled-warning. **Migration**: if you had the
hook installed, run `codeindex hooks uninstall post-commit` (still
accepted for cleanup); refresh indexes with `codeindex scan-all` whenever
you want them fresh. The codeindex repo itself refreshes at release time
(`scripts/release.sh` step 6.5, GH #166).

### Changed

- **README_AI refresh moved from per-commit to release-time** (GH #166).
Expand Down
3 changes: 1 addition & 2 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,11 +241,10 @@ This project uses [codeindex](https://github.com/dreamlx/codeindex) (v0.36.0) fo

### Commands & escape hatches

Full reference: `codeindex --help`. The non-obvious ones:
Full reference: `codeindex --help`. The non-obvious one:

```bash
codeindex scan-all --ai --retry-all # force re-enrich every dir, ignore cache
codeindex hooks rerun post-commit # force-rerun hook vs HEAD (bypasses loop guard)
```

Transient AI failures (`⚠ <dir>: AI error`) → re-run `codeindex scan-all --ai`; successes restore from cache, only failures retry. Persistent → swap model in `ai_command` (`.codeindex.yaml`).
Expand Down
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ Full data incl. the failure cases: **[2026-05 benchmark](docs/benchmark/2026-05-
- **Two-phase documentation pipeline** (v0.23.0) — Phase 1: structural README_AI.md via SmartWriter; Phase 2: AI generates one-line functional descriptions per module. AI agents can browse README_AI.md hierarchy and find the right module **without grep**.
- **Smart indexing** — Tiered documentation (overview → navigation → detailed) optimized for AI agents, ≤10KB per file (navigation index, not a tech doc — see [ADR-005](docs/architecture/adr/005-navigation-disclaimer-and-readme-size-cap.md))
- **Auto-AI enrichment** — When an AI backend is configured (`ai:` section per [ADR-008](docs/architecture/adr/008-direct-http-api-ai-default.md), or `ai_command` CLI escape hatch), `scan-all` automatically enables AI module descriptions. Use `--no-ai` to opt out
- **Auto-update hooks** — Optional post-commit hook (`codeindex hooks install`) regenerates README_AI.md for changed directories. Thin wrapper pattern: `pipx upgrade ai-codeindex` auto-updates hook logic

### Parsing & Analysis

Expand All @@ -58,7 +57,7 @@ Full data incl. the failure cases: **[2026-05 benchmark](docs/benchmark/2026-05-

- **Adaptive symbol extraction** — Dynamic 5–150 symbols per file based on size
- **CLAUDE.md injection** — `codeindex init` injects a codeindex section into your **project's** `CLAUDE.md` (never `~/.claude`)
- **Claude Code plugin** — `codeindex:arch` / `:index` / `:hooks` / `:update-guide` skills via [dreamlx/codeindex-claude](https://github.com/dreamlx/codeindex-claude)
- **Claude Code plugin** — `codeindex:arch` / `:index` / `:update-guide` skills via [dreamlx/codeindex-claude](https://github.com/dreamlx/codeindex-claude)
- **Template-based test generation** — YAML + Jinja2 for rapid language support (88–91% time savings)
- **Parallel scanning** — Concurrent directory processing with configurable workers

Expand Down Expand Up @@ -124,7 +123,6 @@ codeindex, LoomGraph has nothing to index. See [LoomGraph Integration Guide](doc
# Personal developer workflow
codeindex init # Setup CLAUDE.md integration
codeindex scan-all # Structural + AI descriptions (auto)
codeindex hooks install post-commit # Auto-update on commit
# Claude Code reads README_AI.md → understands module purpose → uses Serena for details
```

Expand All @@ -141,7 +139,7 @@ pipx install ai-codeindex
```

> **Claude Code users** — also install the companion plugin for skills
> (`codeindex:arch` / `:index` / `:hooks` / `:update-guide`):
> (`codeindex:arch` / `:index` / `:update-guide`):
> ```
> /plugin marketplace add dreamlx/codeindex-claude
> /plugin install codeindex@codeindex-claude
Expand Down Expand Up @@ -255,7 +253,6 @@ codeindex affected --since HEAD~5
| `codeindex parse <file>` | Parse single file to JSON | [LoomGraph Integration](docs/guides/loomgraph-integration.md) |
| `codeindex tech-debt ./src` | Code quality analysis (debt + test smells) | Enhanced in v0.22.0 |
| `codeindex debt-scan ./src` | Alias for tech-debt | Backward compatibility |
| `codeindex hooks install` | Git hooks for auto-update | [Git Hooks Guide](docs/guides/git-hooks-integration.md) |
| `codeindex doctor` | Health/sync check (CLI, parsers, CLAUDE.md, plugin) | Read-only diagnostic |
| `codeindex config explain <param>` | Parameter help | [Configuration Guide](docs/guides/configuration.md) |

Expand All @@ -274,7 +271,6 @@ codeindex affected --since HEAD~5
|-------|--------------|
| `codeindex:arch` | Answer architecture / "where is X" questions from `README_AI.md` |
| `codeindex:index` | Walk you through `codeindex init` → `scan-all` |
| `codeindex:hooks` | Set up the auto-update post-commit hook |
| `codeindex:update-guide` | Refresh the codeindex section in your project's `CLAUDE.md` |

`codeindex init` also injects a codeindex section into your project's `CLAUDE.md`
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ codeindex 文档导航。codeindex 是 [LoomGraph](https://github.com/dreamlx/Lo
- **[graph-export](guides/graph-export.md)** — NDJSON graph export 用法与 schema
- **[LoomGraph Integration](guides/loomgraph-integration.md)** — 两仓数据流
- **[Claude Code Integration](guides/claude-code-integration.md)** — plugin/skills 集成
- **[Git Hooks](guides/git-hooks-integration.md)** — pre/post-commit hooks
- **[Git Hooks](guides/git-hooks-integration.md)** — pre-commit / pre-push hooks
- **[JSON Output](guides/json-output-integration.md)** — JSON 输出消费
- **[Contributing](guides/contributing.md)** — TDD workflow、代码风格

Expand Down
6 changes: 0 additions & 6 deletions docs/development/team-workflow-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,12 +160,6 @@ Checks **staged Python files only** — fast, targeted.
1. **ruff lint** — style, imports, unused vars, debug code (T100/T201 rules catch `print()` and `breakpoint()`)
2. Reports exact line numbers. Fix then re-stage.

### post-commit (runs after `git commit`)
Runs in background, non-blocking.

1. **codeindex scan** — regenerates README_AI.md for changed directories
2. Logs to `~/.codeindex/hooks/post-commit.log` (check here if indexes seem stale)

### pre-push (runs on `git push`)
Last gate before code leaves your machine.

Expand Down
3 changes: 1 addition & 2 deletions docs/guides/advanced-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -404,12 +404,11 @@ codeindex parse myfile.py | jq .
Automatically regenerate indexes on commit using codeindex's built-in hooks:

```bash
# Install all hooks (pre-commit + post-commit)
# Install all hooks (pre-commit + pre-push)
codeindex hooks install --all

# Or install individually
codeindex hooks install pre-commit
codeindex hooks install post-commit

# Check hook status
codeindex hooks status
Expand Down
7 changes: 3 additions & 4 deletions docs/guides/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -445,9 +445,8 @@ Optional improvements available:
- AI-powered multi-language documentation normalization
- Add `docstrings` section

4. **Git Hooks Configuration** (v0.7.0)
- Configurable post-commit behavior (5 modes)
- Add `hooks:` section or use CLI: `codeindex hooks install --all`
4. **Git Hooks Configuration** (v0.7.0; post-commit modes removed in GH #167)
- Install via CLI: `codeindex hooks install --all`

5. **Config Explain** (v0.14.0)
- Interactive help for any config parameter
Expand Down Expand Up @@ -501,7 +500,7 @@ tech_debt:
```bash
# Explain any config parameter (v0.14.0+)
codeindex config explain parallel_workers
codeindex config explain hooks.post_commit.mode
codeindex config explain output_file

# Future: auto-upgrade
codeindex config upgrade # Planned
Expand Down
Loading
Loading