Skip to content

Commit 0635183

Browse files
bradzacherJamesHenry
authored andcommitted
docs(*): switch from author file comments to all-contributors (typescript-eslint#228)
1 parent 4526f27 commit 0635183

Some content is hidden

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

68 files changed

+355
-430
lines changed

.all-contributorsrc

Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,161 @@
1+
{
2+
"projectName": "typescript-eslint",
3+
"projectOwner": "typescript-eslint",
4+
"repoType": "github",
5+
"repoHost": "https://github.com",
6+
"files": [
7+
"CONTRIBUTORS.md"
8+
],
9+
"imageSize": 100,
10+
"commit": false,
11+
"contributors": [
12+
{
13+
"login": "JamesHenry",
14+
"name": "James Henry",
15+
"avatar_url": "https://avatars1.githubusercontent.com/u/900523?v=4",
16+
"profile": "https://github.com/JamesHenry",
17+
"contributions": []
18+
},
19+
{
20+
"login": "armano2",
21+
"name": "Armano",
22+
"avatar_url": "https://avatars1.githubusercontent.com/u/625469?v=4",
23+
"profile": "https://github.com/armano2",
24+
"contributions": []
25+
},
26+
{
27+
"login": "soda0289",
28+
"name": "Reyad Attiyat",
29+
"avatar_url": "https://avatars1.githubusercontent.com/u/2373964?v=4",
30+
"profile": "https://github.com/soda0289",
31+
"contributions": []
32+
},
33+
{
34+
"login": "bradzacher",
35+
"name": "Brad Zacher",
36+
"avatar_url": "https://avatars1.githubusercontent.com/u/7462525?v=4",
37+
"profile": "https://github.com/bradzacher",
38+
"contributions": []
39+
},
40+
{
41+
"login": "weirdpattern",
42+
"name": "Patricio Trevino",
43+
"avatar_url": "https://avatars0.githubusercontent.com/u/19519411?v=4",
44+
"profile": "https://github.com/weirdpattern",
45+
"contributions": []
46+
},
47+
{
48+
"login": "nzakas",
49+
"name": "Nicholas C. Zakas",
50+
"avatar_url": "https://avatars3.githubusercontent.com/u/38546?v=4",
51+
"profile": "https://github.com/nzakas",
52+
"contributions": []
53+
},
54+
{
55+
"login": "j-f1",
56+
"name": "Jed Fox",
57+
"avatar_url": "https://avatars2.githubusercontent.com/u/25517624?v=4",
58+
"profile": "https://github.com/j-f1",
59+
"contributions": []
60+
},
61+
{
62+
"login": "uniqueiniquity",
63+
"name": "Benjamin Lichtman",
64+
"avatar_url": "https://avatars1.githubusercontent.com/u/9092011?v=4",
65+
"profile": "https://github.com/uniqueiniquity",
66+
"contributions": []
67+
},
68+
{
69+
"login": "kaicataldo",
70+
"name": "Kai Cataldo",
71+
"avatar_url": "https://avatars2.githubusercontent.com/u/7041728?v=4",
72+
"profile": "https://github.com/kaicataldo",
73+
"contributions": []
74+
},
75+
{
76+
"login": "Pajn",
77+
"name": "Rasmus Eneman",
78+
"avatar_url": "https://avatars1.githubusercontent.com/u/817422?v=4",
79+
"profile": "https://github.com/Pajn",
80+
"contributions": []
81+
},
82+
{
83+
"login": "azz",
84+
"name": "Lucas Azzola",
85+
"avatar_url": "https://avatars3.githubusercontent.com/u/1297597?v=4",
86+
"profile": "https://github.com/azz",
87+
"contributions": []
88+
},
89+
{
90+
"login": "dannyfritz",
91+
"name": "Danny Fritz",
92+
"avatar_url": "https://avatars1.githubusercontent.com/u/315788?v=4",
93+
"profile": "https://github.com/dannyfritz",
94+
"contributions": []
95+
},
96+
{
97+
"login": "ikatyang",
98+
"name": "Ika",
99+
"avatar_url": "https://avatars1.githubusercontent.com/u/8341033?v=4",
100+
"profile": "https://github.com/ikatyang",
101+
"contributions": []
102+
},
103+
{
104+
"login": "mysticatea",
105+
"name": "Toru Nagashima",
106+
"avatar_url": "https://avatars2.githubusercontent.com/u/1937871?v=4",
107+
"profile": "https://github.com/mysticatea",
108+
"contributions": []
109+
},
110+
{
111+
"login": "macklinu",
112+
"name": "mackie",
113+
"avatar_url": "https://avatars1.githubusercontent.com/u/2344137?v=4",
114+
"profile": "https://github.com/macklinu",
115+
"contributions": []
116+
},
117+
{
118+
"login": "lukyth",
119+
"name": "Kanitkorn Sujautra",
120+
"avatar_url": "https://avatars3.githubusercontent.com/u/7040242?v=4",
121+
"profile": "https://github.com/lukyth",
122+
"contributions": []
123+
},
124+
{
125+
"login": "platinumazure",
126+
"name": "Kevin Partington",
127+
"avatar_url": "https://avatars0.githubusercontent.com/u/284282?v=4",
128+
"profile": "https://github.com/platinumazure",
129+
"contributions": []
130+
},
131+
{
132+
"login": "mightyiam",
133+
"name": "Shahar Or",
134+
"avatar_url": "https://avatars2.githubusercontent.com/u/635591?v=4",
135+
"profile": "https://github.com/mightyiam",
136+
"contributions": []
137+
},
138+
{
139+
"login": "invalid-email-address",
140+
"name": "Check your git settings!",
141+
"avatar_url": "https://avatars0.githubusercontent.com/u/148100?v=4",
142+
"profile": "https://github.com/invalid-email-address",
143+
"contributions": []
144+
},
145+
{
146+
"login": "flying-sheep",
147+
"name": "Philipp A.",
148+
"avatar_url": "https://avatars0.githubusercontent.com/u/291575?v=4",
149+
"profile": "https://github.com/flying-sheep",
150+
"contributions": []
151+
},
152+
{
153+
"login": "g-plane",
154+
"name": "Pig Fang",
155+
"avatar_url": "https://avatars1.githubusercontent.com/u/17216317?v=4",
156+
"profile": "https://github.com/g-plane",
157+
"contributions": []
158+
}
159+
],
160+
"contributorsPerLine": 7
161+
}

CONTRIBUTORS.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Contributors
2+
3+
Thanks goes to these wonderful people ([emoji key](https://github.com/all-contributors/all-contributors#emoji-key)):
4+
5+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
6+
<!-- prettier-ignore -->
7+
<table cellspacing="0" cellpadding="1"><tr><td><a href="https://github.com/JamesHenry"><img src="https://avatars1.githubusercontent.com/u/900523?v=4" width="100px;" height="100px;" alt="James Henry"/><br /><sub><b>James Henry</b></sub></a><br /></td><td><a href="https://github.com/armano2"><img src="https://avatars1.githubusercontent.com/u/625469?v=4" width="100px;" height="100px;" alt="Armano"/><br /><sub><b>Armano</b></sub></a><br /></td><td><a href="https://github.com/soda0289"><img src="https://avatars1.githubusercontent.com/u/2373964?v=4" width="100px;" height="100px;" alt="Reyad Attiyat"/><br /><sub><b>Reyad Attiyat</b></sub></a><br /></td><td><a href="https://github.com/bradzacher"><img src="https://avatars1.githubusercontent.com/u/7462525?v=4" width="100px;" height="100px;" alt="Brad Zacher"/><br /><sub><b>Brad Zacher</b></sub></a><br /></td><td><a href="https://github.com/weirdpattern"><img src="https://avatars0.githubusercontent.com/u/19519411?v=4" width="100px;" height="100px;" alt="Patricio Trevino"/><br /><sub><b>Patricio Trevino</b></sub></a><br /></td><td><a href="https://github.com/nzakas"><img src="https://avatars3.githubusercontent.com/u/38546?v=4" width="100px;" height="100px;" alt="Nicholas C. Zakas"/><br /><sub><b>Nicholas C. Zakas</b></sub></a><br /></td><td><a href="https://github.com/j-f1"><img src="https://avatars2.githubusercontent.com/u/25517624?v=4" width="100px;" height="100px;" alt="Jed Fox"/><br /><sub><b>Jed Fox</b></sub></a><br /></td></tr><tr><td><a href="https://github.com/uniqueiniquity"><img src="https://avatars1.githubusercontent.com/u/9092011?v=4" width="100px;" height="100px;" alt="Benjamin Lichtman"/><br /><sub><b>Benjamin Lichtman</b></sub></a><br /></td><td><a href="https://github.com/kaicataldo"><img src="https://avatars2.githubusercontent.com/u/7041728?v=4" width="100px;" height="100px;" alt="Kai Cataldo"/><br /><sub><b>Kai Cataldo</b></sub></a><br /></td><td><a href="https://github.com/Pajn"><img src="https://avatars1.githubusercontent.com/u/817422?v=4" width="100px;" height="100px;" alt="Rasmus Eneman"/><br /><sub><b>Rasmus Eneman</b></sub></a><br /></td><td><a href="https://github.com/azz"><img src="https://avatars3.githubusercontent.com/u/1297597?v=4" width="100px;" height="100px;" alt="Lucas Azzola"/><br /><sub><b>Lucas Azzola</b></sub></a><br /></td><td><a href="https://github.com/dannyfritz"><img src="https://avatars1.githubusercontent.com/u/315788?v=4" width="100px;" height="100px;" alt="Danny Fritz"/><br /><sub><b>Danny Fritz</b></sub></a><br /></td><td><a href="https://github.com/ikatyang"><img src="https://avatars1.githubusercontent.com/u/8341033?v=4" width="100px;" height="100px;" alt="Ika"/><br /><sub><b>Ika</b></sub></a><br /></td><td><a href="https://github.com/mysticatea"><img src="https://avatars2.githubusercontent.com/u/1937871?v=4" width="100px;" height="100px;" alt="Toru Nagashima"/><br /><sub><b>Toru Nagashima</b></sub></a><br /></td></tr><tr><td><a href="https://github.com/macklinu"><img src="https://avatars1.githubusercontent.com/u/2344137?v=4" width="100px;" height="100px;" alt="mackie"/><br /><sub><b>mackie</b></sub></a><br /></td><td><a href="https://github.com/lukyth"><img src="https://avatars3.githubusercontent.com/u/7040242?v=4" width="100px;" height="100px;" alt="Kanitkorn Sujautra"/><br /><sub><b>Kanitkorn Sujautra</b></sub></a><br /></td><td><a href="https://github.com/platinumazure"><img src="https://avatars0.githubusercontent.com/u/284282?v=4" width="100px;" height="100px;" alt="Kevin Partington"/><br /><sub><b>Kevin Partington</b></sub></a><br /></td><td><a href="https://github.com/mightyiam"><img src="https://avatars2.githubusercontent.com/u/635591?v=4" width="100px;" height="100px;" alt="Shahar Or"/><br /><sub><b>Shahar Or</b></sub></a><br /></td><td><a href="https://github.com/invalid-email-address"><img src="https://avatars0.githubusercontent.com/u/148100?v=4" width="100px;" height="100px;" alt="Check your git settings!"/><br /><sub><b>Check your git settings!</b></sub></a><br /></td><td><a href="https://github.com/flying-sheep"><img src="https://avatars0.githubusercontent.com/u/291575?v=4" width="100px;" height="100px;" alt="Philipp A."/><br /><sub><b>Philipp A.</b></sub></a><br /></td><td><a href="https://github.com/g-plane"><img src="https://avatars1.githubusercontent.com/u/17216317?v=4" width="100px;" height="100px;" alt="Pig Fang"/><br /><sub><b>Pig Fang</b></sub></a><br /></td></tr></table>
8+
<!-- ALL-CONTRIBUTORS-LIST:END -->
9+
10+
<sup>This list is auto-generated using `yarn generate-contributors`.</sup>

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,8 @@ COMING SOON!
5858

5959
## License
6060

61-
TypeScript ESLint inherits from the original TypeScript ESLint Parser license, as the majority of the work began there. It is licensed under a permissive BSD 2-clause license.
61+
TypeScript ESLint inherits from the the original TypeScript ESLint Parser license, as the majority of the work began there. It is licensed under a permissive BSD 2-clause license.
62+
63+
## Contributors
64+
65+
Thanks goes to the wonderful people listed in [`CONTRIBUTORS.md`](./CONTRIBUTORS.md).

package.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@
2828
"check-format": "prettier --list-different \"./**/*.{ts,js,json,md}\"",
2929
"format": "prettier --write \"./**/*.{ts,js,json,md}\"",
3030
"integration-tests": "docker-compose -f tests/integration/docker-compose.yml up",
31-
"kill-integration-test-containers": "docker-compose -f tests/integration/docker-compose.yml down -v --rmi local"
31+
"kill-integration-test-containers": "docker-compose -f tests/integration/docker-compose.yml down -v --rmi local",
32+
"generate-contributors": "yarn ts-node ./tools/generate-contributors.ts && yarn all-contributors generate"
3233
},
3334
"config": {
3435
"commitizen": {
@@ -56,19 +57,22 @@
5657
"@types/lodash.unescape": "^4.0.4",
5758
"@types/node": "^10.12.2",
5859
"@types/semver": "^5.5.0",
60+
"all-contributors-cli": "^6.0.0",
5961
"cz-conventional-changelog": "2.1.0",
6062
"eslint": "^5.12.1",
6163
"eslint-plugin-eslint-plugin": "^2.0.1",
6264
"eslint-plugin-jest": "^22.2.2",
6365
"glob": "7.1.2",
6466
"husky": "^1.3.1",
67+
"isomorphic-fetch": "^2.2.1",
6568
"jest": "24.1.0",
6669
"lerna": "^3.10.5",
6770
"lint-staged": "8.1.0",
6871
"lodash.isplainobject": "4.0.6",
6972
"prettier": "^1.14.3",
7073
"rimraf": "^2.6.3",
7174
"ts-jest": "^24.0.0",
75+
"ts-node": "^8.0.1",
7276
"tslint": "^5.11.0",
7377
"typescript": ">=3.2.1 <3.4.0"
7478
}

packages/eslint-plugin/package.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,7 @@
4141
"tsutils": "^3.7.0"
4242
},
4343
"devDependencies": {
44-
"eslint-docs": "^0.2.6",
45-
"ts-node": "^8.0.1"
44+
"eslint-docs": "^0.2.6"
4645
},
4746
"peerDependencies": {
4847
"eslint": "^5.0.0",

packages/eslint-plugin/src/index.ts

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
/**
2-
* @fileoverview TypeScript plugin for ESLint
3-
* @author Nicholas C. Zakas
4-
*/
5-
61
import requireIndex from 'requireindex';
72
import path from 'path';
83

packages/eslint-plugin/src/rules/adjacent-overload-signatures.ts

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
/**
2-
* @fileoverview Enforces member overloads to be consecutive.
3-
* @author Patricio Trevino
4-
*/
5-
61
import { TSESTree, AST_NODE_TYPES } from '@typescript-eslint/typescript-estree';
72
import * as util from '../util';
83

packages/eslint-plugin/src/rules/array-type.ts

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
/**
2-
* @fileoverview Requires using either `T[]` or `Array<T>` for arrays.
3-
* @author Mackie Underdown
4-
* @author Armano <https://github.com/armano2>
5-
*/
6-
71
import {
82
AST_NODE_TYPES,
93
AST_TOKEN_TYPES,

packages/eslint-plugin/src/rules/ban-ts-ignore.ts

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
/**
2-
* @fileoverview Bans “// @ts-ignore” comments from being used.
3-
* @author Ricky Lippmann <https://github.com/ldrick>
4-
*/
5-
61
import * as util from '../util';
72

83
export default util.createRule({

packages/eslint-plugin/src/rules/ban-types.ts

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
/**
2-
* @fileoverview Enforces that types will not to be used
3-
* @author Armano <https://github.com/armano2>
4-
*/
5-
61
import { TSESTree, AST_NODE_TYPES } from '@typescript-eslint/typescript-estree';
72
import { ReportFixFunction } from 'ts-eslint';
83
import * as util from '../util';

packages/eslint-plugin/src/rules/camelcase.ts

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
/**
2-
* @fileoverview Rule to flag non-camelcased identifiers
3-
* @author Patricio Trevino
4-
*/
5-
61
import { TSESTree, AST_NODE_TYPES } from '@typescript-eslint/typescript-estree';
72
import baseRule from 'eslint/lib/rules/camelcase';
83
import * as util from '../util';

packages/eslint-plugin/src/rules/class-name-casing.ts

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
/**
2-
* @fileoverview Enforces PascalCased class and interface names.
3-
* @author Jed Fox
4-
* @author Armano <https://github.com/armano2>
5-
*/
6-
71
import * as util from '../util';
82
import { TSESTree, AST_NODE_TYPES } from '@typescript-eslint/typescript-estree';
93

packages/eslint-plugin/src/rules/explicit-function-return-type.ts

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
/**
2-
* @fileoverview Enforces explicit return type for functions
3-
* @author Scott O'Hara
4-
*/
5-
61
import { TSESTree, AST_NODE_TYPES } from '@typescript-eslint/typescript-estree';
72
import * as util from '../util';
83

packages/eslint-plugin/src/rules/explicit-member-accessibility.ts

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
/**
2-
* @fileoverview Enforces explicit accessibility modifier for class members
3-
* @author Danny Fritz
4-
*/
5-
61
import { TSESTree } from '@typescript-eslint/typescript-estree';
72
import * as util from '../util';
83

packages/eslint-plugin/src/rules/generic-type-naming.ts

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
/**
2-
* @fileoverview Enforces naming of generic type variables.
3-
*/
4-
51
import * as util from '../util';
62

73
type Options = [string?];

packages/eslint-plugin/src/rules/indent.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
/**
2-
* @fileoverview Rule to flag non-camelcased identifiers
3-
*
42
* Note this file is rather type-unsafe in its current state.
53
* This is due to some really funky type conversions between different node types.
64
* This is done intentionally based on the internal implementation of the base indent rule.

packages/eslint-plugin/src/rules/interface-name-prefix.ts

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
/**
2-
* @fileoverview Enforces interface names are prefixed with "I".
3-
* @author Danny Fritz
4-
*/
5-
61
import * as util from '../util';
72

83
type Options = ['never' | 'always'];

packages/eslint-plugin/src/rules/member-delimiter-style.ts

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
/**
2-
* @fileoverview Enforces a member delimiter style in interfaces and type literals.
3-
* @author Patricio Trevino
4-
* @author Brad Zacher
5-
*/
6-
71
import { TSESTree, AST_NODE_TYPES } from '@typescript-eslint/typescript-estree';
82
import * as util from '../util';
93

packages/eslint-plugin/src/rules/member-naming.ts

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
/**
2-
* @fileoverview Enforces naming conventions for class members by visibility.
3-
* @author Ian MacLeod
4-
*/
5-
61
import { TSESTree } from '@typescript-eslint/typescript-estree';
72
import * as util from '../util';
83

packages/eslint-plugin/src/rules/member-ordering.ts

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
/**
2-
* @fileoverview Enforces a standard member declaration order.
3-
* @author Patricio Trevino
4-
*/
5-
61
import { TSESTree, AST_NODE_TYPES } from '@typescript-eslint/typescript-estree';
72
import * as util from '../util';
83

packages/eslint-plugin/src/rules/no-angle-bracket-type-assertion.ts

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
/**
2-
* @fileoverview Enforces the use of `as Type` assertions instead of `<Type>` assertions.
3-
* @author Patricio Trevino
4-
*/
5-
61
import * as util from '../util';
72

83
export default util.createRule({

packages/eslint-plugin/src/rules/no-array-constructor.ts

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
/**
2-
* @fileoverview Disallow generic `Array` constructors
3-
* @author Jed Fox
4-
* @author Matt DuVall <http://www.mattduvall.com/>
5-
*/
6-
71
import { TSESTree, AST_NODE_TYPES } from '@typescript-eslint/typescript-estree';
82
import * as util from '../util';
93

packages/eslint-plugin/src/rules/no-empty-interface.ts

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
/**
2-
* @fileoverview Disallows the declaration of empty interfaces.
3-
* @author Patricio Trevino
4-
*/
5-
61
import * as util from '../util';
72

83
type Options = [

packages/eslint-plugin/src/rules/no-explicit-any.ts

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
/**
2-
* @fileoverview Enforces the any type is not used.
3-
* @author Danny Fritz
4-
* @author Patricio Trevino
5-
*/
6-
71
import * as util from '../util';
82

93
export default util.createRule({

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy