@mytechtoday/augment-extensions 1.3.1 → 1.5.0
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 +105 -6
- package/augment-extensions/coding-standards/c/CHANGELOG.md +55 -0
- package/augment-extensions/coding-standards/c/LICENSE +22 -0
- package/augment-extensions/coding-standards/c/README.md +167 -0
- package/augment-extensions/coding-standards/c/config/defaults.json +26 -0
- package/augment-extensions/coding-standards/c/config/examples/embedded.yaml +25 -0
- package/augment-extensions/coding-standards/c/config/examples/systems.json +31 -0
- package/augment-extensions/coding-standards/c/config/schema.json +244 -0
- package/augment-extensions/coding-standards/c/docs/API.md +613 -0
- package/augment-extensions/coding-standards/c/docs/CONFIGURATION.md +259 -0
- package/augment-extensions/coding-standards/c/docs/USER_GUIDE.md +567 -0
- package/augment-extensions/coding-standards/c/examples/drivers/Makefile +33 -0
- package/augment-extensions/coding-standards/c/examples/drivers/README.md +192 -0
- package/augment-extensions/coding-standards/c/examples/drivers/dma-example.c +224 -0
- package/augment-extensions/coding-standards/c/examples/drivers/example.dts +64 -0
- package/augment-extensions/coding-standards/c/examples/drivers/platform-driver.c +174 -0
- package/augment-extensions/coding-standards/c/examples/embedded/README.md +167 -0
- package/augment-extensions/coding-standards/c/examples/embedded/gpio-control.c +172 -0
- package/augment-extensions/coding-standards/c/examples/embedded/timer-isr.c +198 -0
- package/augment-extensions/coding-standards/c/examples/embedded/uart-communication.c +212 -0
- package/augment-extensions/coding-standards/c/examples/kernel/Makefile +82 -0
- package/augment-extensions/coding-standards/c/examples/kernel/README.md +168 -0
- package/augment-extensions/coding-standards/c/examples/kernel/char-device.c +198 -0
- package/augment-extensions/coding-standards/c/examples/kernel/proc-file.c +131 -0
- package/augment-extensions/coding-standards/c/examples/kernel/simple-module.c +111 -0
- package/augment-extensions/coding-standards/c/examples/legacy/Makefile +62 -0
- package/augment-extensions/coding-standards/c/examples/legacy/README.md +255 -0
- package/augment-extensions/coding-standards/c/examples/legacy/c89-to-c11-migration.c +268 -0
- package/augment-extensions/coding-standards/c/examples/legacy/compatibility-layer.c +239 -0
- package/augment-extensions/coding-standards/c/examples/networking/Makefile +35 -0
- package/augment-extensions/coding-standards/c/examples/networking/README.md +207 -0
- package/augment-extensions/coding-standards/c/examples/networking/protocol-parser.c +270 -0
- package/augment-extensions/coding-standards/c/examples/networking/tcp-server.c +197 -0
- package/augment-extensions/coding-standards/c/examples/networking/udp-multicast.c +220 -0
- package/augment-extensions/coding-standards/c/examples/realtime/Makefile +53 -0
- package/augment-extensions/coding-standards/c/examples/realtime/README.md +199 -0
- package/augment-extensions/coding-standards/c/examples/realtime/deadline-monitoring.c +260 -0
- package/augment-extensions/coding-standards/c/examples/realtime/priority-scheduling.c +258 -0
- package/augment-extensions/coding-standards/c/examples/systems/Makefile +34 -0
- package/augment-extensions/coding-standards/c/examples/systems/README.md +123 -0
- package/augment-extensions/coding-standards/c/examples/systems/ipc-pipes.c +181 -0
- package/augment-extensions/coding-standards/c/examples/systems/process-management.c +153 -0
- package/augment-extensions/coding-standards/c/examples/systems/signal-handling.c +162 -0
- package/augment-extensions/coding-standards/c/module.json +149 -0
- package/augment-extensions/coding-standards/c/rules/categories/drivers.md +635 -0
- package/augment-extensions/coding-standards/c/rules/categories/embedded.md +510 -0
- package/augment-extensions/coding-standards/c/rules/categories/kernel.md +653 -0
- package/augment-extensions/coding-standards/c/rules/categories/legacy.md +526 -0
- package/augment-extensions/coding-standards/c/rules/categories/networking.md +735 -0
- package/augment-extensions/coding-standards/c/rules/categories/realtime.md +631 -0
- package/augment-extensions/coding-standards/c/rules/categories/systems.md +586 -0
- package/augment-extensions/coding-standards/c/rules/universal/const-correctness.md +275 -0
- package/augment-extensions/coding-standards/c/rules/universal/documentation.md +251 -0
- package/augment-extensions/coding-standards/c/rules/universal/error-handling.md +250 -0
- package/augment-extensions/coding-standards/c/rules/universal/header-guards.md +254 -0
- package/augment-extensions/coding-standards/c/rules/universal/memory-safety.md +233 -0
- package/augment-extensions/coding-standards/c/rules/universal/naming.md +146 -0
- package/augment-extensions/coding-standards/c/src/conflict-detector.ts +461 -0
- package/augment-extensions/coding-standards/c/src/prompt-generator.ts +307 -0
- package/augment-extensions/coding-standards/c/src/rule-evaluator.ts +307 -0
- package/augment-extensions/coding-standards/c/src/rule-override.ts +427 -0
- package/augment-extensions/coding-standards/c/src/template-engine.ts +217 -0
- package/augment-extensions/coding-standards/c/templates/prompts/drivers.txt +191 -0
- package/augment-extensions/coding-standards/c/templates/prompts/embedded.txt +164 -0
- package/augment-extensions/coding-standards/c/templates/prompts/kernel.txt +175 -0
- package/augment-extensions/coding-standards/c/templates/prompts/legacy.txt +280 -0
- package/augment-extensions/coding-standards/c/templates/prompts/networking.txt +259 -0
- package/augment-extensions/coding-standards/c/templates/prompts/realtime.txt +219 -0
- package/augment-extensions/coding-standards/c/templates/prompts/systems.txt +147 -0
- package/augment-extensions/coding-standards/c/tests/integration/category-specific.test.ts +356 -0
- package/augment-extensions/coding-standards/c/tests/integration/end-to-end-workflow.test.ts +377 -0
- package/augment-extensions/coding-standards/c/tests/performance/benchmarks.test.ts +407 -0
- package/augment-extensions/coding-standards/c/tests/unit/config-manager.test.ts +345 -0
- package/augment-extensions/coding-standards/c/tests/unit/conflict-detector.test.ts +294 -0
- package/augment-extensions/coding-standards/c/tests/unit/prompt-generator.test.ts +174 -0
- package/augment-extensions/coding-standards/c/tests/unit/registry.test.ts +313 -0
- package/augment-extensions/coding-standards/c/tests/unit/rule-evaluator.test.ts +318 -0
- package/augment-extensions/coding-standards/c/tests/unit/rule-override.test.ts +326 -0
- package/augment-extensions/coding-standards/c/tests/unit/template-engine.test.ts +314 -0
- package/augment-extensions/coding-standards/go/CHARACTER-COUNT-REPORT.md +135 -0
- package/augment-extensions/coding-standards/go/PHASE1-COMPLETION.md +146 -0
- package/augment-extensions/coding-standards/go/PHASE4-COMPLETION.md +184 -0
- package/augment-extensions/coding-standards/go/README.md +200 -0
- package/augment-extensions/coding-standards/go/VALIDATION-CHECKLIST.md +154 -0
- package/augment-extensions/coding-standards/go/config/examples/example-cli.json +15 -0
- package/augment-extensions/coding-standards/go/config/examples/example-microservices.json +21 -0
- package/augment-extensions/coding-standards/go/config/examples/example-multi-category.yaml +24 -0
- package/augment-extensions/coding-standards/go/config/examples/example-web.json +15 -0
- package/augment-extensions/coding-standards/go/config/schema.json +110 -0
- package/augment-extensions/coding-standards/go/docs/CATEGORIES.md +221 -0
- package/augment-extensions/coding-standards/go/docs/CONFIGURATION.md +198 -0
- package/augment-extensions/coding-standards/go/docs/TROUBLESHOOTING.md +285 -0
- package/augment-extensions/coding-standards/go/examples/cli/cobra-app.go +287 -0
- package/augment-extensions/coding-standards/go/examples/cloud-native-app.go +217 -0
- package/augment-extensions/coding-standards/go/examples/devops-tool.go +250 -0
- package/augment-extensions/coding-standards/go/examples/distributed-system.go +247 -0
- package/augment-extensions/coding-standards/go/examples/microservices/grpc-service.go +253 -0
- package/augment-extensions/coding-standards/go/examples/rest-api.go +270 -0
- package/augment-extensions/coding-standards/go/examples/web/http-server.go +224 -0
- package/augment-extensions/coding-standards/go/module.json +139 -0
- package/augment-extensions/coding-standards/go/rules/categories/api-development/api-versioning.md +149 -0
- package/augment-extensions/coding-standards/go/rules/categories/api-development/rate-limiting.md +209 -0
- package/augment-extensions/coding-standards/go/rules/categories/api-development/rest-api-design.md +183 -0
- package/augment-extensions/coding-standards/go/rules/categories/cloud-native/cloud-config.md +193 -0
- package/augment-extensions/coding-standards/go/rules/categories/cloud-native/health-checks.md +231 -0
- package/augment-extensions/coding-standards/go/rules/categories/cloud-native/kubernetes.md +180 -0
- package/augment-extensions/coding-standards/go/rules/categories/devops-tooling/automation.md +179 -0
- package/augment-extensions/coding-standards/go/rules/categories/devops-tooling/ci-cd-integration.md +147 -0
- package/augment-extensions/coding-standards/go/rules/categories/devops-tooling/infrastructure-as-code.md +231 -0
- package/augment-extensions/coding-standards/go/rules/categories/distributed-systems/caching.md +150 -0
- package/augment-extensions/coding-standards/go/rules/categories/distributed-systems/consensus.md +187 -0
- package/augment-extensions/coding-standards/go/rules/categories/distributed-systems/event-sourcing.md +246 -0
- package/augment-extensions/coding-standards/go/rules/cli/command-parsing.md +264 -0
- package/augment-extensions/coding-standards/go/rules/cli/configuration.md +268 -0
- package/augment-extensions/coding-standards/go/rules/cli/cross-platform.md +324 -0
- package/augment-extensions/coding-standards/go/rules/microservices/distributed-tracing.md +253 -0
- package/augment-extensions/coding-standards/go/rules/microservices/grpc.md +257 -0
- package/augment-extensions/coding-standards/go/rules/microservices/metrics.md +278 -0
- package/augment-extensions/coding-standards/go/rules/microservices/service-discovery.md +249 -0
- package/augment-extensions/coding-standards/go/rules/universal/code-organization.md +221 -0
- package/augment-extensions/coding-standards/go/rules/universal/documentation.md +269 -0
- package/augment-extensions/coding-standards/go/rules/universal/performance.md +323 -0
- package/augment-extensions/coding-standards/go/rules/universal/testing.md +162 -0
- package/augment-extensions/coding-standards/go/rules/web/graceful-shutdown.md +249 -0
- package/augment-extensions/coding-standards/go/rules/web/http-handlers.md +164 -0
- package/augment-extensions/coding-standards/go/rules/web/middleware.md +234 -0
- package/augment-extensions/coding-standards/go/rules/web/routing.md +251 -0
- package/augment-extensions/coding-standards/go/templates/prompts/api.md +160 -0
- package/augment-extensions/coding-standards/go/templates/prompts/cli.md +225 -0
- package/augment-extensions/coding-standards/go/templates/prompts/cloud-native.md +121 -0
- package/augment-extensions/coding-standards/go/templates/prompts/devops.md +146 -0
- package/augment-extensions/coding-standards/go/templates/prompts/distributed.md +133 -0
- package/augment-extensions/coding-standards/go/templates/prompts/microservices.md +225 -0
- package/augment-extensions/coding-standards/go/templates/prompts/web.md +181 -0
- package/augment-extensions/coding-standards/go/tests/integration/module-integration.test.ts +164 -0
- package/augment-extensions/coding-standards/go/tests/unit/category-selection.test.ts +147 -0
- package/augment-extensions/coding-standards/go/tests/unit/module-structure.test.ts +154 -0
- package/augment-extensions/coding-standards/go/tests/validate-character-count.ps1 +13 -0
- package/augment-extensions/coding-standards/go/tests/validate-examples.ps1 +148 -0
- package/augment-extensions/coding-standards/go/tests/validate-examples.sh +135 -0
- package/cli/dist/analysis/ast-parser.d.ts +47 -0
- package/cli/dist/analysis/ast-parser.d.ts.map +1 -0
- package/cli/dist/analysis/ast-parser.js +161 -0
- package/cli/dist/analysis/ast-parser.js.map +1 -0
- package/cli/dist/analysis/complexity-analyzer.d.ts +27 -0
- package/cli/dist/analysis/complexity-analyzer.d.ts.map +1 -0
- package/cli/dist/analysis/complexity-analyzer.js +189 -0
- package/cli/dist/analysis/complexity-analyzer.js.map +1 -0
- package/cli/dist/analysis/dependency-analyzer.d.ts +23 -0
- package/cli/dist/analysis/dependency-analyzer.d.ts.map +1 -0
- package/cli/dist/analysis/dependency-analyzer.js +237 -0
- package/cli/dist/analysis/dependency-analyzer.js.map +1 -0
- package/cli/dist/analysis/index.d.ts +9 -0
- package/cli/dist/analysis/index.d.ts.map +1 -0
- package/cli/dist/analysis/index.js +25 -0
- package/cli/dist/analysis/index.js.map +1 -0
- package/cli/dist/analysis/security-scanner.d.ts +11 -0
- package/cli/dist/analysis/security-scanner.d.ts.map +1 -0
- package/cli/dist/analysis/security-scanner.js +294 -0
- package/cli/dist/analysis/security-scanner.js.map +1 -0
- package/cli/dist/analysis/types.d.ts +151 -0
- package/cli/dist/analysis/types.d.ts.map +1 -0
- package/cli/dist/analysis/types.js +6 -0
- package/cli/dist/analysis/types.js.map +1 -0
- package/cli/dist/cli.js +24 -0
- package/cli/dist/cli.js.map +1 -1
- package/cli/dist/commands/code-analysis.d.ts +11 -0
- package/cli/dist/commands/code-analysis.d.ts.map +1 -0
- package/cli/dist/commands/code-analysis.js +412 -0
- package/cli/dist/commands/code-analysis.js.map +1 -0
- package/modules.md +99 -3
- package/package.json +21 -2
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
**Reusable augmentation modules for Augment Code AI - Beyond the 49,400 character limit.**
|
|
4
4
|
|
|
5
|
-
[](https://github.com/mytech-today-now/augment-extensions)
|
|
6
6
|
[](./LICENSE)
|
|
7
7
|
[](https://www.npmjs.com/package/@mytechtoday/augment-extensions)
|
|
8
8
|
|
|
@@ -20,8 +20,39 @@ Augment Code AI limits the `.augment/` folder to ~49,400 characters. This reposi
|
|
|
20
20
|
- **Versioned updates** that propagate to consuming projects
|
|
21
21
|
- **Project-agnostic modules** that work across different codebases
|
|
22
22
|
|
|
23
|
-
## ✨ What's New in v1.
|
|
23
|
+
## ✨ What's New in v1.4.0
|
|
24
|
+
|
|
25
|
+
### CLI Expansion - Phase 3 & 4 Complete 🎉
|
|
26
|
+
|
|
27
|
+
**Phase 3 - Integration Commands:**
|
|
28
|
+
- 📋 **Beads Integration** - Full Beads system management with `augx beads` commands
|
|
29
|
+
- `augx beads status` - System status and statistics
|
|
30
|
+
- `augx beads validate` - Validate task structure
|
|
31
|
+
- `augx beads export/import` - Export/import tasks
|
|
32
|
+
- `augx beads stats` - Detailed statistics
|
|
33
|
+
- `augx beads graph` - Dependency graph visualization
|
|
34
|
+
- `augx beads report` - Generate reports (Markdown, HTML, JSON, CSV)
|
|
35
|
+
- ✅ **Task Management** - AI-friendly task commands with `augx task`
|
|
36
|
+
- `augx task list/show/create/update/close` - Task CRUD operations
|
|
37
|
+
- `augx task search` - Search tasks by criteria
|
|
38
|
+
- `augx task deps` - Manage dependencies
|
|
39
|
+
- 📝 **OpenSpec Integration** - Spec-driven development with `augx spec`
|
|
40
|
+
- `augx spec list/show/create/validate/archive` - Spec management
|
|
41
|
+
- `augx spec status` - Spec status tracking
|
|
42
|
+
- 🔄 **Change Management** - Change proposals with `augx change`
|
|
43
|
+
- `augx change list/show/create/validate/archive` - Change proposal management
|
|
44
|
+
- 📦 **Collection Management** - Module collections with `augx collection`
|
|
45
|
+
- `augx collection list/show/link/unlink/validate` - Collection operations
|
|
46
|
+
|
|
47
|
+
**Phase 4 - Quality & Documentation:**
|
|
48
|
+
- 🧪 **Test Runner** - Comprehensive module testing
|
|
49
|
+
- 🔍 **Linter** - AI context quality validation
|
|
50
|
+
- 📚 **Docs Generator** - Automatic API documentation
|
|
51
|
+
- 💡 **Enhanced Help** - Intelligent command suggestions
|
|
24
52
|
|
|
53
|
+
### Previous Releases
|
|
54
|
+
|
|
55
|
+
**v1.1.0:**
|
|
25
56
|
- 📋 **Beads Completed Tracking** - Track and display completed Beads tasks with `augx show completed`
|
|
26
57
|
- 🎨 **Color-Coded Status** - Visual indicators for task status (✓ closed, ⚙ in-progress, ○ open, ✖ blocked)
|
|
27
58
|
- 📅 **Date Filtering** - Filter completed tasks by date range with `--since` and `--until` flags
|
|
@@ -30,8 +61,6 @@ Augment Code AI limits the `.augment/` folder to ~49,400 characters. This reposi
|
|
|
30
61
|
- 🚀 **Auto-Initialization** - `augx init` automatically creates `scripts/completed.jsonl` when `.beads` exists
|
|
31
62
|
- 📊 **JSON Export** - Export completed tasks as JSON with `--json` flag
|
|
32
63
|
|
|
33
|
-
### Previous Releases
|
|
34
|
-
|
|
35
64
|
**v0.4.0:**
|
|
36
65
|
- 🧠 **Skills System** - Token-efficient, on-demand skill loading (500-10K tokens vs 50K+ for modules)
|
|
37
66
|
- 🔧 **CLI Integration** - Wrap external tools and MCP servers as skills
|
|
@@ -792,6 +821,7 @@ augx diff typescript-standards
|
|
|
792
821
|
|
|
793
822
|
## 🚀 CLI Commands
|
|
794
823
|
|
|
824
|
+
### Module Management
|
|
795
825
|
```bash
|
|
796
826
|
# List all available modules
|
|
797
827
|
augx list
|
|
@@ -821,6 +851,75 @@ augx update
|
|
|
821
851
|
augx version
|
|
822
852
|
```
|
|
823
853
|
|
|
854
|
+
### Beads Integration (Phase 3)
|
|
855
|
+
```bash
|
|
856
|
+
# System status and statistics
|
|
857
|
+
augx beads status [--json] [--verbose]
|
|
858
|
+
|
|
859
|
+
# Validate task structure
|
|
860
|
+
augx beads validate [task-id] [--fix]
|
|
861
|
+
|
|
862
|
+
# Export/import tasks
|
|
863
|
+
augx beads export <output-file> [--format json|csv]
|
|
864
|
+
augx beads import <input-file>
|
|
865
|
+
|
|
866
|
+
# Generate statistics
|
|
867
|
+
augx beads stats [--json] [--by-priority|--by-label|--by-owner]
|
|
868
|
+
|
|
869
|
+
# Dependency graph visualization
|
|
870
|
+
augx beads graph [--format ascii|mermaid|dot|svg] [--output file]
|
|
871
|
+
|
|
872
|
+
# Generate reports
|
|
873
|
+
augx beads report [--format markdown|html|json|csv] [--output file]
|
|
874
|
+
```
|
|
875
|
+
|
|
876
|
+
### Task Management (Phase 3)
|
|
877
|
+
```bash
|
|
878
|
+
# Task CRUD operations
|
|
879
|
+
augx task list [--status open|closed] [--priority 0-3]
|
|
880
|
+
augx task show <task-id>
|
|
881
|
+
augx task create <title> [--priority N] [--tags tag1,tag2]
|
|
882
|
+
augx task update <task-id> [--status status] [--priority N]
|
|
883
|
+
augx task close <task-id> [--reason reason]
|
|
884
|
+
|
|
885
|
+
# Search and filter
|
|
886
|
+
augx task search <query> [--labels label1,label2]
|
|
887
|
+
|
|
888
|
+
# Dependency management
|
|
889
|
+
augx task deps <task-id> [--add dep-id] [--remove dep-id]
|
|
890
|
+
```
|
|
891
|
+
|
|
892
|
+
### OpenSpec Integration (Phase 3)
|
|
893
|
+
```bash
|
|
894
|
+
# Spec management
|
|
895
|
+
augx spec list [--status active|draft|archived]
|
|
896
|
+
augx spec show <spec-id>
|
|
897
|
+
augx spec create <name> [--category cat] [--title "Title"]
|
|
898
|
+
augx spec validate <spec-id>
|
|
899
|
+
augx spec archive <spec-id>
|
|
900
|
+
augx spec status [--json]
|
|
901
|
+
```
|
|
902
|
+
|
|
903
|
+
### Change Management (Phase 3)
|
|
904
|
+
```bash
|
|
905
|
+
# Change proposal management
|
|
906
|
+
augx change list [--status active|archived]
|
|
907
|
+
augx change show <change-name>
|
|
908
|
+
augx change create <name> [--title "Title"] [--jira TICKET-123]
|
|
909
|
+
augx change validate <change-name>
|
|
910
|
+
augx change archive <change-name>
|
|
911
|
+
```
|
|
912
|
+
|
|
913
|
+
### Collection Management (Phase 3)
|
|
914
|
+
```bash
|
|
915
|
+
# Collection operations
|
|
916
|
+
augx collection list
|
|
917
|
+
augx collection show <collection-name>
|
|
918
|
+
augx collection link <collection-name>
|
|
919
|
+
augx collection unlink <collection-name>
|
|
920
|
+
augx collection validate <collection-name>
|
|
921
|
+
```
|
|
922
|
+
|
|
824
923
|
## 🔧 Integration with AI Agents
|
|
825
924
|
|
|
826
925
|
Augment Extensions integrates seamlessly with AI coding assistants:
|
|
@@ -950,7 +1049,7 @@ MIT License - See [LICENSE](./LICENSE) for details.
|
|
|
950
1049
|
|
|
951
1050
|
---
|
|
952
1051
|
|
|
953
|
-
**Status**: Active Development | **Version**:
|
|
1052
|
+
**Status**: Active Development | **Version**: 1.4.0 | **Maintainer**: @mytech-today-now
|
|
954
1053
|
|
|
955
|
-
**Latest Release**:
|
|
1054
|
+
**Latest Release**: CLI Expansion Complete (Phase 3 & 4) - Full Beads, OpenSpec, and Collection integration with comprehensive task management, spec-driven development, quality tools, and enhanced documentation generation.
|
|
956
1055
|
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to the C Coding Standards extension will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [1.0.0] - 2026-02-19
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
- Initial release of C Coding Standards extension
|
|
12
|
+
- Module structure with organized directories
|
|
13
|
+
- Configuration system with JSON Schema validation
|
|
14
|
+
- Configuration manager with JSON/YAML support
|
|
15
|
+
- Rule registry with Markdown parsing
|
|
16
|
+
- Support for 7 categories: systems, embedded, kernel, drivers, realtime, networking, legacy
|
|
17
|
+
- 6 universal rules: naming, memory-safety, error-handling, documentation, header-guards, const-correctness
|
|
18
|
+
- Category-specific rule overrides
|
|
19
|
+
- Static analysis tool integration (clang-tidy, cppcheck, valgrind)
|
|
20
|
+
- Custom rules support
|
|
21
|
+
- Hot-reload configuration support
|
|
22
|
+
- Comprehensive examples for each category
|
|
23
|
+
- AI prompt templates
|
|
24
|
+
- TypeScript implementation with full type safety
|
|
25
|
+
- Unit and integration tests
|
|
26
|
+
- Complete documentation
|
|
27
|
+
|
|
28
|
+
### Changed
|
|
29
|
+
- N/A (initial release)
|
|
30
|
+
|
|
31
|
+
### Deprecated
|
|
32
|
+
- N/A (initial release)
|
|
33
|
+
|
|
34
|
+
### Removed
|
|
35
|
+
- N/A (initial release)
|
|
36
|
+
|
|
37
|
+
### Fixed
|
|
38
|
+
- N/A (initial release)
|
|
39
|
+
|
|
40
|
+
### Security
|
|
41
|
+
- N/A (initial release)
|
|
42
|
+
|
|
43
|
+
## [Unreleased]
|
|
44
|
+
|
|
45
|
+
### Planned
|
|
46
|
+
- Additional category-specific rules
|
|
47
|
+
- More code examples
|
|
48
|
+
- Integration with additional static analysis tools
|
|
49
|
+
- VS Code extension integration
|
|
50
|
+
- Real-time rule validation
|
|
51
|
+
- Rule conflict detection and resolution
|
|
52
|
+
- Performance optimizations
|
|
53
|
+
- Enhanced error messages
|
|
54
|
+
- Migration tools for legacy code
|
|
55
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Augment Extensions
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
22
|
+
|
|
@@ -0,0 +1,167 @@
|
|
|
1
|
+
# C Coding Standards
|
|
2
|
+
|
|
3
|
+
Comprehensive C programming language coding standards for Augment Code AI, covering systems programming, embedded systems, kernel development, device drivers, real-time systems, networking, and legacy code maintenance.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
This extension provides category-based coding standards for C development, with universal rules that apply across all categories and specialized rules for specific domains.
|
|
8
|
+
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
11
|
+
### Using augx CLI
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
# Link the module to your project
|
|
15
|
+
augx link coding-standards/c
|
|
16
|
+
|
|
17
|
+
# Verify installation
|
|
18
|
+
augx show c-standards
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
### Manual Installation
|
|
22
|
+
|
|
23
|
+
Copy the contents of this directory to your project's `.augment/` folder.
|
|
24
|
+
|
|
25
|
+
## Quick Start
|
|
26
|
+
|
|
27
|
+
1. **Configure Categories**: Create `.augment/c-standards.json`:
|
|
28
|
+
|
|
29
|
+
```json
|
|
30
|
+
{
|
|
31
|
+
"c_standards": {
|
|
32
|
+
"version": "1.0.0",
|
|
33
|
+
"categories": ["systems"],
|
|
34
|
+
"c_standard": "c11"
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
2. **Start Coding**: The extension will automatically apply rules based on your configuration.
|
|
40
|
+
|
|
41
|
+
## Categories
|
|
42
|
+
|
|
43
|
+
### Systems Programming
|
|
44
|
+
- POSIX compliance
|
|
45
|
+
- Process management
|
|
46
|
+
- Inter-process communication (IPC)
|
|
47
|
+
- Signal handling
|
|
48
|
+
- File I/O and system calls
|
|
49
|
+
|
|
50
|
+
### Embedded Systems
|
|
51
|
+
- Microcontroller programming
|
|
52
|
+
- Interrupt service routines (ISRs)
|
|
53
|
+
- Hardware register access
|
|
54
|
+
- Memory-constrained environments
|
|
55
|
+
- Fixed-size buffers
|
|
56
|
+
|
|
57
|
+
### Kernel Development
|
|
58
|
+
- Linux kernel modules
|
|
59
|
+
- Kernel subsystems
|
|
60
|
+
- Device drivers (character, block, network)
|
|
61
|
+
- Kernel APIs and conventions
|
|
62
|
+
|
|
63
|
+
### Device Drivers
|
|
64
|
+
- GPIO drivers
|
|
65
|
+
- DMA transfers
|
|
66
|
+
- Interrupt handling
|
|
67
|
+
- Platform devices
|
|
68
|
+
- Device tree integration
|
|
69
|
+
|
|
70
|
+
### Real-Time Systems
|
|
71
|
+
- RTOS integration
|
|
72
|
+
- Task scheduling
|
|
73
|
+
- Priority management
|
|
74
|
+
- Deterministic execution
|
|
75
|
+
- Timing constraints
|
|
76
|
+
|
|
77
|
+
### Networking
|
|
78
|
+
- Socket programming
|
|
79
|
+
- Protocol implementation
|
|
80
|
+
- Packet processing
|
|
81
|
+
- Network drivers
|
|
82
|
+
- TCP/IP stack integration
|
|
83
|
+
|
|
84
|
+
### Legacy Code
|
|
85
|
+
- Code modernization
|
|
86
|
+
- Refactoring strategies
|
|
87
|
+
- Migration to modern C standards
|
|
88
|
+
- Compatibility maintenance
|
|
89
|
+
|
|
90
|
+
## Universal Rules
|
|
91
|
+
|
|
92
|
+
These rules apply to all categories:
|
|
93
|
+
|
|
94
|
+
1. **Naming Conventions**: snake_case for functions/variables, UPPER_CASE for macros
|
|
95
|
+
2. **Memory Safety**: Proper allocation, deallocation, and bounds checking
|
|
96
|
+
3. **Error Handling**: Check all return values, use errno appropriately
|
|
97
|
+
4. **Documentation**: Doxygen-style comments for all public APIs
|
|
98
|
+
5. **Header Guards**: Use include guards or `#pragma once`
|
|
99
|
+
6. **Const Correctness**: Use `const` for immutable data
|
|
100
|
+
|
|
101
|
+
## Configuration
|
|
102
|
+
|
|
103
|
+
### Configuration File
|
|
104
|
+
|
|
105
|
+
Create `.augment/c-standards.json` or `.augment/c-standards.yaml`:
|
|
106
|
+
|
|
107
|
+
```json
|
|
108
|
+
{
|
|
109
|
+
"c_standards": {
|
|
110
|
+
"version": "1.0.0",
|
|
111
|
+
"categories": ["systems", "embedded"],
|
|
112
|
+
"c_standard": "c11",
|
|
113
|
+
"universal_rules": {
|
|
114
|
+
"naming": "enabled",
|
|
115
|
+
"memory_safety": "enabled",
|
|
116
|
+
"error_handling": "enabled",
|
|
117
|
+
"documentation": "warning",
|
|
118
|
+
"header_guards": "enabled",
|
|
119
|
+
"const_correctness": "warning"
|
|
120
|
+
},
|
|
121
|
+
"category_overrides": {
|
|
122
|
+
"embedded": {
|
|
123
|
+
"allow_dynamic_allocation": false,
|
|
124
|
+
"require_volatile_hardware": true,
|
|
125
|
+
"max_stack_depth": 5
|
|
126
|
+
}
|
|
127
|
+
},
|
|
128
|
+
"static_analysis": {
|
|
129
|
+
"clang_tidy": true,
|
|
130
|
+
"cppcheck": true,
|
|
131
|
+
"valgrind": false
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### Rule Severity Levels
|
|
138
|
+
|
|
139
|
+
- `enabled`: Enforce rule (errors)
|
|
140
|
+
- `warning`: Warn about violations
|
|
141
|
+
- `disabled`: Ignore rule
|
|
142
|
+
|
|
143
|
+
## Examples
|
|
144
|
+
|
|
145
|
+
See the `examples/` directory for complete, compilable examples for each category.
|
|
146
|
+
|
|
147
|
+
## Static Analysis Integration
|
|
148
|
+
|
|
149
|
+
This extension integrates with:
|
|
150
|
+
- **clang-tidy**: Modern C/C++ linter
|
|
151
|
+
- **cppcheck**: Static analysis tool
|
|
152
|
+
- **valgrind**: Memory debugging and profiling
|
|
153
|
+
|
|
154
|
+
## Contributing
|
|
155
|
+
|
|
156
|
+
See [CONTRIBUTING.md](../../CONTRIBUTING.md) for guidelines.
|
|
157
|
+
|
|
158
|
+
## License
|
|
159
|
+
|
|
160
|
+
MIT License - see [LICENSE](LICENSE) file.
|
|
161
|
+
|
|
162
|
+
## Links
|
|
163
|
+
|
|
164
|
+
- [Documentation](https://github.com/mytech-today-now/augment-extensions/tree/main/augment-extensions/coding-standards/c)
|
|
165
|
+
- [Issues](https://github.com/mytech-today-now/augment-extensions/issues)
|
|
166
|
+
- [Augment Extensions](https://github.com/mytech-today-now/augment-extensions)
|
|
167
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
{
|
|
2
|
+
"c_standards": {
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"categories": ["systems"],
|
|
5
|
+
"c_standard": "c11",
|
|
6
|
+
"universal_rules": {
|
|
7
|
+
"naming": "enabled",
|
|
8
|
+
"memory_safety": "enabled",
|
|
9
|
+
"error_handling": "enabled",
|
|
10
|
+
"documentation": "enabled",
|
|
11
|
+
"header_guards": "enabled",
|
|
12
|
+
"const_correctness": "enabled"
|
|
13
|
+
},
|
|
14
|
+
"category_overrides": {},
|
|
15
|
+
"static_analysis": {
|
|
16
|
+
"clang_tidy": false,
|
|
17
|
+
"cppcheck": false,
|
|
18
|
+
"valgrind": false
|
|
19
|
+
},
|
|
20
|
+
"custom_rules": {
|
|
21
|
+
"enabled": false,
|
|
22
|
+
"path": ".augment/c-standards/custom-rules/"
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
c_standards:
|
|
2
|
+
version: "1.0.0"
|
|
3
|
+
categories:
|
|
4
|
+
- embedded
|
|
5
|
+
c_standard: c99
|
|
6
|
+
universal_rules:
|
|
7
|
+
naming: enabled
|
|
8
|
+
memory_safety: enabled
|
|
9
|
+
error_handling: enabled
|
|
10
|
+
documentation: enabled
|
|
11
|
+
header_guards: enabled
|
|
12
|
+
const_correctness: enabled
|
|
13
|
+
category_overrides:
|
|
14
|
+
embedded:
|
|
15
|
+
allow_dynamic_allocation: false
|
|
16
|
+
require_volatile_hardware: true
|
|
17
|
+
max_stack_depth: 5
|
|
18
|
+
static_analysis:
|
|
19
|
+
clang_tidy: true
|
|
20
|
+
cppcheck: true
|
|
21
|
+
valgrind: false
|
|
22
|
+
custom_rules:
|
|
23
|
+
enabled: false
|
|
24
|
+
path: ".augment/c-standards/custom-rules/"
|
|
25
|
+
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
{
|
|
2
|
+
"c_standards": {
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"categories": ["systems"],
|
|
5
|
+
"c_standard": "c11",
|
|
6
|
+
"universal_rules": {
|
|
7
|
+
"naming": "enabled",
|
|
8
|
+
"memory_safety": "enabled",
|
|
9
|
+
"error_handling": "enabled",
|
|
10
|
+
"documentation": "warning",
|
|
11
|
+
"header_guards": "enabled",
|
|
12
|
+
"const_correctness": "warning"
|
|
13
|
+
},
|
|
14
|
+
"category_overrides": {
|
|
15
|
+
"systems": {
|
|
16
|
+
"require_posix_compliance": true,
|
|
17
|
+
"check_system_call_errors": true
|
|
18
|
+
}
|
|
19
|
+
},
|
|
20
|
+
"static_analysis": {
|
|
21
|
+
"clang_tidy": true,
|
|
22
|
+
"cppcheck": true,
|
|
23
|
+
"valgrind": true
|
|
24
|
+
},
|
|
25
|
+
"custom_rules": {
|
|
26
|
+
"enabled": false,
|
|
27
|
+
"path": ".augment/c-standards/custom-rules/"
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
|