unused

package

v0.4.7 Latest Latest Go to latest Published: Feb 22, 2024 License: MIT Imports: 16 Imported by: 156

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/dominikh/go-tools

Links

Open Source Insights

Documentation ¶

Overview ¶

Package unused contains code for finding unused code.

Index ¶

Variables
type Node
- func Graph(fset *token.FileSet, files []*ast.File, pkg *types.Package, info *types.Info, ...) []Node
type NodeID
type Object
type ObjectPath
type Options
type Result
type SerializedGraph

Constants ¶

This section is empty.

Variables ¶

View Source

var Analyzer = &lint.Analyzer{
	Doc: &lint.Documentation{
		Title: "Unused code",
	},
	Analyzer: &analysis.Analyzer{
		Name:       "U1000",
		Doc:        "Unused code",
		Run:        run,
		Requires:   []*analysis.Analyzer{generated.Analyzer, directives.Analyzer},
		ResultType: reflect.TypeOf(Result{}),
	},
}

View Source

var Debug io.Writer

View Source

var DefaultOptions = Options{
	FieldWritesAreUses:     true,
	PostStatementsAreReads: false,
	ExportedIsUsed:         true,
	ExportedFieldsAreUsed:  true,
	ParametersAreUsed:      true,
	LocalVariablesAreUsed:  true,
	GeneratedIsUsed:        true,
}

Functions ¶

This section is empty.

Types ¶

type Node ¶ added in v0.4.0

type Node struct {
	// contains filtered or unexported fields
}

func Graph ¶ added in v0.4.0

func Graph(fset *token.FileSet,
	files []*ast.File,
	pkg *types.Package,
	info *types.Info,
	directives []lint.Directive,
	generated map[string]generated.Generator,
	opts Options,
) []Node

type NodeID ¶ added in v0.4.0

type NodeID uint64

OPT(dh): 32 bits would be plenty, but the Node struct would end up with padding, anyway.

type Object ¶ added in v0.4.0

type Object struct {
	Name      string
	ShortName string
	// OPT(dh): use an enum for the kind
	Kind            string
	Path            ObjectPath
	Position        token.Position
	DisplayPosition token.Position
}

type ObjectPath ¶ added in v0.4.0

type ObjectPath struct {
	PkgPath string
	ObjPath objectpath.Path
}

type Options ¶ added in v0.4.0

type Options struct {
	FieldWritesAreUses     bool
	PostStatementsAreReads bool
	ExportedIsUsed         bool
	ExportedFieldsAreUsed  bool
	ParametersAreUsed      bool
	LocalVariablesAreUsed  bool
	GeneratedIsUsed        bool
}

type Result ¶

type Result struct {
	Used   []Object
	Unused []Object
	Quiet  []Object
}

TODO(dh): should we return a map instead of two slices?

type SerializedGraph ¶ added in v0.4.0

type SerializedGraph struct {
	// contains filtered or unexported fields
}

func (*SerializedGraph) Dot ¶ added in v0.4.0

func (g *SerializedGraph) Dot() string

Dot formats a graph in Graphviz dot format.

func (*SerializedGraph) Merge ¶ added in v0.4.0

func (g *SerializedGraph) Merge(nodes []Node)

func (*SerializedGraph) Results ¶ added in v0.4.0

func (g *SerializedGraph) Results() Result

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL