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

## What this project is

`parse_packwerk` is a low-dependency Ruby gem for parsing and writing the YAML files that packwerk uses: `package.yml` (package config) and `package_todo.yml` (recorded violations).

## Commands

```bash
bundle install

# Run all tests (RSpec)
bundle exec rspec

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

# Lint
bundle exec rubocop
bundle exec rubocop -a # auto-correct

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

## Architecture

- `lib/parse_packwerk.rb` — entry point; `ParsePackwerk.all` returns all packages
- `lib/parse_packwerk/` — `Package` (parses `package.yml`), `PackageTodo` (parses `package_todo.yml`), and YAML write-back helpers that preserve comments and ordering
- `spec/` — RSpec tests
1 change: 1 addition & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@AGENTS.md
Loading