S019

README

S019

The S019 analyzer reports cases of schemas including Computed: false, Optional: false, or Required: false which are extraneous.

Flagged Code

&schema.Schema{
    Computed: false,
    Optional: true,
}

&schema.Schema{
    Optional: false,
    Required: true,
}

&schema.Schema{
    Computed: true,
    Required: false,
}

Passing Code

&schema.Schema{
    Optional: true,
}

&schema.Schema{
    Required: true,
}

&schema.Schema{
    Computed: true,
}

Ignoring Reports

Singular reports can be ignored by adding the a //lintignore:S019 Go code comment at the end of the offending line or on the line immediately proceding, e.g.

//lintignore:S019
&schema.Schema{
    Computed: false,
    Optional: true,
}

Documentation

Overview

Package S019 defines an Analyzer that checks for Schema that should omit Computed, Optional, or Required set to false

Index

• Constants
• Variables

Constants

const Doc = `` /* 207-byte string literal not displayed */

Variables

var Analyzer = &analysis.Analyzer{
	Name: analyzerName,
	Doc:  Doc,
	Requires: []*analysis.Analyzer{
		schemainfo.Analyzer,
		commentignore.Analyzer,
	},
	Run: run,
}