New option: --hcl-only to only keep the .tf files in the output directory, and removing the others

internal/config/config.go

@@ -15,6 +15,7 @@ type CommonConfig struct {
 	Parallelism         int
 	PlainUI             bool
 	GenerateMappingFile bool
+	HCLOnly             bool
 }
 
 type Config struct {

internal/meta/base_meta.go

@@ -35,6 +35,7 @@ type BaseMeta interface {
 	GenerateCfg(ImportList) error
 	ExportSkippedResources(l ImportList) error
 	ExportResourceMapping(ImportList) error
+	CleanUpWorkspace() error
 }
 
 var _ BaseMeta = &baseMeta{}
@@ -50,6 +51,7 @@ type baseMeta struct {
 	backendConfig  []string
 	fullConfig     bool
 	parallelism    int
+	hclOnly        bool
 
 	// Use a safer name which is less likely to conflicts with users' existing files.
 	// This is mainly used for the --append option.
@@ -152,6 +154,7 @@ The output directory is not empty. Please choose one of actions below:
 		parallelism:     cfg.Parallelism,
 		useSafeFilename: cfg.Append,
 		empty:           empty,
+		hclOnly:         cfg.HCLOnly,
 	}
 
 	return meta, nil
@@ -264,6 +267,44 @@ func (meta baseMeta) ExportSkippedResources(l ImportList) error {
 	return nil
 }
 
+func (meta baseMeta) CleanUpWorkspace() error {
+	// Do nothing if not HCL only... Otherwise, clean up the workspace to only keep the HCL files.
+	if !meta.hclOnly {
+		return nil
+	}
+
+	tmpDir, err := os.MkdirTemp("", "")
+	if err != nil {
+		return err
+	}
+	defer func() {
+		os.RemoveAll(tmpDir)
+	}()
+
+	tmpMainCfg := filepath.Join(tmpDir, meta.filenameMainCfg())
+	tmpProviderCfg := filepath.Join(tmpDir, meta.filenameProviderSetting())
+
+	if err := os.Rename(filepath.Join(meta.Workspace(), meta.filenameMainCfg()), tmpMainCfg); err != nil {
+		return err
+	}
+	if err := os.Rename(filepath.Join(meta.Workspace(), meta.filenameProviderSetting()), tmpProviderCfg); err != nil {
+		return err
+	}
+
+	if err := removeEverythingUnder(meta.Workspace()); err != nil {
+		return err
+	}
+
+	if err := os.Rename(tmpMainCfg, filepath.Join(meta.Workspace(), meta.filenameMainCfg())); err != nil {
+		return err
+	}
+	if err := os.Rename(tmpProviderCfg, filepath.Join(meta.Workspace(), meta.filenameProviderSetting())); err != nil {
+		return err
+	}
+
+	return nil
+}
+
 func (meta baseMeta) generateCfg(l ImportList, cfgTrans ...TFConfigTransformer) error {
 	ctx := context.TODO()
 

internal/meta/meta_dummy.go

@@ -71,3 +71,8 @@ func (m MetaGroupDummy) ExportSkippedResources(l ImportList) error {
 	time.Sleep(500 * time.Millisecond)
 	return nil
 }
+
+func (m MetaGroupDummy) CleanUpWorkspace() error {
+	time.Sleep(500 * time.Millisecond)
+	return nil
+}

internal/run.go

@@ -68,6 +68,11 @@ func BatchImport(cfg config.Config) error {
 			return fmt.Errorf("generating Terraform configuration: %v", err)
 		}
 
+		msg.SetStatus("Cleaning up the output directory to only keep the .tf files...")
+		if err := c.CleanUpWorkspace(); err != nil {
+			return fmt.Errorf("cleaning up the output directory to only keep the .tf files: %v", err)
+		}
+
 		return nil
 	}
 

internal/ui/aztfyclient/client.go

@@ -46,6 +46,8 @@ type ExportSkippedResourcesDoneMsg struct {
 
 type GenerateCfgDoneMsg struct{}
 
+type WorkspaceCleanupDoneMsg struct{}
+
 type QuitMsg struct{}
 
 type CleanTFStateMsg struct {
@@ -117,6 +119,15 @@ func GenerateCfg(c meta.Meta, l meta.ImportList) tea.Cmd {
 	}
 }
 
+func CleanUpWorkspace(c meta.Meta) tea.Cmd {
+	return func() tea.Msg {
+		if err := c.CleanUpWorkspace(); err != nil {
+			return ErrMsg(err)
+		}
+		return WorkspaceCleanupDoneMsg{}
+	}
+}
+
 func ExportResourceMapping(c meta.Meta, l meta.ImportList) tea.Cmd {
 	return func() tea.Msg {
 		if err := c.ExportResourceMapping(l); err != nil {

internal/ui/ui.go

@@ -38,6 +38,7 @@ const (
 	statusImporting
 	statusImportErrorMsg
 	statusGeneratingCfg
+	statusCleaningUpWorkspaceCfg
 	statusExportResourceMapping
 	statusExportSkippedResources
 	statusSummary
@@ -53,6 +54,7 @@ func (s status) String() string {
 		"importing",
 		"import error message",
 		"generating Terraform configuration",
+		"cleaning up output directory",
 		"exporting resource mapping file",
 		"exporting skipped resources file",
 		"summary",
@@ -162,6 +164,9 @@ func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 		m.status = statusGeneratingCfg
 		return m, aztfyclient.GenerateCfg(m.meta, msg.List)
 	case aztfyclient.GenerateCfgDoneMsg:
+		m.status = statusCleaningUpWorkspaceCfg
+		return m, aztfyclient.CleanUpWorkspace(m.meta)
+	case aztfyclient.WorkspaceCleanupDoneMsg:
 		m.status = statusSummary
 		return m, nil
 	case aztfyclient.QuitMsg:
@@ -217,12 +222,14 @@ func (m model) View() string {
 		s += importErrorView(m)
 	case statusImporting:
 		s += m.spinner.View() + m.progress.View()
-	case statusGeneratingCfg:
-		s += m.spinner.View() + " Generating Terraform Configurations..."
 	case statusExportResourceMapping:
 		s += m.spinner.View() + " Exporting Resource Mapping..."
 	case statusExportSkippedResources:
 		s += m.spinner.View() + " Exporting Skipped Resources..."
+	case statusGeneratingCfg:
+		s += m.spinner.View() + " Generating Terraform Configurations..."
+	case statusCleaningUpWorkspaceCfg:
+		s += m.spinner.View() + " Cleaning up the output directory..."
 	case statusSummary:
 		s += summaryView(m)
 	case statusError:

main.go

@@ -36,6 +36,7 @@ func main() {
 		flagContinue            bool
 		flagNonInteractive      bool
 		flagGenerateMappingFile bool
+		flagHCLOnly             bool
 
 		// common flags (hidden)
 		hflagMockClient bool
@@ -78,6 +79,14 @@ func main() {
 				return fmt.Errorf("`--generate-mapping-file` must be used together with `--non-interactive`")
 			}
 		}
+		if flagHCLOnly {
+			if flagBackendType != "local" {
+				return fmt.Errorf("`--hcl-only` only works for local backend")
+			}
+			if flagAppend {
+				return fmt.Errorf("`--appned` conflicts with `--hcl-only`")
+			}
+		}
 
 		// Identify the subscription id, which comes from one of following (starts from the highest priority):
 		// - Command line option
@@ -182,6 +191,12 @@ func main() {
 			Usage:       "Only generate the resource mapping file, but DO NOT import any resource",
 			Destination: &flagGenerateMappingFile,
 		},
+		&cli.BoolFlag{
+			Name:        "hcl-only",
+			EnvVars:     []string{"AZTFY_HCL_ONLY"},
+			Usage:       "Only generate HCL code, but not the files for resource management (e.g. the state file)",
+			Destination: &flagHCLOnly,
+		},
 
 		// Hidden flags
 		&cli.BoolFlag{
@@ -292,6 +307,7 @@ func main() {
 							Parallelism:         flagParallelism,
 							PlainUI:             hflagPlainUI,
 							GenerateMappingFile: flagGenerateMappingFile,
+							HCLOnly:             flagHCLOnly,
 						},
 						ResourceId:     resId,
 						TFResourceName: flagResName,
@@ -336,6 +352,7 @@ func main() {
 							Parallelism:         flagParallelism,
 							PlainUI:             hflagPlainUI,
 							GenerateMappingFile: flagGenerateMappingFile,
+							HCLOnly:             flagHCLOnly,
 						},
 						ResourceGroupName:   rg,
 						ResourceNamePattern: flagPattern,
@@ -379,6 +396,7 @@ func main() {
 							Parallelism:         flagParallelism,
 							PlainUI:             hflagPlainUI,
 							GenerateMappingFile: flagGenerateMappingFile,
+							HCLOnly:             flagHCLOnly,
 						},
 						ARGPredicate:        predicate,
 						ResourceNamePattern: flagPattern,
@@ -422,6 +440,7 @@ func main() {
 							Parallelism:         flagParallelism,
 							PlainUI:             hflagPlainUI,
 							GenerateMappingFile: flagGenerateMappingFile,
+							HCLOnly:             flagHCLOnly,
 						},
 						MappingFile: mapFile,
 					}