mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
311 lines
7.9 KiB
YAML
311 lines
7.9 KiB
YAML
|
|
# Constants & Shared Values
|
|||
|
|
|
|||
|
|
## Legend
|
|||
|
|
| Symbol | Meaning | | Abbrev | Meaning |
|
|||
|
|
|--------|---------|---|--------|---------|
|
|||
|
|
| 📁 | directory/path | | cfg | configuration |
|
|||
|
|
| 🔢 | number/count | | std | standard |
|
|||
|
|
| 📝 | text/string | | val | value |
|
|||
|
|
| ⚙ | setting/config | | def | default |
|
|||
|
|
|
|||
|
|
## Standard Paths & Directories
|
|||
|
|
|
|||
|
|
```yaml
|
|||
|
|
Documentation_Paths:
|
|||
|
|
Claude_Docs: ".claudedocs/"
|
|||
|
|
Reports: ".claudedocs/reports/"
|
|||
|
|
Metrics: ".claudedocs/metrics/"
|
|||
|
|
Summaries: ".claudedocs/summaries/"
|
|||
|
|
Checkpoints: ".claudedocs/checkpoints/"
|
|||
|
|
Tasks: ".claudedocs/tasks/"
|
|||
|
|
Task_Pending: ".claudedocs/tasks/pending/"
|
|||
|
|
Task_In_Progress: ".claudedocs/tasks/in-progress/"
|
|||
|
|
Task_Completed: ".claudedocs/tasks/completed/"
|
|||
|
|
Task_Cancelled: ".claudedocs/tasks/cancelled/"
|
|||
|
|
|
|||
|
|
Project_Docs:
|
|||
|
|
Documentation: "docs/"
|
|||
|
|
API_Docs: "docs/api/"
|
|||
|
|
User_Docs: "docs/user/"
|
|||
|
|
Developer_Docs: "docs/dev/"
|
|||
|
|
|
|||
|
|
Build_Artifacts:
|
|||
|
|
Build_Dir: "build/"
|
|||
|
|
Dist_Dir: "dist/"
|
|||
|
|
Output_Dir: "out/"
|
|||
|
|
Next_Dir: ".next/"
|
|||
|
|
Temp_Dir: "tmp/"
|
|||
|
|
Cache_Dir: ".cache/"
|
|||
|
|
Node_Modules: "node_modules/"
|
|||
|
|
|
|||
|
|
Git_Paths:
|
|||
|
|
Git_Dir: ".git/"
|
|||
|
|
Git_Hooks: ".git/hooks/"
|
|||
|
|
Git_Config: ".git/config"
|
|||
|
|
Gitignore: ".gitignore"
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## File Naming Conventions
|
|||
|
|
|
|||
|
|
```yaml
|
|||
|
|
Report_Files:
|
|||
|
|
Analysis_Report: "analysis-{type}-{timestamp}.md"
|
|||
|
|
Performance_Report: "performance-{date}.md"
|
|||
|
|
Security_Report: "security-scan-{timestamp}.md"
|
|||
|
|
Daily_Summary: "daily-summary-{YYYY-MM-DD}.md"
|
|||
|
|
Weekly_Trends: "weekly-trends-{YYYY-WW}.md"
|
|||
|
|
Monthly_Insights: "monthly-insights-{YYYY-MM}.md"
|
|||
|
|
|
|||
|
|
Task_Files:
|
|||
|
|
Task_Format: "{type}-{id}-{slug}.md"
|
|||
|
|
Task_ID_Format: "YYYYMMDD-HHMMSS"
|
|||
|
|
Task_Types: ["feature", "bugfix", "refactor", "docs", "test"]
|
|||
|
|
|
|||
|
|
Git_Branches:
|
|||
|
|
Task_Branch: "task/{id}-{slug}"
|
|||
|
|
Feature_Branch: "feature/{name}"
|
|||
|
|
Bugfix_Branch: "bugfix/{name}"
|
|||
|
|
Release_Branch: "release/{version}"
|
|||
|
|
|
|||
|
|
Log_Files:
|
|||
|
|
Performance_Log: "performance-{YYYY-MM-DD}.jsonl"
|
|||
|
|
Error_Log: "errors-{YYYY-MM-DD}.log"
|
|||
|
|
Audit_Log: "audit-{YYYY-MM-DD}.log"
|
|||
|
|
Debug_Log: "debug-{timestamp}.log"
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## Standard Symbols & Abbreviations
|
|||
|
|
|
|||
|
|
```yaml
|
|||
|
|
Process_Symbols:
|
|||
|
|
Leads_To: "→"
|
|||
|
|
Combine: "&"
|
|||
|
|
With: "w/"
|
|||
|
|
At_Location: "@"
|
|||
|
|
For_All: "∀"
|
|||
|
|
Exists: "∃"
|
|||
|
|
Therefore: "∴"
|
|||
|
|
Because: "∵"
|
|||
|
|
|
|||
|
|
Status_Symbols:
|
|||
|
|
Success: "✅"
|
|||
|
|
Failure: "❌"
|
|||
|
|
Warning: "⚠"
|
|||
|
|
Information: "ℹ"
|
|||
|
|
Critical: "🚨"
|
|||
|
|
Fast: "⚡"
|
|||
|
|
Slow: "🐌"
|
|||
|
|
Progress: "🔄"
|
|||
|
|
Complete: "✨"
|
|||
|
|
|
|||
|
|
File_Operations:
|
|||
|
|
Read: "📖"
|
|||
|
|
Write: "📝"
|
|||
|
|
Edit: "✏"
|
|||
|
|
Delete: "🗑"
|
|||
|
|
Copy: "📋"
|
|||
|
|
Move: "➡"
|
|||
|
|
Create: "➕"
|
|||
|
|
|
|||
|
|
Common_Abbreviations:
|
|||
|
|
Configuration: "cfg"
|
|||
|
|
Implementation: "impl"
|
|||
|
|
Performance: "perf"
|
|||
|
|
Validation: "val"
|
|||
|
|
Requirements: "req"
|
|||
|
|
Dependencies: "deps"
|
|||
|
|
Environment: "env"
|
|||
|
|
Database: "db"
|
|||
|
|
Interface: "api"
|
|||
|
|
Documentation: "docs"
|
|||
|
|
Operations: "ops"
|
|||
|
|
Standard: "std"
|
|||
|
|
Default: "def"
|
|||
|
|
Context: "ctx"
|
|||
|
|
Error: "err"
|
|||
|
|
Recovery: "rec"
|
|||
|
|
Execution: "exec"
|
|||
|
|
Token: "tok"
|
|||
|
|
Optimization: "opt"
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## Standard Time & Size Limits
|
|||
|
|
|
|||
|
|
```yaml
|
|||
|
|
Time_Limits:
|
|||
|
|
Quick_Operation: "< 5 seconds"
|
|||
|
|
Standard_Operation: "< 30 seconds"
|
|||
|
|
Long_Operation: "< 120 seconds"
|
|||
|
|
Critical_Timeout: "300 seconds (5 minutes)"
|
|||
|
|
Session_Timeout: "1800 seconds (30 minutes)"
|
|||
|
|
|
|||
|
|
Token_Limits:
|
|||
|
|
Small_Response: "< 500 tokens"
|
|||
|
|
Medium_Response: "< 2000 tokens"
|
|||
|
|
Large_Response: "< 5000 tokens"
|
|||
|
|
Context_Warning: "> 70% context size"
|
|||
|
|
Context_Critical: "> 90% context size"
|
|||
|
|
|
|||
|
|
File_Size_Limits:
|
|||
|
|
Small_File: "< 10 KB"
|
|||
|
|
Medium_File: "< 100 KB"
|
|||
|
|
Large_File: "< 1 MB"
|
|||
|
|
Huge_File: "> 1 MB"
|
|||
|
|
Max_Analysis: "5 MB"
|
|||
|
|
|
|||
|
|
Retry_Limits:
|
|||
|
|
Default_Retries: 3
|
|||
|
|
Network_Retries: 5
|
|||
|
|
File_Lock_Retries: 3
|
|||
|
|
MCP_Server_Retries: 3
|
|||
|
|
Max_Consecutive_Failures: 5
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## Standard Priority & Severity Values
|
|||
|
|
|
|||
|
|
```yaml
|
|||
|
|
Priority_Levels:
|
|||
|
|
Critical: "critical"
|
|||
|
|
High: "high"
|
|||
|
|
Medium: "medium"
|
|||
|
|
Low: "low"
|
|||
|
|
|
|||
|
|
Severity_Numbers:
|
|||
|
|
Critical: 10
|
|||
|
|
High_Max: 9
|
|||
|
|
High_Mid: 8
|
|||
|
|
High_Min: 7
|
|||
|
|
Medium_Max: 6
|
|||
|
|
Medium_Mid: 5
|
|||
|
|
Medium_Min: 4
|
|||
|
|
Low_Max: 3
|
|||
|
|
Low_Mid: 2
|
|||
|
|
Low_Min: 1
|
|||
|
|
|
|||
|
|
Status_Values:
|
|||
|
|
Pending: "pending"
|
|||
|
|
In_Progress: "in_progress"
|
|||
|
|
Completed: "completed"
|
|||
|
|
Failed: "failed"
|
|||
|
|
Cancelled: "cancelled"
|
|||
|
|
Paused: "paused"
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## Standard Tool Names & Commands
|
|||
|
|
|
|||
|
|
```yaml
|
|||
|
|
Native_Tools:
|
|||
|
|
File_Tools: ["Read", "Write", "Edit", "MultiEdit", "Glob"]
|
|||
|
|
System_Tools: ["Bash", "LS"]
|
|||
|
|
Search_Tools: ["Grep", "Task"]
|
|||
|
|
Notebook_Tools: ["NotebookRead", "NotebookEdit"]
|
|||
|
|
Web_Tools: ["WebFetch", "WebSearch"]
|
|||
|
|
Task_Tools: ["TodoRead", "TodoWrite"]
|
|||
|
|
|
|||
|
|
MCP_Servers:
|
|||
|
|
Context7: "mcp__context7__*"
|
|||
|
|
Sequential: "mcp__sequential-thinking__*"
|
|||
|
|
Magic: "mcp__magic__*"
|
|||
|
|
Puppeteer: "mcp__puppeteer__*"
|
|||
|
|
|
|||
|
|
Common_Commands:
|
|||
|
|
Git_Commands: ["status", "add", "commit", "push", "pull", "checkout", "branch", "merge"]
|
|||
|
|
Build_Commands: ["build", "test", "lint", "format", "typecheck"]
|
|||
|
|
Package_Commands: ["install", "update", "audit", "outdated"]
|
|||
|
|
|
|||
|
|
Standard_Flags:
|
|||
|
|
Planning: "--plan"
|
|||
|
|
Thinking: ["--think", "--think-hard", "--ultrathink"]
|
|||
|
|
Compression: ["--uc", "--ultracompressed"]
|
|||
|
|
MCP_Control: ["--c7", "--seq", "--magic", "--pup", "--all-mcp", "--no-mcp"]
|
|||
|
|
Execution: ["--dry-run", "--watch", "--interactive", "--force"]
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## Standard Messages & Templates
|
|||
|
|
|
|||
|
|
```yaml
|
|||
|
|
Success_Messages:
|
|||
|
|
Operation_Complete: "✅ {operation} completed successfully"
|
|||
|
|
File_Created: "📝 Created: {file_path}"
|
|||
|
|
File_Updated: "✏ Updated: {file_path}"
|
|||
|
|
Task_Complete: "✨ Task completed: {task_title}"
|
|||
|
|
|
|||
|
|
Warning_Messages:
|
|||
|
|
Performance_Warning: "⚠ Operation taking longer than expected"
|
|||
|
|
Context_Warning: "⚠ Context size approaching limit"
|
|||
|
|
Token_Warning: "⚠ High token usage detected"
|
|||
|
|
Fallback_Warning: "⚠ Using fallback method"
|
|||
|
|
|
|||
|
|
Error_Messages:
|
|||
|
|
File_Not_Found: "❌ File not found: {file_path}"
|
|||
|
|
Permission_Denied: "❌ Permission denied: {operation}"
|
|||
|
|
Operation_Failed: "❌ {operation} failed: {reason}"
|
|||
|
|
Timeout_Error: "❌ Operation timed out after {duration}"
|
|||
|
|
|
|||
|
|
Info_Messages:
|
|||
|
|
Operation_Started: "▶ Starting {operation}"
|
|||
|
|
Checkpoint_Created: "💾 Checkpoint created: {checkpoint_id}"
|
|||
|
|
Optimization_Applied: "⚡ Optimization applied: {optimization}"
|
|||
|
|
Fallback_Used: "🔄 Using alternative approach: {method}"
|
|||
|
|
|
|||
|
|
Report_References:
|
|||
|
|
Report_Saved: "📄 Report saved to: {path}"
|
|||
|
|
Metrics_Updated: "📊 Metrics updated: {path}"
|
|||
|
|
Log_Entry: "📝 Logged to: {path}"
|
|||
|
|
Checkpoint_Reference: "🔖 Checkpoint: {id}"
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## Standard Configuration Values
|
|||
|
|
|
|||
|
|
```yaml
|
|||
|
|
Default_Settings:
|
|||
|
|
Max_Retries: 3
|
|||
|
|
Timeout_Seconds: 120
|
|||
|
|
Context_Warning_Threshold: 0.7
|
|||
|
|
Context_Critical_Threshold: 0.9
|
|||
|
|
Performance_Alert_Threshold: 30
|
|||
|
|
Token_Efficiency_Threshold: 0.5
|
|||
|
|
|
|||
|
|
Environment_Types:
|
|||
|
|
Development: "dev"
|
|||
|
|
Testing: "test"
|
|||
|
|
Staging: "staging"
|
|||
|
|
Production: "prod"
|
|||
|
|
Local: "local"
|
|||
|
|
|
|||
|
|
File_Extensions:
|
|||
|
|
Markdown: [".md", ".markdown"]
|
|||
|
|
Code: [".js", ".ts", ".tsx", ".jsx", ".py", ".go", ".rs", ".cpp", ".c", ".java"]
|
|||
|
|
Config: [".json", ".yml", ".yaml", ".toml", ".ini", ".env"]
|
|||
|
|
Documentation: [".md", ".rst", ".txt", ".adoc"]
|
|||
|
|
|
|||
|
|
Supported_Frameworks:
|
|||
|
|
Frontend: ["React", "Vue", "Angular", "Svelte", "Next.js", "Nuxt.js"]
|
|||
|
|
Backend: ["Express", "FastAPI", "Django", "Rails", "Spring", "Gin"]
|
|||
|
|
Database: ["PostgreSQL", "MySQL", "MongoDB", "Redis", "SQLite"]
|
|||
|
|
Testing: ["Jest", "Mocha", "Pytest", "JUnit", "Cypress", "Playwright"]
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## Cross-Reference Patterns
|
|||
|
|
|
|||
|
|
```yaml
|
|||
|
|
Reference_Formats:
|
|||
|
|
Include_Reference: "@include shared/constants.yml#{section}"
|
|||
|
|
See_Reference: "@see shared/constants.yml#{section}"
|
|||
|
|
Flag_Reference: "@flags shared/constants.yml#{flag_group}"
|
|||
|
|
|
|||
|
|
Common_References:
|
|||
|
|
Paths: "@include shared/constants.yml#Documentation_Paths"
|
|||
|
|
Symbols: "@include shared/constants.yml#Process_Symbols"
|
|||
|
|
Limits: "@include shared/constants.yml#Time_Limits"
|
|||
|
|
Messages: "@include shared/constants.yml#Success_Messages"
|
|||
|
|
|
|||
|
|
Usage_Examples:
|
|||
|
|
Command_File: |
|
|||
|
|
Report location: @include shared/constants.yml#Documentation_Paths.Reports
|
|||
|
|
Success format: @include shared/constants.yml#Success_Messages.Operation_Complete
|
|||
|
|
Time limit: @include shared/constants.yml#Time_Limits.Standard_Operation
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
*Constants v1.0 - Shared values, paths, symbols, and standards for SuperClaude consistency*
|