chore: standardize eslint setup (aws#7232)

Major changes - switched global eslint configuration in `cdk-build-tools` to a javascript config, `eslintrc.yml` → `eslintrc.js`. - each package now has a `.eslintrc` file that simply re-exports the global config. This file exists for any package specific customization. - `eslint` section in `package.json` has been removed, and moved into the package local `.eslintrc` file. - lint only `.ts` files - no longer lints `.js` files, generated or otherwise. - `yarn lint` now works! ✅ - new pkglint rule that ensures that `.eslintrc.js` exists, that the file is ignored in `.npmignore` and excluded in `.gitignore`. Motivation At a high level, reduce cdk-specific magic around eslint as much as possible. Specifically, bring all packages in line with standard eslint setup, that can be invoked by running the standard `eslint` CLI. Further benefit from any tooling or IDE experience that relies on a standard, conventional setup for a typescript package with eslint. Additionally, remove all eslint specific configuration and complexity out of `cdk-build-tools`. Any configuration special to a package is now added to the `.eslintrc.js` local to that package.
tusharkalecam · Apr 17, 2020 · 4e9c425 · 4e9c425
1 parent fda05c3
commit 4e9c425
Show file tree

Hide file tree

Showing 490 changed files with 1,023 additions and 425 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -18,8 +18,7 @@ and let us know if it's not up-to-date (even better, submit a PR with your  corr
   - [Main build scripts](#main-build-scripts)
   - [Partial build tools](#partial-build-tools)
   - [Useful aliases](#useful-aliases)
-  - [pkglint](#pkglint)
-  - [awslint](#awslint)
+  - [Linters](#linters)
   - [cfn2ts](#cfn2ts)
   - [scripts/foreach.sh](#scriptsforeachsh)
   - [Jetbrains support (WebStorm/IntelliJ)](#jetbrains-support-webstormintellij)
@@ -262,7 +261,47 @@ alias lt='lr test'
 alias lw='lr watch'
 ```
 
-### pkglint
+### Linters
+
+All linters are executed automatically as part of the build script, `yarn build`.
+
+They can also be executed independently of the build script. From the root of a specific package (e.g.
+`packages/@aws-cdk/aws-ec2`), run the following command to execute all the linters on that package -
+
+```bash
+yarn lint
+```
+
+The following linters are used -
+
+- [eslint](#eslint)
+- [pkglint](#pkglint)
+- [awslint](#awslint)
+
+#### eslint
+
+Historically, the CDK has used tslint for linting its typescript source code. With [tslint's deprecation in
+2019](https://medium.com/palantir/tslint-in-2019-1a144c2317a9), we are slowly moving over to using eslint.
+
+All packages in the repo use a standard base configuration found at [eslintrc.js](tools/cdk-build-tools/config/eslintrc.js).
+This can be customized for any package by modifying the `.eslintrc` file found at its root.
+
+If you're using the VS Code and would like to see eslint violations on it, install the [eslint
+extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint).
+
+The following additional [VS Code setting](https://code.visualstudio.com/docs/getstarted/settings) is required when the
+entire project is opened (not required if only a specific module is opened) -
+
+```json
+"eslint.workingDirectories": [
+  { "pattern": "./packages/@aws-cdk/*" },
+  { "pattern": "./packages/@monocdk-experiment/*" },
+  { "pattern": "./packages/*" },
+  { "pattern": "./tools/*" },
+],
+```
+
+#### pkglint
 
 The `pkglint` tool "lints" package.json files across the repo according to [rules.ts](tools/pkglint/lib/rules.ts).
 
@@ -279,7 +318,7 @@ You can also do that per package:
 $ lr pkglint
 ```
 
-### awslint
+#### awslint
 
 **awslint** is a linter for the AWS Construct Library APIs. It is executed as a
 part of the build of all AWS modules in the project and enforces the [AWS

diff --git a/packages/@aws-cdk/alexa-ask/.eslintrc.js b/packages/@aws-cdk/alexa-ask/.eslintrc.js
@@ -0,0 +1,2 @@
+const baseConfig = require('../../../tools/cdk-build-tools/config/eslintrc');
+module.exports = baseConfig;
diff --git a/packages/@aws-cdk/alexa-ask/.gitignore b/packages/@aws-cdk/alexa-ask/.gitignore
@@ -11,4 +11,4 @@ nyc.config.js
 coverage
 dist
 tsconfig.json
-tslint.json
+!.eslintrc.js
diff --git a/packages/@aws-cdk/alexa-ask/.npmignore b/packages/@aws-cdk/alexa-ask/.npmignore
@@ -20,4 +20,5 @@ dist
 
 *.tsbuildinfo
 
-tsconfig.json
+tsconfig.json
+.eslintrc.js
diff --git a/packages/@aws-cdk/app-delivery/.eslintrc.js b/packages/@aws-cdk/app-delivery/.eslintrc.js
@@ -0,0 +1,2 @@
+const baseConfig = require('../../../tools/cdk-build-tools/config/eslintrc');
+module.exports = baseConfig;
diff --git a/packages/@aws-cdk/app-delivery/.gitignore b/packages/@aws-cdk/app-delivery/.gitignore
@@ -9,3 +9,4 @@ tsconfig.json
 *.d.ts
 *.snk
 coverage
+!.eslintrc.js
diff --git a/packages/@aws-cdk/app-delivery/.npmignore b/packages/@aws-cdk/app-delivery/.npmignore
@@ -15,4 +15,5 @@ coverage
 
 *.tsbuildinfo
 
-tsconfig.json
+tsconfig.json
+.eslintrc.js
diff --git a/packages/@aws-cdk/app-delivery/package.json b/packages/@aws-cdk/app-delivery/package.json
@@ -94,6 +94,9 @@
   },
   "stability": "experimental",
   "maturity": "experimental",
+  "nyc": {
+    "statements": 75
+  },
   "awslint": {
     "exclude": [
       "docs-public-apis:@aws-cdk/app-delivery.PipelineDeployStackAction.actionProperties",

diff --git a/packages/@aws-cdk/assert/.eslintrc.js b/packages/@aws-cdk/assert/.eslintrc.js
@@ -0,0 +1,2 @@
+const baseConfig = require('../../../tools/cdk-build-tools/config/eslintrc');
+module.exports = baseConfig;
diff --git a/packages/@aws-cdk/assert/.gitignore b/packages/@aws-cdk/assert/.gitignore
@@ -10,3 +10,4 @@ coverage
 nyc.config.js
 .LAST_PACKAGE
 *.snk
+!.eslintrc.js
diff --git a/packages/@aws-cdk/assert/.npmignore b/packages/@aws-cdk/assert/.npmignore
@@ -12,4 +12,5 @@ dist
 
 *.tsbuildinfo
 
-tsconfig.json
+tsconfig.json
+.eslintrc.js
diff --git a/packages/@aws-cdk/assets/.eslintrc.js b/packages/@aws-cdk/assets/.eslintrc.js
@@ -0,0 +1,2 @@
+const baseConfig = require('../../../tools/cdk-build-tools/config/eslintrc');
+module.exports = baseConfig;
diff --git a/packages/@aws-cdk/assets/.gitignore b/packages/@aws-cdk/assets/.gitignore
@@ -4,7 +4,6 @@
 node_modules
 dist
 tsconfig.json
-tslint.json
 
 .LAST_BUILD
 .nyc_output
@@ -15,3 +14,4 @@ coverage
 nyc.config.js
 .LAST_PACKAGE
 *.snk
+!.eslintrc.js
diff --git a/packages/@aws-cdk/assets/.npmignore b/packages/@aws-cdk/assets/.npmignore
@@ -17,4 +17,5 @@ dist
 
 *.tsbuildinfo
 
-tsconfig.json
+tsconfig.json
+.eslintrc.js
diff --git a/packages/@aws-cdk/aws-accessanalyzer/.eslintrc.js b/packages/@aws-cdk/aws-accessanalyzer/.eslintrc.js
@@ -0,0 +1,2 @@
+const baseConfig = require('../../../tools/cdk-build-tools/config/eslintrc');
+module.exports = baseConfig;
diff --git a/packages/@aws-cdk/aws-accessanalyzer/.gitignore b/packages/@aws-cdk/aws-accessanalyzer/.gitignore
@@ -11,4 +11,4 @@ nyc.config.js
 coverage
 dist
 tsconfig.json
-tslint.json
+!.eslintrc.js
diff --git a/packages/@aws-cdk/aws-accessanalyzer/.npmignore b/packages/@aws-cdk/aws-accessanalyzer/.npmignore
@@ -17,4 +17,5 @@ dist
 
 *.tsbuildinfo
 tsconfig.json
-!.jsii
+!.jsii
+.eslintrc.js
diff --git a/packages/@aws-cdk/aws-acmpca/.eslintrc.js b/packages/@aws-cdk/aws-acmpca/.eslintrc.js
@@ -0,0 +1,2 @@
+const baseConfig = require('../../../tools/cdk-build-tools/config/eslintrc');
+module.exports = baseConfig;
diff --git a/packages/@aws-cdk/aws-acmpca/.gitignore b/packages/@aws-cdk/aws-acmpca/.gitignore
@@ -2,7 +2,6 @@
 *.js.map
 *.d.ts
 tsconfig.json
-tslint.json
 node_modules
 *.generated.ts
 dist
@@ -15,3 +14,4 @@ coverage
 .nycrc
 .LAST_PACKAGE
 *.snk
+!.eslintrc.js
diff --git a/packages/@aws-cdk/aws-acmpca/.npmignore b/packages/@aws-cdk/aws-acmpca/.npmignore
@@ -18,3 +18,5 @@ dist
 *.tsbuildinfo
 
 tsconfig.json
+
+.eslintrc.js
diff --git a/packages/@aws-cdk/aws-amazonmq/.eslintrc.js b/packages/@aws-cdk/aws-amazonmq/.eslintrc.js
@@ -0,0 +1,2 @@
+const baseConfig = require('../../../tools/cdk-build-tools/config/eslintrc');
+module.exports = baseConfig;
diff --git a/packages/@aws-cdk/aws-amazonmq/.gitignore b/packages/@aws-cdk/aws-amazonmq/.gitignore
@@ -10,6 +10,6 @@ nyc.config.js
 coverage
 dist
 tsconfig.json
-tslint.json
 
 *.snk
+!.eslintrc.js
diff --git a/packages/@aws-cdk/aws-amazonmq/.npmignore b/packages/@aws-cdk/aws-amazonmq/.npmignore
@@ -21,4 +21,5 @@ dist
 
 *.tsbuildinfo
 
-tsconfig.json
+tsconfig.json
+.eslintrc.js
diff --git a/packages/@aws-cdk/aws-amplify/.eslintrc.js b/packages/@aws-cdk/aws-amplify/.eslintrc.js
@@ -0,0 +1,2 @@
+const baseConfig = require('../../../tools/cdk-build-tools/config/eslintrc');
+module.exports = baseConfig;
diff --git a/packages/@aws-cdk/aws-amplify/.gitignore b/packages/@aws-cdk/aws-amplify/.gitignore
@@ -11,4 +11,4 @@ nyc.config.js
 coverage
 dist
 tsconfig.json
-tslint.json
+!.eslintrc.js
diff --git a/packages/@aws-cdk/aws-amplify/.npmignore b/packages/@aws-cdk/aws-amplify/.npmignore
@@ -21,4 +21,5 @@ dist
 # Include .jsii
 !.jsii
 
-tsconfig.json
+tsconfig.json
+.eslintrc.js
diff --git a/packages/@aws-cdk/aws-apigateway/.eslintrc.js b/packages/@aws-cdk/aws-apigateway/.eslintrc.js
@@ -0,0 +1,2 @@
+const baseConfig = require('../../../tools/cdk-build-tools/config/eslintrc');
+module.exports = baseConfig;
diff --git a/packages/@aws-cdk/aws-apigateway/.gitignore b/packages/@aws-cdk/aws-apigateway/.gitignore
@@ -2,7 +2,6 @@
 *.js.map
 *.d.ts
 tsconfig.json
-tslint.json
 node_modules
 *.generated.ts
 dist
@@ -14,3 +13,4 @@ coverage
 nyc.config.js
 .LAST_PACKAGE
 *.snk
+!.eslintrc.js
diff --git a/packages/@aws-cdk/aws-apigateway/.npmignore b/packages/@aws-cdk/aws-apigateway/.npmignore
@@ -17,4 +17,5 @@ dist
 
 *.tsbuildinfo
 
-tsconfig.json
+tsconfig.json
+.eslintrc.js
diff --git a/packages/@aws-cdk/aws-apigatewayv2/.eslintrc.js b/packages/@aws-cdk/aws-apigatewayv2/.eslintrc.js
@@ -0,0 +1,2 @@
+const baseConfig = require('../../../tools/cdk-build-tools/config/eslintrc');
+module.exports = baseConfig;
diff --git a/packages/@aws-cdk/aws-apigatewayv2/.gitignore b/packages/@aws-cdk/aws-apigatewayv2/.gitignore
@@ -11,4 +11,4 @@ nyc.config.js
 coverage
 dist
 tsconfig.json
-tslint.json
+!.eslintrc.js
diff --git a/packages/@aws-cdk/aws-apigatewayv2/.npmignore b/packages/@aws-cdk/aws-apigatewayv2/.npmignore
@@ -17,4 +17,5 @@ dist
 
 *.tsbuildinfo
 tsconfig.json
-!.jsii
+!.jsii
+.eslintrc.js
diff --git a/packages/@aws-cdk/aws-appconfig/.eslintrc.js b/packages/@aws-cdk/aws-appconfig/.eslintrc.js
@@ -0,0 +1,2 @@
+const baseConfig = require('../../../tools/cdk-build-tools/config/eslintrc');
+module.exports = baseConfig;
diff --git a/packages/@aws-cdk/aws-appconfig/.gitignore b/packages/@aws-cdk/aws-appconfig/.gitignore
@@ -2,7 +2,6 @@
 *.js.map
 *.d.ts
 tsconfig.json
-tslint.json
 node_modules
 *.generated.ts
 dist
@@ -15,4 +14,5 @@ coverage
 .LAST_PACKAGE
 *.snk
 
-nyc.config.js
+nyc.config.js
+!.eslintrc.js
diff --git a/packages/@aws-cdk/aws-appconfig/.npmignore b/packages/@aws-cdk/aws-appconfig/.npmignore
@@ -18,3 +18,5 @@ dist
 *.tsbuildinfo
 
 tsconfig.json
+
+.eslintrc.js
diff --git a/packages/@aws-cdk/aws-applicationautoscaling/.eslintrc.js b/packages/@aws-cdk/aws-applicationautoscaling/.eslintrc.js
@@ -0,0 +1,2 @@
+const baseConfig = require('../../../tools/cdk-build-tools/config/eslintrc');
+module.exports = baseConfig;
diff --git a/packages/@aws-cdk/aws-applicationautoscaling/.gitignore b/packages/@aws-cdk/aws-applicationautoscaling/.gitignore
@@ -2,7 +2,6 @@
 *.js.map
 *.d.ts
 tsconfig.json
-tslint.json
 node_modules
 *.generated.ts
 dist
@@ -14,3 +13,4 @@ coverage
 nyc.config.js
 .LAST_PACKAGE
 *.snk
+!.eslintrc.js
diff --git a/packages/@aws-cdk/aws-applicationautoscaling/.npmignore b/packages/@aws-cdk/aws-applicationautoscaling/.npmignore
@@ -17,4 +17,5 @@ dist
 
 *.tsbuildinfo
 
-tsconfig.json
+tsconfig.json
+.eslintrc.js
diff --git a/packages/@aws-cdk/aws-appmesh/.eslintrc.js b/packages/@aws-cdk/aws-appmesh/.eslintrc.js
@@ -0,0 +1,2 @@
+const baseConfig = require('../../../tools/cdk-build-tools/config/eslintrc');
+module.exports = baseConfig;
diff --git a/packages/@aws-cdk/aws-appmesh/.gitignore b/packages/@aws-cdk/aws-appmesh/.gitignore
@@ -11,4 +11,4 @@ nyc.config.js
 coverage
 dist
 tsconfig.json
-tslint.json
+!.eslintrc.js
diff --git a/packages/@aws-cdk/aws-appmesh/.npmignore b/packages/@aws-cdk/aws-appmesh/.npmignore
@@ -20,4 +20,5 @@ dist
 
 *.tsbuildinfo
 
-tsconfig.json
+tsconfig.json
+.eslintrc.js
diff --git a/packages/@aws-cdk/aws-appmesh/package.json b/packages/@aws-cdk/aws-appmesh/package.json
@@ -50,6 +50,9 @@
   "cdk-build": {
     "cloudformation": "AWS::AppMesh"
   },
+  "nyc": {
+    "statements": 75
+  },
   "keywords": [
     "aws",
     "cdk",

diff --git a/packages/@aws-cdk/aws-appstream/.eslintrc.js b/packages/@aws-cdk/aws-appstream/.eslintrc.js
@@ -0,0 +1,2 @@
+const baseConfig = require('../../../tools/cdk-build-tools/config/eslintrc');
+module.exports = baseConfig;
diff --git a/packages/@aws-cdk/aws-appstream/.gitignore b/packages/@aws-cdk/aws-appstream/.gitignore
@@ -11,4 +11,4 @@ nyc.config.js
 coverage
 dist
 tsconfig.json
-tslint.json
+!.eslintrc.js
diff --git a/packages/@aws-cdk/aws-appstream/.npmignore b/packages/@aws-cdk/aws-appstream/.npmignore
@@ -20,4 +20,5 @@ dist
 
 *.tsbuildinfo
 
-tsconfig.json
+tsconfig.json
+.eslintrc.js
diff --git a/packages/@aws-cdk/aws-appsync/.eslintrc.js b/packages/@aws-cdk/aws-appsync/.eslintrc.js
@@ -0,0 +1,2 @@
+const baseConfig = require('../../../tools/cdk-build-tools/config/eslintrc');
+module.exports = baseConfig;
diff --git a/packages/@aws-cdk/aws-appsync/.gitignore b/packages/@aws-cdk/aws-appsync/.gitignore
@@ -2,7 +2,6 @@
 *.js.map
 *.d.ts
 tsconfig.json
-tslint.json
 node_modules
 *.generated.ts
 dist
@@ -14,3 +13,4 @@ coverage
 nyc.config.js
 .LAST_PACKAGE
 *.snk
+!.eslintrc.js
diff --git a/packages/@aws-cdk/aws-appsync/.npmignore b/packages/@aws-cdk/aws-appsync/.npmignore
@@ -17,4 +17,5 @@ dist
 
 *.tsbuildinfo
 
-tsconfig.json
+tsconfig.json
+.eslintrc.js
diff --git a/packages/@aws-cdk/aws-athena/.eslintrc.js b/packages/@aws-cdk/aws-athena/.eslintrc.js
@@ -0,0 +1,2 @@
+const baseConfig = require('../../../tools/cdk-build-tools/config/eslintrc');
+module.exports = baseConfig;
diff --git a/packages/@aws-cdk/aws-athena/.gitignore b/packages/@aws-cdk/aws-athena/.gitignore
@@ -2,7 +2,6 @@
 *.js.map
 *.d.ts
 tsconfig.json
-tslint.json
 node_modules
 *.generated.ts
 dist
@@ -14,3 +13,4 @@ coverage
 nyc.config.js
 .LAST_PACKAGE
 *.snk
+!.eslintrc.js
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		const baseConfig = require('../../../tools/cdk-build-tools/config/eslintrc');
		module.exports = baseConfig;
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,3 +9,4 @@ tsconfig.json @@
     *.d.ts
     *.snk
     coverage
+    !.eslintrc.js
Original file line number	Diff line number	Diff line change
Expand Up		@@ -18,3 +18,5 @@ dist
		*.tsbuildinfo

		tsconfig.json

		.eslintrc.js