Skip to content

Commit a486bbc

Browse files
authored
chore(eslint): lint jsdoc alignment (#33242)
ensures that our jsdocs are aligned correctly ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent e69c79e commit a486bbc

File tree

123 files changed

+905
-907
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

123 files changed

+905
-907
lines changed

packages/@aws-cdk-testing/cli-integ/lib/package-sources/repo-source.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,10 @@ async function writePackageMap(repoRoot: string): Promise<string> {
7676
const YARN_MONOREPO_CACHE: Record<string, any> = {};
7777

7878
/**
79-
* Return a { name -> directory } packages found in a Yarn monorepo
80-
*
81-
* Cached in YARN_MONOREPO_CACHE.
82-
*/
79+
* Return a { name -> directory } packages found in a Yarn monorepo
80+
*
81+
* Cached in YARN_MONOREPO_CACHE.
82+
*/
8383
export async function findYarnPackages(root: string): Promise<Record<string, string>> {
8484
if (!(root in YARN_MONOREPO_CACHE)) {
8585
const outputDataString: string = JSON.parse(await shell(['yarn', 'workspaces', '--json', 'info'], {

packages/@aws-cdk-testing/framework-integ/test/aws-certificatemanager/test/integ.certificate-key-algorithm.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { Certificate, CertificateValidation, KeyAlgorithm } from 'aws-cdk-lib/aw
88
* to have a valid public hosted zone that you can use
99
* to request certificates for.
1010
*
11-
*/
11+
*/
1212
const hostedZoneId = process.env.CDK_INTEG_HOSTED_ZONE_ID ?? process.env.HOSTED_ZONE_ID;
1313
if (!hostedZoneId) throw new Error('For this test you must provide your own HostedZoneId as an env var "HOSTED_ZONE_ID". See framework-integ/README.md for details.');
1414
const hostedZoneName = process.env.CDK_INTEG_HOSTED_ZONE_NAME ?? process.env.HOSTED_ZONE_NAME;

packages/@aws-cdk-testing/framework-integ/test/aws-certificatemanager/test/integ.certificate-name.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { Certificate, CertificateValidation } from 'aws-cdk-lib/aws-certificatem
77
* In order to test this you need to have a valid public hosted zone that you can use
88
* to request certificates for.
99
*
10-
*/
10+
*/
1111
const hostedZoneId = process.env.CDK_INTEG_HOSTED_ZONE_ID ?? process.env.HOSTED_ZONE_ID;
1212
if (!hostedZoneId) throw new Error('For this test you must provide your own HostedZoneId as an env var "HOSTED_ZONE_ID". See framework-integ/README.md for details.');
1313
const hostedZoneName = process.env.CDK_INTEG_HOSTED_ZONE_NAME ?? process.env.HOSTED_ZONE_NAME;

packages/@aws-cdk-testing/framework-integ/test/aws-ec2/test/integ.vpc-ipam.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ const awsIpamVpc = new Vpc(stack, 'AwsIpamVpc', {
6464

6565
/**
6666
* Testing That the Vpc is Deployed with the correct Cidrs.
67-
**/
67+
**/
6868
const integ = new IntegTest(app, 'Vpc-Ipam', {
6969
testCases: [stack],
7070
allowDestroy: ['EC2::IPAM'],

packages/@aws-cdk-testing/framework-integ/test/aws-elasticloadbalancingv2-actions/test/integ.cognito.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ class CognitoStack extends Stack {
173173
* In order to test this you need to have a valid public hosted zone that you can use
174174
* to request certificates for.
175175
*
176-
*/
176+
*/
177177
const hostedZoneId = process.env.CDK_INTEG_HOSTED_ZONE_ID ?? process.env.HOSTED_ZONE_ID;
178178
if (!hostedZoneId) throw new Error('For this test you must provide your own HostedZoneId as an env var "HOSTED_ZONE_ID". See framework-integ/README.md for details.');
179179
const hostedZoneName = process.env.CDK_INTEG_HOSTED_ZONE_NAME ?? process.env.HOSTED_ZONE_NAME;

packages/@aws-cdk-testing/framework-integ/test/aws-elasticloadbalancingv2/test/integ.alb-mtls.ts

+32-32
Original file line numberDiff line numberDiff line change
@@ -20,37 +20,37 @@ import { Construct } from 'constructs';
2020
* `openssl req -x509 -CA rootCA_cert.pem -CAkey rootCA_key.pem -days 7 -new -nodes -keyout client_key.pem -out client_cert.pem`
2121
*
2222
* 3. Create OpenSSL configuration file (openssl.cnf):
23-
```
24-
cat << EOF > openssl.cnf
25-
[ ca ]
26-
default_ca = CA_default
27-
28-
[ CA_default ]
29-
dir = .
30-
database = \$dir/index.txt
31-
new_certs_dir = \$dir/newcerts
32-
certificate = \$dir/rootCA_cert.pem
33-
serial = \$dir/serial
34-
private_key = \$dir/rootCA_key.pem
35-
RANDFILE = \$dir/private/.rand
36-
default_crl_days = 30
37-
default_md = sha256
38-
preserve = no
39-
policy = policy_match
40-
crl_extensions = crl_ext
41-
42-
[ policy_match ]
43-
countryName = optional
44-
stateOrProvinceName = optional
45-
organizationName = optional
46-
organizationalUnitName = optional
47-
commonName = supplied
48-
emailAddress = optional
49-
50-
[ crl_ext ]
51-
authorityKeyIdentifier=keyid:always
52-
EOF
53-
```
23+
* ```
24+
* cat << EOF > openssl.cnf
25+
* [ ca ]
26+
* default_ca = CA_default
27+
*
28+
* [ CA_default ]
29+
* dir = .
30+
* database = \$dir/index.txt
31+
* new_certs_dir = \$dir/newcerts
32+
* certificate = \$dir/rootCA_cert.pem
33+
* serial = \$dir/serial
34+
* private_key = \$dir/rootCA_key.pem
35+
* RANDFILE = \$dir/private/.rand
36+
* default_crl_days = 30
37+
* default_md = sha256
38+
* preserve = no
39+
* policy = policy_match
40+
* crl_extensions = crl_ext
41+
*
42+
* [ policy_match ]
43+
* countryName = optional
44+
* stateOrProvinceName = optional
45+
* organizationName = optional
46+
* organizationalUnitName = optional
47+
* commonName = supplied
48+
* emailAddress = optional
49+
*
50+
* [ crl_ext ]
51+
* authorityKeyIdentifier=keyid:always
52+
* EOF
53+
* ```
5454
*
5555
* 4. Generate Certificate Revocation List (CRL) (valid for 30 days):
5656
* `openssl ca -config openssl.cnf -gencrl -out crl.pem -crldays 30 -md sha256`
@@ -140,7 +140,7 @@ class MutualTls extends Stack {
140140
* In order to test this you need to have a valid public hosted zone that you can use
141141
* to request certificates for.
142142
*
143-
*/
143+
*/
144144
const hostedZoneId = process.env.CDK_INTEG_HOSTED_ZONE_ID ?? process.env.HOSTED_ZONE_ID;
145145
if (!hostedZoneId) throw new Error('For this test you must provide your own HostedZoneId as an env var "HOSTED_ZONE_ID". See framework-integ/README.md for details.');
146146
const hostedZoneName = process.env.CDK_INTEG_HOSTED_ZONE_NAME ?? process.env.HOSTED_ZONE_NAME;

packages/@aws-cdk-testing/framework-integ/test/aws-elasticloadbalancingv2/test/integ.alb.oidc.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ class AlbOidcStack extends Stack {
153153
* In order to test this you need to have a valid public hosted zone that you can use
154154
* to request certificates for.
155155
*
156-
*/
156+
*/
157157
const hostedZoneId = process.env.CDK_INTEG_HOSTED_ZONE_ID ?? process.env.HOSTED_ZONE_ID;
158158
if (!hostedZoneId) throw new Error('For this test you must provide your own HostedZoneId as an env var "HOSTED_ZONE_ID". See framework-integ/README.md for details.');
159159
const hostedZoneName = process.env.CDK_INTEG_HOSTED_ZONE_NAME ?? process.env.HOSTED_ZONE_NAME;

packages/@aws-cdk-testing/framework-integ/test/aws-lambda/test/integ.autoscaling.lit.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ import * as lambda from 'aws-cdk-lib/aws-lambda';
55
import { STANDARD_NODEJS_RUNTIME } from '../../config';
66

77
/**
8-
* Stack verification steps:
9-
* aws application-autoscaling describe-scalable-targets --service-namespace lambda --resource-ids function:<function name>:prod
10-
* has a minCapacity of 3 and maxCapacity of 50
11-
*/
8+
* Stack verification steps:
9+
* aws application-autoscaling describe-scalable-targets --service-namespace lambda --resource-ids function:<function name>:prod
10+
* has a minCapacity of 3 and maxCapacity of 50
11+
*/
1212
class TestStack extends cdk.Stack {
1313
constructor(scope: cdk.App, id: string) {
1414
super(scope, id);

packages/@aws-cdk-testing/framework-integ/test/aws-route53/test/integ.cross-account-zone-delegation.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import { IntegTest } from '@aws-cdk/integ-tests-alpha';
2828
* - `yarn integ aws-route53/test/integ.cross-account-zone-delegation.js`
2929
* b. Fall back if temp credentials do not work (account info may be in snapshot)
3030
* - `yarn integ aws-route53/test/integ.cross-account-zone-delegation.js --profiles cross-account`
31-
*/
31+
*/
3232

3333
const app = new cdk.App();
3434

packages/@aws-cdk-testing/framework-integ/test/custom-resources/test/aws-custom-resource/integ.cross-account-assumeRole.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import { AwsCustomResource, AwsCustomResourcePolicy, PhysicalResourceId } from '
2626
* - `yarn integ custom-resources/test/aws-custom-resource/integ.cross-account-assumeRole.js`
2727
* b. Fall back if temp credentials do not work (account info may be in snapshot)
2828
* - `yarn integ custom-resources/test/aws-custom-resource/integ.cross-account-assumeRole.js --profiles cross-account`
29-
*/
29+
*/
3030

3131
const app = new cdk.App();
3232

packages/@aws-cdk/app-staging-synthesizer-alpha/test/app-staging-synthesizer.test.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -597,10 +597,10 @@ describe(AppStagingSynthesizer, () => {
597597
});
598598

599599
/**
600-
* Evaluate a possibly string-containing value the same way CFN would do
601-
*
602-
* (Be invariant to the specific Fn::Sub or Fn::Join we would output)
603-
*/
600+
* Evaluate a possibly string-containing value the same way CFN would do
601+
*
602+
* (Be invariant to the specific Fn::Sub or Fn::Join we would output)
603+
*/
604604
function evalCFN(value: any) {
605605
return evaluateCFN(stack.resolve(value), CFN_CONTEXT);
606606
}

packages/@aws-cdk/aws-amplify-alpha/test/integ.app-custom-domain.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ class TestStack extends Stack {
5353
/**
5454
* In order to test this you need to have a valid public hosted zone that you can use
5555
* to request certificates for.
56-
*/
56+
*/
5757
const hostedZoneId = process.env.CDK_INTEG_HOSTED_ZONE_ID ?? process.env.HOSTED_ZONE_ID;
5858
if (!hostedZoneId) throw new Error('For this test you must provide your own HostedZoneId as an env var "HOSTED_ZONE_ID". See framework-integ/README.md for details.');
5959
const hostedZoneName = process.env.CDK_INTEG_HOSTED_ZONE_NAME ?? process.env.HOSTED_ZONE_NAME;

packages/@aws-cdk/aws-apprunner-alpha/lib/vpc-ingress-connection.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,9 @@ export interface IVpcIngressConnection extends cdk.IResource {
6767
readonly vpcIngressConnectionArn: string;
6868

6969
/**
70-
* The name of the VPC Ingress Connection.
71-
* @attribute
72-
*/
70+
* The name of the VPC Ingress Connection.
71+
* @attribute
72+
*/
7373
readonly vpcIngressConnectionName: string;
7474
}
7575

packages/@aws-cdk/aws-cognito-identitypool-alpha/lib/identitypool.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ export interface IdentityPoolFacebookLoginProvider {
174174

175175
/**
176176
* Login Provider for identity federation using Apple credentials
177-
*/
177+
*/
178178
export interface IdentityPoolAppleLoginProvider {
179179
/**
180180
* Services ID for Apple identity federation

packages/@aws-cdk/aws-ec2-alpha/lib/ipam.ts

+15-15
Original file line numberDiff line numberDiff line change
@@ -127,14 +127,14 @@ export interface PoolOptions {
127127
readonly publicIpSource?: IpamPoolPublicIpSource;
128128

129129
/**
130-
* Limits which service in AWS that the pool can be used in.
131-
*
132-
* "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.
133-
*
134-
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-awsservice
135-
*
136-
* @default - required in case of an IPv6, throws an error if not provided.
137-
*/
130+
* Limits which service in AWS that the pool can be used in.
131+
*
132+
* "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.
133+
*
134+
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-awsservice
135+
*
136+
* @default - required in case of an IPv6, throws an error if not provided.
137+
*/
138138
readonly awsService?: AwsServiceName;
139139

140140
/**
@@ -184,9 +184,9 @@ export interface IpamPoolCidrProvisioningOptions {
184184
*/
185185
export interface IIpamPool {
186186
/**
187-
* Pool ID to be passed to the VPC construct
188-
* @attribute IpamPoolId
189-
*/
187+
* Pool ID to be passed to the VPC construct
188+
* @attribute IpamPoolId
189+
*/
190190
readonly ipamPoolId: string;
191191

192192
/**
@@ -468,10 +468,10 @@ class IpamScopeBase implements IIpamScopeBase {
468468
*/
469469
export class Ipam extends Resource {
470470
/**
471-
* Provides access to default public IPAM scope through add pool method.
472-
* Usage: To add an Ipam Pool to a default public scope
473-
* @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html
474-
*/
471+
* Provides access to default public IPAM scope through add pool method.
472+
* Usage: To add an Ipam Pool to a default public scope
473+
* @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html
474+
*/
475475
public readonly publicScope: IIpamScopeBase;
476476

477477
/**

packages/@aws-cdk/aws-ec2-alpha/lib/subnet-v2.ts

+24-24
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ interface ICidr {
1717
*/
1818
export class IpCidr implements ICidr {
1919
/**
20-
* IPv6 CIDR range for the subnet
21-
* Allowed only if IPv6 is enabled on VPc
22-
*/
20+
* IPv6 CIDR range for the subnet
21+
* Allowed only if IPv6 is enabled on VPc
22+
*/
2323
public readonly cidr: string;
2424
constructor(props: string ) {
2525
this.cidr = props;
@@ -133,50 +133,50 @@ export class SubnetV2 extends Resource implements ISubnetV2 {
133133
*/
134134
public static fromSubnetV2Attributes(scope: Construct, id: string, attrs: SubnetV2Attributes) : ISubnetV2 {
135135
/**
136-
* Class to define an import for an existing subnet
137-
* @resource AWS::EC2::Subnet
138-
*/
136+
* Class to define an import for an existing subnet
137+
* @resource AWS::EC2::Subnet
138+
*/
139139
class ImportedSubnetV2 extends Resource implements ISubnetV2 {
140140
/**
141-
* The IPv6 CIDR Block assigned to this subnet
142-
*/
141+
* The IPv6 CIDR Block assigned to this subnet
142+
*/
143143
public readonly ipv6CidrBlock?: string = attrs.ipv6CidrBlock;
144144

145145
/**
146-
* The type of subnet (eg. public or private) that this subnet represents.
147-
*/
146+
* The type of subnet (eg. public or private) that this subnet represents.
147+
*/
148148
public readonly subnetType?: SubnetType = attrs.subnetType;
149149

150150
/**
151-
* The Availability Zone in which subnet is located
152-
*/
151+
* The Availability Zone in which subnet is located
152+
*/
153153
public readonly availabilityZone: string = attrs.availabilityZone;
154154

155155
/**
156-
* The subnetId for this particular subnet
157-
* Refers to the physical ID created
158-
*/
156+
* The subnetId for this particular subnet
157+
* Refers to the physical ID created
158+
*/
159159
public readonly subnetId: string = attrs.subnetId;
160160

161161
/**
162-
* Dependable that can be depended upon to force internet connectivity established on the VPC
163-
*/
162+
* Dependable that can be depended upon to force internet connectivity established on the VPC
163+
*/
164164
public readonly internetConnectivityEstablished: IDependable = new DependencyGroup();
165165

166166
/**
167-
* The IPv4 CIDR block assigned to this subnet
168-
*/
167+
* The IPv4 CIDR block assigned to this subnet
168+
*/
169169
public readonly ipv4CidrBlock: string = attrs.ipv4CidrBlock;
170170

171171
/**
172-
* Current route table associated with this subnet
173-
*/
172+
* Current route table associated with this subnet
173+
*/
174174
public readonly routeTable: IRouteTable = { routeTableId: attrs.routeTableId! };
175175

176176
/**
177-
* Associate a Network ACL with this subnet
178-
* Required here since it is implemented in the ISubnetV2
179-
*/
177+
* Associate a Network ACL with this subnet
178+
* Required here since it is implemented in the ISubnetV2
179+
*/
180180
public associateNetworkAcl(aclId: string, networkAcl: INetworkAcl) {
181181
const aclScope = networkAcl instanceof Construct ? networkAcl : this;
182182
const other = networkAcl instanceof Construct ? this : networkAcl;

0 commit comments

Comments
 (0)