Skip to content

Commit 0cad340

Browse files
committed
feat: init source
1 parent 4790ac5 commit 0cad340

File tree

4 files changed

+1587
-20
lines changed

4 files changed

+1587
-20
lines changed

.eslintrc.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
extends: ['standard', 'prettier', 'prettier/standard'],
3+
};

README.md

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,57 @@
11
<div align="center">
2-
<h1>repo-template</h1>
3-
<p>Boring GitHub Repository Template</p>
2+
<h1>eslint-config</h1>
3+
<p>Boring ESLint Config</p>
44

55
<div>
6-
<a href="https://github.com/boringcodes/repo-template/commits" aria-label="Commitizen Friendly">
6+
<a href="https://github.com/boringcodes/eslint-config/commits" aria-label="Commitizen Friendly">
77
<img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square">
88
</a>
9-
<a href="https://github.com/boringcodes/repo-template" aria-label="Prettier Code Style">
9+
<a href="https://github.com/boringcodes/eslint-config" aria-label="Prettier Code Style">
1010
<img src="https://img.shields.io/badge/code_style-prettier-brightgreen?style=flat-square">
1111
</a>
12-
<a href="https://github.com/boringcodes/repo-template/actions" aria-label="GitHub Workflow Status">
13-
<img src="https://img.shields.io/github/workflow/status/boringcodes/repo-template/main?style=flat-square">
12+
<a href="https://github.com/boringcodes/eslint-config/actions" aria-label="GitHub Workflow Status">
13+
<img src="https://img.shields.io/github/workflow/status/boringcodes/eslint-config/publish-npm?style=flat-square">
1414
</a>
15-
<a href="https://david-dm.org/boringcodes/repo-template" aria-label="Dependencies Status">
16-
<img src="https://img.shields.io/david/boringcodes/repo-template?style=flat-square">
15+
<a href="https://david-dm.org/boringcodes/eslint-config" aria-label="Dependencies Status">
16+
<img src="https://img.shields.io/david/boringcodes/eslint-config?style=flat-square">
1717
</a>
18-
<a href="https://www.npmjs.com/package/@boringcodes/repo-template" aria-label="NPM Version">
19-
<img src="https://img.shields.io/npm/v/@boringcodes/repo-template?color=brightgreen&style=flat-square">
18+
<a href="https://www.npmjs.com/package/@boringcodes/eslint-config" aria-label="NPM Version">
19+
<img src="https://img.shields.io/npm/v/@boringcodes/eslint-config?color=brightgreen&style=flat-square">
2020
</a>
21-
<a href="https://www.npmjs.com/package/@boringcodes/repo-template" aria-label="NPM Downloads">
22-
<img src="https://img.shields.io/npm/dm/@boringcodes/repo-template?style=flat-square">
21+
<a href="https://www.npmjs.com/package/@boringcodes/eslint-config" aria-label="NPM Downloads">
22+
<img src="https://img.shields.io/npm/dm/@boringcodes/eslint-config?style=flat-square">
2323
</a>
24-
<a href="https://github.com/boringcodes/repo-template/blob/master/LICENSE" aria-label="MIT License">
25-
<img src="https://img.shields.io/github/license/boringcodes/repo-template?color=brightgreen&style=flat-square">
24+
<a href="https://github.com/boringcodes/eslint-config/blob/master/LICENSE" aria-label="MIT License">
25+
<img src="https://img.shields.io/github/license/boringcodes/eslint-config?color=brightgreen&style=flat-square">
2626
</a>
2727
<a href="https://github.com/boringcodes" aria-label="BoringCodes Verified">
2828
<img src="https://img.shields.io/badge/boringcodes-verified-brightgreen?style=flat-square">
2929
</a>
3030
</div>
3131
</div>
3232

33+
## Features
34+
35+
- [x] Standard config
36+
- [x] Prettier config
37+
- [x] Prettier - Standard conflicts removed
38+
3339
## Installation
3440

35-
Use the package manager to install foobar
41+
Use the package manager to install
3642

3743
```bash
38-
yarn add foobar
44+
yarn add @boringcodes/eslint-config --dev
3945
```
4046

4147
## Usage
4248

43-
```javascript
44-
import foobar from 'foobar';
49+
Create `.eslintrc`/`.eslintrc.json` and add the content
4550

46-
foobar();
51+
```json
52+
{
53+
"extends": ["@boringcodes/eslint-config"]
54+
}
4755
```
4856

4957
## Contributing
@@ -58,4 +66,4 @@ Please make sure to update tests as appropriate.
5866

5967
## License
6068

61-
[MIT](https://github.com/boringcodes/repo-template/blob/master/LICENSE)
69+
[MIT](https://github.com/boringcodes/eslint-config/blob/master/LICENSE)

package.json

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"name": "@boringcodes/eslint-config",
3+
"version": "0.0.0",
4+
"description": "Boring ESLint Config",
5+
"homepage": "https://github.com/boringcodes/eslint-config",
6+
"bugs": "https://github.com/boringcodes/eslint-config/issues",
7+
"license": "MIT",
8+
"author": "BoringCodes <hi@boringcodes.com> (https://boringcodes.com)",
9+
"repository": "https://github.com/boringcodes/eslint-config.git",
10+
"main": ".eslintrc.js",
11+
"scripts": {
12+
"purge": "rm -rf node_modules",
13+
"release": "standard-version --no-verify",
14+
"release:major": "yarn release --release-as major",
15+
"release:minor": "yarn release --release-as minor",
16+
"release:patch": "yarn release --release-as patch"
17+
},
18+
"devDependencies": {
19+
"standard-version": "^6.0.1"
20+
},
21+
"peerDependencies": {
22+
"eslint": "^6.8.0",
23+
"eslint-config-prettier": "^6.10.1",
24+
"eslint-config-standard": "^14.1.1",
25+
"eslint-plugin-import": "^2.20.1",
26+
"eslint-plugin-node": "^11.0.0",
27+
"eslint-plugin-promise": "^4.2.1",
28+
"eslint-plugin-standard": "^4.0.1"
29+
}
30+
}

0 commit comments

Comments
 (0)