Skip to content

Commit 5d4c9c6

Browse files
ldezSeigeC
ldez
authored and
SeigeC
committed
doc: improve revive documentation (golangci#2458)
1 parent deec181 commit 5d4c9c6

File tree

1 file changed

+286
-2
lines changed

1 file changed

+286
-2
lines changed

‎.golangci.example.yml

+286-2
Original file line numberDiff line numberDiff line change
@@ -638,16 +638,300 @@ linters-settings:
638638
# see https://github.com/mgechev/revive#available-rules for details.
639639
ignore-generated-header: true
640640
severity: warning
641+
enable-all-rules: false
642+
# confidence: 0.8
643+
# error-code: 0
644+
# warning-code: 0
641645
rules:
642-
- name: indent-error-flow
643-
severity: warning
646+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#add-constant
644647
- name: add-constant
645648
severity: warning
649+
disable: false
646650
arguments:
647651
- maxLitCount: "3"
648652
allowStrs: '""'
649653
allowInts: "0,1,2"
650654
allowFloats: "0.0,0.,1.0,1.,2.0,2."
655+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#atomic
656+
- name: atomic
657+
severity: warning
658+
disable: false
659+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#bare-return
660+
- name: bare-return
661+
severity: warning
662+
disable: false
663+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#blank-imports
664+
- name: blank-imports
665+
severity: warning
666+
disable: false
667+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#bool-literal-in-expr
668+
- name: bool-literal-in-expr
669+
severity: warning
670+
disable: false
671+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#call-to-gc
672+
- name: call-to-gc
673+
severity: warning
674+
disable: false
675+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#cognitive-complexity
676+
- name: cognitive-complexity
677+
severity: warning
678+
disable: false
679+
arguments: [ 7 ]
680+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#confusing-naming
681+
- name: confusing-naming
682+
severity: warning
683+
disable: false
684+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#confusing-results
685+
- name: confusing-results
686+
severity: warning
687+
disable: false
688+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#constant-logical-expr
689+
- name: constant-logical-expr
690+
severity: warning
691+
disable: false
692+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#context-as-argument
693+
- name: context-as-argument
694+
severity: warning
695+
disable: false
696+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#context-keys-type
697+
- name: context-keys-type
698+
severity: warning
699+
disable: false
700+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#cyclomatic
701+
- name: cyclomatic
702+
severity: warning
703+
disable: false
704+
arguments: [ 3 ]
705+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#deep-exit
706+
- name: deep-exit
707+
severity: warning
708+
disable: false
709+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#defer
710+
- name: defer
711+
severity: warning
712+
disable: false
713+
arguments:
714+
- [ "call-chain", "loop" ]
715+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#dot-imports
716+
- name: dot-imports
717+
severity: warning
718+
disable: false
719+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#duplicated-imports
720+
- name: duplicated-imports
721+
severity: warning
722+
disable: false
723+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#early-return
724+
- name: early-return
725+
severity: warning
726+
disable: false
727+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#empty-block
728+
- name: empty-block
729+
severity: warning
730+
disable: false
731+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#empty-lines
732+
- name: empty-lines
733+
severity: warning
734+
disable: false
735+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#error-naming
736+
- name: error-naming
737+
severity: warning
738+
disable: false
739+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#error-return
740+
- name: error-return
741+
severity: warning
742+
disable: false
743+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#error-strings
744+
- name: error-strings
745+
severity: warning
746+
disable: false
747+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#errorf
748+
- name: errorf
749+
severity: warning
750+
disable: false
751+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#exported
752+
- name: exported
753+
severity: warning
754+
disable: false
755+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#file-header
756+
- name: file-header
757+
severity: warning
758+
disable: false
759+
arguments:
760+
- This is the text that must appear at the top of source files.
761+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#flag-parameter
762+
- name: flag-parameter
763+
severity: warning
764+
disable: false
765+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#function-result-limit
766+
- name: function-result-limit
767+
severity: warning
768+
disable: false
769+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#function-length
770+
- name: function-length
771+
severity: warning
772+
disable: false
773+
arguments: [ 10, 0 ]
774+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#get-return
775+
- name: get-return
776+
severity: warning
777+
disable: false
778+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#identical-branches
779+
- name: identical-branches
780+
severity: warning
781+
disable: false
782+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#if-return
783+
- name: if-return
784+
severity: warning
785+
disable: false
786+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#increment-decrement
787+
- name: increment-decrement
788+
severity: warning
789+
disable: false
790+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#indent-error-flow
791+
- name: indent-error-flow
792+
severity: warning
793+
disable: false
794+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#imports-blacklist
795+
- name: imports-blacklist
796+
severity: warning
797+
disable: false
798+
arguments:
799+
- "crypto/md5"
800+
- "crypto/sha1"
801+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#import-shadowing
802+
- name: import-shadowing
803+
severity: warning
804+
disable: false
805+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#line-length-limit
806+
- name: line-length-limit
807+
severity: warning
808+
disable: false
809+
arguments: [ 80 ]
810+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#max-public-structs
811+
- name: max-public-structs
812+
severity: warning
813+
disable: false
814+
arguments: [ 3 ]
815+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#modifies-parameter
816+
- name: modifies-parameter
817+
severity: warning
818+
disable: false
819+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#modifies-value-receiver
820+
- name: modifies-value-receiver
821+
severity: warning
822+
disable: false
823+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#nested-structs
824+
- name: nested-structs
825+
severity: warning
826+
disable: false
827+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#package-comments
828+
- name: package-comments
829+
severity: warning
830+
disable: false
831+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#range
832+
- name: range
833+
severity: warning
834+
disable: false
835+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#range-val-in-closure
836+
- name: range-val-in-closure
837+
severity: warning
838+
disable: false
839+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#range-val-address
840+
- name: range-val-address
841+
severity: warning
842+
disable: false
843+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#receiver-naming
844+
- name: receiver-naming
845+
severity: warning
846+
disable: false
847+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#redefines-builtin-id
848+
- name: redefines-builtin-id
849+
severity: warning
850+
disable: false
851+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#string-of-int
852+
- name: string-of-int
853+
severity: warning
854+
disable: false
855+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#string-format
856+
- name: string-format
857+
severity: warning
858+
disable: false
859+
arguments:
860+
- - 'core.WriteError[1].Message'
861+
- '/^([^A-Z]|$)/'
862+
- must not start with a capital letter
863+
- - 'fmt.Errorf[0]'
864+
- '/(^|[^\.!?])$/'
865+
- must not end in punctuation
866+
- - panic
867+
- '/^[^\n]*$/'
868+
- must not contain line breaks
869+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#struct-tag
870+
- name: struct-tag
871+
severity: warning
872+
disable: false
873+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#superfluous-else
874+
- name: superfluous-else
875+
severity: warning
876+
disable: false
877+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#time-naming
878+
- name: time-naming
879+
severity: warning
880+
disable: false
881+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#var-naming
882+
- name: var-naming
883+
severity: warning
884+
disable: false
885+
arguments:
886+
- - ID
887+
- - VM
888+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#var-declaration
889+
- name: var-declaration
890+
severity: warning
891+
disable: false
892+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unconditional-recursion
893+
- name: unconditional-recursion
894+
severity: warning
895+
disable: false
896+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unexported-naming
897+
- name: unexported-naming
898+
severity: warning
899+
disable: false
900+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unexported-return
901+
- name: unexported-return
902+
severity: warning
903+
disable: false
904+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unhandled-error
905+
- name: unhandled-error
906+
severity: warning
907+
disable: false
908+
arguments:
909+
- "fmt.Printf"
910+
- "myFunction"
911+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unnecessary-stmt
912+
- name: unnecessary-stmt
913+
severity: warning
914+
disable: false
915+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unreachable-code
916+
- name: unreachable-code
917+
severity: warning
918+
disable: false
919+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unused-parameter
920+
- name: unused-parameter
921+
severity: warning
922+
disable: false
923+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unused-receiver
924+
- name: unused-receiver
925+
severity: warning
926+
disable: false
927+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#useless-break
928+
- name: useless-break
929+
severity: warning
930+
disable: false
931+
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#waitgroup-by-value
932+
- name: waitgroup-by-value
933+
severity: warning
934+
disable: false
651935

652936
staticcheck:
653937
# Select the Go version to target. The default is '1.13'.

0 commit comments

Comments
 (0)