linter

Documentation

Overview

Copyright (c) 2015-2016 The GoAnalysis Authors. All rights reserved. Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.

Index

• Constants
• type GoFile
  • func (f *GoFile) AddViolation(tokPosition token.Pos, violationType Rule, description string) *Violation
  • func (goFile *GoFile) Analyse()
• type GoPackage
  • func DetectViolations(goSourceDir string) (goPackageViolations []*GoPackage, err error)
  • func (goPackage *GoPackage) Analyze()
  • func (goPackage *GoPackage) GetFileNodes() (goFiles []*ast.File)
• type Rule
  • func (rule Rule) MarshalText() ([]byte, error)
  • func (rule Rule) String() string
• type Violation
  • func (violation *Violation) String() string

Constants

const CC_LIMIT = 10 // Upper limit of cyclomatic complexity measures.

const ERROR_OUTPUT_FILE = "GoAnalyzerError.log"

Types

type GoFile

type GoFile struct {
	FilePath        string
	LinesOfCode     int
	LinesOfComments int
	Violations      []*Violation
	// contains filtered or unexported fields
}

func (*GoFile) AddViolation

func (f *GoFile) AddViolation(tokPosition token.Pos, violationType Rule, description string) *Violation

AddViolation adds a new violation as specified trough its argument to the GoFile list of violations.

func (*GoFile) Analyse

func (goFile *GoFile) Analyse()

Analyse fires off all detection algorithms on the goFile.

type GoPackage

type GoPackage struct {
	Violations []*GoFile

	Path string
	Pack *ast.Package
	// contains filtered or unexported fields
}

func DetectViolations

func DetectViolations(goSourceDir string) (goPackageViolations []*GoPackage, err error)

func (*GoPackage) Analyze

func (goPackage *GoPackage) Analyze()

func (*GoPackage) GetFileNodes

func (goPackage *GoPackage) GetFileNodes() (goFiles []*ast.File)

type Rule

type Rule int

const (
	RACE_CONDITION Rule = iota
	FMT_PRINTING
	STRING_CALLS_ITSELF
	MAP_ALLOCATED_WITH_NEW
	ERROR_IGNORED
	EMPTY_IF_BODY
	EMPTY_ELSE_BODY
	EMPTY_FOR_BODY
	GOTO_USED
	CONDITION_EVALUATED_STATICALLY
	BUFFER_NOT_FLUSHED
	RETURN_KILLS_CODE
	CYCLOMATIC_COMPLEXITY
)

Rules.

func (Rule) MarshalText

func (rule Rule) MarshalText() ([]byte, error)

Marshal Rule string value instead of int value.

func (Rule) String

func (rule Rule) String() string

type Violation

type Violation struct {
	Type        Rule
	Description string
	SrcLine     int
}

func (*Violation) String

func (violation *Violation) String() string