sneak/prompts
1
0
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

style(go): add rule against type-only packages

Browse Source 
Types should live alongside their implementations, not in separate
'types', 'domain', or 'models' packages. Type-only packages cause
alias imports and indicate poor package design.

Prompted by review feedback on upaas PR #126.
This commit is contained in:
user 2026-02-23 11:47:50 -08:00
parent 189e54862e
commit f9dcef4c9e
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
prompts/CODE_STYLEGUIDE_GO.md
View File

@ -229,6 +229,15 @@ last_modified: 2026-02-22
1. Define your struct types near their constructors.
1. Do not create packages whose sole purpose is to hold type definitions.
Packages named `types`, `domain`, or `models` that contain only structs and
interfaces (with no behavior) are a code smell. Define types alongside the
code that uses them. Type-only packages force consuming packages into alias
imports and circular-dependency gymnastics, and indicate that the package
boundaries were drawn around nouns instead of responsibilities. If multiple
packages need the same type, put it in the package that owns the behavior,
or in a small, focused interface package — not in a grab-bag types package.
1. Define your interface types near the functions that use them, or if you have
multiple conformant types, put the interface(s) in their own file.