org.sonar.l10n.go.rules.golint.rules.json Maven / Gradle / Ivy

Go to download
[
  {
    "key": "PackageComment",
    "name": "Checks package comments",
    "description": "This rule complains if there is no package comment, or if it is not of the right form.See
Go Code Review Comments: Package Comments"
  },
  {
    "key": "BlankImports",
    "name": "Check blank imports",
    "description": "This rule complains if a non-main package has blank imports that are not documented."
  },
  {
    "key": "Imports",
    "name": "Examines import blocks",
    "description": "This rule Examines usage of dot import.See
Go Code Review Comments: Import Dot"
  },
  {
    "key": "Exported",
    "name": "Examines exported names",
    "description": "This rule complains if any required doc comments are missing, or if they are not of the right form. It also complains if the names stutter when combined with the package name.See
Go Code Review Comments: Doc Comments
Go Code Review Comments: Package Names"
  },
  {
    "key": "Names",
    "name": "Examines all names in the file",
    "description": "This rule complains if any use underscores or incorrect known initialisms.See
Go Code Review Comments: Mixed Caps
Go Code Review Comments: Initialisms
Effective Go: MixedCaps
Effective Go: Package names"
  },
  {
    "key": "VarDecls",
    "name": "Examines variable declarations",
    "description": "This rule complains about declarations with redundant LHS types that can be inferred from the RHS."
  },
  {
    "key": "Elses",
    "name": "Examines else blocks",
    "description": "This rule complains about any else block whose if block ends in a return.See
Go Code Review Comments: Indent Error Flow"
  },
  {
    "key": "Ranges",
    "name": "Examines range clauses",
    "description": "This rule complains about redundant constructions."
  },
  {
    "key": "Errorf",
    "name": "Examines errors.New and testing.Error calls",
    "description": "This rule complains if its only argument is an fmt.Sprintf invocation."
  },
  {
    "key": "Errors",
    "name": "Examines global error vars.",
    "description": "This rule complains if they aren't named in the standard way.See
Go Code Review Comments: Error Strings"
  },
  {
    "key": "ErrorStrings",
    "name": "Examines error strings",
    "description": "This rule  complains if they are capitalized or end in punctuation or a newline."
  },
  {
    "key": "ReceiverNames",
    "name": "Examines receiver names",
    "description": "This rule complains about inconsistent names used for the same type and names such as \"this\"."
  },
  {
    "key": "IncDec",
    "name": "Examines statements that increment or decrement a variable",
    "description": "This rule complains if they don't use x++ or x--."
  },
  {
    "key": "ErrorReturn",
    "name": "Examines function declarations that return an error",
    "description": "This rule complains if the error isn't the last parameter."
  },
  {
    "key": "UnexportedReturn",
    "name": "Examines exported function declarations",
    "description": "This rule complains if any return an unexported type."
  },
  {
    "key": "TimeNames",
    "name": "Check times names",
    "description": "Look for time.Duration suffix"
  },
  {
    "key": "ContextKeyTypes",
    "name": "Checks for call expressions to context.WithValue with basic type",
    "description": "This rule checks for call expressions to context.WithValue with basic types used for the key argument.See
cmd/vet issues: #17293"
  },
  {
    "key": "ContextArgs",
    "name": "Examines function declarations that contain an argument with a type of context.Context",
    "description": "This rule complains if that argument isn't the first parameter.See
The Go Programming Language: Package context"
  }
]