Skip to content

Commit e10c09c

Browse files
committed
fix(readme): document which configs this package extends from
1 parent 1b9dfce commit e10c09c

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,13 @@ To get the most out of this config, it is assumed that projects have the followi
7474

7575
## Rules
7676

77+
### Extends
78+
79+
- [`airbnb`](https://www.npmjs.com/package/eslint-config-airbnb)
80+
- [`prettier`](https://github.com/prettier/eslint-config-prettier)
81+
- [`prettier/react`](https://github.com/prettier/eslint-config-prettier)
82+
- [`prettier/flowtype`](https://github.com/prettier/eslint-config-prettier)
83+
7784
### Cookbook config
7885

7986
- [no-warning-comments](https://eslint.org/docs/rules/no-warning-comments): `1, terms: todo, fixme, xxx, location: start`
@@ -82,7 +89,7 @@ To get the most out of this config, it is assumed that projects have the followi
8289
- [no-param-reassign](https://eslint.org/docs/rules/no-param-reassign): `2, props: false`
8390
- [react/forbid-prop-types](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/forbid-prop-types.md): `2, forbid: any`
8491

85-
### Rules of [`eslint-config-airbnb`](https://github.com/airbnb/javascript)
92+
### Rules of [`airbnb`](https://github.com/airbnb/javascript)
8693

8794
<details>
8895

src/documentation.js

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,11 +98,18 @@ const disabled = Object.keys(rules)
9898
const rulesDocumentation = `
9999
## Rules
100100
101+
### Extends
102+
103+
- [\`airbnb\`](https://www.npmjs.com/package/eslint-config-airbnb)
104+
- [\`prettier\`](https://github.com/prettier/eslint-config-prettier)
105+
- [\`prettier/react\`](https://github.com/prettier/eslint-config-prettier)
106+
- [\`prettier/flowtype\`](https://github.com/prettier/eslint-config-prettier)
107+
101108
### Cookbook config
102109
103110
${generateList(formatRows(customConventions))}
104111
105-
### Rules of [\`eslint-config-airbnb\`](https://github.com/airbnb/javascript)
112+
### Rules of [\`airbnb\`](https://github.com/airbnb/javascript)
106113
107114
<details>
108115

0 commit comments

Comments
 (0)