go-convention

Golang Guidelines

• Follow the Go style guide (https://go.dev/doc/effective_go).
• Use lowercase package names (e.g., http, utils).
• Prefer explicit error handling with if err != nil over panics.
• Use structs with exported fields (capitalized) for public APIs; lowercase for internal use.
• Avoid unnecessary interfaces; only define them when multiple implementations are needed.
• Use go fmt style: no unnecessary whitespace, consistent indentation.
• Structure files: one main type/struct per file with related methods, helpers in separate utils files.
• Naming: Short, concise, and contextual (e.g., db for database, srv for server).
• Applying the Design Pattern when see the use case is fit with any design pattern.

Golang IDE Cursor Rules

These rules govern how the cursor behaves in your IDE to ensure that all generated Golang code passes linters (golint), static analysis (go vet), and can run without issues.

Automatic Imports

1. Auto-import: When a new package is referenced, the cursor automatically adds the import to the top of the file
2. Clean imports: When removing code that uses an import, the cursor automatically removes unused imports
3. Group imports: Standard library imports are grouped first, followed by third-party libraries, then local packages
4. Alphabetical order: Imports within each group are sorted alphabetically

Indentation and Formatting

1. Tab-based indentation: Always use tabs (not spaces) for indentation
2. Auto-format on save: Always run gofmt when saving a file
3. Standard bracing: Opening braces always on the same line as the statement:

   if condition {
       // Code
   }
   

4. Line length: Hard wrap at 100 characters

Variable and Function Naming

1. camelCase for private: Private variables and functions use camelCase
2. PascalCase for exported: Exported variables and functions use PascalCase
3. Acronyms: Acronyms in names are all uppercase (e.g., HTTPServer not HttpServer)
4. Short-lived variables: Use short names for variables with small scopes
5. Descriptive names: Use descriptive names for exported functions and variables
6. Context parameter: Name the context parameter ctx when present