chore: integrated feedback from ansgar, made clear workflow for confi…

…g generation, updated docs

examples/typescript/aws-import/main.ts

@@ -38,7 +38,7 @@ class StackWithImportAndConfigurationGeneration extends TerraformStack {
     });
 
     // Step 2: Create import block
-    S3Bucket.importGenerateConfig(this, "bucket", bucketId);
+    S3Bucket.generateConfigForImport(this, "bucket", bucketId);
 
     // Step 3: Run `cdktf plan` and get the configuration to put in below
     // Step 4: Remove the `import` call, the resource is now imported

packages/@cdktf/cli-core/src/lib/cdktf-stack.ts

@@ -8,7 +8,8 @@ import { extractJsonLogIfPresent } from "./server/terraform-logs";
 import {
   TerraformCli,
   OutputFilter,
-  findGeneratedConfigurationFile,
+  tryReadGeneratedConfigurationFile,
+  tryRemoveGeneratedConfigurationFile,
 } from "./models/terraform-cli";
 import { ProviderConstraint } from "./dependencies/dependency-manager";
 import { terraformJsonSchema, TerraformStack } from "./terraform-json";
@@ -379,7 +380,7 @@ export class CdktfStack {
       this.updateState({ type: "planned", stackName: this.stack.name });
 
       // Find generated file
-      const configFile = await findGeneratedConfigurationFile(
+      const configFile = await tryReadGeneratedConfigurationFile(
         this.stack.workingDirectory
       );
       if (configFile) {
@@ -389,7 +390,10 @@ export class CdktfStack {
           configuration: configFile,
         });
 
-        const convertedCode = await convertConfigurationFile(configFile);
+        const convertedCode = await convertConfigurationFile(
+          configFile,
+          this.stack.workingDirectory
+        );
         this.updateState({
           type: "import with configuration converted",
           stackName: this.stack.name,
@@ -406,10 +410,15 @@ CDKTF has translated the code to the following:
 ${convertedCode}
 
 Please review the code and make any necessary changes before adding it to your codebase.
-Make sure to only copy the code within the construct's constructor.`,
+Make sure to only copy the code within the construct's constructor.
+
+NOTE: Your resource has not yet become managed by CDKTF. 
+To finish the import remove the call "generateConfigForImport", add the above code within the construct's constructor, and then append the call importFrom({resource_id_to_import_from}) to the generated code. 
+`,
             isError: false,
           });
         }
+        await tryRemoveGeneratedConfigurationFile(this.stack.workingDirectory);
       }
     });
   }

packages/@cdktf/cli-core/src/lib/convert.ts

@@ -13,8 +13,11 @@ import {
   ConstructsMakerProviderTarget,
 } from "@cdktf/commons";
 
-export async function convertConfigurationFile(configuration: string) {
-  const cfg = CdktfConfig.read(process.cwd()); // TODO: make this the project directory instead of cwd
+export async function convertConfigurationFile(
+  configuration: string,
+  stackWorkingDirectory: string
+) {
+  const cfg = CdktfConfig.read(stackWorkingDirectory); // TODO: make this the project directory instead of cwd
   const targets = cfg.terraformProviders.map((constraint) =>
     ConstructsMakerProviderTarget.from(
       new TerraformProviderConstraint(constraint),

packages/@cdktf/cli-core/src/lib/models/terraform-cli.ts

@@ -81,6 +81,7 @@ class VariableRequiredFilter extends AbstractOutputFilter {
 
 export class TerraformCli implements Terraform {
   public readonly workdir: string;
+  static readonly generatedImportConfigFile: string = "generated_resources.tf";
   private readonly onStdout: (
     stateName: string,
     filter?: OutputFilter[]
@@ -227,13 +228,15 @@ export class TerraformCli implements Terraform {
 
     const generatedConfigFile = path.join(
       this.workdir,
-      "generated_resources.tf"
+      TerraformCli.generatedImportConfigFile
     );
     if (fs.existsSync(generatedConfigFile)) {
       fs.remove(generatedConfigFile);
     }
     if (this.hasImports) {
-      options.push("-generate-config-out=generated_resources.tf");
+      options.push(
+        `-generate-config-out=${TerraformCli.generatedImportConfigFile}`
+      );
     }
     if (!this.isCloudStack) {
       const planFile = "plan";
@@ -481,12 +484,25 @@ export class TerraformCli implements Terraform {
   }
 }
 
-export async function findGeneratedConfigurationFile(
+export async function tryReadGeneratedConfigurationFile(
   workingDir: string
 ): Promise<string | null> {
-  const generatedConfigPath = path.join(workingDir, "generated_resources.tf");
+  const generatedConfigPath = path.join(
+    workingDir,
+    TerraformCli.generatedImportConfigFile
+  );
   if (!fs.existsSync(generatedConfigPath)) {
     return null;
   }
   return fs.readFileSync(generatedConfigPath, "utf-8");
 }
+
+export async function tryRemoveGeneratedConfigurationFile(workingDir: string) {
+  const generatedConfigPath = path.join(
+    workingDir,
+    TerraformCli.generatedImportConfigFile
+  );
+  if (fs.existsSync(generatedConfigPath)) {
+    fs.unlinkSync(generatedConfigPath);
+  }
+}