Go

Configuration - Analysis

This section covers configuration specific to go analyzer. Please make sure to read the general configuration guide first.

name

  • Type: String
  • Presence: mandatory
  • Description: Shortcode of the analyzer.
  • Example:
name = "go"

enabled

  • Type: Boolean
  • Presence: mandatory
  • Description: Toggle whether this analyzer should be run.
  • Example:
enabled = true

meta

  • Type: Table
  • Presense: mandatory
  • Description: Any supported metadata to pass to the analyzer.
  • Example:
[analyzers.meta]
  import_path = "github.com/coreos/rkt"
import_path
  • Type: String
  • Presence: mandatory
  • Description: Repository source code will be placed in GOPATH/src/{repo-source}.
  • Example:
import_path = "github.com/kubernetes/kops"
skip_doc_coverage
  • Type: Array

  • Presence: optional

  • Description: Specify which artifacts to skip when calculating documentation coverage. Available values are file.

    • file - Do not include file docs while calculating documentation coverage. By default, file docs are taken into account for calculating the doc coverage.
  • Example:

skip_doc_coverage = ["file"]

Example

version = 1

test_patterns = [
  "tests/*_test.go",
  "**/*_test.go"
]

[[analyzers]]
name = "go"
enabled = true

  [analyzers.meta]
  import_path = "github.com/rkt/rkt"