Skip to content

Commit

Permalink
chore: remove tabs in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@DanielMSchmidt
DanielMSchmidt committed Nov 20, 2023
1 parent 1ab9319 commit 9f70e6f
Show file tree
Hide file tree
Showing 4 changed files with 141 additions and 117 deletions.
28 changes: 26 additions & 2 deletions tools/documentation-code-snippets/update-documentation-code-snippets.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -223,10 +223,34 @@ async function collectSnippetsFromFile(
return Math.min(leadingWhitespace, currentMin);
}, Number.MAX_VALUE);

const whitespaceTrimmedLines = snippet.lines.map((line) =>
line.substring(whiteSpacesToRemove)
);

function numberOfPrefixedTabs(input: string) {
let count = 0;
for (const char of input) {
if (char === "\t") {
count++;
} else {
break;
}
}
return count;
}

const tabsToRemove = whitespaceTrimmedLines.reduce((currentMin, line) => {
if (line === "") return currentMin; // ignore empty lines
if (line === "\n") return currentMin; // ignore newline lines

const leadingTabs = numberOfPrefixedTabs(line);
return Math.min(leadingTabs, currentMin);
}, Number.MAX_VALUE);

return {
snippetId: id,
content: snippet.lines
.map((line) => line.substring(whiteSpacesToRemove))
content: whitespaceTrimmedLines
.map((line) => line.substring(tabsToRemove))
.join("\n"),
sourcePath,
};
Expand Down
92 changes: 46 additions & 46 deletions website/docs/cdktf/concepts/iterators.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,24 +92,24 @@ from cdktf import TerraformIterator, TerraformVariable, TerraformLocal
});

