R003

README

R003

The R003 analyzer reports likely extraneous uses of Exists functions for a resource. Exists logic can be handled inside the Read function to prevent logic duplication.

Flagged Code

func resourceExampleThingExists(d *schema.ResourceData, meta interface{}) (bool, error) { /* ... */ }

func resourceExampleThingRead(d *schema.ResourceData, meta interface{}) error { /* ... */ }

&schema.Resource{
    Exists: resourceExampleThingExists,
    Read:   resourceExampleThingRead,
    /* ... */
}

Passing Code

func resourceExampleThingRead(d *schema.ResourceData, meta interface{}) error { /* ... */ }

&schema.Resource{
    Read: resourceExampleThingRead,
    /* ... */
}

Ignoring Reports

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

&schema.Resource{
    //lintignore:R003
    Exists: resourceExampleThingExists,
    Read:   resourceExampleThingRead,
    /* ... */
}

Documentation

Overview

Package R003 defines an Analyzer that checks for Resource having Exists functions

Index

• Constants
• Variables

Constants

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

Variables

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