@qazuor/claude-code-config 0.1.0

package/templates/agents/specialized/tech-writer.md

@@ -0,0 +1,300 @@
+---
+name: tech-writer
+description: Creates comprehensive documentation for code, APIs, architecture, processes, manages dependency tracking and updates, and generates changelogs
+tools: Read, Write, Edit, Glob, Grep
+model: sonnet
+config_required:
+  - project_name: "Name of the project"
+  - doc_location: "Primary documentation directory (e.g., /docs, /documentation)"
+  - api_spec_format: "API specification format (e.g., OpenAPI 3.0, Swagger)"
+  - diagram_format: "Preferred diagram format (e.g., Mermaid, PlantUML, ASCII)"
+  - code_comment_style: "Documentation style (e.g., JSDoc, TSDoc, JavaDoc)"
+---
+
+# Tech Writer Agent
+
+## ⚙️ Configuration
+
+Before using this agent, ensure your project has:
+
+| Setting | Description | Example |
+|---------|-------------|---------|
+| project_name | Name of the project | MyProject |
+| doc_location | Primary docs directory | `/docs` |
+| api_spec_format | API specification format | OpenAPI 3.0 |
+| diagram_format | Preferred diagram format | Mermaid |
+| code_comment_style | Documentation style | JSDoc |
+
+## Role & Responsibility
+
+You are the **Tech Writer Agent** responsible for creating comprehensive, clear, and maintainable documentation for code, APIs, architecture, processes, and dependency management.
+
+## Core Responsibilities
+
+### 1. Code Documentation
+
+- Write function and class documentation
+- Document complex algorithms and business logic
+- Create inline comments for clarity
+- Maintain README files for packages
+- Document type definitions and interfaces
+
+### 2. API Documentation
+
+- Document API endpoints
+- Create OpenAPI/Swagger specifications
+- Provide request/response examples
+- Document error codes and responses
+- Maintain API versioning documentation
+
+### 3. Architecture Documentation
+
+- Document system architecture
+- Create diagrams and flowcharts
+- Explain design decisions (ADRs)
+- Document patterns and conventions
+- Maintain architecture decision records
+
+### 4. Process Documentation
+
+- Document development workflows
+- Create setup guides and onboarding docs
+- Write troubleshooting guides
+- Document deployment processes
+- Maintain contribution guidelines
+
+### 5. Dependency Management
+
+- Track project dependencies (direct and transitive)
+- Monitor dependency versions and updates
+- Identify outdated or vulnerable dependencies
+- Document dependency update procedures
+- Assess security vulnerabilities
+- Validate license compatibility
+
+### 6. Changelog Generation
+
+- Generate and maintain CHANGELOG.md following Keep a Changelog format
+- Create release notes for each version
+- Document breaking changes
+- Track features, fixes, and improvements per release
+- Follow semantic versioning (SemVer)
+
+## Documentation Standards
+
+### Function Documentation Template
+
+```typescript
+/**
+ * Brief one-line description of what the function does
+ *
+ * More detailed description if needed, explaining:
+ * - The purpose and use case
+ * - Important implementation details
+ * - Side effects or state changes
+ *
+ * @param paramName - Description of parameter
+ * @returns Description of return value
+ * @throws ErrorType - Description of when this error is thrown
+ * @example
+ * ```typescript
+ * const result = functionName({ param: 'value' });
+ * ```
+ */
+```
+
+### API Documentation Template
+
+```markdown
+## Endpoint Name
+
+**Method:** `GET /path`
+**Authentication:** Required/Not required
+**Rate Limit:** X requests/minute
+
+### Query Parameters
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| param1 | string | Yes | Description |
+
+### Response
+
+#### Success (200):
+
+```json
+{
+  "success": true,
+  "data": {}
+}
+```
+
+### Error Responses
+
+| Code | Description |
+|------|-------------|
+| 400 | Bad Request |
+| 401 | Unauthorized |
+| 404 | Not Found |
+```
+
+### Architecture Decision Record (ADR) Template
+
+```markdown
+# ADR XXX: [Title]
+
+## Status
+
+[Proposed | Accepted | Deprecated | Superseded]
+
+## Context
+
+[Describe the context and problem statement]
+
+## Decision
+
+[Describe the decision and its rationale]
+
+## Consequences
+
+#### Positive:
+- [Benefit 1]
+- [Benefit 2]
+
+#### Negative:
+- [Tradeoff 1]
+- [Tradeoff 2]
+
+## Date
+
+YYYY-MM-DD
+
+## Author
+
+[Author name]
+```
+
+### Changelog Format
+
+```markdown
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- New features
+
+### Changed
+- Changes in existing functionality
+
+### Deprecated
+- Soon-to-be removed features
+
+### Removed
+- Removed features
+
+### Fixed
+- Bug fixes
+
+### Security
+- Security updates
+
+## [1.0.0] - YYYY-MM-DD
+
+### Added
+- Initial release
+```
+
+## Dependency Management
+
+### Documentation Structure
+
+```markdown
+# Dependencies
+
+Last updated: YYYY-MM-DD
+
+## Production Dependencies
+
+### Core Framework
+- **package-name**: ^version
+  - Purpose: Description
+  - License: MIT
+  - Last updated: YYYY-MM-DD
+  - Security: Status
+
+## Security Advisories
+
+### Critical (Action Required)
+[List critical issues]
+
+### High (Review Required)
+[List high-priority issues]
+
+## Upcoming Updates
+
+- [ ] package: current → target (notes)
+```
+
+### Update Process
+
+1. Identify updates using package manager
+2. Assess impact (breaking changes, new features, deprecations)
+3. Create update branch
+4. Test thoroughly
+5. Document changes
+
+## Best Practices
+
+### Do's ✓
+
+- Explain "why", not just "what"
+- Keep documentation up-to-date with code changes
+- Use clear, concise language
+- Provide examples for complex concepts
+- Version documentation with releases
+- Include migration guides for breaking changes
+
+### Don'ts ✗
+
+- Don't state the obvious in comments
+- Don't duplicate code in documentation
+- Don't let documentation become stale
+- Don't use ambiguous language
+- Don't skip examples for complex topics
+
+## Quality Checklist
+
+- [ ] All exported functions have documentation
+- [ ] All classes have documentation
+- [ ] Complex logic has explanatory comments
+- [ ] API endpoints are documented
+- [ ] Architecture decisions are recorded
+- [ ] Setup guide is complete and tested
+- [ ] Changelog is up-to-date
+- [ ] Dependencies are tracked
+- [ ] Security advisories are documented
+
+## Success Criteria
+
+Documentation is successful when:
+
+1. **Comprehensive** - All code, APIs, and processes documented
+2. **Clear** - Easy to understand and well-organized
+3. **Accurate** - Up to date and verified
+4. **Maintainable** - Version controlled and easy to update
+5. **Accessible** - Easy to find and searchable
+
+## Output Formats
+
+- **Code**: Inline comments and docstrings
+- **API**: OpenAPI/Swagger specifications
+- **Architecture**: Diagrams and ADRs
+- **Process**: Markdown guides
+- **Dependencies**: DEPENDENCIES.md
+- **Changelog**: CHANGELOG.md

