awesome-agv 1.0.4 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -5
- package/bin/awesome-agv.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -22,6 +22,8 @@
|
|
|
22
22
|
|
|
23
23
|
Instead of just generating code that works, the rules and skills ensures agents generate code that **survives**.
|
|
24
24
|
|
|
25
|
+
> **⚠️ Opinionated by design.** Awesome AGV ships with opinionated defaults for specific technology stacks. See [Opinionated Technology Choices](#opinionated-technology-choices) for details and how to customize.
|
|
26
|
+
|
|
25
27
|
While this configuration is originally designed for **Antigravity**, it is built on standard markdown-based context protocols that are easily portable to other AI coding tools. As a matter of fact, the original form [Technical Constitution](https://github.com/irahardianto/technical-constitution/blob/main/technical-constitution-full.md) was first created for **Gemini CLI**
|
|
26
28
|
|
|
27
29
|
You can drop this configuration into the context or custom rule settings of:
|
|
@@ -34,7 +36,7 @@ For example, the principles of the [Rugged Software Constitution](.agent/rules/r
|
|
|
34
36
|
|
|
35
37
|
### Key Features
|
|
36
38
|
|
|
37
|
-
* 📏 **
|
|
39
|
+
* 📏 **38 Rules** — covering security, reliability, architecture, maintainability, language idioms, and DevOps.
|
|
38
40
|
* 🛠️ **7 Skills** — specialized capabilities for debugging, design, code review, and more.
|
|
39
41
|
* 🔄 **10 Workflows** — end-to-end development processes from research to ship.
|
|
40
42
|
* 🏗️ **Two-Tier Rule System** — always-on mandates + contextual principles for zero-noise enforcement.
|
|
@@ -128,14 +130,22 @@ The power of the setup comes from its extensive collection of rules covering eve
|
|
|
128
130
|
* **[API Design Principles](.agent/rules/api-design-principles.md)**: Creating clean, intuitive, and versionable APIs.
|
|
129
131
|
* **[Architectural Pattern](.agent/rules/architectural-pattern.md)**: Testability-first design with I/O isolation.
|
|
130
132
|
* **[Project Structure](.agent/rules/project-structure.md)**: Feature-based organization (the single source of truth for layout).
|
|
133
|
+
* **[Project Structure — Go Backend](.agent/rules/project-structure-go-backend.md)**: Go-specific directory layout.
|
|
134
|
+
* **[Project Structure — Vue Frontend](.agent/rules/project-structure-vue-frontend.md)**: Vue/React frontend layout.
|
|
135
|
+
* **[Project Structure — Flutter Mobile](.agent/rules/project-structure-flutter-mobile.md)**: Flutter/RN mobile app layout.
|
|
136
|
+
* **[Project Structure — Rust/Cargo](.agent/rules/project-structure-rust-cargo.md)**: Rust workspace and crate layout.
|
|
131
137
|
* **[Database Design](.agent/rules/database-design-principles.md)**: Schema design, migrations, and query safety.
|
|
132
138
|
* **[Data Serialization](.agent/rules/data-serialization-and-interchange-principles.md)**: Safe data handling and formats.
|
|
133
139
|
* **[Command Execution](.agent/rules/command-execution-principles.md)**: Principles for running system commands securely.
|
|
134
|
-
* **[Avoid Circular Dependencies](.agent/rules/avoid-circular-dependencies.md)**: Preventing module import cycles.
|
|
135
140
|
|
|
136
141
|
#### 🧩 Maintainability & Quality
|
|
137
142
|
* **[Code Organization](.agent/rules/code-organization-principles.md)**: Structuring projects for readability.
|
|
138
143
|
* **[Code Idioms](.agent/rules/code-idioms-and-conventions.md)**: Following language-specific best practices.
|
|
144
|
+
* **[Go Idioms](.agent/rules/go-idioms-and-patterns.md)**: Go-specific patterns, error handling, concurrency, and tooling.
|
|
145
|
+
* **[TypeScript Idioms](.agent/rules/typescript-idioms-and-patterns.md)**: TypeScript type system, strict mode, async patterns.
|
|
146
|
+
* **[Vue Idioms](.agent/rules/vue-idioms-and-patterns.md)**: Vue 3 Composition API, Pinia stores, composables.
|
|
147
|
+
* **[Flutter Idioms](.agent/rules/flutter-idioms-and-patterns.md)**: Flutter/Dart, Riverpod state management, freezed models.
|
|
148
|
+
* **[Rust Idioms](.agent/rules/rust-idioms-and-patterns.md)**: Ownership, error handling, async with tokio, clippy.
|
|
139
149
|
* **[Testing Strategy](.agent/rules/testing-strategy.md)**: Ensuring code is verifiable and tested.
|
|
140
150
|
* **[Dependency Management](.agent/rules/dependency-management-principles.md)**: Managing external libraries safely.
|
|
141
151
|
* **[Documentation Principles](.agent/rules/documentation-principles.md)**: Writing clear and helpful documentation.
|
|
@@ -193,7 +203,7 @@ Research → Implement (TDD) → Integrate → E2E (conditional) → Verify →
|
|
|
193
203
|
|
|
194
204
|
```
|
|
195
205
|
.agent/
|
|
196
|
-
├── rules/ #
|
|
206
|
+
├── rules/ # 38 rules (mandates + principles + language idioms)
|
|
197
207
|
│ ├── rugged-software-constitution.md
|
|
198
208
|
│ ├── security-mandate.md
|
|
199
209
|
│ ├── rule-priority.md
|
|
@@ -224,11 +234,24 @@ Research → Implement (TDD) → Integrate → E2E (conditional) → Verify →
|
|
|
224
234
|
|
|
225
235
|
- [x] Include more specialized skills to aid development process (7 skills shipped).
|
|
226
236
|
- [x] Add development workflows for structured feature delivery (10 workflows shipped).
|
|
227
|
-
- [
|
|
237
|
+
- [x] Add language-specific idiom and pattern rules (Go, TypeScript, Vue, Flutter, Rust).
|
|
228
238
|
- [x] Create a CLI tool for easier installation (`npx awesome-agv`).
|
|
229
239
|
- [ ] Add automated validation scripts to check if an agent is following the constitution.
|
|
230
240
|
- [x] Publish comprehensive documentation site (GitHub Pages).
|
|
231
241
|
|
|
242
|
+
## Opinionated Technology Choices
|
|
243
|
+
|
|
244
|
+
Awesome AGV ships with **opinionated defaults** for specific technology stacks. Each stack has dedicated idiom files with patterns, tooling, and verification commands.
|
|
245
|
+
|
|
246
|
+
| Stack | Default Choice | Idiom File(s) |
|
|
247
|
+
| ------------ | --------------------------------------------------- | ----------------------------------------------------------------- |
|
|
248
|
+
| **Backend** | Go — vanilla stdlib, minimal deps | `go-idioms-and-patterns.md` |
|
|
249
|
+
| **Frontend** | TypeScript + Vue 3 — Composition API, Pinia, Vitest | `typescript-idioms-and-patterns.md`, `vue-idioms-and-patterns.md` |
|
|
250
|
+
| **Mobile** | Flutter + Riverpod — freezed models, go_router | `flutter-idioms-and-patterns.md` |
|
|
251
|
+
| **Systems** | Rust — tokio, thiserror/anyhow, clippy pedantic | `rust-idioms-and-patterns.md` |
|
|
252
|
+
|
|
253
|
+
**Using a different framework?** The idiom files are modular — swap or edit them to match your stack. See the [Adapting guide](https://irahardianto.github.io/awesome-agv/adapting) for which files to change.
|
|
254
|
+
|
|
232
255
|
## Project Adaptation Guide
|
|
233
256
|
|
|
234
257
|
This setup supports different project structures:
|
|
@@ -241,7 +264,7 @@ This setup supports different project structures:
|
|
|
241
264
|
| **Microservices** | Adapt `project-structure.md` per service, add service mesh rules |
|
|
242
265
|
| **Mobile (Flutter/RN)** | Adapt frontend rules, add mobile-specific accessibility/testing |
|
|
243
266
|
|
|
244
|
-
**To adapt:** Edit `project-structure.md
|
|
267
|
+
**To adapt:** Edit `project-structure.md`, the relevant idiom file, and `4-verify.md` to match your project layout.
|
|
245
268
|
|
|
246
269
|
<!-- CONTRIBUTING -->
|
|
247
270
|
## Contributing
|
package/bin/awesome-agv.js
CHANGED
|
@@ -91,7 +91,7 @@ ${color.bold}EXAMPLES${color.reset}
|
|
|
91
91
|
npx awesome-agv --force
|
|
92
92
|
|
|
93
93
|
${color.bold}WHAT GETS INSTALLED${color.reset}
|
|
94
|
-
${icons.book}
|
|
94
|
+
${icons.book} 38 Rules — Security, architecture, language idioms, DevOps standards
|
|
95
95
|
${icons.tool} 7 Skills — Debugging, design, code review, and more
|
|
96
96
|
${icons.cycle} 10 Workflows — End-to-end development processes
|
|
97
97
|
|