XS001

package
v1.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 29, 2022 License: MPL-2.0 Imports: 5 Imported by: 0

README

XS001

The XS001 analyzer reports cases of schemas where Description is not configured, which is generally useful for providers that wish to automatically generate documentation based on the schema information.

Flagged Code

map[string]*schema.Schema{
    "attribute_name": {
        Optional: true,
        Type:     schema.TypeString,
    },
}

Passing Code

map[string]*schema.Schema{
    "attribute_name": {
        Description: "does something useful",
        Optional:    true,
        Type:        schema.TypeString,
    },
}

Ignoring Reports

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

//lintignore:XS001
map[string]*schema.Schema{
    "attribute_name": {
        Optional: true,
        Type:     schema.TypeString,
    },
}

Documentation

Overview

Package XS001 defines an Analyzer that checks for Schema that Description is configured

Index

Constants

View Source
const Doc = `` /* 252-byte string literal not displayed */

Variables

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

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

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