JeffDeCola/my-go-examples

View on GitHub
.codeclimate.yml

Summary

Maintainability
Test Coverage
# .codeclimate.yml

version: "2"

# --------------------------------------------------------------------------
# prepare: Actions to perform before analysis begins
#   fetch: Remote files to fetch (files placed relative to the repo's root dir)
#     url: url to fetch
#     path: destination relative to repo's root directory

# --------------------------------------------------------------------------
# checks: Configuration of maintainability checks
#   <name>
#     enabled: true|false
#     config: check configuration

checks:
  similar-code:
    enabled: false
  identical-code:
    enabled: false

# --------------------------------------------------------------------------
# plugins: Enable optional engines to run in addition to your analysis
#   <name>
#     enabled: true|false
#     channel: alternate channel to use (stable is default)
#     config: plugin configuration

plugins:
  # A tool designed to check markdown files and flag style issues
  markdownlint:
    enabled: true
    checks:
      # Emphasis used instead of a header
      MD036:
        enabled: false
  # A tool for suggesting possible improvements to bash/sh shell scripts
  shellcheck:
    enabled: true
  # Official style checker from the Go team
  gofmt:
    enabled: true
  # Lints
  golint:
    enabled: true
    config:
      min_confidence: 0.9
  # Examines source code to identify suspicious constructs and potential bugs
  govet:
    enabled: true

# --------------------------------------------------------------------------
# exclude_patterns: Exclude files and/or directories from analysis
# - <pattern>
# - <pattern>

exclude_patterns:
- "docs/"
- "**/*_test.go" # exclude the unit testing code
- "**/goroutines/goroutines-multi-core/main.go" #doWork` has 72 lines of code
- "**/common-go/my-generic-go-template/jeffs-basic-go-template/main.go" #getNumbers` has 5 return statements
- "**/goroutines/goroutines-multi-core/README.md" #Line length
- "**/common-go/error-reporting/error-example/README.md" #Line length