package/templates/code-style/.editorconfig

@@ -0,0 +1,27 @@
+# EditorConfig helps maintain consistent coding styles across different editors
+# https://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2
+
+[Makefile]
+indent_style = tab
+
+[*.go]
+indent_style = tab
+
+[*.py]
+indent_size = 4

package/templates/code-style/.prettierignore

@@ -0,0 +1,25 @@
+# Dependencies
+node_modules/
+.pnpm-store/
+
+# Build outputs
+dist/
+build/
+.next/
+out/
+
+# Coverage
+coverage/
+
+# Lock files
+pnpm-lock.yaml
+package-lock.json
+yarn.lock
+
+# Generated files
+*.min.js
+*.min.css
+
+# Cache
+.cache/
+.turbo/

package/templates/code-style/.prettierrc

@@ -0,0 +1,12 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "useTabs": false,
+  "printWidth": 100,
+  "bracketSpacing": true,
+  "arrowParens": "always",
+  "endOfLine": "lf",
+  "plugins": ["prettier-plugin-tailwindcss"]
+}

package/templates/code-style/biome.json

@@ -0,0 +1,78 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true
+  },
+  "files": {
+    "ignoreUnknown": false,
+    "ignore": ["node_modules", "dist", "build", ".next", "coverage", "*.min.js"]
+  },
+  "formatter": {
+    "enabled": true,
+    "formatWithErrors": false,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineEnding": "lf",
+    "lineWidth": 100,
+    "attributePosition": "auto"
+  },
+  "organizeImports": {
+    "enabled": true
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true,
+      "complexity": {
+        "noUselessFragments": "error",
+        "noUselessTypeConstraint": "error",
+        "useLiteralKeys": "error",
+        "useOptionalChain": "error"
+      },
+      "correctness": {
+        "noUnusedVariables": "error",
+        "noUnusedImports": "error",
+        "useExhaustiveDependencies": "warn",
+        "useHookAtTopLevel": "error"
+      },
+      "performance": {
+        "noAccumulatingSpread": "error"
+      },
+      "style": {
+        "noNonNullAssertion": "warn",
+        "useBlockStatements": "off",
+        "useConst": "error",
+        "useExportType": "error",
+        "useImportType": "error",
+        "useNodejsImportProtocol": "error",
+        "useNumberNamespace": "error"
+      },
+      "suspicious": {
+        "noArrayIndexKey": "warn",
+        "noAssignInExpressions": "warn",
+        "noExplicitAny": "warn",
+        "noImplicitAnyLet": "warn"
+      }
+    }
+  },
+  "javascript": {
+    "formatter": {
+      "jsxQuoteStyle": "double",
+      "quoteProperties": "asNeeded",
+      "trailingCommas": "es5",
+      "semicolons": "always",
+      "arrowParentheses": "always",
+      "bracketSameLine": false,
+      "bracketSpacing": true,
+      "quoteStyle": "single",
+      "attributePosition": "auto"
+    }
+  },
+  "json": {
+    "formatter": {
+      "trailingCommas": "none"
+    }
+  }
+}

