Skip to content

Commit

Permalink
docs(*): switch from author file comments to all-contributors (#228)
Browse files Browse the repository at this point in the history
  • Loading branch information
bradzacher authored and JamesHenry committed Feb 23, 2019
1 parent 4526f27 commit 0635183
Show file tree
Hide file tree
Showing 68 changed files with 355 additions and 430 deletions.
161 changes: 161 additions & 0 deletions .all-contributorsrc
@@ -0,0 +1,161 @@
{
"projectName": "typescript-eslint",
"projectOwner": "typescript-eslint",
"repoType": "github",
"repoHost": "https://github.com",
"files": [
"CONTRIBUTORS.md"
],
"imageSize": 100,
"commit": false,
"contributors": [
{
"login": "JamesHenry",
"name": "James Henry",
"avatar_url": "https://avatars1.githubusercontent.com/u/900523?v=4",
"profile": "https://github.com/JamesHenry",
"contributions": []
},
{
"login": "armano2",
"name": "Armano",
"avatar_url": "https://avatars1.githubusercontent.com/u/625469?v=4",
"profile": "https://github.com/armano2",
"contributions": []
},
{
"login": "soda0289",
"name": "Reyad Attiyat",
"avatar_url": "https://avatars1.githubusercontent.com/u/2373964?v=4",
"profile": "https://github.com/soda0289",
"contributions": []
},
{
"login": "bradzacher",
"name": "Brad Zacher",
"avatar_url": "https://avatars1.githubusercontent.com/u/7462525?v=4",
"profile": "https://github.com/bradzacher",
"contributions": []
},
{
"login": "weirdpattern",
"name": "Patricio Trevino",
"avatar_url": "https://avatars0.githubusercontent.com/u/19519411?v=4",
"profile": "https://github.com/weirdpattern",
"contributions": []
},
{
"login": "nzakas",
"name": "Nicholas C. Zakas",
"avatar_url": "https://avatars3.githubusercontent.com/u/38546?v=4",
"profile": "https://github.com/nzakas",
"contributions": []
},
{
"login": "j-f1",
"name": "Jed Fox",
"avatar_url": "https://avatars2.githubusercontent.com/u/25517624?v=4",
"profile": "https://github.com/j-f1",
"contributions": []
},
{
"login": "uniqueiniquity",
"name": "Benjamin Lichtman",
"avatar_url": "https://avatars1.githubusercontent.com/u/9092011?v=4",
"profile": "https://github.com/uniqueiniquity",
"contributions": []
},
{
"login": "kaicataldo",
"name": "Kai Cataldo",
"avatar_url": "https://avatars2.githubusercontent.com/u/7041728?v=4",
"profile": "https://github.com/kaicataldo",
"contributions": []
},
{
"login": "Pajn",
"name": "Rasmus Eneman",
"avatar_url": "https://avatars1.githubusercontent.com/u/817422?v=4",
"profile": "https://github.com/Pajn",
"contributions": []
},
{
"login": "azz",
"name": "Lucas Azzola",
"avatar_url": "https://avatars3.githubusercontent.com/u/1297597?v=4",
"profile": "https://github.com/azz",
"contributions": []
},
{
"login": "dannyfritz",
"name": "Danny Fritz",
"avatar_url": "https://avatars1.githubusercontent.com/u/315788?v=4",
"profile": "https://github.com/dannyfritz",
"contributions": []
},
{
"login": "ikatyang",
"name": "Ika",
"avatar_url": "https://avatars1.githubusercontent.com/u/8341033?v=4",
"profile": "https://github.com/ikatyang",
"contributions": []
},
{
"login": "mysticatea",
"name": "Toru Nagashima",
"avatar_url": "https://avatars2.githubusercontent.com/u/1937871?v=4",
"profile": "https://github.com/mysticatea",
"contributions": []
},
{
"login": "macklinu",
"name": "mackie",
"avatar_url": "https://avatars1.githubusercontent.com/u/2344137?v=4",
"profile": "https://github.com/macklinu",
"contributions": []
},
{
"login": "lukyth",
"name": "Kanitkorn Sujautra",
"avatar_url": "https://avatars3.githubusercontent.com/u/7040242?v=4",
"profile": "https://github.com/lukyth",
"contributions": []
},
{
"login": "platinumazure",
"name": "Kevin Partington",
"avatar_url": "https://avatars0.githubusercontent.com/u/284282?v=4",
"profile": "https://github.com/platinumazure",
"contributions": []
},
{
"login": "mightyiam",
"name": "Shahar Or",
"avatar_url": "https://avatars2.githubusercontent.com/u/635591?v=4",
"profile": "https://github.com/mightyiam",
"contributions": []
},
{
"login": "invalid-email-address",
"name": "Check your git settings!",
"avatar_url": "https://avatars0.githubusercontent.com/u/148100?v=4",
"profile": "https://github.com/invalid-email-address",
"contributions": []
},
{
"login": "flying-sheep",
"name": "Philipp A.",
"avatar_url": "https://avatars0.githubusercontent.com/u/291575?v=4",
"profile": "https://github.com/flying-sheep",
"contributions": []
},
{
"login": "g-plane",
"name": "Pig Fang",
"avatar_url": "https://avatars1.githubusercontent.com/u/17216317?v=4",
"profile": "https://github.com/g-plane",
"contributions": []
}
],
"contributorsPerLine": 7
}
10 changes: 10 additions & 0 deletions CONTRIBUTORS.md
@@ -0,0 +1,10 @@
# Contributors

Thanks goes to these wonderful people ([emoji key](https://github.com/all-contributors/all-contributors#emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
<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>
<!-- ALL-CONTRIBUTORS-LIST:END -->

<sup>This list is auto-generated using `yarn generate-contributors`.</sup>
6 changes: 5 additions & 1 deletion README.md
Expand Up @@ -58,4 +58,8 @@ COMING SOON!

## License

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.
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.

## Contributors

Thanks goes to the wonderful people listed in [`CONTRIBUTORS.md`](./CONTRIBUTORS.md).
6 changes: 5 additions & 1 deletion package.json
Expand Up @@ -28,7 +28,8 @@
"check-format": "prettier --list-different \"./**/*.{ts,js,json,md}\"",
"format": "prettier --write \"./**/*.{ts,js,json,md}\"",
"integration-tests": "docker-compose -f tests/integration/docker-compose.yml up",
"kill-integration-test-containers": "docker-compose -f tests/integration/docker-compose.yml down -v --rmi local"
"kill-integration-test-containers": "docker-compose -f tests/integration/docker-compose.yml down -v --rmi local",
"generate-contributors": "yarn ts-node ./tools/generate-contributors.ts && yarn all-contributors generate"
},
"config": {
"commitizen": {
Expand Down Expand Up @@ -56,19 +57,22 @@
"@types/lodash.unescape": "^4.0.4",
"@types/node": "^10.12.2",
"@types/semver": "^5.5.0",
"all-contributors-cli": "^6.0.0",
"cz-conventional-changelog": "2.1.0",
"eslint": "^5.12.1",
"eslint-plugin-eslint-plugin": "^2.0.1",
"eslint-plugin-jest": "^22.2.2",
"glob": "7.1.2",
"husky": "^1.3.1",
"isomorphic-fetch": "^2.2.1",
"jest": "24.1.0",
"lerna": "^3.10.5",
"lint-staged": "8.1.0",
"lodash.isplainobject": "4.0.6",
"prettier": "^1.14.3",
"rimraf": "^2.6.3",
"ts-jest": "^24.0.0",
"ts-node": "^8.0.1",
"tslint": "^5.11.0",
"typescript": ">=3.2.1 <3.4.0"
}
Expand Down
3 changes: 1 addition & 2 deletions packages/eslint-plugin/package.json
Expand Up @@ -41,8 +41,7 @@
"tsutils": "^3.7.0"
},
"devDependencies": {
"eslint-docs": "^0.2.6",
"ts-node": "^8.0.1"
"eslint-docs": "^0.2.6"
},
"peerDependencies": {
"eslint": "^5.0.0",
Expand Down
5 changes: 0 additions & 5 deletions packages/eslint-plugin/src/index.ts
@@ -1,8 +1,3 @@
/**
* @fileoverview TypeScript plugin for ESLint
* @author Nicholas C. Zakas
*/

import requireIndex from 'requireindex';
import path from 'path';

Expand Down
@@ -1,8 +1,3 @@
/**
* @fileoverview Enforces member overloads to be consecutive.
* @author Patricio Trevino
*/

import { TSESTree, AST_NODE_TYPES } from '@typescript-eslint/typescript-estree';
import * as util from '../util';

Expand Down
6 changes: 0 additions & 6 deletions packages/eslint-plugin/src/rules/array-type.ts
@@ -1,9 +1,3 @@
/**
* @fileoverview Requires using either `T[]` or `Array<T>` for arrays.
* @author Mackie Underdown
* @author Armano <https://github.com/armano2>
*/

import {
AST_NODE_TYPES,
AST_TOKEN_TYPES,
Expand Down
5 changes: 0 additions & 5 deletions packages/eslint-plugin/src/rules/ban-ts-ignore.ts
@@ -1,8 +1,3 @@
/**
* @fileoverview Bans “// @ts-ignore” comments from being used.
* @author Ricky Lippmann <https://github.com/ldrick>
*/

import * as util from '../util';

export default util.createRule({
Expand Down
5 changes: 0 additions & 5 deletions packages/eslint-plugin/src/rules/ban-types.ts
@@ -1,8 +1,3 @@
/**
* @fileoverview Enforces that types will not to be used
* @author Armano <https://github.com/armano2>
*/

import { TSESTree, AST_NODE_TYPES } from '@typescript-eslint/typescript-estree';
import { ReportFixFunction } from 'ts-eslint';
import * as util from '../util';
Expand Down
5 changes: 0 additions & 5 deletions packages/eslint-plugin/src/rules/camelcase.ts
@@ -1,8 +1,3 @@
/**
* @fileoverview Rule to flag non-camelcased identifiers
* @author Patricio Trevino
*/

import { TSESTree, AST_NODE_TYPES } from '@typescript-eslint/typescript-estree';
import baseRule from 'eslint/lib/rules/camelcase';
import * as util from '../util';
Expand Down
6 changes: 0 additions & 6 deletions packages/eslint-plugin/src/rules/class-name-casing.ts
@@ -1,9 +1,3 @@
/**
* @fileoverview Enforces PascalCased class and interface names.
* @author Jed Fox
* @author Armano <https://github.com/armano2>
*/

import * as util from '../util';
import { TSESTree, AST_NODE_TYPES } from '@typescript-eslint/typescript-estree';

Expand Down
@@ -1,8 +1,3 @@
/**
* @fileoverview Enforces explicit return type for functions
* @author Scott O'Hara
*/

import { TSESTree, AST_NODE_TYPES } from '@typescript-eslint/typescript-estree';
import * as util from '../util';

Expand Down
@@ -1,8 +1,3 @@
/**
* @fileoverview Enforces explicit accessibility modifier for class members
* @author Danny Fritz
*/

import { TSESTree } from '@typescript-eslint/typescript-estree';
import * as util from '../util';

Expand Down
4 changes: 0 additions & 4 deletions packages/eslint-plugin/src/rules/generic-type-naming.ts
@@ -1,7 +1,3 @@
/**
* @fileoverview Enforces naming of generic type variables.
*/

import * as util from '../util';

type Options = [string?];
Expand Down
2 changes: 0 additions & 2 deletions packages/eslint-plugin/src/rules/indent.ts
@@ -1,6 +1,4 @@
/**
* @fileoverview Rule to flag non-camelcased identifiers
*
* Note this file is rather type-unsafe in its current state.
* This is due to some really funky type conversions between different node types.
* This is done intentionally based on the internal implementation of the base indent rule.
Expand Down
5 changes: 0 additions & 5 deletions packages/eslint-plugin/src/rules/interface-name-prefix.ts
@@ -1,8 +1,3 @@
/**
* @fileoverview Enforces interface names are prefixed with "I".
* @author Danny Fritz
*/

import * as util from '../util';

type Options = ['never' | 'always'];
Expand Down
6 changes: 0 additions & 6 deletions packages/eslint-plugin/src/rules/member-delimiter-style.ts
@@ -1,9 +1,3 @@
/**
* @fileoverview Enforces a member delimiter style in interfaces and type literals.
* @author Patricio Trevino
* @author Brad Zacher
*/

import { TSESTree, AST_NODE_TYPES } from '@typescript-eslint/typescript-estree';
import * as util from '../util';

Expand Down
5 changes: 0 additions & 5 deletions packages/eslint-plugin/src/rules/member-naming.ts
@@ -1,8 +1,3 @@
/**
* @fileoverview Enforces naming conventions for class members by visibility.
* @author Ian MacLeod
*/

import { TSESTree } from '@typescript-eslint/typescript-estree';
import * as util from '../util';

Expand Down
5 changes: 0 additions & 5 deletions packages/eslint-plugin/src/rules/member-ordering.ts
@@ -1,8 +1,3 @@
/**
* @fileoverview Enforces a standard member declaration order.
* @author Patricio Trevino
*/

import { TSESTree, AST_NODE_TYPES } from '@typescript-eslint/typescript-estree';
import * as util from '../util';

Expand Down
@@ -1,8 +1,3 @@
/**
* @fileoverview Enforces the use of `as Type` assertions instead of `<Type>` assertions.
* @author Patricio Trevino
*/

import * as util from '../util';

export default util.createRule({
Expand Down
6 changes: 0 additions & 6 deletions packages/eslint-plugin/src/rules/no-array-constructor.ts
@@ -1,9 +1,3 @@
/**
* @fileoverview Disallow generic `Array` constructors
* @author Jed Fox
* @author Matt DuVall <http://www.mattduvall.com/>
*/

import { TSESTree, AST_NODE_TYPES } from '@typescript-eslint/typescript-estree';
import * as util from '../util';

Expand Down
5 changes: 0 additions & 5 deletions packages/eslint-plugin/src/rules/no-empty-interface.ts
@@ -1,8 +1,3 @@
/**
* @fileoverview Disallows the declaration of empty interfaces.
* @author Patricio Trevino
*/

import * as util from '../util';

type Options = [
Expand Down
6 changes: 0 additions & 6 deletions packages/eslint-plugin/src/rules/no-explicit-any.ts
@@ -1,9 +1,3 @@
/**
* @fileoverview Enforces the any type is not used.
* @author Danny Fritz
* @author Patricio Trevino
*/

import * as util from '../util';

export default util.createRule({
Expand Down

0 comments on commit 0635183

Please sign in to comment.