S015

README

S015

The S015 analyzer reports cases of schemas which the attribute name includes characters outside lowercase alphanumerics and underscores, which will fail provider schema validation.

Flagged Code

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

map[string]*schema.Schema{
    "invalid!": {
        Required: true,
        Type:     schema.TypeString,
    },
}

map[string]*schema.Schema{
    "invalid-name": {
        Required: true,
        Type:     schema.TypeString,
    },
}

Passing Code

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

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

Ignoring Reports

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

//lintignore:S015
map[string]*schema.Schema{
    "INVALID": {
        Required: true,
        Type:     schema.TypeString,
    },
}

Documentation

Overview

Package S015 defines an Analyzer that checks for Schema that attribute names contain only lowercase alphanumerics and underscores

Index

• Constants
• Variables

Constants

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

Variables

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