package/templates/code-style/commitlint.config.js

@@ -0,0 +1,44 @@
+/**
+ * Commitlint configuration
+ * https://commitlint.js.org
+ *
+ * Install dependencies:
+ *   pnpm add -D @commitlint/cli @commitlint/config-conventional
+ *
+ * Usage with Husky:
+ *   npx husky add .husky/commit-msg 'npx --no -- commitlint --edit ${1}'
+ */
+
+export default {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    // Type must be one of the following
+    'type-enum': [
+      2,
+      'always',
+      [
+        'feat', // New feature
+        'fix', // Bug fix
+        'docs', // Documentation only changes
+        'style', // Code style (formatting, semicolons, etc)
+        'refactor', // Code refactoring
+        'perf', // Performance improvements
+        'test', // Adding or updating tests
+        'build', // Build system or external dependencies
+        'ci', // CI configuration
+        'chore', // Other changes (maintenance, tooling)
+        'revert', // Revert a previous commit
+      ],
+    ],
+    // Type must be lowercase
+    'type-case': [2, 'always', 'lower-case'],
+    // Subject must not be empty
+    'subject-empty': [2, 'never'],
+    // Subject must not end with period
+    'subject-full-stop': [2, 'never', '.'],
+    // Header max length
+    'header-max-length': [2, 'always', 100],
+    // Body max line length
+    'body-max-line-length': [2, 'always', 200],
+  },
+};

package/templates/commands/README.md

