Skip to content

Commit df489d3

Browse files
committed
docs: add promlinter rule descriptions
1 parent 93213f8 commit df489d3

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

.golangci.next.reference.yml

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2068,15 +2068,24 @@ linters-settings:
20682068
# Please refer to https://github.com/yeya24/promlinter#usage for detailed usage.
20692069
# Default: []
20702070
disabled-linters:
2071+
# Help detects issues related to the help text for a metric.
20712072
- Help
2073+
# MetricUnits detects issues with metric unit names.
20722074
- MetricUnits
2075+
# Counter detects issues specific to counters, as well as patterns that should only be used with counters.
20732076
- Counter
2077+
# HistogramSummaryReserved detects when other types of metrics use names or labels reserved for use by histograms and/or summaries.
20742078
- HistogramSummaryReserved
2079+
# MetricTypeInName detects when metric types are included in the metric name.
20752080
- MetricTypeInName
2081+
# ReservedChars detects colons in metric names.
20762082
- ReservedChars
2083+
# CamelCase detects metric names and label names written in camelCase.
20772084
- CamelCase
2085+
# UnitAbbreviations detects abbreviated units in the metric name.
20782086
- UnitAbbreviations
20792087

2088+
20802089
protogetter:
20812090
# Skip files generated by specified generators from the checking.
20822091
# Checks only the file's initial comment, which must follow the format: "// Code generated by <generator-name>".
@@ -2974,6 +2983,16 @@ linters-settings:
29742983
- SA9009
29752984

29762985
stylecheck:
2986+
# https://staticcheck.io/docs/configuration/options/#dot_import_whitelist
2987+
# Default: ["github.com/mmcloughlin/avo/build", "github.com/mmcloughlin/avo/operand", "github.com/mmcloughlin/avo/reg"]
2988+
dot-import-whitelist:
2989+
- fmt
2990+
# https://staticcheck.io/docs/configuration/options/#initialisms
2991+
# Default: ["ACL", "API", "ASCII", "CPU", "CSS", "DNS", "EOF", "GUID", "HTML", "HTTP", "HTTPS", "ID", "IP", "JSON", "QPS", "RAM", "RPC", "SLA", "SMTP", "SQL", "SSH", "TCP", "TLS", "TTL", "UDP", "UI", "GID", "UID", "UUID", "URI", "URL", "UTF8", "VM", "XML", "XMPP", "XSRF", "XSS", "SIP", "RTP", "AMQP", "DB", "TS"]
2992+
initialisms: [ "ACL", "API", "ASCII", "CPU", "CSS", "DNS", "EOF", "GUID", "HTML", "HTTP", "HTTPS", "ID", "IP", "JSON", "QPS", "RAM", "RPC", "SLA", "SMTP", "SQL", "SSH", "TCP", "TLS", "TTL", "UDP", "UI", "GID", "UID", "UUID", "URI", "URL", "UTF8", "VM", "XML", "XMPP", "XSRF", "XSS", "SIP", "RTP", "AMQP", "DB", "TS" ]
2993+
# https://staticcheck.io/docs/configuration/options/#http_status_code_whitelist
2994+
# Default: ["200", "400", "404", "500"]
2995+
http-status-code-whitelist: [ "200", "400", "404", "500" ]
29772996
# STxxxx checks in https://staticcheck.io/docs/configuration/options/#checks
29782997
# Example (to disable some checks): [ "all", "-ST1000", "-ST1003", "-ST1016", "-ST1020", "-ST1021", "-ST1022" ]
29792998
# Default: ["*"]
@@ -3033,17 +3052,6 @@ linters-settings:
30333052
# https://staticcheck.dev/docs/checks/#ST1023
30343053
- ST1023
30353054

3036-
# https://staticcheck.io/docs/configuration/options/#dot_import_whitelist
3037-
# Default: ["github.com/mmcloughlin/avo/build", "github.com/mmcloughlin/avo/operand", "github.com/mmcloughlin/avo/reg"]
3038-
dot-import-whitelist:
3039-
- fmt
3040-
# https://staticcheck.io/docs/configuration/options/#initialisms
3041-
# Default: ["ACL", "API", "ASCII", "CPU", "CSS", "DNS", "EOF", "GUID", "HTML", "HTTP", "HTTPS", "ID", "IP", "JSON", "QPS", "RAM", "RPC", "SLA", "SMTP", "SQL", "SSH", "TCP", "TLS", "TTL", "UDP", "UI", "GID", "UID", "UUID", "URI", "URL", "UTF8", "VM", "XML", "XMPP", "XSRF", "XSS", "SIP", "RTP", "AMQP", "DB", "TS"]
3042-
initialisms: [ "ACL", "API", "ASCII", "CPU", "CSS", "DNS", "EOF", "GUID", "HTML", "HTTP", "HTTPS", "ID", "IP", "JSON", "QPS", "RAM", "RPC", "SLA", "SMTP", "SQL", "SSH", "TCP", "TLS", "TTL", "UDP", "UI", "GID", "UID", "UUID", "URI", "URL", "UTF8", "VM", "XML", "XMPP", "XSRF", "XSS", "SIP", "RTP", "AMQP", "DB", "TS" ]
3043-
# https://staticcheck.io/docs/configuration/options/#http_status_code_whitelist
3044-
# Default: ["200", "400", "404", "500"]
3045-
http-status-code-whitelist: [ "200", "400", "404", "500" ]
3046-
30473055
tagalign:
30483056
# Align and sort can be used together or separately.
30493057
#

0 commit comments

Comments
 (0)