Switch internal Terraform rules to the bundled plugin

terraform-linters · Sep 7, 2022 · d5921e6 · d5921e6
1 parent 46b52b6
commit d5921e6
Show file tree

Hide file tree

Showing 84 changed files with 636 additions and 9,566 deletions.
diff --git a/Makefile b/Makefile
@@ -13,7 +13,7 @@ build:
 install:
 	go install
 
-e2e: prepare
+e2e: prepare install
 	go test -timeout 5m ./integrationtest/inspection ./integrationtest/langserver ./integrationtest/init ./integrationtest/cli
 
 lint:

diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ A Pluggable [Terraform](https://www.terraform.io/) Linter
 
 TFLint is a framework and each feature is provided by plugins, the key features are as follows:
 
-- Find possible errors (like illegal instance types) for Major Cloud providers (AWS/Azure/GCP).
+- Find possible errors (like invalid instance types) for Major Cloud providers (AWS/Azure/GCP).
 - Warn about deprecated syntax, unused declarations.
 - Enforce best practices, naming conventions.
 
@@ -74,14 +74,25 @@ If you want to run on GitHub Actions, [setup-tflint](https://github.com/terrafor
 
 ## Getting Started
 
-If you are using an AWS/Azure/GCP provider, it is a good idea to install the plugin and try it according to each usage:
+First, enable rules for [Terraform Language](https://www.terraform.io/language) (e.g. warn about deprecated syntax, unused declarations). [TFLint Ruleset for Terraform Language](https://github.com/terraform-linters/tflint-ruleset-terraform) is bundled with TFLint, so you can use it without installing it separately.
+
+The bundled plugin enables the "recommended" preset by default, but you can disable the plugin or use a different preset. Declare the plugin block in `.tflint.hcl` like this:
+
+```hcl
+plugin "terraform" {
+  enabled = true
+  preset  = "recommended"
+}
+```
+
+See the [tflint-ruleset-terraform documentation](https://github.com/terraform-linters/tflint-ruleset-terraform/blob/main/docs/configuration.md) for more information.
+
+Next, If you are using an AWS/Azure/GCP provider, it is a good idea to install the plugin and try it according to each usage:
 
 - [Amazon Web Services](https://github.com/terraform-linters/tflint-ruleset-aws)
 - [Microsoft Azure](https://github.com/terraform-linters/tflint-ruleset-azurerm)
 - [Google Cloud Platform](https://github.com/terraform-linters/tflint-ruleset-google)
 
-Rules for the Terraform Language is built into the TFLint binary, so you don't need to install any plugins. Please see [Rules](docs/rules) for a list of available rules.
-
 If you want to extend TFLint with other plugins, you can declare the plugins in the config file and easily install them with `tflint --init`.
 
 ```hcl

diff --git a/cmd/bundled_plugin.go b/cmd/bundled_plugin.go
@@ -0,0 +1,24 @@
+package cmd
+
+import (
+	"fmt"
+
+	"github.com/terraform-linters/tflint-plugin-sdk/plugin"
+	"github.com/terraform-linters/tflint-plugin-sdk/tflint"
+	"github.com/terraform-linters/tflint-ruleset-terraform/project"
+	"github.com/terraform-linters/tflint-ruleset-terraform/rules"
+	"github.com/terraform-linters/tflint-ruleset-terraform/terraform"
+)
+
+func (cli *CLI) actAsBundledPlugin() int {
+	plugin.Serve(&plugin.ServeOpts{
+		RuleSet: &terraform.RuleSet{
+			BuiltinRuleSet: tflint.BuiltinRuleSet{
+				Name:    "terraform",
+				Version: fmt.Sprintf("%s-bundled", project.Version),
+			},
+			PresetRules: rules.PresetRules,
+		},
+	})
+	return ExitCodeOK
+}
diff --git a/cmd/cli.go b/cmd/cli.go
@@ -97,6 +97,8 @@ func (cli *CLI) Run(args []string) int {
 		return cli.init(opts)
 	case opts.Langserver:
 		return cli.startLanguageServer(opts.Config, opts.toConfig())
+	case opts.ActAsBundledPlugin:
+		return cli.actAsBundledPlugin()
 	default:
 		return cli.inspect(opts, dir, filterFiles)
 	}

diff --git a/cmd/inspect.go b/cmd/inspect.go
@@ -7,7 +7,6 @@ import (
 	"github.com/spf13/afero"
 	"github.com/terraform-linters/tflint-plugin-sdk/hclext"
 	"github.com/terraform-linters/tflint/plugin"
-	"github.com/terraform-linters/tflint/rules"
 	"github.com/terraform-linters/tflint/tflint"
 )
 
@@ -51,7 +50,7 @@ func (cli *CLI) inspect(opts Options, dir string, filterFiles []string) int {
 	}
 	defer rulesetPlugin.Clean()
 
-	rulesets := []tflint.RuleSet{&rules.RuleSet{}}
+	rulesets := []tflint.RuleSet{}
 	config := cfg.ToPluginConfig()
 	for name, ruleset := range rulesetPlugin.RuleSets {
 		if err := ruleset.ApplyGlobalConfig(config); err != nil {
@@ -86,16 +85,6 @@ func (cli *CLI) inspect(opts Options, dir string, filterFiles []string) int {
 	}
 
 	// Run inspection
-	for _, rule := range rules.NewRules(cfg) {
-		for _, runner := range runners {
-			err := rule.Check(runner)
-			if err != nil {
-				cli.formatter.Print(tflint.Issues{}, fmt.Errorf("Failed to check `%s` rule; %w", rule.Name(), err), cli.loader.Sources())
-				return ExitCodeError
-			}
-		}
-	}
-
 	for _, ruleset := range rulesetPlugin.RuleSets {
 		for _, runner := range runners {
 			err = ruleset.Check(plugin.NewGRPCServer(runner, rootRunner, cli.loader.Files()))

diff --git a/cmd/option.go b/cmd/option.go
@@ -9,23 +9,24 @@ import (
 
 // Options is an option specified by arguments.
 type Options struct {
-	Version       bool     `short:"v" long:"version" description:"Print TFLint version"`
-	Init          bool     `long:"init" description:"Install plugins"`
-	Langserver    bool     `long:"langserver" description:"Start language server"`
-	Format        string   `short:"f" long:"format" description:"Output format" choice:"default" choice:"json" choice:"checkstyle" choice:"junit" choice:"compact" choice:"sarif"`
-	Config        string   `short:"c" long:"config" description:"Config file name" value-name:"FILE" default:".tflint.hcl"`
-	IgnoreModules []string `long:"ignore-module" description:"Ignore module sources" value-name:"SOURCE"`
-	EnableRules   []string `long:"enable-rule" description:"Enable rules from the command line" value-name:"RULE_NAME"`
-	DisableRules  []string `long:"disable-rule" description:"Disable rules from the command line" value-name:"RULE_NAME"`
-	Only          []string `long:"only" description:"Enable only this rule, disabling all other defaults. Can be specified multiple times" value-name:"RULE_NAME"`
-	EnablePlugins []string `long:"enable-plugin" description:"Enable plugins from the command line" value-name:"PLUGIN_NAME"`
-	Varfiles      []string `long:"var-file" description:"Terraform variable file name" value-name:"FILE"`
-	Variables     []string `long:"var" description:"Set a Terraform variable" value-name:"'foo=bar'"`
-	Module        bool     `long:"module" description:"Inspect modules"`
-	Force         bool     `long:"force" description:"Return zero exit status even if issues found"`
-	Color         bool     `long:"color" description:"Enable colorized output"`
-	NoColor       bool     `long:"no-color" description:"Disable colorized output"`
-	LogLevel      string   `long:"loglevel" description:"Change the loglevel" choice:"trace" choice:"debug" choice:"info" choice:"warn" choice:"error"`
+	Version            bool     `short:"v" long:"version" description:"Print TFLint version"`
+	Init               bool     `long:"init" description:"Install plugins"`
+	Langserver         bool     `long:"langserver" description:"Start language server"`
+	Format             string   `short:"f" long:"format" description:"Output format" choice:"default" choice:"json" choice:"checkstyle" choice:"junit" choice:"compact" choice:"sarif"`
+	Config             string   `short:"c" long:"config" description:"Config file name" value-name:"FILE" default:".tflint.hcl"`
+	IgnoreModules      []string `long:"ignore-module" description:"Ignore module sources" value-name:"SOURCE"`
+	EnableRules        []string `long:"enable-rule" description:"Enable rules from the command line" value-name:"RULE_NAME"`
+	DisableRules       []string `long:"disable-rule" description:"Disable rules from the command line" value-name:"RULE_NAME"`
+	Only               []string `long:"only" description:"Enable only this rule, disabling all other defaults. Can be specified multiple times" value-name:"RULE_NAME"`
+	EnablePlugins      []string `long:"enable-plugin" description:"Enable plugins from the command line" value-name:"PLUGIN_NAME"`
+	Varfiles           []string `long:"var-file" description:"Terraform variable file name" value-name:"FILE"`
+	Variables          []string `long:"var" description:"Set a Terraform variable" value-name:"'foo=bar'"`
+	Module             bool     `long:"module" description:"Inspect modules"`
+	Force              bool     `long:"force" description:"Return zero exit status even if issues found"`
+	Color              bool     `long:"color" description:"Enable colorized output"`
+	NoColor            bool     `long:"no-color" description:"Disable colorized output"`
+	LogLevel           string   `long:"loglevel" description:"Change the loglevel" choice:"trace" choice:"debug" choice:"info" choice:"warn" choice:"error"`
+	ActAsBundledPlugin bool     `long:"act-as-bundled-plugin" hidden:"true"`
 }
 
 func (opts *Options) toConfig() *tflint.Config {

diff --git a/docs/README.md b/docs/README.md
@@ -1,5 +1,4 @@
 # TFLint Documentation
 
 - [User Guide](user-guide)
-- [Rules](rules)
 - [Developer Guide](developer-guide)
diff --git a/docs/rules/README.md b/docs/rules/README.md
diff --git a/docs/rules/terraform_comment_syntax.md b/docs/rules/terraform_comment_syntax.md
diff --git a/docs/rules/terraform_deprecated_index.md b/docs/rules/terraform_deprecated_index.md
diff --git a/docs/rules/terraform_deprecated_interpolation.md b/docs/rules/terraform_deprecated_interpolation.md
diff --git a/docs/rules/terraform_documented_outputs.md b/docs/rules/terraform_documented_outputs.md
diff --git a/docs/rules/terraform_documented_variables.md b/docs/rules/terraform_documented_variables.md