Skip to content

Commit 9f45783

Browse files
author
Elad Ben-Israel
authored
chore: awslint (aws#1468)
Introducing awslint: a linter for the AWS Construct Library APIs. The goal of the linter is to enforce the API design guidelines across the AWS Construct Library. This commit includes a set of initial rules for the guidelines defined under design/aws-guidelines.md. - The `awslint` npm script has been added to all modules through pkglint. - All violations have been captured through "exclude"s in `package.json` files so we can continue to lint from here.
1 parent 0f8362d commit 9f45783

File tree

116 files changed

+2999
-96
lines changed

Some content is hidden

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

116 files changed

+2999
-96
lines changed

CONTRIBUTING.md

+22
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,28 @@ You can also do that per package:
134134
$ lr pkglint
135135
```
136136

137+
### awslint
138+
139+
**awslint** is a linter for the AWS Construct Library APIs. It is executed as a
140+
part of the build of all AWS modules in the project and enforces the [AWS
141+
Construct Library Design Guidelines](./design/aws-guidelines.md).
142+
143+
For more information about this tool, see the [awslint
144+
README](./tools/awslint/README.md).
145+
146+
Generally speaking, if you make any changes which violate an awslint rule, build
147+
will fail with appropriate messages. All rules are documented and explained in
148+
the [guidelines](./design/aws-guidelines.md).
149+
150+
Here are a few useful commands:
151+
152+
* `npm run awslint` in every module will run __awslint__ for that module.
153+
* `npm run awslint list` prints all rules (details and rationale in the guidelines doc)
154+
* `lerna run awslint` will run __awslint__ in all modules.
155+
* `lerna run awslint -- -i <RULE>` will run awslint throughout the repo and
156+
evaluate only the rule specified [awslint README](./tools/awslint/README.md)
157+
for details on include/exclude rule patterns.
158+
137159
## Development Workflows
138160

139161
### Full clean build

0 commit comments

Comments
 (0)