diff --git a/.all-contributorsrc b/.all-contributorsrc
index bdd6f75d8c9..55cf18e201b 100644
--- a/.all-contributorsrc
+++ b/.all-contributorsrc
@@ -16,6 +16,13 @@
"profile": "https://github.com/JamesHenry",
"contributions": []
},
+ {
+ "login": "bradzacher",
+ "name": "Brad Zacher",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/7462525?v=4",
+ "profile": "https://github.com/bradzacher",
+ "contributions": []
+ },
{
"login": "armano2",
"name": "Armano",
@@ -24,10 +31,10 @@
"contributions": []
},
{
- "login": "bradzacher",
- "name": "Brad Zacher",
- "avatar_url": "https://avatars1.githubusercontent.com/u/7462525?v=4",
- "profile": "https://github.com/bradzacher",
+ "login": "a-tarasyuk",
+ "name": "Alexander T.",
+ "avatar_url": "https://avatars0.githubusercontent.com/u/509265?v=4",
+ "profile": "https://github.com/a-tarasyuk",
"contributions": []
},
{
@@ -44,6 +51,13 @@
"profile": "https://github.com/weirdpattern",
"contributions": []
},
+ {
+ "login": "G-Rath",
+ "name": "Gareth Jones",
+ "avatar_url": "https://avatars2.githubusercontent.com/u/3151613?v=4",
+ "profile": "https://github.com/G-Rath",
+ "contributions": []
+ },
{
"login": "nzakas",
"name": "Nicholas C. Zakas",
@@ -58,13 +72,6 @@
"profile": "https://github.com/j-f1",
"contributions": []
},
- {
- "login": "a-tarasyuk",
- "name": "Alexander T.",
- "avatar_url": "https://avatars0.githubusercontent.com/u/509265?v=4",
- "profile": "https://github.com/a-tarasyuk",
- "contributions": []
- },
{
"login": "uniqueiniquity",
"name": "Ben Lichtman",
@@ -72,6 +79,13 @@
"profile": "https://github.com/uniqueiniquity",
"contributions": []
},
+ {
+ "login": "JoshuaKGoldberg",
+ "name": "Josh Goldberg",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/3335181?v=4",
+ "profile": "https://github.com/JoshuaKGoldberg",
+ "contributions": []
+ },
{
"login": "scottohara",
"name": "Scott O'Hara",
@@ -80,10 +94,10 @@
"contributions": []
},
{
- "login": "JoshuaKGoldberg",
- "name": "Josh Goldberg",
- "avatar_url": "https://avatars1.githubusercontent.com/u/3335181?v=4",
- "profile": "https://github.com/JoshuaKGoldberg",
+ "login": "Retsam",
+ "name": "Retsam",
+ "avatar_url": "https://avatars0.githubusercontent.com/u/2281166?v=4",
+ "profile": "https://github.com/Retsam",
"contributions": []
},
{
@@ -114,6 +128,13 @@
"profile": "https://github.com/azz",
"contributions": []
},
+ {
+ "login": "yeonjuan",
+ "name": "YeonJuan",
+ "avatar_url": "https://avatars3.githubusercontent.com/u/41323220?v=4",
+ "profile": "https://github.com/yeonjuan",
+ "contributions": []
+ },
{
"login": "dannyfritz",
"name": "Danny Fritz",
@@ -135,6 +156,13 @@
"profile": "https://github.com/macklinu",
"contributions": []
},
+ {
+ "login": "phaux",
+ "name": "Nikita Stefaniak",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/1270987?v=4",
+ "profile": "https://github.com/phaux",
+ "contributions": []
+ },
{
"login": "lukyth",
"name": "Kanitkorn Sujautra",
@@ -142,6 +170,13 @@
"profile": "https://github.com/lukyth",
"contributions": []
},
+ {
+ "login": "anikethsaha",
+ "name": "Anix",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/26347874?v=4",
+ "profile": "https://github.com/anikethsaha",
+ "contributions": []
+ },
{
"login": "ldrick",
"name": "Ricky Lippmann",
@@ -156,6 +191,13 @@
"profile": "https://github.com/SimenB",
"contributions": []
},
+ {
+ "login": "vapurrmaid",
+ "name": "G r e y",
+ "avatar_url": "https://avatars0.githubusercontent.com/u/11184711?v=4",
+ "profile": "https://github.com/vapurrmaid",
+ "contributions": []
+ },
{
"login": "gavinbarron",
"name": "Gavin Barron",
@@ -177,6 +219,20 @@
"profile": "https://github.com/duailibe",
"contributions": []
},
+ {
+ "login": "Validark",
+ "name": "Niles",
+ "avatar_url": "https://avatars2.githubusercontent.com/u/15217173?v=4",
+ "profile": "https://github.com/Validark",
+ "contributions": []
+ },
+ {
+ "login": "pablobirukov",
+ "name": "Pavel Birukov ",
+ "avatar_url": "https://avatars2.githubusercontent.com/u/1861546?v=4",
+ "profile": "https://github.com/pablobirukov",
+ "contributions": []
+ },
{
"login": "octogonz",
"name": "Pete Gonzalez",
@@ -184,13 +240,6 @@
"profile": "https://github.com/octogonz",
"contributions": []
},
- {
- "login": "Retsam",
- "name": "Retsam",
- "avatar_url": "https://avatars0.githubusercontent.com/u/2281166?v=4",
- "profile": "https://github.com/Retsam",
- "contributions": []
- },
{
"login": "mightyiam",
"name": "Shahar Dawn Or",
@@ -198,6 +247,20 @@
"profile": "https://github.com/mightyiam",
"contributions": []
},
+ {
+ "login": "sosukesuzuki",
+ "name": "Sosuke Suzuki",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/14838850?v=4",
+ "profile": "https://github.com/sosukesuzuki",
+ "contributions": []
+ },
+ {
+ "login": "ulrichb",
+ "name": "ulrichb",
+ "avatar_url": "https://avatars3.githubusercontent.com/u/388796?v=4",
+ "profile": "https://github.com/ulrichb",
+ "contributions": []
+ },
{
"login": "webschik",
"name": "Denys Kniazevych",
@@ -206,17 +269,24 @@
"contributions": []
},
{
- "login": "Validark",
- "name": "Niles",
- "avatar_url": "https://avatars2.githubusercontent.com/u/15217173?v=4",
- "profile": "https://github.com/Validark",
+ "login": "dimitropoulos",
+ "name": "Dimitri Mitropoulos",
+ "avatar_url": "https://avatars2.githubusercontent.com/u/15232461?v=4",
+ "profile": "https://github.com/dimitropoulos",
"contributions": []
},
{
- "login": "pablobirukov",
- "name": "Pavel Birukov ",
- "avatar_url": "https://avatars2.githubusercontent.com/u/1861546?v=4",
- "profile": "https://github.com/pablobirukov",
+ "login": "nevir",
+ "name": "Ian MacLeod",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/41373?v=4",
+ "profile": "https://github.com/nevir",
+ "contributions": []
+ },
+ {
+ "login": "jonathanrdelgado",
+ "name": "Jonathan Delgado",
+ "avatar_url": "https://avatars2.githubusercontent.com/u/1841149?v=4",
+ "profile": "https://github.com/jonathanrdelgado",
"contributions": []
},
{
@@ -233,6 +303,13 @@
"profile": "https://github.com/g-plane",
"contributions": []
},
+ {
+ "login": "susisu",
+ "name": "Susisu",
+ "avatar_url": "https://avatars0.githubusercontent.com/u/2443491?v=4",
+ "profile": "https://github.com/susisu",
+ "contributions": []
+ },
{
"login": "ThomasdenH",
"name": "Thomas den Hollander",
@@ -240,12 +317,26 @@
"profile": "https://github.com/ThomasdenH",
"contributions": []
},
+ {
+ "login": "timkraut",
+ "name": "Tim Kraut",
+ "avatar_url": "https://avatars2.githubusercontent.com/u/509669?v=4",
+ "profile": "https://github.com/timkraut",
+ "contributions": []
+ },
{
"login": "madbence",
"name": "Bence Dányi",
"avatar_url": "https://avatars2.githubusercontent.com/u/296735?v=4",
"profile": "https://github.com/madbence",
"contributions": []
+ },
+ {
+ "login": "dependabot[bot]",
+ "name": "dependabot[bot]",
+ "avatar_url": "https://avatars0.githubusercontent.com/in/29110?v=4",
+ "profile": "https://github.com/apps/dependabot",
+ "contributions": []
}
],
"contributorsPerLine": 5
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
index 04023618bf8..23094e08349 100644
--- a/CONTRIBUTORS.md
+++ b/CONTRIBUTORS.md
@@ -7,52 +7,70 @@ Thanks goes to these wonderful people ([emoji key](https://github.com/all-contri
diff --git a/README.md b/README.md
index 89922b3a685..d327f2d355b 100644
--- a/README.md
+++ b/README.md
@@ -3,12 +3,10 @@
Monorepo for all the tooling which enables ESLint to support TypeScript
- 
+ 
- 
- 
diff --git a/docs/getting-started/linting/README.md b/docs/getting-started/linting/README.md
index f62888df0b7..6abe587e3a3 100644
--- a/docs/getting-started/linting/README.md
+++ b/docs/getting-started/linting/README.md
@@ -7,13 +7,8 @@ Whether you're adding linting to a new TypeScript codebase, adding TypeScript to
First step is to make sure you've got the required packages installed:
```bash
-$ yarn add -D eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin
-```
-
-or with NPM:
-
-```bash
-$ npm i --save-dev eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin
+$ yarn add -D eslint typescript @typescript-eslint/parser @typescript-eslint/eslint-plugin
+$ npm i --save-dev eslint typescript @typescript-eslint/parser @typescript-eslint/eslint-plugin
```
## Configuration
diff --git a/packages/eslint-plugin-internal/README.md b/packages/eslint-plugin-internal/README.md
index bf6ed0bbe38..adf36999928 100644
--- a/packages/eslint-plugin-internal/README.md
+++ b/packages/eslint-plugin-internal/README.md
@@ -1,5 +1,9 @@
-# `eslint-plugin-internal`
+Internal ESLint Plugin
-This is just a collection of internal lint rules to help enforce some guidelines specific to this repository.
+An ESLint plugin used internally in this project to ensure consistency.
-These are not intended to be used externally.
+
+
+
+
+This plugin is not intended to be used externally.
diff --git a/packages/eslint-plugin-tslint/README.md b/packages/eslint-plugin-tslint/README.md
index f8a7f4f3e58..021b8780bfb 100644
--- a/packages/eslint-plugin-tslint/README.md
+++ b/packages/eslint-plugin-tslint/README.md
@@ -3,11 +3,9 @@
ESLint plugin wraps a TSLint configuration and lints the whole source using TSLint.
- 
-
+
-
## Installation
diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md
index cc2bbc07899..5f9822ed12f 100644
--- a/packages/eslint-plugin/README.md
+++ b/packages/eslint-plugin/README.md
@@ -1,11 +1,11 @@
ESLint Plugin TypeScript
+An ESLint plugin which provides lint rules for TypeScript codebases.
+
-
-
+
-
## Getting Started
@@ -19,10 +19,18 @@ These docs walk you through setting up ESLint, this plugin, and our parser. If y
### Installation
-Make sure you have TypeScript and [`@typescript-eslint/parser`](../parser) installed, then install the plugin:
+Make sure you have TypeScript and [`@typescript-eslint/parser`](../parser) installed:
+
+```bash
+$ yarn add -D typescript @typescript-eslint/parser
+$ npm i --save-dev typescript @typescript-eslint/parser
+```
+
+Then install the plugin:
-```sh
-yarn add -D @typescript-eslint/eslint-plugin
+```bash
+$ yarn add -D @typescript-eslint/eslint-plugin
+$ npm i --save-dev @typescript-eslint/eslint-plugin
```
It is important that you use the same version number for `@typescript-eslint/parser` and `@typescript-eslint/eslint-plugin`.
diff --git a/packages/experimental-utils/README.md b/packages/experimental-utils/README.md
index cba85c84d6e..05f65ecb7da 100644
--- a/packages/experimental-utils/README.md
+++ b/packages/experimental-utils/README.md
@@ -1,6 +1,12 @@
-# `@typescript-eslint/experimental-utils`
+Utils for ESLint Plugins
-(Experimental) Utilities for working with TypeScript + ESLint together.
+Utilities for working with TypeScript + ESLint together.
+
+
+
+
+
+
## Note
@@ -10,7 +16,7 @@ i.e. treat it as a `0.x.y` package.
Feel free to use it now, and let us know what utilities you need or send us PRs with utilities you build on top of it.
-Once it is stable, it will be renamed to `@typescript-eslint/util` for a `3.0.0` release.
+Once it is stable, it will be renamed to `@typescript-eslint/util` for a `4.0.0` release.
## Exports
diff --git a/packages/parser/README.md b/packages/parser/README.md
index 594f89dd6c2..02bb09e561a 100644
--- a/packages/parser/README.md
+++ b/packages/parser/README.md
@@ -1,13 +1,11 @@
TypeScript ESLint Parser
-An ESLint custom parser which leverages TypeScript ESTree to allow for ESLint to lint TypeScript source code.
+An ESLint parser which leverages TypeScript ESTree to allow for ESLint to lint TypeScript source code.
-
-
+
-
## Getting Started
@@ -20,8 +18,9 @@ These docs walk you through setting up ESLint, this parser, and our plugin. If y
### Installation
-```sh
-yarn add -D @typescript-eslint/parser
+```bash
+$ yarn add -D typescript @typescript-eslint/parser
+$ npm i --save-dev typescript @typescript-eslint/parser
```
### Usage
diff --git a/packages/shared-fixtures/README.md b/packages/shared-fixtures/README.md
new file mode 100644
index 00000000000..866a6e86614
--- /dev/null
+++ b/packages/shared-fixtures/README.md
@@ -0,0 +1,7 @@
+Fixtures for Testing typescript-eslint
+
+Code fixtures used to test the parser. This is not intended for external use.
+
+
+
+
diff --git a/packages/typescript-estree/README.md b/packages/typescript-estree/README.md
index 5ab7fe44a7b..eafb1463d53 100644
--- a/packages/typescript-estree/README.md
+++ b/packages/typescript-estree/README.md
@@ -3,14 +3,14 @@
A parser that converts TypeScript source code into an ESTree-compatible form
-
-
+
-
-
+## Getting Started
+
+**[You can find our Getting Started docs here](../../docs/getting-started/linting/README.md)**
## About
diff --git a/tools/generate-contributors.ts b/tools/generate-contributors.ts
index 4c3c2b0a36d..38c3690cb0a 100644
--- a/tools/generate-contributors.ts
+++ b/tools/generate-contributors.ts
@@ -7,6 +7,7 @@ import 'isomorphic-fetch';
import * as path from 'path';
const IGNORED_USERS = new Set([
+ 'dependabot[bot]',
'eslint[bot]',
'greenkeeper[bot]',
'semantic-release-bot',
