Cursor rule

1---
2description: YAML File Rules
3globs: ["**/*.yaml", "**/*.yml"]
4alwaysApply: false
5---
6 
7 
8# YAML File Rules
9 
10## Overview
11 
12Rules for modifying YAML files (`*.yaml`, `*.yml`) in go-crypto-wallet.
13 
14## Applicable Directories
15 
16| Directory | Description |
17|-----------|-------------|
18| `config/` | Application configuration files |
19| `.github/workflows/` | GitHub Actions workflows |
20| `.devcontainer/` | Dev container configuration |
21| Root (`*.yaml`) | Docker Compose, tool configurations |
22 
23## Verification Commands
24 
25| Command | Purpose | Required |
26|---------|---------|----------|
27| `make yaml-lint` | Lint YAML files | Recommended |
28 
29### Target Directories for yaml-lint
30 
31The `yaml-lint` command checks:
32 
33- `.github/workflows/`
34- `.devcontainer/`
35- `config/`
36 
37## Configuration File Types
38 
39### Application Config (`config/`)
40 
41Wallet configuration files for BTC, BCH, ETH, XRP:
42 
43```yaml
44# Example: config/wallet/btc/watch.yaml
45bitcoin:
46  network: testnet
47  host: "127.0.0.1:18332"
48```
49 
50### Docker Compose (`compose*.yaml`)
51 
52Service definitions:
53 
54| File | Description |
55|------|-------------|
56| `compose.yaml` | Base services (database, etc.) |
57| `compose.btc.yaml` | Bitcoin services |
58| `compose.bch.yaml` | Bitcoin Cash services |
59| `compose.eth.yaml` | Ethereum services |
60| `compose.xrp.yaml` | Ripple services |
61 
62### GitHub Actions (`.github/workflows/`)
63 
64CI/CD workflow definitions.
65 
66## Validation
67 
68### Manual Validation
69 
70```bash
71# Validate YAML syntax
72python -c "import yaml; yaml.safe_load(open('file.yaml'))"
73 
74# Or using yq
75yq eval '.' file.yaml > /dev/null
76```
77 
78### Docker Compose Validation
79 
80```bash
81docker compose config
82```
83 
84## Best Practices
85 
86### Formatting
87 
88- Use 2 spaces for indentation
89- Use quotes for strings that could be misinterpreted
90- Keep lines under 120 characters
91 
92### Structure
93 
94```yaml
95# Good: Explicit quotes for version strings
96version: "3.8"
97 
98# Good: Explicit quotes for port mappings
99ports:
100  - "8080:80"
101 
102# Good: Anchors for repeated values
103defaults: &defaults
104  restart: unless-stopped
105
106services:
107  app:
108    <<: *defaults
109```
110 
111## Quick Checklist
112 
113- [ ] Valid YAML syntax
114- [ ] Consistent indentation (2 spaces)
115- [ ] Sensitive values use environment variables, not hardcoded
116- [ ] Port mappings are quoted
117- [ ] Comments explain non-obvious configurations
118 
119## Related Documentation
120 
121- @compose.yaml - Main Docker Compose configuration
122- @config/ - Application configuration files
123- @.github/workflows/ - CI/CD workflows
124 
125## Related Skills
126 
127- `devops` - CI/CD and DevOps workflow
128