XS001

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
• Variables

Constants

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

Variables

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