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
26 changes: 26 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
This file provides guidance to AI coding agents when working with code in this repository.

## What this project is

`visualize_packs` is a Ruby gem that generates visual diagrams of pack connections in a Rails application using [packs](https://github.com/rubyatscale/packs) and packwerk. It helps teams understand dependency relationships and identify architectural issues.

## Commands

```bash
bundle install

# Run all tests (RSpec)
bundle exec rspec

# Run a single spec file
bundle exec rspec spec/path/to/spec.rb

# Type checking (Sorbet)
bundle exec srb tc
```

## Architecture

- `lib/visualize_packs.rb` — entry point; reads pack configuration and produces graph output
- `lib/visualize_packs/` — core logic: graph building, layout, and rendering (e.g. to DOT/SVG)
- `spec/` — RSpec tests; `spec/sample_app1/` contains a sample pack-structured application used in tests
1 change: 1 addition & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@AGENTS.md