Skip to content

Commit ff514fb

Browse files
committed
updated AGENTS.md
1 parent a09c0d6 commit ff514fb

File tree

1 file changed

+53
-21
lines changed

1 file changed

+53
-21
lines changed

AGENTS.md

Lines changed: 53 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,47 +2,79 @@
22

33
## 🚨 CRITICAL RULES - MUST ALWAYS BE FOLLOWED 🚨
44

5-
1. **NEVER mark a feature as done until `task all` is passing**
6-
2. **ALWAYS run `task all` before claiming completion**
5+
1. **NEVER mark a feature as done until `task ci` is passing**
6+
2. **ALWAYS run `task ci` before claiming completion**
77
3. **NO EXCEPTIONS to the above rules - features are NOT complete until all checks pass**
88
4. **This rule must ALWAYS be followed no matter what**
99

1010
## Commands
1111

12+
All commands use [Task](https://taskfile.dev) - run `task --list` to see all available tasks.
13+
1214
### Core Commands
1315

1416
- Setup: `scripts/setup.sh`
15-
- Run all checks: `task all` (runs typecheck, export, lint, test, etc.)
16-
- Run all checks with auto-fix: `task fix`
17+
- Run full CI validation: `task ci` (typecheck, lint, spellcheck, tests, etc.)
18+
- Auto-fix lint issues then run CI: `task fix`
1719
- Interactive console: `scripts/console.rb`
1820

1921
### Testing Commands
2022

21-
- Run all tests (unit + Rails integration): `scripts/all_tests.sh`
22-
- Run all Ruby unit tests: `scripts/test.rb`
23-
- Run single test file: `scripts/test.rb test/path_to_test.rb`
24-
- Run test at specific line: `scripts/test.rb test/path_to_test.rb:LINE_NUMBER`
25-
- Run test by name: `scripts/test.rb -n=test_method_name`
23+
- Run all tests (unit + Rails integration): `task test`
24+
- Run Ruby unit tests only: `task ruby:test`
25+
- Run Rails integration tests: `task rails:test`
26+
- Run Rails tests for all supported versions: `task rails:test:matrix`
27+
- Run frontend tests: `task docs:test`
28+
- Run single test file: `bundle exec ruby scripts/test.rb test/path_to_test.rb`
29+
- Run test at specific line: `bundle exec ruby scripts/test.rb test/path_to_test.rb:LINE_NUMBER`
30+
- Run test by name: `bundle exec ruby scripts/test.rb -n=test_method_name`
2631
- Debug a specific test: Add `debugger` statements (developer only)
27-
- Run Rails integration tests: `scripts/rails_tests.sh`
28-
- Merge coverage reports: `scripts/merge_coverage.sh`
29-
- Run Next.js TypeScript tests: `cd docs && npm test`
32+
- Merge coverage reports: `task ruby:coverage:merge`
3033

3134
### Quality Commands
3235

33-
- Ruby typecheck: `scripts/typecheck.sh`
34-
- Next.js typecheck: `cd docs && pnpm exec tsc --noEmit`
35-
- Lint Ruby: `bin/rubocop`
36-
- Format Ruby: `bin/rubocop -A`
37-
- Format JS/TS/JSON: `scripts/prettier.sh --write`
38-
- Lint JS/TS/JSON: `scripts/prettier.sh --check`
39-
- Spellcheck: `scripts/spellcheck.sh`
36+
- Run all typechecking: `task typecheck`
37+
- Run all linting: `task lint`
38+
- Auto-fix all lint issues: `task lint:fix`
39+
- Spellcheck: `task spellcheck`
40+
41+
#### Ruby Commands
42+
43+
- Ruby typecheck: `task ruby:typecheck`
44+
- Lint Ruby: `task ruby:lint`
45+
- Format Ruby: `task ruby:lint:fix`
46+
47+
#### Frontend Commands
48+
49+
- Next.js typecheck: `task docs:typecheck`
50+
- Lint frontend: `task docs:lint`
51+
- Auto-fix frontend lint: `task docs:lint:fix`
52+
53+
#### Formatting Commands
54+
55+
- Format all files (JS/TS/JSON/YAML/MD): `task prettier:write`
56+
- Check formatting: `task prettier:check`
4057

4158
### Development Commands
4259

43-
- Generate Sorbet RBI files: `scripts/tapioca.rb`
60+
- Generate all (structs + catalog): `task generate`
61+
- Generate Sorbet RBI files: `task ruby:tapioca`
4462
- Generate spellcheck dictionary: `scripts/generate_lockfile_words.sh`
45-
- Generate TypeScript + Ruby structs from YAML schemas: `scripts/generate_structs.rb`
63+
- Check generated files are up to date: `task ruby:check-generated`
64+
65+
### Documentation Commands
66+
67+
- Generate YARD docs: `task yard:generate`
68+
- Clean YARD docs: `task yard:clean`
69+
- Regenerate YARD docs: `task yard:regen`
70+
- Open YARD docs in browser: `task yard:open`
71+
72+
### Gem Commands
73+
74+
- Build gem: `task gem:build`
75+
- Install gem locally: `task gem:install`
76+
- Install gem without network: `task gem:install:local`
77+
- Release gem to RubyGems: `task gem:release`
4678

4779
## Terraform Provider repo in this workspace
4880

0 commit comments

Comments
 (0)