Skip to content

Commit

Permalink
docs: @nft-team/eslint-config 문서 README.md 생성
Browse files Browse the repository at this point in the history
  • Loading branch information
saseungmin committed Jul 9, 2023
1 parent d254263 commit d79552c
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 2 deletions.
7 changes: 6 additions & 1 deletion packages/eslint/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
# @nft-team/eslint-config

## 1.0.1

### Patch Changes

- docs: @nft-team/eslint-config 문서 README.md 생성

## 1.0.0

### Major Changes

- @nft-team/eslint-config 초기 publish

45 changes: 45 additions & 0 deletions packages/eslint/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# 🚧 WIP 🚧 @nft-team/eslint-config

<a href="https://github.com/mbti-nf-team/frontend-libraries/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">
<img src="https://img.shields.io/github/issues/mbti-nf-team/frontend-libraries?style=flat-square" />
</a>

<a href="https://github.com/mbti-nf-team/frontend-libraries/blob/main/LICENSE">
<img src="https://img.shields.io/github/license/mbti-nf-team/frontend-libraries?style=flat-square">
</a>

## 🚀 Quick Overview

Install `@nft-team/eslint-config` dependency

```bash
npm install --save-dev @nft-team/eslint-config
```

Add `@nft-team/eslint-config` to `extends` in your `.eslintrc`

```js
module.exports = {
// ...
extends: ['@nft-team/eslint-config'],
rules: {
// ...
},
};
```

## 🤔 What eslint extensions does `@nft-team/eslint-config` have?
- [eslint-config-airbnb](https://www.npmjs.com/package/eslint-config-airbnb)
- [eslint-config-airbnb-typescript](https://www.npmjs.com/package/eslint-config-airbnb-typescript)
- [eslint-plugin-react](https://www.npmjs.com/package/eslint-plugin-react)
- [eslint-plugin-react-hooks](https://www.npmjs.com/package/eslint-plugin-react-hooks)
- [eslint-plugin-simple-import-sort](https://www.npmjs.com/package/eslint-plugin-simple-import-sort)
- [eslint-plugin-unused-imports](https://www.npmjs.com/package/eslint-plugin-unused-imports)

[View more extensions..](https://github.com/mbti-nf-team/frontend-libraries/blob/main/packages/eslint/index.js)

## 🐛 Bug reporting
[Issues](https://github.com/mbti-nf-team/frontend-libraries/issues)

## 🔒 LICENSE
This Project is [MIT licensed](https://github.com/mbti-nf-team/frontend-libraries/blob/main/LICENSE).
11 changes: 10 additions & 1 deletion packages/eslint/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@nft-team/eslint-config",
"version": "1.0.0",
"version": "1.0.1",
"description": "nft team eslint config",
"main": "index.js",
"license": "MIT",
Expand All @@ -9,6 +9,15 @@
"name": "SEUNGMIN SA (Harang)",
"url": "https://github.com/saseungmin"
},
"keywords": [
"nft-team",
"eslint-config-airbnb",
"eslint-config-airbnb-typescript",
"eslint-import",
"eslint-plugin-react",
"eslint-plugin-simple-import-sort",
"eslint-plugin-unused-imports"
],
"repository": {
"type": "git",
"url": "https://github.com/mbti-nf-team/frontend-libraries.git"
Expand Down

0 comments on commit d79552c

Please sign in to comment.