Skip to content

Commit 3a6417c

Browse files
ldezldez
authored
doc: improve revive documentation (#2458)
1 parent 9e12949 commit 3a6417c

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

647931
staticcheck:
648932
# Select the Go version to target. The default is '1.13'.

0 commit comments

Comments
 (0)