rework: Address 3rd round of feedback provided on the pull request. F…

…ix README.md and correct & update comments.
minamijoyo · Dec 6, 2022 · d63c744 · d63c744
1 parent e0e47b1
commit d63c744
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -603,7 +603,7 @@ defined at the top level then you can rename them using:
 migration "state" "test" {
   dir = "dir1"
   actions = [
-    "xmv aws_security_group.* aws_security_group.${1}2",
+    "xmv aws_security_group.* aws_security_group.$${1}2",
   ]
 }
 ```

diff --git a/tfmigrate/state_xmv_action.go b/tfmigrate/state_xmv_action.go
@@ -21,7 +21,7 @@ type StateXMvAction struct {
 
 var _ StateAction = (*StateXMvAction)(nil)
 
-// NewStateMvAction returns a new StateXMvAction instance.
+// NewStateXMvAction returns a new StateXMvAction instance.
 func NewStateXMvAction(source string, destination string) *StateXMvAction {
 	return &StateXMvAction{
 		source:      source,
@@ -56,8 +56,7 @@ func (a *StateXMvAction) generateMvActions(ctx context.Context, tf tfexec.Terraf
 	return a.getStateMvActionsForStateList(stateList)
 }
 
-// When a wildcardChar is used in a path it should only match a single part of the path
-// It can therefore not contain a dot(.), whitespace nor square brackets
+// A wildcardChar will greedy match with any character in the resource path.
 const matchWildcardRegex = "(.*)"
 const wildcardChar = "*"