chore: rename static method for greater clarity

hashicorp · Sep 25, 2023 · f3ae8fc · f3ae8fc
1 parent 92922bf
commit f3ae8fc
Show file tree

Hide file tree

Showing 12 changed files with 52 additions and 48 deletions.
diff --git a/examples/typescript/aws-import/main.ts b/examples/typescript/aws-import/main.ts
@@ -38,7 +38,7 @@ class StackWithImportAndConfigurationGeneration extends TerraformStack {
     });
 
     // Step 2: Create import block
-    S3Bucket.importOf(this, "bucket", bucketId);
+    S3Bucket.importGenerateConfig(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

diff --git a/packages/@cdktf/cli-core/src/lib/convert.ts b/packages/@cdktf/cli-core/src/lib/convert.ts
@@ -7,7 +7,11 @@ import * as hcl2cdk from "@cdktf/hcl2cdk";
 import { CdktfConfig } from "./cdktf-config";
 import { TerraformProviderConstraint } from "@cdktf/provider-generator";
 import { readSchema } from "@cdktf/provider-schema";
-import { Errors, LANGUAGES, ConstructsMakerProviderTarget } from "@cdktf/commons";
+import {
+  Errors,
+  LANGUAGES,
+  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

diff --git a/packages/@cdktf/provider-generator/lib/__tests__/provider.test.ts b/packages/@cdktf/provider-generator/lib/__tests__/provider.test.ts
@@ -96,7 +96,7 @@ describe("Provider", () => {
             terraformResourceType = `datadog_${terraformResourceType}`;
           }
           expect(snapshot[`providers/datadog/${resource}/index.ts`]).toContain(
-            `public static importOf(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider)`
+            `public static importGenerateConfig(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider)`
           );
           expect(snapshot[`providers/datadog/${resource}/index.ts`]).toContain(
             `return new cdktf.ImportableResource(scope, name, { terraformResourceType: "${terraformResourceType}", importId: id, provider });`

diff --git a/...r-generator/lib/get/__tests__/generator/__snapshots__/complex-computed-types.test.ts.snap b/...r-generator/lib/get/__tests__/generator/__snapshots__/complex-computed-types.test.ts.snap
@@ -214,7 +214,7 @@ export class AcmCertificate extends cdktf.TerraformResource {
   // ==============
   // STATIC Methods
   // ==============
-  public static importOf(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
+  public static importGenerateConfig(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
         return new cdktf.ImportableResource(scope, name, { terraformResourceType: "aws_acm_certificate", importId: id, provider });
       }
 

diff --git a/...der-generator/lib/get/__tests__/generator/__snapshots__/description-escaping.test.ts.snap b/...der-generator/lib/get/__tests__/generator/__snapshots__/description-escaping.test.ts.snap
@@ -37,7 +37,7 @@ export class DescriptionEscaping extends cdktf.TerraformResource {
   // ==============
   // STATIC Methods
   // ==============
-  public static importOf(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
+  public static importGenerateConfig(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
         return new cdktf.ImportableResource(scope, name, { terraformResourceType: "description_escaping", importId: id, provider });
       }
 
@@ -132,7 +132,7 @@ export class CodeBlocks extends cdktf.TerraformResource {
   // ==============
   // STATIC Methods
   // ==============
-  public static importOf(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
+  public static importGenerateConfig(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
         return new cdktf.ImportableResource(scope, name, { terraformResourceType: "code_blocks", importId: id, provider });
       }
 
@@ -225,7 +225,7 @@ export class CodeBlocks extends cdktf.TerraformResource {
   // ==============
   // STATIC Methods
   // ==============
-  public static importOf(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
+  public static importGenerateConfig(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
         return new cdktf.ImportableResource(scope, name, { terraformResourceType: "code_blocks", importId: id, provider });
       }
 

diff --git a/...provider-generator/lib/get/__tests__/generator/__snapshots__/export-sharding.test.ts.snap b/...provider-generator/lib/get/__tests__/generator/__snapshots__/export-sharding.test.ts.snap
@@ -110,7 +110,7 @@ export class Dashboard extends cdktf.TerraformResource {
   // ==============
   // STATIC Methods
   // ==============
-  public static importOf(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
+  public static importGenerateConfig(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
         return new cdktf.ImportableResource(scope, name, { terraformResourceType: "datadog_dashboard", importId: id, provider });
       }
 
@@ -146871,7 +146871,7 @@ export class Wafv2WebAcl extends cdktf.TerraformResource {
   // ==============
   // STATIC Methods
   // ==============
-  public static importOf(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
+  public static importGenerateConfig(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
         return new cdktf.ImportableResource(scope, name, { terraformResourceType: "aws_wafv2_web_acl", importId: id, provider });
       }
 

diff --git a/...tf/provider-generator/lib/get/__tests__/generator/__snapshots__/nested-types.test.ts.snap b/...tf/provider-generator/lib/get/__tests__/generator/__snapshots__/nested-types.test.ts.snap
@@ -303,7 +303,7 @@ export class NestedTypesResource extends cdktf.TerraformResource {
   // ==============
   // STATIC Methods
   // ==============
-  public static importOf(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
+  public static importGenerateConfig(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
         return new cdktf.ImportableResource(scope, name, { terraformResourceType: "nested_types_resource", importId: id, provider });
       }
 

diff --git a/...@cdktf/provider-generator/lib/get/__tests__/generator/__snapshots__/provider.test.ts.snap b/...@cdktf/provider-generator/lib/get/__tests__/generator/__snapshots__/provider.test.ts.snap
@@ -1173,7 +1173,7 @@ export class AwsProvider extends cdktf.TerraformProvider {
   // ==============
   // STATIC Methods
   // ==============
-  public static importOf(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
+  public static importGenerateConfig(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
         return new cdktf.ImportableResource(scope, name, { terraformResourceType: "aws", importId: id, provider });
       }
 
@@ -1697,7 +1697,7 @@ export class ElasticstackProvider extends cdktf.TerraformProvider {
   // ==============
   // STATIC Methods
   // ==============
-  public static importOf(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
+  public static importGenerateConfig(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
         return new cdktf.ImportableResource(scope, name, { terraformResourceType: "elasticstack", importId: id, provider });
       }
 

diff --git a/.../provider-generator/lib/get/__tests__/generator/__snapshots__/resource-types.test.ts.snap b/.../provider-generator/lib/get/__tests__/generator/__snapshots__/resource-types.test.ts.snap
@@ -4023,7 +4023,7 @@ export class CloudfrontDistribution extends cdktf.TerraformResource {
   // ==============
   // STATIC Methods
   // ==============
-  public static importOf(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
+  public static importGenerateConfig(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
         return new cdktf.ImportableResource(scope, name, { terraformResourceType: "aws_cloudfront_distribution", importId: id, provider });
       }
 
@@ -4515,7 +4515,7 @@ export class FmsAdminAccount extends cdktf.TerraformResource {
   // ==============
   // STATIC Methods
   // ==============
-  public static importOf(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
+  public static importGenerateConfig(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
         return new cdktf.ImportableResource(scope, name, { terraformResourceType: "aws_fms_admin_account", importId: id, provider });
       }
 
@@ -7536,7 +7536,7 @@ export class S3Bucket extends cdktf.TerraformResource {
   // ==============
   // STATIC Methods
   // ==============
-  public static importOf(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
+  public static importGenerateConfig(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
         return new cdktf.ImportableResource(scope, name, { terraformResourceType: "aws_s3_bucket", importId: id, provider });
       }
 
@@ -8805,7 +8805,7 @@ export class SecurityGroup extends cdktf.TerraformResource {
   // ==============
   // STATIC Methods
   // ==============
-  public static importOf(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
+  public static importGenerateConfig(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
         return new cdktf.ImportableResource(scope, name, { terraformResourceType: "aws_security_group", importId: id, provider });
       }
 

diff --git a/...vider-generator/lib/get/__tests__/generator/__snapshots__/skipped-attributes.test.ts.snap b/...vider-generator/lib/get/__tests__/generator/__snapshots__/skipped-attributes.test.ts.snap
@@ -691,7 +691,7 @@ export class QuicksightTemplate extends cdktf.TerraformResource {
   // ==============
   // STATIC Methods
   // ==============
-  public static importOf(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
+  public static importGenerateConfig(scope: Construct, name: string, id: string, provider?: cdktf.TerraformProvider) {
         return new cdktf.ImportableResource(scope, name, { terraformResourceType: "aws_quicksight_template", importId: id, provider });
       }