docs: add project guide for Claude #1

Closed
mvhutz wants to merge 16 commits from docs/claude-guide into main
Showing only changes of commit 9f06a5109f - Show all commits

View File

@@ -1,230 +1,84 @@
--- ---
# golangci-lint configuration file made by @ccoVeille
# Source: https://github.com/ccoVeille/golangci-lint-config-examples/
# Author: @ccoVeille
# License: MIT
# Variant: 03-safe
# Version: v2.0.0
#
version: "2" version: "2"
formatters: formatters:
enable: enable:
# format the code
- gofmt - gofmt
# format the block of imports
- gci - gci
settings: settings:
# format the code with Go standard library
gofmt: gofmt:
# simplify the code
# https://pkg.go.dev/cmd/gofmt#hdr-The_simplify_command
simplify: true simplify: true
rewrite-rules: rewrite-rules:
# replace `interface{}` with `any` in the code on format
- pattern: 'interface{}' - pattern: 'interface{}'
replacement: 'any' replacement: 'any'
# make sure imports are always in a deterministic order gci:
# https://github.com/daixiang0/gci/
gci: # define the section orders for imports
sections: sections:
# Standard section: captures all standard packages.
- standard - standard
# Default section: catchall that is not standard or custom
- default - default
# linters that related to local tool, so they should be separated
- localmodule - localmodule
linters: linters:
exclusions: exclusions:
# these presets where present in the v1 version of golangci-lint
# it's interesting to keep them when migrating, but removing them should be the goal
presets: presets:
# exclude check on comments format in godoc
# These are common false positives in poor code
# you should not use this on recent code you write from scratch
# More information: https://golangci-lint.run/usage/false-positives/#comments
#
# Please uncomment the following line if your code is not using the godoc format
- comments - comments
# Common false positives
# feel free to remove this if you don't have any false positives
# More information: https://golangci-lint.run/usage/false-positives/#common-false-positives
- common-false-positives - common-false-positives
# Legacy preset is not recommended anymore
# More information: https://golangci-lint.run/usage/false-positives/#legacy
- legacy - legacy
# std-error-handling is a set of rules that avoid reporting unhandled errors on common functions/methods
# More information: https://golangci-lint.run/usage/false-positives/#std-error-handling
- std-error-handling - std-error-handling
# some linters are enabled by default
# https://golangci-lint.run/usage/linters/
#
# enable some extra linters
enable: enable:
# Errcheck is a program for checking for unchecked errors in Go code.
- errcheck - errcheck
# Vet examines Go source code and reports suspicious constructs.
- govet - govet
# Detects when assignments to existing variables are not used.
- ineffassign - ineffassign
# It's a set of rules from staticcheck. See https://staticcheck.io/
- staticcheck - staticcheck
# Checks Go code for unused constants, variables, functions and types.
- unused - unused
# Fast, configurable, extensible, flexible, and beautiful linter for Go.
# Drop-in replacement of golint.
- revive - revive
# make sure to use t.Helper() when needed
- thelper - thelper
# mirror suggests rewrites to avoid unnecessary []byte/string conversion
- mirror - mirror
# detect the possibility to use variables/constants from the Go standard library.
- usestdlibvars - usestdlibvars
# Finds commonly misspelled English words.
- misspell - misspell
# Checks for duplicate words in the source code.
- dupword - dupword
# linter to detect errors invalid key values count
- loggercheck - loggercheck
# detect when a package or method could be replaced by one from the standard library
- exptostd - exptostd
# detects nested contexts in loops or function literals
- fatcontext - fatcontext
# Reports uses of functions with replacement inside the testing package.
- usetesting - usetesting
settings: settings:
revive: revive:
rules: rules:
# these are the default revive rules
# you can remove the whole "rules" node if you want
# BUT
# ! /!\ they all need to be present when you want to add more rules than the default ones
# otherwise, you won't have the default rules, but only the ones you define in the "rules" node
# Blank import should be only in a main or test package, or have a comment justifying it.
- name: blank-imports - name: blank-imports
# context.Context() should be the first parameter of a function when provided as argument.
- name: context-as-argument - name: context-as-argument
arguments: arguments:
- allowTypesBefore: "*testing.T" - allowTypesBefore: "*testing.T"
# Basic types should not be used as a key in `context.WithValue`
- name: context-keys-type - name: context-keys-type
# Importing with `.` makes the programs much harder to understand
- name: dot-imports - name: dot-imports
# Empty blocks make code less readable and could be a symptom of a bug or unfinished refactoring.
- name: empty-block - name: empty-block
# for better readability, variables of type `error` must be named with the prefix `err`.
- name: error-naming - name: error-naming
# for better readability, the errors should be last in the list of returned values by a function.
- name: error-return - name: error-return
# for better readability, error messages should not be capitalized or end with punctuation or a newline.
- name: error-strings - name: error-strings
# report when replacing `errors.New(fmt.Sprintf())` with `fmt.Errorf()` is possible
- name: errorf - name: errorf
# check naming and commenting conventions on exported symbols.
- name: exported - name: exported
arguments: arguments:
# make error messages clearer
- "sayRepetitiveInsteadOfStutters" - "sayRepetitiveInsteadOfStutters"
# incrementing an integer variable by 1 is recommended to be done using the `++` operator
- name: increment-decrement - name: increment-decrement
# highlights redundant else-blocks that can be eliminated from the code
# - name: indent-error-flow
# This rule suggests a shorter way of writing ranges that do not use the second value.
- name: range - name: range
# receiver names in a method should reflect the struct name (p for Person, for example)
- name: receiver-naming - name: receiver-naming
# redefining built in names (true, false, append, make) can lead to bugs very difficult to detect.
- name: redefines-builtin-id - name: redefines-builtin-id
# redundant else-blocks that can be eliminated from the code.
# - name: superfluous-else
# prevent confusing name for variables when using `time` package
- name: time-naming - name: time-naming
# warns when an exported function or method returns a value of an un-exported type.
- name: unexported-return - name: unexported-return
# spots and proposes to remove unreachable code. also helps to spot errors
- name: unreachable-code - name: unreachable-code
# Functions or methods with unused parameters can be a symptom of an unfinished refactoring or a bug.
- name: unused-parameter - name: unused-parameter
# report when a variable declaration can be simplified
- name: var-declaration - name: var-declaration
# warns when initialism, variable or package naming conventions are not followed.
- name: var-naming - name: var-naming
misspell: misspell:
# Correct spellings using locale preferences for US or UK.
# Setting locale to US will correct the British spelling of 'colour' to 'color'.
# Default ("") is to use a neutral variety of English.
locale: US locale: US
# List of words to ignore
# among the one defined in https://github.com/golangci/misspell/blob/master/words.go
ignore-rules: [] ignore-rules: []
# - valor
# - and
# Extra word corrections.
extra-words: [] extra-words: []
# - typo: "whattever"
# correction: "whatever"
output: output:
# Order to use when sorting results.
# Possible values: `file`, `linter`, and `severity`.
#
# If the severity values are inside the following list, they are ordered in this order:
# 1. error
# 2. warning
# 3. high
# 4. medium
# 5. low
# Either they are sorted alphabetically.
#
# Default: ["file"]
sort-order: sort-order:
- linter - linter
- severity - severity
- file # filepath, line, and column. - file