Skip to content

Commit

Permalink
docs(eslint-config-typescript): add the usage section of README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
trylovetom committed Feb 23, 2020
1 parent a6ded86 commit 0c40fe3
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
27 changes: 27 additions & 0 deletions packages/ESLintConfig/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,29 @@
# ESLintConfig
> The ESLint Config Be Used For AllJointNext
## Usage
1. Installation
```sh
yarn add eslint prettier @alljoint-next/eslint-config --dev
# npm install eslint prettier @alljoint-next/eslint-config --save-dev
```

2. Setup Configuration
```sh
echo '{ "extends": "@alljoint-next" }' > .eslintrc.json
echo '!**/node_modules/**
!./node_modules/**
!**/.{git,svn,hg}/**
!./.{git,svn,hg}/**' > .eslintignore
```

3. Add Scripts
package.json
```json
{
"scripts": {
"format": "prettier **/*.{js,json,md,yaml} --write && yarn lint --fix",
"lint": "eslint **/*.js"
}
}
```
2 changes: 1 addition & 1 deletion packages/ESLintConfig/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@alljoint-next/eslint-config",
"version": "0.1.0",
"description": "The ESLint Config Used For AllJointNext",
"description": "The ESLint Config Be Used For AllJointNext",
"author": "TZU-YEN, CHANG <[email protected]>",
"license": "GPL-3.0",
"main": ".eslintrc.json",
Expand Down

0 comments on commit 0c40fe3

Please sign in to comment.