@mytechtoday/augment-extensions 1.3.1 → 1.5.0

package/augment-extensions/coding-standards/go/config/schema.json

@@ -0,0 +1,110 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://github.com/mytech-today-now/augment-extensions/coding-standards/go/config/schema.json",
+  "title": "Go Coding Standards Configuration",
+  "description": "Configuration schema for Go coding standards extension",
+  "type": "object",
+  "properties": {
+    "categories": {
+      "type": "array",
+      "description": "Array of Go project categories to enable. Each category provides specialized rules and best practices.",
+      "items": {
+        "type": "string",
+        "enum": ["web", "microservices", "cli", "cloud", "distributed", "devops", "api"],
+        "enumDescriptions": {
+          "web": "HTTP server development, middleware patterns, routing, graceful shutdown",
+          "microservices": "gRPC, service discovery, distributed tracing, health checks, metrics",
+          "cli": "Command-line tools with cobra, viper, flag handling, cross-platform support",
+          "cloud": "Kubernetes operators, cloud SDKs, containerization, 12-factor apps",
+          "distributed": "Event sourcing, message queues, consensus algorithms, distributed locks",
+          "devops": "Infrastructure automation, CI/CD, monitoring, log aggregation",
+          "api": "RESTful APIs, GraphQL, authentication, rate limiting, OpenAPI"
+        }
+      },
+      "uniqueItems": true,
+      "minItems": 1,
+      "default": ["web"]
+    },
+    "rules": {
+      "type": "object",
+      "description": "Rule configuration and overrides",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "description": "Enable or disable all rules globally",
+          "default": true
+        },
+        "severity": {
+          "type": "string",
+          "description": "Default severity level for all rules",
+          "enum": ["error", "warning", "info"],
+          "default": "error"
+        },
+        "overrides": {
+          "type": "object",
+          "description": "Category-specific rule overrides",
+          "patternProperties": {
+            "^(web|microservices|cli|cloud|distributed|devops|api)$": {
+              "type": "object",
+              "properties": {
+                "enabled": {
+                  "type": "boolean",
+                  "description": "Enable/disable rules for this category"
+                },
+                "severity": {
+                  "type": "string",
+                  "enum": ["error", "warning", "info"],
+                  "description": "Override severity for this category"
+                },
+                "specific": {
+                  "type": "object",
+                  "description": "Specific rule configurations",
+                  "additionalProperties": {
+                    "type": "object",
+                    "properties": {
+                      "enabled": {
+                        "type": "boolean"
+                      },
+                      "severity": {
+                        "type": "string",
+                        "enum": ["error", "warning", "info"]
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "staticAnalysis": {
+      "type": "object",
+      "description": "Static analysis tool configuration",
+      "properties": {
+        "golangci-lint": {
+          "type": "boolean",
+          "description": "Enable golangci-lint integration",
+          "default": true
+        },
+        "staticcheck": {
+          "type": "boolean",
+          "description": "Enable staticcheck integration",
+          "default": true
+        },
+        "govet": {
+          "type": "boolean",
+          "description": "Enable go vet integration",
+          "default": true
+        },
+        "gosec": {
+          "type": "boolean",
+          "description": "Enable gosec security scanner",
+          "default": true
+        }
+      }
+    }
+  },
+  "required": ["categories"]
+}
+

package/augment-extensions/coding-standards/go/docs/CATEGORIES.md

@@ -0,0 +1,221 @@
+# Category Guide
+
+## Overview
+
+The Go Coding Standards module supports 7 specialized categories, each with tailored rules and best practices for specific project types.
+
+## Categories
+
+### 1. Web Services (`web`)
+
+**Use Case:** HTTP servers, REST APIs, web applications
+
+**Key Rules:**
+- HTTP handler patterns
+- Middleware implementation
+- Request/response handling
+- Graceful shutdown
+- Routing best practices
+
+**Example Projects:**
+- REST API servers
+- Web applications
+- HTTP microservices
+- API gateways
+
+**Template:** `templates/web-service.md`
+
+**Examples:** `examples/web/`
+
+---
+
+### 2. Microservices (`microservices`)
+
+**Use Case:** gRPC services, service-oriented architectures
+
+**Key Rules:**
+- gRPC service implementation
+- Service discovery patterns
+- Distributed tracing
+- Metrics and monitoring
+- Inter-service communication
+
+**Example Projects:**
+- gRPC services
+- Service meshes
+- Event-driven microservices
+- Backend-for-frontend (BFF)
+
+**Template:** `templates/microservice.md`
+
+**Examples:** `examples/microservices/`
+
+---
+
+### 3. CLI Tools (`cli`)
+
+**Use Case:** Command-line applications, developer tools
+
+**Key Rules:**
+- Command parsing (Cobra)
+- Configuration management (Viper)
+- Cross-platform compatibility
+- User-friendly error messages
+- Exit codes and signals
+
+**Example Projects:**
+- Developer tools
+- System utilities
+- Build tools
+- Deployment scripts
+
+**Template:** `templates/cli-tool.md`
+
+**Examples:** `examples/cli/`
+
+---
+
+### 4. Cloud-Native (`cloud`)
+
+**Use Case:** Kubernetes applications, cloud platforms
+
+**Key Rules:**
+- Kubernetes integration
+- Health checks and readiness probes
+- Configuration from environment
+- Graceful shutdown
+- 12-factor app principles
+
+**Example Projects:**
+- Kubernetes operators
+- Cloud-native applications
+- Containerized services
+- Platform services
+
+**Template:** `templates/cloud-native.md`
+
+**Examples:** `examples/cloud/`
+
+---
+
+### 5. Distributed Systems (`distributed`)
+
+**Use Case:** Event-driven architectures, distributed computing
+
+**Key Rules:**
+- Consensus algorithms (Raft)
+- Event sourcing and CQRS
+- Distributed caching
+- Message queues
+- Eventual consistency
+
+**Example Projects:**
+- Event-driven systems
+- Distributed databases
+- Message brokers
+- Stream processing
+
+**Template:** `templates/distributed.md`
+
+**Examples:** `examples/distributed/`
+
+---
+
+### 6. DevOps Tooling (`devops`)
+
+**Use Case:** Automation tools, infrastructure management
+
+**Key Rules:**
+- Deployment automation
+- CI/CD integration
+- Infrastructure as code
+- Idempotent operations
+- State management
+
+**Example Projects:**
+- Deployment tools
+- Infrastructure automation
+- CI/CD pipelines
+- Configuration management
+
+**Template:** `templates/devops.md`
+
+**Examples:** `examples/devops/`
+
+---
+
+### 7. API Development (`api`)
+
+**Use Case:** REST and GraphQL APIs
+
+**Key Rules:**
+- REST API design
+- API versioning
+- Rate limiting
+- Authentication/authorization
+- API documentation
+
+**Example Projects:**
+- REST APIs
+- GraphQL servers
+- API gateways
+- Backend services
+
+**Template:** `templates/api.md`
+
+**Examples:** `examples/api/`
+
+---
+
+## Selecting Categories
+
+### Single Category
+
+```json
+{
+  "categories": ["web"]
+}
+```
+
+### Multiple Categories
+
+```json
+{
+  "categories": ["web", "api", "microservices"]
+}
+```
+
+## Category Combinations
+
+### Common Combinations
+
+**Web + API:**
+```json
+{
+  "categories": ["web", "api"]
+}
+```
+Best for: REST API servers, web services
+
+**Microservices + Distributed:**
+```json
+{
+  "categories": ["microservices", "distributed"]
+}
+```
+Best for: Event-driven microservices, distributed systems
+
+**CLI + DevOps:**
+```json
+{
+  "categories": ["cli", "devops"]
+}
+```
+Best for: Deployment tools, automation scripts
+
+## Next Steps
+
+- See [CONFIGURATION.md](./CONFIGURATION.md) for configuration details
+- See [README.md](../README.md) for module overview
+- See category-specific rules in `rules/[category]/`
+

package/augment-extensions/coding-standards/go/docs/CONFIGURATION.md

@@ -0,0 +1,198 @@
+# Configuration Guide
+
+## Overview
+
+The Go Coding Standards module supports flexible configuration to match your project's needs. You can select specific categories, enable/disable rules, and configure static analysis tools.
+
+## Configuration File
+
+Create a `.augment/go-config.json` file in your project root:
+
+```json
+{
+  "categories": ["web", "api"],
+  "rules": {
+    "enabled": true,
+    "severity": "error"
+  },
+  "staticAnalysis": {
+    "golangci-lint": true,
+    "staticcheck": true,
+    "govet": true,
+    "gosec": true
+  }
+}
+```
+
+## Configuration Options
+
+### Categories
+
+Select one or more project categories:
+
+- **`web`** - Web services and HTTP servers
+- **`microservices`** - gRPC services and microservices
+- **`cli`** - Command-line tools and utilities
+- **`cloud`** - Cloud-native applications (Kubernetes, etc.)
+- **distributed`** - Distributed systems and event-driven architectures
+- **`devops`** - DevOps tooling and automation
+- **`api`** - REST and GraphQL API development
+
+**Example:**
+```json
+{
+  "categories": ["web", "api"]
+}
+```
+
+### Rules Configuration
+
+Control rule enforcement:
+
+```json
+{
+  "rules": {
+    "enabled": true,
+    "severity": "error"
+  }
+}
+```
+
+**Options:**
+- `enabled` (boolean): Enable/disable all rules
+- `severity` (string): Default severity level (`error`, `warning`, `info`)
+
+### Static Analysis Tools
+
+Configure which tools to use:
+
+```json
+{
+  "staticAnalysis": {
+    "golangci-lint": true,
+    "staticcheck": true,
+    "govet": true,
+    "gosec": true
+  }
+}
+```
+
+## Category-Specific Configuration
+
+### Web Services
+
+```json
+{
+  "categories": ["web"],
+  "web": {
+    "framework": "standard-library",
+    "middleware": ["logging", "recovery", "cors"],
+    "gracefulShutdown": true
+  }
+}
+```
+
+### Microservices
+
+```json
+{
+  "categories": ["microservices"],
+  "microservices": {
+    "protocol": "grpc",
+    "serviceDiscovery": "consul",
+    "tracing": "jaeger",
+    "metrics": "prometheus"
+  }
+}
+```
+
+### CLI Tools
+
+```json
+{
+  "categories": ["cli"],
+  "cli": {
+    "framework": "cobra",
+    "configuration": "viper",
+    "crossPlatform": true
+  }
+}
+```
+
+## Environment-Specific Configuration
+
+### Development
+
+```json
+{
+  "categories": ["web"],
+  "rules": {
+    "severity": "warning"
+  },
+  "staticAnalysis": {
+    "golangci-lint": true
+  }
+}
+```
+
+### Production
+
+```json
+{
+  "categories": ["web", "api"],
+  "rules": {
+    "severity": "error"
+  },
+  "staticAnalysis": {
+    "golangci-lint": true,
+    "staticcheck": true,
+    "govet": true,
+    "gosec": true
+  }
+}
+```
+
+## Configuration Schema
+
+See `config/schema.json` for the complete JSON Schema definition.
+
+## Configuration Examples
+
+See `config/examples/` for complete configuration examples:
+
+- `web-service.json` - Web service configuration
+- `microservice.json` - Microservice configuration
+- `cli-tool.json` - CLI tool configuration
+- `multi-category.json` - Multiple categories
+
+## Validation
+
+Validate your configuration:
+
+```bash
+# Using JSON Schema validator
+ajv validate -s config/schema.json -d .augment/go-config.json
+```
+
+## Troubleshooting
+
+### Configuration Not Loading
+
+1. Check file location: `.augment/go-config.json`
+2. Validate JSON syntax
+3. Verify category names match exactly
+4. Check file permissions
+
+### Rules Not Applying
+
+1. Ensure `rules.enabled` is `true`
+2. Check category selection
+3. Verify rule files exist in `rules/` directory
+4. Check severity level
+
+## Next Steps
+
+- See [CATEGORIES.md](./CATEGORIES.md) for category details
+- See [TROUBLESHOOTING.md](./TROUBLESHOOTING.md) for common issues
+- See [README.md](../README.md) for module overview
+