Skip to content

Commit 29564b6

Browse files
authored
Merge pull request #15 from rubyatscale/add-claude-agents-md
Add AGENTS.md and CLAUDE.md for AI coding agent guidance
2 parents 3e2b7b1 + ab1ef22 commit 29564b6

2 files changed

Lines changed: 26 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
This file provides guidance to AI coding agents when working with code in this repository.
2+
3+
## What this project is
4+
5+
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.
6+
7+
## Commands
8+
9+
```bash
10+
npm install
11+
12+
# Compile TypeScript
13+
npm run vscode:prepublish # production compile (tsc)
14+
15+
# Watch mode during development
16+
npm run compile # tsc --watch
17+
18+
# Run tests
19+
npm test
20+
```
21+
22+
## Architecture
23+
24+
- `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
25+
- `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)