ListTerraformIterator iterator = ListTerraformIterator.FromList(list.ListValue);
S3Bucket s3Bucket = new S3Bucket(this, "bucket", new S3BucketConfig
S3Bucket s3Bucket = new S3Bucket(this, "value-bucket", new S3BucketConfig
{
ForEach = iterator,
Bucket = Token.AsString(iterator.Value)
});
```

```go
list := cdktf.NewTerraformVariable(stack, jsii.String("list"), &cdktf.TerraformVariableConfig{
Type: cdktf.VariableType_LIST_STRING(),
})
list := cdktf.NewTerraformVariable(stack, jsii.String("list"), &cdktf.TerraformVariableConfig{
Type: cdktf.VariableType_LIST_STRING(),
})

simpleIterator := cdktf.TerraformIterator_FromList(list.ListValue())
simpleIterator := cdktf.TerraformIterator_FromList(list.ListValue())

s3bucket.NewS3Bucket(stack, jsii.String("iterator-bucket"), &s3bucket.S3BucketConfig{
ForEach: simpleIterator,
Bucket: cdktf.Token_AsString(simpleIterator.Value(), nil),
})
s3bucket.NewS3Bucket(stack, jsii.String("iterator-bucket"), &s3bucket.S3BucketConfig{
ForEach: simpleIterator,
Bucket: cdktf.Token_AsString(simpleIterator.Value(), nil),
})
```

</CodeTabs>
Expand Down Expand Up @@ -248,7 +248,7 @@ TerraformLocal complexLocal = new TerraformLocal(this, "complex_local", new Dict
}
});
MapTerraformIterator mapIterator = MapTerraformIterator.FromMap(complexLocal.AsAnyMap);
new S3Bucket(this, "bucket", new S3BucketConfig
new S3Bucket(this, "tag-bucket", new S3BucketConfig
{
ForEach = mapIterator,
Bucket = mapIterator.GetString("name"),
Expand All @@ -257,24 +257,24 @@ new S3Bucket(this, "bucket", new S3BucketConfig
```
```go
complexList := cdktf.NewTerraformLocal(stack, jsii.String("complex-list-local"), []map[string]interface{}{
{
"name": "website-static-files",
"tags": map[string]string{"app": "website"},
},
{
"name": "images",
"tags": map[string]string{"app": "image-converter"},
},
})

complexIterator := cdktf.TerraformIterator_FromList(complexList.Expression())

s3bucket.NewS3Bucket(stack, jsii.String("complex-iterator-bucket"), &s3bucket.S3BucketConfig{
ForEach: complexIterator,
Bucket: complexIterator.GetString(jsii.String("name")),
Tags: complexIterator.GetStringMap(jsii.String("tags")),
})
complexList := cdktf.NewTerraformLocal(stack, jsii.String("complex-list-local"), []map[string]interface{}{
{
"name": "website-static-files",
"tags": map[string]string{"app": "website"},
},
{
"name": "images",
"tags": map[string]string{"app": "image-converter"},
},
})

complexIterator := cdktf.TerraformIterator_FromList(complexList.Expression())

s3bucket.NewS3Bucket(stack, jsii.String("complex-iterator-bucket"), &s3bucket.S3BucketConfig{
ForEach: complexIterator,
Bucket: complexIterator.GetString(jsii.String("name")),
Tags: complexIterator.GetStringMap(jsii.String("tags")),
})
```
</CodeTabs>
Expand Down Expand Up @@ -407,29 +407,29 @@ new TeamMembers(this, "members", {
```
```go
orgName := "my-org"
orgName := "my-org"

github.NewGithubProvider(stack, jsii.String("github"), &github.GithubProviderConfig{
Organization: &orgName,
})
github.NewGithubProvider(stack, jsii.String("github"), &github.GithubProviderConfig{
Organization: &orgName,
})

team := team.NewTeam(stack, jsii.String("core-team"), &team.TeamConfig{
Name: jsii.String("core"),
})
team := team.NewTeam(stack, jsii.String("core-team"), &team.TeamConfig{
Name: jsii.String("core"),
})

orgMembers := datagithuborganization.NewDataGithubOrganization(stack, jsii.String("org"), &datagithuborganization.DataGithubOrganizationConfig{
Name: &orgName,
})
orgMembers := datagithuborganization.NewDataGithubOrganization(stack, jsii.String("org"), &datagithuborganization.DataGithubOrganizationConfig{
Name: &orgName,
})

orgMemberIterator := cdktf.TerraformIterator_FromList(orgMembers.Members())
orgMemberIterator := cdktf.TerraformIterator_FromList(orgMembers.Members())

teammembers.NewTeamMembers(stack, jsii.String("members"), &teammembers.TeamMembersConfig{
TeamId: team.Id(),
Members: orgMemberIterator.Dynamic(&map[string]interface{}{
"username": orgMemberIterator.Value(),
"role": jsii.String("maintainer"),
}),
})
teammembers.NewTeamMembers(stack, jsii.String("members"), &teammembers.TeamMembersConfig{
TeamId: team.Id(),
Members: orgMemberIterator.Dynamic(&map[string]interface{}{
"username": orgMemberIterator.Value(),
"role": jsii.String("maintainer"),
}),
})
```
</CodeTabs>
Expand Down
92 changes: 46 additions & 46 deletions website/docs/cdktf/concepts/resources.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -334,38 +334,38 @@ import imports.kubernetes.namespace.NamespaceMetadata;
```

```go
exampleNamespace := namespace.NewNamespace(stack, jsii.String("tf-cdk-example"), &namespace.NamespaceConfig{
Metadata: &namespace.NamespaceMetadata{
Name: jsii.String("tf-cdk-example"),
},
})
exampleNamespace := namespace.NewNamespace(stack, jsii.String("tf-cdk-example"), &namespace.NamespaceConfig{
Metadata: &namespace.NamespaceMetadata{
Name: jsii.String("tf-cdk-example"),
},
})

deployment.NewDeployment(stack, jsii.String("nginx-deployment"), &deployment.DeploymentConfig{
Metadata: &deployment.DeploymentMetadata{
Name: jsii.String("nginx"),
Namespace: exampleNamespace.Metadata().Name(), // Reference the name property
Labels: &map[string]*string{
"app": jsii.String("my-app"),
},
deployment.NewDeployment(stack, jsii.String("nginx-deployment"), &deployment.DeploymentConfig{
Metadata: &deployment.DeploymentMetadata{
Name: jsii.String("nginx"),
Namespace: exampleNamespace.Metadata().Name(), // Reference the name property
Labels: &map[string]*string{
"app": jsii.String("my-app"),
},
Spec: &deployment.DeploymentSpec{
Template: &deployment.DeploymentSpecTemplate{
Metadata: &deployment.DeploymentSpecTemplateMetadata{
Labels: &map[string]*string{
"app": jsii.String("my-app"),
},
},
Spec: &deployment.DeploymentSpec{
Template: &deployment.DeploymentSpecTemplate{
Metadata: &deployment.DeploymentSpecTemplateMetadata{
Labels: &map[string]*string{
"app": jsii.String("my-app"),
},
Spec: &deployment.DeploymentSpecTemplateSpec{
Container: []deployment.DeploymentSpecTemplateSpecContainer{
{
Name: jsii.String("nginx"),
Image: jsii.String("nginx:1.7.9"),
},
},
Spec: &deployment.DeploymentSpecTemplateSpec{
Container: []deployment.DeploymentSpecTemplateSpecContainer{
{
Name: jsii.String("nginx"),
Image: jsii.String("nginx:1.7.9"),
},
},
},
},
})
},
})
```

</CodeTabs>
Expand Down Expand Up @@ -1135,30 +1135,30 @@ new SecurityGroup(this, "security2", new SecurityGroupConfig
```

```go
ports := []float64{22, 80, 443, 5432}
ingress := make([]securitygroup.SecurityGroupIngress, 0)
for _, port := range ports {
ingress = append(ingress, securitygroup.SecurityGroupIngress{
FromPort: jsii.Number(port),
ToPort: jsii.Number(port),
ports := []float64{22, 80, 443, 5432}
ingress := make([]securitygroup.SecurityGroupIngress, 0)
for _, port := range ports {
ingress = append(ingress, securitygroup.SecurityGroupIngress{
FromPort: jsii.Number(port),
ToPort: jsii.Number(port),
CidrBlocks: &[]*string{jsii.String("0.0.0.0/0")},
Protocol: jsii.String("-1"),
})
}

securitygroup.NewSecurityGroup(stack, jsii.String("security2"), &securitygroup.SecurityGroupConfig{
Name: jsii.String("security2"),
VpcId: jsii.String("vpcs"),
Egress: &[]securitygroup.SecurityGroupEgress{
{
FromPort: jsii.Number(0),
ToPort: jsii.Number(0),
CidrBlocks: &[]*string{jsii.String("0.0.0.0/0")},
Protocol: jsii.String("-1"),
})
}

securitygroup.NewSecurityGroup(stack, jsii.String("security2"), &securitygroup.SecurityGroupConfig{
Name: jsii.String("security2"),
VpcId: jsii.String("vpcs"),
Egress: &[]securitygroup.SecurityGroupEgress{
{
FromPort: jsii.Number(0),
ToPort: jsii.Number(0),
CidrBlocks: &[]*string{jsii.String("0.0.0.0/0")},
Protocol: jsii.String("-1"),
},
},
Ingress: &ingress,
})
},
Ingress: &ingress,
})
```
</CodeTabs>
Expand Down
46 changes: 23 additions & 23 deletions website/docs/cdktf/concepts/variables-and-outputs.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -134,30 +134,30 @@ new TerraformResource(this, "resource", {
```

```go
nodeGroupConfig := cdktf.NewTerraformVariable(stack, jsii.String("node-group-config"), &cdktf.TerraformVariableConfig{
Type: cdktf.VariableType_Object(&map[string]*string{
"node_group_name": cdktf.VariableType_STRING(),
"instance_types": cdktf.VariableType_List(cdktf.VariableType_STRING()),
"min_size": cdktf.VariableType_NUMBER(),
"desired_size": cdktf.VariableType_NUMBER(),
"max_size": cdktf.VariableType_NUMBER(),
}),
Nullable: jsii.Bool(false),
Description: jsii.String("Node group configuration"),
})
nodeGroupConfig := cdktf.NewTerraformVariable(stack, jsii.String("node-group-config"), &cdktf.TerraformVariableConfig{
Type: cdktf.VariableType_Object(&map[string]*string{
"node_group_name": cdktf.VariableType_STRING(),
"instance_types": cdktf.VariableType_List(cdktf.VariableType_STRING()),
"min_size": cdktf.VariableType_NUMBER(),
"desired_size": cdktf.VariableType_NUMBER(),
"max_size": cdktf.VariableType_NUMBER(),
}),
Nullable: jsii.Bool(false),
Description: jsii.String("Node group configuration"),
})

eksnodegroup.NewEksNodeGroup(stack, jsii.String("node-group"), &eksnodegroup.EksNodeGroupConfig{
ClusterName: jsii.String("my-cluster"),
NodeRoleArn: jsii.String("arn:::::dummy"),
SubnetIds: jsii.Strings("id-1234"),
NodeGroupName: jsii.String(fmt.Sprintf("${%s.node_group_name}", *nodeGroupConfig.Fqn())),
InstanceTypes: cdktf.Token_AsList(fmt.Sprintf("${%s.instance_types}", *nodeGroupConfig.Fqn()), &cdktf.EncodingOptions{}),
ScalingConfig: &eksnodegroup.EksNodeGroupScalingConfig{
DesiredSize: cdktf.Token_AsNumber(fmt.Sprintf("${%s.desired_size}", *nodeGroupConfig.Fqn())),
MinSize: cdktf.Token_AsNumber(fmt.Sprintf("${%s.min_size}", *nodeGroupConfig.Fqn())),
MaxSize: cdktf.Token_AsNumber(fmt.Sprintf("${%s.max_size}", *nodeGroupConfig.Fqn())),
},
})
eksnodegroup.NewEksNodeGroup(stack, jsii.String("node-group"), &eksnodegroup.EksNodeGroupConfig{
ClusterName: jsii.String("my-cluster"),
NodeRoleArn: jsii.String("arn:::::dummy"),
SubnetIds: jsii.Strings("id-1234"),
NodeGroupName: jsii.String(fmt.Sprintf("${%s.node_group_name}", *nodeGroupConfig.Fqn())),
InstanceTypes: cdktf.Token_AsList(fmt.Sprintf("${%s.instance_types}", *nodeGroupConfig.Fqn()), &cdktf.EncodingOptions{}),
ScalingConfig: &eksnodegroup.EksNodeGroupScalingConfig{
DesiredSize: cdktf.Token_AsNumber(fmt.Sprintf("${%s.desired_size}", *nodeGroupConfig.Fqn())),
MinSize: cdktf.Token_AsNumber(fmt.Sprintf("${%s.min_size}", *nodeGroupConfig.Fqn())),
MaxSize: cdktf.Token_AsNumber(fmt.Sprintf("${%s.max_size}", *nodeGroupConfig.Fqn())),
},
})
```

</CodeTabs>
Expand Down

0 comments on commit 9f70e6f

Please sign in to comment.