Skip to content

Commit 9e2d382

Browse files
committed
Renaming functions
Signed-off-by: Diogenes Fernandes <[email protected]>
1 parent 8009280 commit 9e2d382

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+544
-542
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55

66
TFLint ruleset plugin for OpenTofu Language
77

8+
This project is forked from https://github.com/terraform-linters/tflint-ruleset-terraform
9+
810
This ruleset focus on possible errors and best practices about OpenTofu Language.
911

1012
## Requirements

rules/opentofu_comment_syntax.go

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,38 +9,38 @@ import (
99
"github.com/terraform-linters/tflint-plugin-sdk/tflint"
1010
)
1111

12-
// TerraformCommentSyntaxRule checks whether comments use the preferred syntax
13-
type TerraformCommentSyntaxRule struct {
12+
// OpentofuCommentSyntaxRule checks whether comments use the preferred syntax
13+
type OpentofuCommentSyntaxRule struct {
1414
tflint.DefaultRule
1515
}
1616

17-
// NewTerraformCommentSyntaxRule returns a new rule
18-
func NewTerraformCommentSyntaxRule() *TerraformCommentSyntaxRule {
19-
return &TerraformCommentSyntaxRule{}
17+
// NewOpentofuCommentSyntaxRule returns a new rule
18+
func NewOpentofuCommentSyntaxRule() *OpentofuCommentSyntaxRule {
19+
return &OpentofuCommentSyntaxRule{}
2020
}
2121

2222
// Name returns the rule name
23-
func (r *TerraformCommentSyntaxRule) Name() string {
23+
func (r *OpentofuCommentSyntaxRule) Name() string {
2424
return "opentofu_comment_syntax"
2525
}
2626

2727
// Enabled returns whether the rule is enabled by default
28-
func (r *TerraformCommentSyntaxRule) Enabled() bool {
28+
func (r *OpentofuCommentSyntaxRule) Enabled() bool {
2929
return true
3030
}
3131

3232
// Severity returns the rule severity
33-
func (r *TerraformCommentSyntaxRule) Severity() tflint.Severity {
33+
func (r *OpentofuCommentSyntaxRule) Severity() tflint.Severity {
3434
return tflint.WARNING
3535
}
3636

3737
// Link returns the rule reference link
38-
func (r *TerraformCommentSyntaxRule) Link() string {
38+
func (r *OpentofuCommentSyntaxRule) Link() string {
3939
return project.ReferenceLink(r.Name())
4040
}
4141

4242
// Check checks whether single line comments is used
43-
func (r *TerraformCommentSyntaxRule) Check(runner tflint.Runner) error {
43+
func (r *OpentofuCommentSyntaxRule) Check(runner tflint.Runner) error {
4444
path, err := runner.GetModulePath()
4545
if err != nil {
4646
return err
@@ -63,7 +63,7 @@ func (r *TerraformCommentSyntaxRule) Check(runner tflint.Runner) error {
6363
return nil
6464
}
6565

66-
func (r *TerraformCommentSyntaxRule) checkComments(runner tflint.Runner, filename string, file *hcl.File) error {
66+
func (r *OpentofuCommentSyntaxRule) checkComments(runner tflint.Runner, filename string, file *hcl.File) error {
6767
if strings.HasSuffix(filename, ".json") {
6868
return nil
6969
}

rules/opentofu_comment_syntax_test.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import (
77
"github.com/terraform-linters/tflint-plugin-sdk/helper"
88
)
99

10-
func Test_TerraformCommentSyntaxRule(t *testing.T) {
10+
func Test_OpentofuCommentSyntaxRule(t *testing.T) {
1111
cases := []struct {
1212
Name string
1313
Content string
@@ -34,7 +34,7 @@ func Test_TerraformCommentSyntaxRule(t *testing.T) {
3434
Content: `// foo`,
3535
Expected: helper.Issues{
3636
{
37-
Rule: NewTerraformCommentSyntaxRule(),
37+
Rule: NewOpentofuCommentSyntaxRule(),
3838
Message: "Single line comments should begin with #",
3939
Range: hcl.Range{
4040
Filename: "variables.tf",
@@ -68,7 +68,7 @@ variable "foo" {
6868
},
6969
}
7070

71-
rule := NewTerraformCommentSyntaxRule()
71+
rule := NewOpentofuCommentSyntaxRule()
7272

7373
for _, tc := range cases {
7474
t.Run(tc.Name, func(t *testing.T) {

rules/opentofu_deprecated_index.go

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,38 +10,38 @@ import (
1010
"github.com/terraform-linters/tflint-plugin-sdk/tflint"
1111
)
1212

13-
// TerraformDeprecatedIndexRule warns about usage of the legacy dot syntax for indexes (foo.0)
14-
type TerraformDeprecatedIndexRule struct {
13+
// OpentofuDeprecatedIndexRule warns about usage of the legacy dot syntax for indexes (foo.0)
14+
type OpentofuDeprecatedIndexRule struct {
1515
tflint.DefaultRule
1616
}
1717

18-
// NewTerraformDeprecatedIndexRule return a new rule
19-
func NewTerraformDeprecatedIndexRule() *TerraformDeprecatedIndexRule {
20-
return &TerraformDeprecatedIndexRule{}
18+
// NewOpentofuDeprecatedIndexRule return a new rule
19+
func NewOpentofuDeprecatedIndexRule() *OpentofuDeprecatedIndexRule {
20+
return &OpentofuDeprecatedIndexRule{}
2121
}
2222

2323
// Name returns the rule name
24-
func (r *TerraformDeprecatedIndexRule) Name() string {
24+
func (r *OpentofuDeprecatedIndexRule) Name() string {
2525
return "opentofu_deprecated_index"
2626
}
2727

2828
// Enabled returns whether the rule is enabled by default
29-
func (r *TerraformDeprecatedIndexRule) Enabled() bool {
29+
func (r *OpentofuDeprecatedIndexRule) Enabled() bool {
3030
return true
3131
}
3232

3333
// Severity returns the rule severity
34-
func (r *TerraformDeprecatedIndexRule) Severity() tflint.Severity {
34+
func (r *OpentofuDeprecatedIndexRule) Severity() tflint.Severity {
3535
return tflint.WARNING
3636
}
3737

3838
// Link returns the rule reference link
39-
func (r *TerraformDeprecatedIndexRule) Link() string {
39+
func (r *OpentofuDeprecatedIndexRule) Link() string {
4040
return project.ReferenceLink(r.Name())
4141
}
4242

4343
// Check walks all expressions and emit issues if deprecated index syntax is found
44-
func (r *TerraformDeprecatedIndexRule) Check(runner tflint.Runner) error {
44+
func (r *OpentofuDeprecatedIndexRule) Check(runner tflint.Runner) error {
4545
path, err := runner.GetModulePath()
4646
if err != nil {
4747
return err
@@ -99,7 +99,7 @@ func (r *TerraformDeprecatedIndexRule) Check(runner tflint.Runner) error {
9999
return nil
100100
}
101101

102-
func (r *TerraformDeprecatedIndexRule) checkLegacyTraversalIndex(runner tflint.Runner, traversal hcl.Traversal, file []byte) hcl.Diagnostics {
102+
func (r *OpentofuDeprecatedIndexRule) checkLegacyTraversalIndex(runner tflint.Runner, traversal hcl.Traversal, file []byte) hcl.Diagnostics {
103103
for _, t := range traversal {
104104
if tn, ok := t.(hcl.TraverseIndex); ok {
105105
if strings.HasPrefix(string(t.SourceRange().SliceBytes(file)), ".") {
@@ -125,7 +125,7 @@ func (r *TerraformDeprecatedIndexRule) checkLegacyTraversalIndex(runner tflint.R
125125
return nil
126126
}
127127

128-
func (r *TerraformDeprecatedIndexRule) checkJSONExpression(runner tflint.Runner, e hcl.Expression, file []byte) hcl.Diagnostics {
128+
func (r *OpentofuDeprecatedIndexRule) checkJSONExpression(runner tflint.Runner, e hcl.Expression, file []byte) hcl.Diagnostics {
129129
var diags hcl.Diagnostics
130130

131131
for _, v := range e.Variables() {

rules/opentofu_deprecated_index_test.go

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import (
77
"github.com/terraform-linters/tflint-plugin-sdk/helper"
88
)
99

10-
func Test_TerraformDeprecatedIndexRule(t *testing.T) {
10+
func Test_OpentofuDeprecatedIndexRule(t *testing.T) {
1111
cases := []struct {
1212
Name string
1313
Content string
@@ -25,7 +25,7 @@ locals {
2525
`,
2626
Expected: helper.Issues{
2727
{
28-
Rule: NewTerraformDeprecatedIndexRule(),
28+
Rule: NewOpentofuDeprecatedIndexRule(),
2929
Message: "List items should be accessed using square brackets",
3030
Range: hcl.Range{
3131
Filename: "config.tf",
@@ -57,7 +57,7 @@ locals {
5757
`,
5858
Expected: helper.Issues{
5959
{
60-
Rule: NewTerraformDeprecatedIndexRule(),
60+
Rule: NewOpentofuDeprecatedIndexRule(),
6161
Message: "List items should be accessed using square brackets",
6262
Range: hcl.Range{
6363
Filename: "config.tf",
@@ -124,7 +124,7 @@ EOF
124124
`,
125125
Expected: helper.Issues{
126126
{
127-
Rule: NewTerraformDeprecatedIndexRule(),
127+
Rule: NewOpentofuDeprecatedIndexRule(),
128128
Message: "List items should be accessed using square brackets",
129129
Range: hcl.Range{
130130
Filename: "config.tf",
@@ -159,7 +159,7 @@ locals {
159159
`,
160160
Expected: helper.Issues{
161161
{
162-
Rule: NewTerraformDeprecatedIndexRule(),
162+
Rule: NewOpentofuDeprecatedIndexRule(),
163163
Message: "List items should be accessed using square brackets",
164164
Range: hcl.Range{
165165
Filename: "config.tf",
@@ -174,7 +174,7 @@ locals {
174174
},
175175
},
176176
{
177-
Rule: NewTerraformDeprecatedIndexRule(),
177+
Rule: NewOpentofuDeprecatedIndexRule(),
178178
Message: "List items should be accessed using square brackets",
179179
Range: hcl.Range{
180180
Filename: "config.tf",
@@ -206,7 +206,7 @@ locals {
206206
`,
207207
Expected: helper.Issues{
208208
{
209-
Rule: NewTerraformDeprecatedIndexRule(),
209+
Rule: NewOpentofuDeprecatedIndexRule(),
210210
Message: "List items should be accessed using square brackets",
211211
Range: hcl.Range{
212212
Filename: "config.tf",
@@ -240,7 +240,7 @@ locals {
240240
}`,
241241
Expected: helper.Issues{
242242
{
243-
Rule: NewTerraformDeprecatedIndexRule(),
243+
Rule: NewOpentofuDeprecatedIndexRule(),
244244
Message: "List items should be accessed using square brackets",
245245
Range: hcl.Range{
246246
Filename: "config.tf.json",
@@ -289,7 +289,7 @@ locals {
289289
},
290290
}
291291

292-
rule := NewTerraformDeprecatedIndexRule()
292+
rule := NewOpentofuDeprecatedIndexRule()
293293

294294
for _, tc := range cases {
295295
t.Run(tc.Name, func(t *testing.T) {

rules/opentofu_deprecated_interpolation.go

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,40 +7,40 @@ import (
77
"github.com/terraform-linters/tflint-plugin-sdk/tflint"
88
)
99

10-
// TerraformDeprecatedInterpolationRule warns of deprecated interpolation in Terraform v0.11 or earlier.
11-
type TerraformDeprecatedInterpolationRule struct {
10+
// OpentofuDeprecatedInterpolationRule warns of deprecated interpolation in Opentofu v0.11 or earlier.
11+
type OpentofuDeprecatedInterpolationRule struct {
1212
tflint.DefaultRule
1313
}
1414

15-
// NewTerraformDeprecatedInterpolationRule return a new rule
16-
func NewTerraformDeprecatedInterpolationRule() *TerraformDeprecatedInterpolationRule {
17-
return &TerraformDeprecatedInterpolationRule{}
15+
// NewOpentofuDeprecatedInterpolationRule return a new rule
16+
func NewOpentofuDeprecatedInterpolationRule() *OpentofuDeprecatedInterpolationRule {
17+
return &OpentofuDeprecatedInterpolationRule{}
1818
}
1919

2020
// Name returns the rule name
21-
func (r *TerraformDeprecatedInterpolationRule) Name() string {
21+
func (r *OpentofuDeprecatedInterpolationRule) Name() string {
2222
return "opentofu_deprecated_interpolation"
2323
}
2424

2525
// Enabled returns whether the rule is enabled by default
26-
func (r *TerraformDeprecatedInterpolationRule) Enabled() bool {
26+
func (r *OpentofuDeprecatedInterpolationRule) Enabled() bool {
2727
return true
2828
}
2929

3030
// Severity returns the rule severity
31-
func (r *TerraformDeprecatedInterpolationRule) Severity() tflint.Severity {
31+
func (r *OpentofuDeprecatedInterpolationRule) Severity() tflint.Severity {
3232
return tflint.WARNING
3333
}
3434

3535
// Link returns the rule reference link
36-
func (r *TerraformDeprecatedInterpolationRule) Link() string {
36+
func (r *OpentofuDeprecatedInterpolationRule) Link() string {
3737
return project.ReferenceLink(r.Name())
3838
}
3939

4040
// Check emits issues on the deprecated interpolation syntax.
41-
// This logic is equivalent to the warning logic implemented in Terraform.
41+
// This logic is equivalent to the warning logic implemented in Opentofu.
4242
// See https://github.com/hashicorp/terraform/blob/2ce03abe480c3f40d04bd0f289762721ea280848/configs/compat_shim.go#L144-L156
43-
func (r *TerraformDeprecatedInterpolationRule) Check(runner tflint.Runner) error {
43+
func (r *OpentofuDeprecatedInterpolationRule) Check(runner tflint.Runner) error {
4444
path, err := runner.GetModulePath()
4545
if err != nil {
4646
return err
@@ -65,7 +65,7 @@ func (r *TerraformDeprecatedInterpolationRule) Check(runner tflint.Runner) error
6565

6666
type terraformDeprecatedInterpolationWalker struct {
6767
runner tflint.Runner
68-
rule *TerraformDeprecatedInterpolationRule
68+
rule *OpentofuDeprecatedInterpolationRule
6969
contextStack []terraformDeprecatedInterpolationContext
7070
}
7171

@@ -91,7 +91,7 @@ func (w *terraformDeprecatedInterpolationWalker) Enter(expr hcl.Expression) hcl.
9191
// so we don't need to do anything further to distinguish that
9292
// situation. ("normal" templates are *hclsyntax.TemplateExpr.)
9393

94-
const message = "Interpolation-only expressions are deprecated in Terraform v0.12.14"
94+
const message = "Interpolation-only expressions are deprecated in Opentofu v0.12.14"
9595
switch w.currentContext() {
9696
case terraformDeprecatedInterpolationContextObjKey:
9797
// This case requires a different autofix strategy is needed

0 commit comments

Comments
 (0)