Skip to content

Commit 0f59ead

Browse files
TastefulElkTastefulElk
authored
chore(init-templates): READMEs produce markdownlint errors (#18681)
---- Hey CDK gang! 👋 This may seem small, but it's something that's bugging me every time I bootstrap a new project - the generated `README` doesn't adhere to the [commonmark](https://commonmark.org/) standard and therefore gets lint warnings by [markdownlint](https://github.com/DavidAnson/markdownlint). I'm not sure you're interested in the changes, but if you are, I'd happily go over the non-template readme's as well but one thing at a time. *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license* <img width="1232" alt="2022-01-27_10-35-28" src="https://user-images.githubusercontent.com/5831347/151332032-126289bf-4442-4c69-8f79-0dbaf7aba92c.png"> <img width="754" alt="2022-01-27_10-35-04" src="https://user-images.githubusercontent.com/5831347/151332037-e6709283-ec9a-445b-9fb6-9446aaa1b39c.png"> <img width="972" alt="2022-01-27_10-34-19" src="https://user-images.githubusercontent.com/5831347/151332043-eaf5fdc5-e0cd-4ed9-b5c2-d70adcb176e2.png">
1 parent a7dbeef commit 0f59ead

File tree

10 files changed

+60
-59
lines changed

10 files changed

+60
-59
lines changed

‎packages/aws-cdk/lib/init-templates/v1/app/javascript/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Welcome to your CDK JavaScript project!
1+
# Welcome to your CDK JavaScript project
22

33
This is a blank project for JavaScript development with CDK.
44

55
The `cdk.json` file tells the CDK Toolkit how to execute your app. The build step is not required when using JavaScript.
66

77
## Useful commands
88

9-
* `npm run test` perform the jest unit tests
10-
* `cdk deploy` deploy this stack to your default AWS account/region
11-
* `cdk diff` compare deployed stack with current state
12-
* `cdk synth` emits the synthesized CloudFormation template
9+
* `npm run test` perform the jest unit tests
10+
* `cdk deploy` deploy this stack to your default AWS account/region
11+
* `cdk diff` compare deployed stack with current state
12+
* `cdk synth` emits the synthesized CloudFormation template

‎packages/aws-cdk/lib/init-templates/v1/app/typescript/README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# Welcome to your CDK TypeScript project!
1+
# Welcome to your CDK TypeScript project
22

33
This is a blank project for TypeScript development with CDK.
44

55
The `cdk.json` file tells the CDK Toolkit how to execute your app.
66

77
## Useful commands
88

9-
* `npm run build` compile typescript to js
10-
* `npm run watch` watch for changes and compile
11-
* `npm run test` perform the jest unit tests
12-
* `cdk deploy` deploy this stack to your default AWS account/region
13-
* `cdk diff` compare deployed stack with current state
14-
* `cdk synth` emits the synthesized CloudFormation template
9+
* `npm run build` compile typescript to js
10+
* `npm run watch` watch for changes and compile
11+
* `npm run test` perform the jest unit tests
12+
* `cdk deploy` deploy this stack to your default AWS account/region
13+
* `cdk diff` compare deployed stack with current state
14+
* `cdk synth` emits the synthesized CloudFormation template

‎packages/aws-cdk/lib/init-templates/v1/lib/typescript/README.template.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Welcome to your CDK TypeScript Construct Library project!
1+
# Welcome to your CDK TypeScript Construct Library project
22

33
You should explore the contents of this project. It demonstrates a CDK Construct Library that includes a construct (`%name.PascalCased%`)
44
which contains an Amazon SQS queue that is subscribed to an Amazon SNS topic.
@@ -7,6 +7,6 @@ The construct defines an interface (`%name.PascalCased%Props`) to configure the
77

88
## Useful commands
99

10-
* `npm run build` compile typescript to js
11-
* `npm run watch` watch for changes and compile
12-
* `npm run test` perform the jest unit tests
10+
* `npm run build` compile typescript to js
11+
* `npm run watch` watch for changes and compile
12+
* `npm run test` perform the jest unit tests

‎packages/aws-cdk/lib/init-templates/v1/sample-app/javascript/README.template.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
1-
# Welcome to your CDK JavaScript project!
1+
# Welcome to your CDK JavaScript project
22

33
You should explore the contents of this project. It demonstrates a CDK app with an instance of a stack (`%name.PascalCased%Stack`)
44
which contains an Amazon SQS queue that is subscribed to an Amazon SNS topic.
55

66
The `cdk.json` file tells the CDK Toolkit how to execute your app. The build step is not required when using JavaScript.
77

8-
## Tutorial
8+
## Tutorial
9+
910
See [this useful workshop](https://cdkworkshop.com/20-typescript.html) on working with the AWS CDK for Typescript projects.
1011

1112
## Useful commands
1213

13-
* `npm run test` perform the jest unit tests
14-
* `cdk deploy` deploy this stack to your default AWS account/region
15-
* `cdk diff` compare deployed stack with current state
16-
* `cdk synth` emits the synthesized CloudFormation template
14+
* `npm run test` perform the jest unit tests
15+
* `cdk deploy` deploy this stack to your default AWS account/region
16+
* `cdk diff` compare deployed stack with current state
17+
* `cdk synth` emits the synthesized CloudFormation template

‎packages/aws-cdk/lib/init-templates/v1/sample-app/typescript/README.template.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
# Welcome to your CDK TypeScript project!
1+
# Welcome to your CDK TypeScript project
22

33
You should explore the contents of this project. It demonstrates a CDK app with an instance of a stack (`%name.PascalCased%Stack`)
44
which contains an Amazon SQS queue that is subscribed to an Amazon SNS topic.
55

66
The `cdk.json` file tells the CDK Toolkit how to execute your app.
77

8-
## Tutorial
9-
See [this useful workshop](https://cdkworkshop.com/20-typescript.html) on working with the AWS CDK for Typescript projects.
8+
## Tutorial
109

10+
See [this useful workshop](https://cdkworkshop.com/20-typescript.html) on working with the AWS CDK for Typescript projects.
1111

1212
## Useful commands
1313

14-
* `npm run build` compile typescript to js
15-
* `npm run watch` watch for changes and compile
16-
* `npm run test` perform the jest unit tests
17-
* `cdk deploy` deploy this stack to your default AWS account/region
18-
* `cdk diff` compare deployed stack with current state
19-
* `cdk synth` emits the synthesized CloudFormation template
14+
* `npm run build` compile typescript to js
15+
* `npm run watch` watch for changes and compile
16+
* `npm run test` perform the jest unit tests
17+
* `cdk deploy` deploy this stack to your default AWS account/region
18+
* `cdk diff` compare deployed stack with current state
19+
* `cdk synth` emits the synthesized CloudFormation template

‎packages/aws-cdk/lib/init-templates/v2/app/javascript/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Welcome to your CDK JavaScript project!
1+
# Welcome to your CDK JavaScript project
22

33
This is a blank project for JavaScript development with CDK.
44

55
The `cdk.json` file tells the CDK Toolkit how to execute your app. The build step is not required when using JavaScript.
66

77
## Useful commands
88

9-
* `npm run test` perform the jest unit tests
10-
* `cdk deploy` deploy this stack to your default AWS account/region
11-
* `cdk diff` compare deployed stack with current state
12-
* `cdk synth` emits the synthesized CloudFormation template
9+
* `npm run test` perform the jest unit tests
10+
* `cdk deploy` deploy this stack to your default AWS account/region
11+
* `cdk diff` compare deployed stack with current state
12+
* `cdk synth` emits the synthesized CloudFormation template

‎packages/aws-cdk/lib/init-templates/v2/app/typescript/README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# Welcome to your CDK TypeScript project!
1+
# Welcome to your CDK TypeScript project
22

33
This is a blank project for TypeScript development with CDK.
44

55
The `cdk.json` file tells the CDK Toolkit how to execute your app.
66

77
## Useful commands
88

9-
* `npm run build` compile typescript to js
10-
* `npm run watch` watch for changes and compile
11-
* `npm run test` perform the jest unit tests
12-
* `cdk deploy` deploy this stack to your default AWS account/region
13-
* `cdk diff` compare deployed stack with current state
14-
* `cdk synth` emits the synthesized CloudFormation template
9+
* `npm run build` compile typescript to js
10+
* `npm run watch` watch for changes and compile
11+
* `npm run test` perform the jest unit tests
12+
* `cdk deploy` deploy this stack to your default AWS account/region
13+
* `cdk diff` compare deployed stack with current state
14+
* `cdk synth` emits the synthesized CloudFormation template

‎packages/aws-cdk/lib/init-templates/v2/lib/typescript/README.template.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Welcome to your CDK TypeScript Construct Library project!
1+
# Welcome to your CDK TypeScript Construct Library project
22

33
You should explore the contents of this project. It demonstrates a CDK Construct Library that includes a construct (`%name.PascalCased%`)
44
which contains an Amazon SQS queue that is subscribed to an Amazon SNS topic.
@@ -7,6 +7,6 @@ The construct defines an interface (`%name.PascalCased%Props`) to configure the
77

88
## Useful commands
99

10-
* `npm run build` compile typescript to js
11-
* `npm run watch` watch for changes and compile
12-
* `npm run test` perform the jest unit tests
10+
* `npm run build` compile typescript to js
11+
* `npm run watch` watch for changes and compile
12+
* `npm run test` perform the jest unit tests

‎packages/aws-cdk/lib/init-templates/v2/sample-app/javascript/README.template.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Welcome to your CDK JavaScript project!
1+
# Welcome to your CDK JavaScript project
22

33
You should explore the contents of this project. It demonstrates a CDK app with an instance of a stack (`%name.PascalCased%Stack`)
44
which contains an Amazon SQS queue that is subscribed to an Amazon SNS topic.
@@ -7,7 +7,7 @@ The `cdk.json` file tells the CDK Toolkit how to execute your app. The build ste
77

88
## Useful commands
99

10-
* `npm run test` perform the jest unit tests
11-
* `cdk deploy` deploy this stack to your default AWS account/region
12-
* `cdk diff` compare deployed stack with current state
13-
* `cdk synth` emits the synthesized CloudFormation template
10+
* `npm run test` perform the jest unit tests
11+
* `cdk deploy` deploy this stack to your default AWS account/region
12+
* `cdk diff` compare deployed stack with current state
13+
* `cdk synth` emits the synthesized CloudFormation template

‎packages/aws-cdk/lib/init-templates/v2/sample-app/typescript/README.template.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Welcome to your CDK TypeScript project!
1+
# Welcome to your CDK TypeScript project
22

33
You should explore the contents of this project. It demonstrates a CDK app with an instance of a stack (`%name.PascalCased%Stack`)
44
which contains an Amazon SQS queue that is subscribed to an Amazon SNS topic.
@@ -7,9 +7,9 @@ The `cdk.json` file tells the CDK Toolkit how to execute your app.
77

88
## Useful commands
99

10-
* `npm run build` compile typescript to js
11-
* `npm run watch` watch for changes and compile
12-
* `npm run test` perform the jest unit tests
13-
* `cdk deploy` deploy this stack to your default AWS account/region
14-
* `cdk diff` compare deployed stack with current state
15-
* `cdk synth` emits the synthesized CloudFormation template
10+
* `npm run build` compile typescript to js
11+
* `npm run watch` watch for changes and compile
12+
* `npm run test` perform the jest unit tests
13+
* `cdk deploy` deploy this stack to your default AWS account/region
14+
* `cdk diff` compare deployed stack with current state
15+
* `cdk synth` emits the synthesized CloudFormation template

0 commit comments

Comments
 (0)