File size: 2,930 Bytes
7f0ec95 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 | # Example Plugin Settings File
## Template: Basic Configuration
**.claude/my-plugin.local.md:**
```markdown
---
enabled: true
mode: standard
---
# My Plugin Configuration
Plugin is active in standard mode.
```
## Template: Advanced Configuration
**.claude/my-plugin.local.md:**
```markdown
---
enabled: true
strict_mode: false
max_file_size: 1000000
allowed_extensions: [".js", ".ts", ".tsx"]
enable_logging: true
notification_level: info
retry_attempts: 3
timeout_seconds: 60
custom_path: "/path/to/data"
---
# My Plugin Advanced Configuration
This project uses custom plugin configuration with:
- Standard validation mode
- 1MB file size limit
- JavaScript/TypeScript files allowed
- Info-level logging
- 3 retry attempts
## Additional Notes
Contact @team-lead with questions about this configuration.
```
## Template: Agent State File
**.claude/multi-agent-swarm.local.md:**
```markdown
---
agent_name: database-implementation
task_number: 4.2
pr_number: 5678
coordinator_session: team-leader
enabled: true
dependencies: ["Task 3.5", "Task 4.1"]
additional_instructions: "Use PostgreSQL, not MySQL"
---
# Task Assignment: Database Schema Implementation
Implement the database schema for the new features module.
## Requirements
- Create migration files
- Add indexes for performance
- Write tests for constraints
- Document schema in README
## Success Criteria
- Migrations run successfully
- All tests pass
- PR created with CI green
- Schema documented
## Coordination
Depends on:
- Task 3.5: API endpoint definitions
- Task 4.1: Data model design
Report status to coordinator session 'team-leader'.
```
## Template: Feature Flag Pattern
**.claude/experimental-features.local.md:**
```markdown
---
enabled: true
features:
- ai_suggestions
- auto_formatting
- advanced_refactoring
experimental_mode: false
---
# Experimental Features Configuration
Current enabled features:
- AI-powered code suggestions
- Automatic code formatting
- Advanced refactoring tools
Experimental mode is OFF (stable features only).
```
## Usage in Hooks
These templates can be read by hooks:
```bash
# Check if plugin is configured
if [[ ! -f ".claude/my-plugin.local.md" ]]; then
exit 0 # Not configured, skip hook
fi
# Read settings
FRONTMATTER=$(sed -n '/^---$/,/^---$/{ /^---$/d; p; }' ".claude/my-plugin.local.md")
ENABLED=$(echo "$FRONTMATTER" | grep '^enabled:' | sed 's/enabled: *//')
# Apply settings
if [[ "$ENABLED" == "true" ]]; then
# Hook is active
# ...
fi
```
## Gitignore
Always add to project `.gitignore`:
```gitignore
# Plugin settings (user-local, not committed)
.claude/*.local.md
.claude/*.local.json
```
## Editing Settings
Users can edit settings files manually:
```bash
# Edit settings
vim .claude/my-plugin.local.md
# Changes take effect after restart
exit # Exit Claude Code
claude # Restart
```
Changes require Claude Code restart - hooks can't be hot-swapped.
|