Skip to content

Commit 214da5b

Browse files
committed
Add AGENTS.md and CLAUDE.md for AI coding agent guidance
1 parent 3e2b7b1 commit 214da5b

2 files changed

Lines changed: 28 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# AGENTS.md
2+
3+
This file provides guidance to AI coding agents when working with code in this repository.
4+
5+
## What this project is
6+
7+
A Visual Studio Code extension that integrates [packwerk](https://github.com/Shopify/packwerk) checks directly into the editor. It runs `packwerk check` (or `pks check`) on the current Ruby file and surfaces violations inline.
8+
9+
## Commands
10+
11+
```bash
12+
npm install
13+
14+
# Compile TypeScript
15+
npm run vscode:prepublish # production compile (tsc)
16+
17+
# Watch mode during development
18+
npm run compile # tsc --watch
19+
20+
# Run tests
21+
npm test
22+
```
23+
24+
## Architecture
25+
26+
- `src/` — TypeScript source; extension entry point registers a command that shells out to the packwerk/pks binary and parses its output into VS Code diagnostics
27+
- `package.json` — declares the VS Code extension manifest, activation events, and contributed commands

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@AGENTS.md

0 commit comments

Comments
 (0)