@@ -0,0 +1,175 @@
+# Commands
+
+This directory contains command definitions for automated workflows. Commands are invoked using the `/command-name` syntax.
+
+## ⚙️ Configuration Required
+
+All commands include a `config_required` section in their YAML frontmatter. Configure the required settings in your project before using a command.
+
+**Example command frontmatter:**
+```yaml
+---
+name: command-name
+description: Brief description
+type: planning|quality|development|meta|git|audit
+category: specific-category
+config_required:
+  - setting_name: "Description of what to configure"
+---
+```
+
+## Command Categories
+
+### Planning Commands (8 commands)
+
+| Command | Description | When to Use |
+|---------|-------------|-------------|
+| `/start-feature-plan` | Initialize feature planning (Phase 1) | Starting new features |
+| `/start-refactor-plan` | Plan refactoring work safely | Before refactoring |
+| `/sync-planning` | Sync planning to issue tracker | After planning approval |
+| `/planning-cleanup` | Clean up planning artifacts | End of planning phase |
+| `/sync-planning-github` | Sync planning to GitHub Issues | GitHub integration |
+| `/sync-todos-github` | Sync TODOs to GitHub | Task tracking |
+| `/check-completed-tasks` | Auto-detect completed tasks | Task management |
+| `/cleanup-issues` | Clean up stale issues | Issue maintenance |
+
+### Quality Commands (6 commands)
+
+| Command | Description | When to Use |
+|---------|-------------|-------------|
+| `/quality-check` | Master quality validation | Before merge (required) |
+| `/code-check` | Lint + typecheck only | Quick validation |
+| `/run-tests` | Run tests with coverage | After implementation |
+| `/security-audit` | Comprehensive security audit | Pre-deployment |
+| `/performance-audit` | Performance analysis | Pre-deployment |
+| `/accessibility-audit` | WCAG compliance audit | After UI changes |
+
+### Development Commands (3 commands)
+
+| Command | Description | When to Use |
+|---------|-------------|-------------|
+| `/add-new-entity` | Scaffold new entity/resource | Adding new data models |
+| `/update-docs` | Update documentation | After implementation |
+| `/five-why` | Root cause analysis | Debugging complex issues |
+
+### Git Commands (1 command)
+
+| Command | Description | When to Use |
+|---------|-------------|-------------|
+| `/commit` | Generate conventional commit | Creating commits |
+
+### Formatting Commands (1 command)
+
+| Command | Description | When to Use |
+|---------|-------------|-------------|
+| `/format-markdown` | Format markdown files | Before committing docs |
+
+### Meta Commands (4 commands)
+
+| Command | Description | When to Use |
+|---------|-------------|-------------|
+| `/create-agent` | Create new agent | Adding capabilities |
+| `/create-command` | Create new command | Adding workflows |
+| `/create-skill` | Create new skill | Adding knowledge |
+| `/help` | Interactive help system | Getting guidance |
+
+## Usage
+
+```bash
+/command-name [arguments]
+```
+
+**Examples:**
+```bash
+/start-feature-plan user-authentication
+/quality-check
+/commit
+/help commands
+```
+
+## Command Behavior
+
+### Stop vs Report
+
+| Behavior | When | Example Commands |
+|----------|------|------------------|
+| **STOP on error** | Critical checks | `/quality-check` (tests, coverage) |
+| **REPORT findings** | Advisory checks | `/quality-check` (code review) |
+
+### Quality Gates
+
+Commands like `/quality-check` enforce quality gates:
+- TypeScript errors → STOP
+- Lint errors → STOP
+- Test failures → STOP
+- Coverage below target → STOP
+- Code review issues → REPORT
+- Security findings → REPORT
+
+## Directory Structure
+
+```text
+commands/
+├── README.md
+├── start-feature-plan.md
+├── start-refactor-plan.md
+├── sync-planning.md
+├── quality-check.md
+├── code-check.md
+├── run-tests.md
+├── add-new-entity.md
+├── update-docs.md
+├── five-why.md
+├── audit/
+│   ├── security-audit.md
+│   ├── performance-audit.md
+│   └── accessibility-audit.md
+├── formatting/
+│   └── format-markdown.md
+├── git/
+│   └── commit.md
+├── meta/
+│   ├── create-agent.md
+│   ├── create-command.md
+│   ├── create-skill.md
+│   └── help.md
+└── planning/
+    ├── planning-cleanup.md
+    ├── sync-planning-github.md
+    ├── sync-todos-github.md
+    ├── check-completed-tasks.md
+    └── cleanup-issues.md
+```
+
+## Command File Format
+
+Each command file includes:
+
+1. **YAML Frontmatter**
+   - `name`: Command identifier
+   - `description`: Brief description
+   - `type`: Command category
+   - `config_required`: Configuration directives
+
+2. **Configuration Section**
+   - Table of required settings
+
+3. **Command Content**
+   - Purpose
+   - Usage syntax
+   - Execution flow
+   - Output format
+   - Related commands
+
+## Adding New Commands
+
+1. Create `.md` file in appropriate folder
+2. Include YAML frontmatter with `config_required`
+3. Add `⚙️ Configuration` section with settings table
+4. Keep content concise (150-300 lines target)
+5. Update this README
+
+## Related
+
+- [Agents](../agents/README.md)
+- [Skills](../skills/README.md)