oh-my-customcode 0.1.1 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +45 -32
- package/dist/cli/index.js +12 -20
- package/dist/index.js +3 -3
- package/package.json +2 -2
- package/templates/.claude/rules/MUST-orchestrator-coordination.md +25 -0
- package/templates/agents/index.yaml +6 -0
- package/templates/agents/infra-engineer/aws-expert/refs/aws/common-patterns.md +169 -0
- package/templates/agents/infra-engineer/aws-expert/refs/aws/index.yaml +26 -0
- package/templates/agents/infra-engineer/aws-expert/refs/aws/well-architected.md +143 -0
- package/templates/agents/infra-engineer/aws-expert/refs/aws-best-practices/SKILL.md +279 -0
- package/templates/agents/infra-engineer/aws-expert/refs/aws-best-practices/index.yaml +27 -0
- package/templates/agents/infra-engineer/docker-expert/refs/docker/compose-best-practices.md +284 -0
- package/templates/agents/infra-engineer/docker-expert/refs/docker/dockerfile-best-practices.md +262 -0
- package/templates/agents/infra-engineer/docker-expert/refs/docker/index.yaml +26 -0
- package/templates/agents/infra-engineer/docker-expert/refs/docker-best-practices/SKILL.md +274 -0
- package/templates/agents/infra-engineer/docker-expert/refs/docker-best-practices/index.yaml +26 -0
- package/templates/agents/manager/creator/refs/rules/MAY-optimization.md +93 -0
- package/templates/agents/manager/creator/refs/rules/MUST-agent-design.md +107 -0
- package/templates/agents/manager/creator/refs/rules/MUST-agent-identification.md +108 -0
- package/templates/agents/manager/creator/refs/rules/MUST-continuous-improvement.md +132 -0
- package/templates/agents/manager/creator/refs/rules/MUST-intent-transparency.md +199 -0
- package/templates/agents/manager/creator/refs/rules/MUST-language-policy.md +62 -0
- package/templates/agents/manager/creator/refs/rules/MUST-orchestrator-coordination.md +291 -0
- package/templates/agents/manager/creator/refs/rules/MUST-parallel-execution.md +341 -0
- package/templates/agents/manager/creator/refs/rules/MUST-permissions.md +84 -0
- package/templates/agents/manager/creator/refs/rules/MUST-safety.md +69 -0
- package/templates/agents/manager/creator/refs/rules/MUST-sync-verification.md +219 -0
- package/templates/agents/manager/creator/refs/rules/MUST-tool-identification.md +112 -0
- package/templates/agents/manager/creator/refs/rules/SHOULD-ecomode.md +145 -0
- package/templates/agents/manager/creator/refs/rules/SHOULD-error-handling.md +102 -0
- package/templates/agents/manager/creator/refs/rules/SHOULD-hud-statusline.md +89 -0
- package/templates/agents/manager/creator/refs/rules/SHOULD-interaction.md +103 -0
- package/templates/agents/manager/creator/refs/rules/SHOULD-memory-integration.md +114 -0
- package/templates/agents/manager/creator/refs/rules/SHOULD-pipeline-mode.md +165 -0
- package/templates/agents/manager/creator/refs/rules/index.yaml +125 -0
- package/templates/agents/manager/supplier/refs/guides/aws/common-patterns.md +169 -0
- package/templates/agents/manager/supplier/refs/guides/aws/index.yaml +26 -0
- package/templates/agents/manager/supplier/refs/guides/aws/well-architected.md +143 -0
- package/templates/agents/manager/supplier/refs/guides/claude-code/01-overview.md +42 -0
- package/templates/agents/manager/supplier/refs/guides/claude-code/03-tools.md +107 -0
- package/templates/agents/manager/supplier/refs/guides/claude-code/04-agent-skills.md +90 -0
- package/templates/agents/manager/supplier/refs/guides/claude-code/05-agent-sdk.md +129 -0
- package/templates/agents/manager/supplier/refs/guides/claude-code/06-mcp.md +165 -0
- package/templates/agents/manager/supplier/refs/guides/claude-code/07-prompt-engineering.md +100 -0
- package/templates/agents/manager/supplier/refs/guides/claude-code/08-testing.md +58 -0
- package/templates/agents/manager/supplier/refs/guides/claude-code/09-guardrails.md +80 -0
- package/templates/agents/manager/supplier/refs/guides/claude-code/10-monitoring.md +89 -0
- package/templates/agents/manager/supplier/refs/guides/claude-code/index.yaml +51 -0
- package/templates/agents/manager/supplier/refs/guides/docker/compose-best-practices.md +284 -0
- package/templates/agents/manager/supplier/refs/guides/docker/dockerfile-best-practices.md +262 -0
- package/templates/agents/manager/supplier/refs/guides/docker/index.yaml +26 -0
- package/templates/agents/manager/supplier/refs/guides/fastapi/best-practices.md +232 -0
- package/templates/agents/manager/supplier/refs/guides/fastapi/index.yaml +21 -0
- package/templates/agents/manager/supplier/refs/guides/go-backend/index.yaml +26 -0
- package/templates/agents/manager/supplier/refs/guides/go-backend/project-layout.md +243 -0
- package/templates/agents/manager/supplier/refs/guides/go-backend/uber-style.md +212 -0
- package/templates/agents/manager/supplier/refs/guides/golang/concurrency.md +282 -0
- package/templates/agents/manager/supplier/refs/guides/golang/effective-go.md +309 -0
- package/templates/agents/manager/supplier/refs/guides/golang/error-handling.md +250 -0
- package/templates/agents/manager/supplier/refs/guides/golang/index.yaml +27 -0
- package/templates/agents/manager/supplier/refs/guides/index.yaml +101 -0
- package/templates/agents/manager/supplier/refs/guides/kotlin/coding-conventions.md +247 -0
- package/templates/agents/manager/supplier/refs/guides/kotlin/idioms.md +234 -0
- package/templates/agents/manager/supplier/refs/guides/kotlin/index.yaml +26 -0
- package/templates/agents/manager/supplier/refs/guides/python/index.yaml +26 -0
- package/templates/agents/manager/supplier/refs/guides/python/pep8-style-guide.md +202 -0
- package/templates/agents/manager/supplier/refs/guides/python/zen-of-python.md +79 -0
- package/templates/agents/manager/supplier/refs/guides/rust/error-handling.md +262 -0
- package/templates/agents/manager/supplier/refs/guides/rust/index.yaml +26 -0
- package/templates/agents/manager/supplier/refs/guides/rust/ownership.md +180 -0
- package/templates/agents/manager/supplier/refs/guides/springboot/best-practices.md +361 -0
- package/templates/agents/manager/supplier/refs/guides/springboot/index.yaml +22 -0
- package/templates/agents/manager/supplier/refs/guides/typescript/advanced-types.md +225 -0
- package/templates/agents/manager/supplier/refs/guides/typescript/index.yaml +26 -0
- package/templates/agents/manager/supplier/refs/guides/typescript/type-system.md +219 -0
- package/templates/agents/manager/supplier/refs/guides/web-design/accessibility.md +66 -0
- package/templates/agents/manager/supplier/refs/guides/web-design/index.yaml +20 -0
- package/templates/agents/manager/supplier/refs/guides/web-design/performance.md +102 -0
- package/templates/agents/manager/supplier/refs/rules/MAY-optimization.md +93 -0
- package/templates/agents/manager/supplier/refs/rules/MUST-agent-design.md +107 -0
- package/templates/agents/manager/supplier/refs/rules/MUST-agent-identification.md +108 -0
- package/templates/agents/manager/supplier/refs/rules/MUST-continuous-improvement.md +132 -0
- package/templates/agents/manager/supplier/refs/rules/MUST-intent-transparency.md +199 -0
- package/templates/agents/manager/supplier/refs/rules/MUST-language-policy.md +62 -0
- package/templates/agents/manager/supplier/refs/rules/MUST-orchestrator-coordination.md +291 -0
- package/templates/agents/manager/supplier/refs/rules/MUST-parallel-execution.md +341 -0
- package/templates/agents/manager/supplier/refs/rules/MUST-permissions.md +84 -0
- package/templates/agents/manager/supplier/refs/rules/MUST-safety.md +69 -0
- package/templates/agents/manager/supplier/refs/rules/MUST-sync-verification.md +219 -0
- package/templates/agents/manager/supplier/refs/rules/MUST-tool-identification.md +112 -0
- package/templates/agents/manager/supplier/refs/rules/SHOULD-ecomode.md +145 -0
- package/templates/agents/manager/supplier/refs/rules/SHOULD-error-handling.md +102 -0
- package/templates/agents/manager/supplier/refs/rules/SHOULD-hud-statusline.md +89 -0
- package/templates/agents/manager/supplier/refs/rules/SHOULD-interaction.md +103 -0
- package/templates/agents/manager/supplier/refs/rules/SHOULD-memory-integration.md +114 -0
- package/templates/agents/manager/supplier/refs/rules/SHOULD-pipeline-mode.md +165 -0
- package/templates/agents/manager/supplier/refs/rules/index.yaml +125 -0
- package/templates/agents/manager/supplier/refs/skills/backend/fastapi-best-practices/SKILL.md +269 -0
- package/templates/agents/manager/supplier/refs/skills/backend/fastapi-best-practices/index.yaml +25 -0
- package/templates/agents/manager/supplier/refs/skills/backend/go-backend-best-practices/SKILL.md +337 -0
- package/templates/agents/manager/supplier/refs/skills/backend/go-backend-best-practices/index.yaml +26 -0
- package/templates/agents/manager/supplier/refs/skills/backend/springboot-best-practices/SKILL.md +356 -0
- package/templates/agents/manager/supplier/refs/skills/backend/springboot-best-practices/index.yaml +27 -0
- package/templates/agents/manager/supplier/refs/skills/development/go-best-practices/SKILL.md +202 -0
- package/templates/agents/manager/supplier/refs/skills/development/go-best-practices/index.yaml +25 -0
- package/templates/agents/manager/supplier/refs/skills/development/kotlin-best-practices/SKILL.md +255 -0
- package/templates/agents/manager/supplier/refs/skills/development/kotlin-best-practices/index.yaml +27 -0
- package/templates/agents/manager/supplier/refs/skills/development/python-best-practices/SKILL.md +221 -0
- package/templates/agents/manager/supplier/refs/skills/development/python-best-practices/index.yaml +25 -0
- package/templates/agents/manager/supplier/refs/skills/development/react-best-practices/SKILL.md +100 -0
- package/templates/agents/manager/supplier/refs/skills/development/react-best-practices/index.yaml +39 -0
- package/templates/agents/manager/supplier/refs/skills/development/rust-best-practices/SKILL.md +266 -0
- package/templates/agents/manager/supplier/refs/skills/development/rust-best-practices/index.yaml +26 -0
- package/templates/agents/manager/supplier/refs/skills/development/typescript-best-practices/SKILL.md +320 -0
- package/templates/agents/manager/supplier/refs/skills/development/typescript-best-practices/index.yaml +28 -0
- package/templates/agents/manager/supplier/refs/skills/development/vercel-deploy/SKILL.md +73 -0
- package/templates/agents/manager/supplier/refs/skills/development/vercel-deploy/index.yaml +30 -0
- package/templates/agents/manager/supplier/refs/skills/development/web-design-guidelines/SKILL.md +117 -0
- package/templates/agents/manager/supplier/refs/skills/development/web-design-guidelines/index.yaml +34 -0
- package/templates/agents/manager/supplier/refs/skills/index.yaml +129 -0
- package/templates/agents/manager/supplier/refs/skills/infrastructure/aws-best-practices/SKILL.md +279 -0
- package/templates/agents/manager/supplier/refs/skills/infrastructure/aws-best-practices/index.yaml +27 -0
- package/templates/agents/manager/supplier/refs/skills/infrastructure/docker-best-practices/SKILL.md +274 -0
- package/templates/agents/manager/supplier/refs/skills/infrastructure/docker-best-practices/index.yaml +26 -0
- package/templates/agents/manager/supplier/refs/skills/orchestration/intent-detection/SKILL.md +214 -0
- package/templates/agents/manager/supplier/refs/skills/orchestration/intent-detection/index.yaml +30 -0
- package/templates/agents/manager/supplier/refs/skills/orchestration/intent-detection/patterns/agent-triggers.yaml +342 -0
- package/templates/agents/manager/supplier/refs/skills/orchestration/pipeline-execution/SKILL.md +188 -0
- package/templates/agents/manager/supplier/refs/skills/orchestration/pipeline-execution/index.yaml +27 -0
- package/templates/agents/manager/supplier/refs/skills/system/memory-management/SKILL.md +194 -0
- package/templates/agents/manager/supplier/refs/skills/system/memory-management/index.yaml +30 -0
- package/templates/agents/manager/supplier/refs/skills/system/result-aggregation/SKILL.md +163 -0
- package/templates/agents/manager/supplier/refs/skills/system/result-aggregation/index.yaml +36 -0
- package/templates/agents/manager/updater/refs/rules/MAY-optimization.md +93 -0
- package/templates/agents/manager/updater/refs/rules/MUST-agent-design.md +107 -0
- package/templates/agents/manager/updater/refs/rules/MUST-agent-identification.md +108 -0
- package/templates/agents/manager/updater/refs/rules/MUST-continuous-improvement.md +132 -0
- package/templates/agents/manager/updater/refs/rules/MUST-intent-transparency.md +199 -0
- package/templates/agents/manager/updater/refs/rules/MUST-language-policy.md +62 -0
- package/templates/agents/manager/updater/refs/rules/MUST-orchestrator-coordination.md +291 -0
- package/templates/agents/manager/updater/refs/rules/MUST-parallel-execution.md +341 -0
- package/templates/agents/manager/updater/refs/rules/MUST-permissions.md +84 -0
- package/templates/agents/manager/updater/refs/rules/MUST-safety.md +69 -0
- package/templates/agents/manager/updater/refs/rules/MUST-sync-verification.md +219 -0
- package/templates/agents/manager/updater/refs/rules/MUST-tool-identification.md +112 -0
- package/templates/agents/manager/updater/refs/rules/SHOULD-ecomode.md +145 -0
- package/templates/agents/manager/updater/refs/rules/SHOULD-error-handling.md +102 -0
- package/templates/agents/manager/updater/refs/rules/SHOULD-hud-statusline.md +89 -0
- package/templates/agents/manager/updater/refs/rules/SHOULD-interaction.md +103 -0
- package/templates/agents/manager/updater/refs/rules/SHOULD-memory-integration.md +114 -0
- package/templates/agents/manager/updater/refs/rules/SHOULD-pipeline-mode.md +165 -0
- package/templates/agents/manager/updater/refs/rules/index.yaml +125 -0
- package/templates/agents/orchestrator/secretary/refs/rules/MAY-optimization.md +93 -0
- package/templates/agents/orchestrator/secretary/refs/rules/MUST-agent-design.md +107 -0
- package/templates/agents/orchestrator/secretary/refs/rules/MUST-agent-identification.md +108 -0
- package/templates/agents/orchestrator/secretary/refs/rules/MUST-continuous-improvement.md +132 -0
- package/templates/agents/orchestrator/secretary/refs/rules/MUST-intent-transparency.md +199 -0
- package/templates/agents/orchestrator/secretary/refs/rules/MUST-language-policy.md +62 -0
- package/templates/agents/orchestrator/secretary/refs/rules/MUST-orchestrator-coordination.md +291 -0
- package/templates/agents/orchestrator/secretary/refs/rules/MUST-parallel-execution.md +341 -0
- package/templates/agents/orchestrator/secretary/refs/rules/MUST-permissions.md +84 -0
- package/templates/agents/orchestrator/secretary/refs/rules/MUST-safety.md +69 -0
- package/templates/agents/orchestrator/secretary/refs/rules/MUST-sync-verification.md +219 -0
- package/templates/agents/orchestrator/secretary/refs/rules/MUST-tool-identification.md +112 -0
- package/templates/agents/orchestrator/secretary/refs/rules/SHOULD-ecomode.md +145 -0
- package/templates/agents/orchestrator/secretary/refs/rules/SHOULD-error-handling.md +102 -0
- package/templates/agents/orchestrator/secretary/refs/rules/SHOULD-hud-statusline.md +89 -0
- package/templates/agents/orchestrator/secretary/refs/rules/SHOULD-interaction.md +103 -0
- package/templates/agents/orchestrator/secretary/refs/rules/SHOULD-memory-integration.md +114 -0
- package/templates/agents/orchestrator/secretary/refs/rules/SHOULD-pipeline-mode.md +165 -0
- package/templates/agents/orchestrator/secretary/refs/rules/index.yaml +125 -0
- package/templates/agents/sw-engineer/backend/fastapi-expert/refs/fastapi/best-practices.md +232 -0
- package/templates/agents/sw-engineer/backend/fastapi-expert/refs/fastapi/index.yaml +21 -0
- package/templates/agents/sw-engineer/backend/fastapi-expert/refs/fastapi-best-practices/SKILL.md +269 -0
- package/templates/agents/sw-engineer/backend/fastapi-expert/refs/fastapi-best-practices/index.yaml +25 -0
- package/templates/agents/sw-engineer/backend/go-backend-expert/refs/go-backend/index.yaml +26 -0
- package/templates/agents/sw-engineer/backend/go-backend-expert/refs/go-backend/project-layout.md +243 -0
- package/templates/agents/sw-engineer/backend/go-backend-expert/refs/go-backend/uber-style.md +212 -0
- package/templates/agents/sw-engineer/backend/go-backend-expert/refs/go-backend-best-practices/SKILL.md +337 -0
- package/templates/agents/sw-engineer/backend/go-backend-expert/refs/go-backend-best-practices/index.yaml +26 -0
- package/templates/agents/sw-engineer/backend/springboot-expert/refs/springboot/best-practices.md +361 -0
- package/templates/agents/sw-engineer/backend/springboot-expert/refs/springboot/index.yaml +22 -0
- package/templates/agents/sw-engineer/backend/springboot-expert/refs/springboot-best-practices/SKILL.md +356 -0
- package/templates/agents/sw-engineer/backend/springboot-expert/refs/springboot-best-practices/index.yaml +27 -0
- package/templates/agents/sw-engineer/frontend/vercel-agent/refs/react-best-practices/SKILL.md +100 -0
- package/templates/agents/sw-engineer/frontend/vercel-agent/refs/react-best-practices/index.yaml +39 -0
- package/templates/agents/sw-engineer/frontend/vercel-agent/refs/vercel-deploy/SKILL.md +73 -0
- package/templates/agents/sw-engineer/frontend/vercel-agent/refs/vercel-deploy/index.yaml +30 -0
- package/templates/agents/sw-engineer/frontend/vercel-agent/refs/web-design/accessibility.md +66 -0
- package/templates/agents/sw-engineer/frontend/vercel-agent/refs/web-design/index.yaml +20 -0
- package/templates/agents/sw-engineer/frontend/vercel-agent/refs/web-design/performance.md +102 -0
- package/templates/agents/sw-engineer/frontend/vercel-agent/refs/web-design-guidelines/SKILL.md +117 -0
- package/templates/agents/sw-engineer/frontend/vercel-agent/refs/web-design-guidelines/index.yaml +34 -0
- package/templates/agents/sw-engineer/language/golang-expert/refs/go-best-practices/SKILL.md +202 -0
- package/templates/agents/sw-engineer/language/golang-expert/refs/go-best-practices/index.yaml +25 -0
- package/templates/agents/sw-engineer/language/golang-expert/refs/golang/concurrency.md +282 -0
- package/templates/agents/sw-engineer/language/golang-expert/refs/golang/effective-go.md +309 -0
- package/templates/agents/sw-engineer/language/golang-expert/refs/golang/error-handling.md +250 -0
- package/templates/agents/sw-engineer/language/golang-expert/refs/golang/index.yaml +27 -0
- package/templates/agents/sw-engineer/language/kotlin-expert/refs/kotlin/coding-conventions.md +247 -0
- package/templates/agents/sw-engineer/language/kotlin-expert/refs/kotlin/idioms.md +234 -0
- package/templates/agents/sw-engineer/language/kotlin-expert/refs/kotlin/index.yaml +26 -0
- package/templates/agents/sw-engineer/language/kotlin-expert/refs/kotlin-best-practices/SKILL.md +255 -0
- package/templates/agents/sw-engineer/language/kotlin-expert/refs/kotlin-best-practices/index.yaml +27 -0
- package/templates/agents/sw-engineer/language/python-expert/refs/python/index.yaml +26 -0
- package/templates/agents/sw-engineer/language/python-expert/refs/python/pep8-style-guide.md +202 -0
- package/templates/agents/sw-engineer/language/python-expert/refs/python/zen-of-python.md +79 -0
- package/templates/agents/sw-engineer/language/python-expert/refs/python-best-practices/SKILL.md +221 -0
- package/templates/agents/sw-engineer/language/python-expert/refs/python-best-practices/index.yaml +25 -0
- package/templates/agents/sw-engineer/language/rust-expert/refs/rust/error-handling.md +262 -0
- package/templates/agents/sw-engineer/language/rust-expert/refs/rust/index.yaml +26 -0
- package/templates/agents/sw-engineer/language/rust-expert/refs/rust/ownership.md +180 -0
- package/templates/agents/sw-engineer/language/rust-expert/refs/rust-best-practices/SKILL.md +266 -0
- package/templates/agents/sw-engineer/language/rust-expert/refs/rust-best-practices/index.yaml +26 -0
- package/templates/agents/sw-engineer/language/typescript-expert/refs/typescript/advanced-types.md +225 -0
- package/templates/agents/sw-engineer/language/typescript-expert/refs/typescript/index.yaml +26 -0
- package/templates/agents/sw-engineer/language/typescript-expert/refs/typescript/type-system.md +219 -0
- package/templates/agents/sw-engineer/language/typescript-expert/refs/typescript-best-practices/SKILL.md +320 -0
- package/templates/agents/sw-engineer/language/typescript-expert/refs/typescript-best-practices/index.yaml +28 -0
- package/templates/agents/tutor/go-tutor/AGENT.md +130 -0
- package/templates/agents/tutor/go-tutor/index.yaml +48 -0
- package/templates/manifest.json +55 -0
- package/templates/skills/orchestration/intent-detection/patterns/agent-triggers.yaml +9 -0
|
@@ -0,0 +1,212 @@
|
|
|
1
|
+
# Uber Go Style Guide
|
|
2
|
+
|
|
3
|
+
> Source: https://github.com/uber-go/guide/blob/master/style.md
|
|
4
|
+
|
|
5
|
+
## Guidelines
|
|
6
|
+
|
|
7
|
+
### Verify Interface Compliance
|
|
8
|
+
|
|
9
|
+
```go
|
|
10
|
+
// Compile-time check
|
|
11
|
+
var _ http.Handler = (*Handler)(nil)
|
|
12
|
+
var _ io.Reader = (*MyReader)(nil)
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
### Receiver Type
|
|
16
|
+
|
|
17
|
+
```go
|
|
18
|
+
// Value receiver: doesn't modify state
|
|
19
|
+
func (s Stack) Length() int {
|
|
20
|
+
return len(s.items)
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
// Pointer receiver: modifies state or is large
|
|
24
|
+
func (s *Stack) Push(item int) {
|
|
25
|
+
s.items = append(s.items, item)
|
|
26
|
+
}
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### Zero-value Mutexes
|
|
30
|
+
|
|
31
|
+
```go
|
|
32
|
+
// Good: zero-value is valid
|
|
33
|
+
var mu sync.Mutex
|
|
34
|
+
|
|
35
|
+
// Good: embedded in struct
|
|
36
|
+
type Store struct {
|
|
37
|
+
mu sync.Mutex
|
|
38
|
+
items map[string]Item
|
|
39
|
+
}
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### Copy Slices and Maps
|
|
43
|
+
|
|
44
|
+
```go
|
|
45
|
+
// Returning: copy to prevent external modification
|
|
46
|
+
func (s *Store) GetItems() []Item {
|
|
47
|
+
s.mu.RLock()
|
|
48
|
+
defer s.mu.RUnlock()
|
|
49
|
+
items := make([]Item, len(s.items))
|
|
50
|
+
copy(items, s.items)
|
|
51
|
+
return items
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
// Receiving: copy to prevent caller modification
|
|
55
|
+
func (s *Store) SetItems(items []Item) {
|
|
56
|
+
s.mu.Lock()
|
|
57
|
+
defer s.mu.Unlock()
|
|
58
|
+
s.items = make([]Item, len(items))
|
|
59
|
+
copy(s.items, items)
|
|
60
|
+
}
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Defer for Cleanup
|
|
64
|
+
|
|
65
|
+
```go
|
|
66
|
+
func readFile(path string) ([]byte, error) {
|
|
67
|
+
f, err := os.Open(path)
|
|
68
|
+
if err != nil {
|
|
69
|
+
return nil, err
|
|
70
|
+
}
|
|
71
|
+
defer f.Close()
|
|
72
|
+
return io.ReadAll(f)
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
func process() {
|
|
76
|
+
mu.Lock()
|
|
77
|
+
defer mu.Unlock()
|
|
78
|
+
// ...
|
|
79
|
+
}
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### Channel Size
|
|
83
|
+
|
|
84
|
+
```go
|
|
85
|
+
// Good: unbuffered or 1
|
|
86
|
+
ch := make(chan int)
|
|
87
|
+
ch := make(chan int, 1)
|
|
88
|
+
|
|
89
|
+
// Requires justification
|
|
90
|
+
ch := make(chan int, 100) // Why 100?
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### Start Enums at One
|
|
94
|
+
|
|
95
|
+
```go
|
|
96
|
+
type Operation int
|
|
97
|
+
|
|
98
|
+
const (
|
|
99
|
+
Add Operation = iota + 1
|
|
100
|
+
Subtract
|
|
101
|
+
Multiply
|
|
102
|
+
)
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### Error Types
|
|
106
|
+
|
|
107
|
+
```go
|
|
108
|
+
// Sentinel errors
|
|
109
|
+
var ErrNotFound = errors.New("not found")
|
|
110
|
+
|
|
111
|
+
// Error wrapping
|
|
112
|
+
if err != nil {
|
|
113
|
+
return fmt.Errorf("failed to get user: %w", err)
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
// Checking errors
|
|
117
|
+
if errors.Is(err, ErrNotFound) {
|
|
118
|
+
// handle not found
|
|
119
|
+
}
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### Handle Errors Once
|
|
123
|
+
|
|
124
|
+
```go
|
|
125
|
+
// Bad: logs AND returns
|
|
126
|
+
if err != nil {
|
|
127
|
+
log.Printf("error: %v", err)
|
|
128
|
+
return err
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
// Good: return with context
|
|
132
|
+
if err != nil {
|
|
133
|
+
return fmt.Errorf("process: %w", err)
|
|
134
|
+
}
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### Use strconv Over fmt
|
|
138
|
+
|
|
139
|
+
```go
|
|
140
|
+
// Good
|
|
141
|
+
s := strconv.Itoa(n)
|
|
142
|
+
n, err := strconv.Atoi(s)
|
|
143
|
+
|
|
144
|
+
// Slower
|
|
145
|
+
s := fmt.Sprintf("%d", n)
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### Table-Driven Tests
|
|
149
|
+
|
|
150
|
+
```go
|
|
151
|
+
func TestSplit(t *testing.T) {
|
|
152
|
+
tests := []struct {
|
|
153
|
+
name string
|
|
154
|
+
input string
|
|
155
|
+
sep string
|
|
156
|
+
want []string
|
|
157
|
+
}{
|
|
158
|
+
{
|
|
159
|
+
name: "simple",
|
|
160
|
+
input: "a/b/c",
|
|
161
|
+
sep: "/",
|
|
162
|
+
want: []string{"a", "b", "c"},
|
|
163
|
+
},
|
|
164
|
+
{
|
|
165
|
+
name: "empty",
|
|
166
|
+
input: "",
|
|
167
|
+
sep: "/",
|
|
168
|
+
want: []string{""},
|
|
169
|
+
},
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
for _, tt := range tests {
|
|
173
|
+
t.Run(tt.name, func(t *testing.T) {
|
|
174
|
+
got := strings.Split(tt.input, tt.sep)
|
|
175
|
+
if diff := cmp.Diff(tt.want, got); diff != "" {
|
|
176
|
+
t.Errorf("mismatch (-want +got):\n%s", diff)
|
|
177
|
+
}
|
|
178
|
+
})
|
|
179
|
+
}
|
|
180
|
+
}
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
### Functional Options
|
|
184
|
+
|
|
185
|
+
```go
|
|
186
|
+
type Server struct {
|
|
187
|
+
addr string
|
|
188
|
+
timeout time.Duration
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
type Option func(*Server)
|
|
192
|
+
|
|
193
|
+
func WithTimeout(d time.Duration) Option {
|
|
194
|
+
return func(s *Server) {
|
|
195
|
+
s.timeout = d
|
|
196
|
+
}
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
func NewServer(addr string, opts ...Option) *Server {
|
|
200
|
+
s := &Server{
|
|
201
|
+
addr: addr,
|
|
202
|
+
timeout: time.Second * 30,
|
|
203
|
+
}
|
|
204
|
+
for _, opt := range opts {
|
|
205
|
+
opt(s)
|
|
206
|
+
}
|
|
207
|
+
return s
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
// Usage
|
|
211
|
+
server := NewServer(":8080", WithTimeout(time.Minute))
|
|
212
|
+
```
|
|
@@ -0,0 +1,282 @@
|
|
|
1
|
+
# Go Concurrency Patterns
|
|
2
|
+
|
|
3
|
+
> Reference for concurrent programming in Go
|
|
4
|
+
|
|
5
|
+
## Core Philosophy
|
|
6
|
+
|
|
7
|
+
> Do not communicate by sharing memory; instead, share memory by communicating.
|
|
8
|
+
|
|
9
|
+
Go's approach to concurrency differs from traditional threading models. Channels provide a way to safely communicate between goroutines without explicit locks.
|
|
10
|
+
|
|
11
|
+
## Goroutines
|
|
12
|
+
|
|
13
|
+
A goroutine is a lightweight thread managed by the Go runtime.
|
|
14
|
+
|
|
15
|
+
```go
|
|
16
|
+
// Start a goroutine
|
|
17
|
+
go doSomething()
|
|
18
|
+
|
|
19
|
+
// With anonymous function
|
|
20
|
+
go func() {
|
|
21
|
+
// concurrent work
|
|
22
|
+
}()
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### Goroutine Lifecycle
|
|
26
|
+
|
|
27
|
+
- Created with `go` keyword
|
|
28
|
+
- Runs concurrently with calling goroutine
|
|
29
|
+
- Exits when function returns
|
|
30
|
+
- Main goroutine exit = program exit
|
|
31
|
+
|
|
32
|
+
## Channels
|
|
33
|
+
|
|
34
|
+
### Basic Operations
|
|
35
|
+
|
|
36
|
+
```go
|
|
37
|
+
// Create
|
|
38
|
+
ch := make(chan int) // unbuffered
|
|
39
|
+
ch := make(chan int, 10) // buffered, capacity 10
|
|
40
|
+
|
|
41
|
+
// Send
|
|
42
|
+
ch <- value
|
|
43
|
+
|
|
44
|
+
// Receive
|
|
45
|
+
value := <-ch
|
|
46
|
+
value, ok := <-ch // ok is false if channel closed
|
|
47
|
+
|
|
48
|
+
// Close
|
|
49
|
+
close(ch)
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Unbuffered vs Buffered
|
|
53
|
+
|
|
54
|
+
| Type | Behavior |
|
|
55
|
+
|------|----------|
|
|
56
|
+
| Unbuffered | Sender blocks until receiver ready |
|
|
57
|
+
| Buffered | Sender blocks only when buffer full |
|
|
58
|
+
|
|
59
|
+
### Directional Channels
|
|
60
|
+
|
|
61
|
+
```go
|
|
62
|
+
func sender(ch chan<- int) {
|
|
63
|
+
ch <- 42 // send-only
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
func receiver(ch <-chan int) {
|
|
67
|
+
v := <-ch // receive-only
|
|
68
|
+
}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Common Patterns
|
|
72
|
+
|
|
73
|
+
### Worker Pool
|
|
74
|
+
|
|
75
|
+
```go
|
|
76
|
+
func worker(id int, jobs <-chan int, results chan<- int) {
|
|
77
|
+
for j := range jobs {
|
|
78
|
+
results <- j * 2
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
func main() {
|
|
83
|
+
jobs := make(chan int, 100)
|
|
84
|
+
results := make(chan int, 100)
|
|
85
|
+
|
|
86
|
+
// Start 3 workers
|
|
87
|
+
for w := 1; w <= 3; w++ {
|
|
88
|
+
go worker(w, jobs, results)
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
// Send jobs
|
|
92
|
+
for j := 1; j <= 9; j++ {
|
|
93
|
+
jobs <- j
|
|
94
|
+
}
|
|
95
|
+
close(jobs)
|
|
96
|
+
|
|
97
|
+
// Collect results
|
|
98
|
+
for a := 1; a <= 9; a++ {
|
|
99
|
+
<-results
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### Fan-Out, Fan-In
|
|
105
|
+
|
|
106
|
+
```go
|
|
107
|
+
// Fan-out: multiple goroutines read from same channel
|
|
108
|
+
// Fan-in: single goroutine reads from multiple channels
|
|
109
|
+
|
|
110
|
+
func fanIn(ch1, ch2 <-chan int) <-chan int {
|
|
111
|
+
out := make(chan int)
|
|
112
|
+
go func() {
|
|
113
|
+
for {
|
|
114
|
+
select {
|
|
115
|
+
case v := <-ch1:
|
|
116
|
+
out <- v
|
|
117
|
+
case v := <-ch2:
|
|
118
|
+
out <- v
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
}()
|
|
122
|
+
return out
|
|
123
|
+
}
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
### Pipeline
|
|
127
|
+
|
|
128
|
+
```go
|
|
129
|
+
func gen(nums ...int) <-chan int {
|
|
130
|
+
out := make(chan int)
|
|
131
|
+
go func() {
|
|
132
|
+
for _, n := range nums {
|
|
133
|
+
out <- n
|
|
134
|
+
}
|
|
135
|
+
close(out)
|
|
136
|
+
}()
|
|
137
|
+
return out
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
func sq(in <-chan int) <-chan int {
|
|
141
|
+
out := make(chan int)
|
|
142
|
+
go func() {
|
|
143
|
+
for n := range in {
|
|
144
|
+
out <- n * n
|
|
145
|
+
}
|
|
146
|
+
close(out)
|
|
147
|
+
}()
|
|
148
|
+
return out
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
// Usage: for v := range sq(sq(gen(2, 3))) { ... }
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
### Context for Cancellation
|
|
155
|
+
|
|
156
|
+
```go
|
|
157
|
+
func operation(ctx context.Context) error {
|
|
158
|
+
select {
|
|
159
|
+
case <-time.After(time.Second):
|
|
160
|
+
return nil // completed
|
|
161
|
+
case <-ctx.Done():
|
|
162
|
+
return ctx.Err() // cancelled
|
|
163
|
+
}
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
func main() {
|
|
167
|
+
ctx, cancel := context.WithTimeout(context.Background(), 500*time.Millisecond)
|
|
168
|
+
defer cancel()
|
|
169
|
+
|
|
170
|
+
if err := operation(ctx); err != nil {
|
|
171
|
+
log.Fatal(err)
|
|
172
|
+
}
|
|
173
|
+
}
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
## Select Statement
|
|
177
|
+
|
|
178
|
+
```go
|
|
179
|
+
select {
|
|
180
|
+
case v := <-ch1:
|
|
181
|
+
// received from ch1
|
|
182
|
+
case ch2 <- x:
|
|
183
|
+
// sent to ch2
|
|
184
|
+
case <-time.After(time.Second):
|
|
185
|
+
// timeout
|
|
186
|
+
default:
|
|
187
|
+
// non-blocking
|
|
188
|
+
}
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
## Synchronization
|
|
192
|
+
|
|
193
|
+
### sync.WaitGroup
|
|
194
|
+
|
|
195
|
+
```go
|
|
196
|
+
var wg sync.WaitGroup
|
|
197
|
+
|
|
198
|
+
for i := 0; i < 5; i++ {
|
|
199
|
+
wg.Add(1)
|
|
200
|
+
go func(id int) {
|
|
201
|
+
defer wg.Done()
|
|
202
|
+
// work
|
|
203
|
+
}(i)
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
wg.Wait() // blocks until all done
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
### sync.Mutex
|
|
210
|
+
|
|
211
|
+
```go
|
|
212
|
+
var (
|
|
213
|
+
mu sync.Mutex
|
|
214
|
+
counter int
|
|
215
|
+
)
|
|
216
|
+
|
|
217
|
+
func increment() {
|
|
218
|
+
mu.Lock()
|
|
219
|
+
defer mu.Unlock()
|
|
220
|
+
counter++
|
|
221
|
+
}
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
### sync.Once
|
|
225
|
+
|
|
226
|
+
```go
|
|
227
|
+
var once sync.Once
|
|
228
|
+
|
|
229
|
+
func initialize() {
|
|
230
|
+
once.Do(func() {
|
|
231
|
+
// runs exactly once
|
|
232
|
+
})
|
|
233
|
+
}
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
## Avoiding Common Pitfalls
|
|
237
|
+
|
|
238
|
+
### Goroutine Leaks
|
|
239
|
+
|
|
240
|
+
```go
|
|
241
|
+
// BAD: goroutine never exits
|
|
242
|
+
go func() {
|
|
243
|
+
for {
|
|
244
|
+
// infinite loop with no exit
|
|
245
|
+
}
|
|
246
|
+
}()
|
|
247
|
+
|
|
248
|
+
// GOOD: use context or done channel
|
|
249
|
+
go func(ctx context.Context) {
|
|
250
|
+
for {
|
|
251
|
+
select {
|
|
252
|
+
case <-ctx.Done():
|
|
253
|
+
return
|
|
254
|
+
default:
|
|
255
|
+
// work
|
|
256
|
+
}
|
|
257
|
+
}
|
|
258
|
+
}(ctx)
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
### Race Conditions
|
|
262
|
+
|
|
263
|
+
```go
|
|
264
|
+
// BAD: race condition
|
|
265
|
+
go func() { x++ }()
|
|
266
|
+
go func() { x++ }()
|
|
267
|
+
|
|
268
|
+
// GOOD: use channels or mutex
|
|
269
|
+
go func() { ch <- 1 }()
|
|
270
|
+
go func() { ch <- 1 }()
|
|
271
|
+
x += <-ch + <-ch
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
### Closing Channels
|
|
275
|
+
|
|
276
|
+
```go
|
|
277
|
+
// Only sender should close
|
|
278
|
+
// Closing already-closed channel panics
|
|
279
|
+
// Sending to closed channel panics
|
|
280
|
+
|
|
281
|
+
// Pattern: use sync.Once or single sender
|
|
282
|
+
```
|