-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into typescript-react-eslint-config
- Loading branch information
Showing
5 changed files
with
296 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,71 @@ | ||
| # @singularit/eslint-config [](https://npmjs.com/package/@singularit/eslint-config) | ||
|
|
||
| ## Usage | ||
|
|
||
| ### Install | ||
|
|
||
| ```bash | ||
| npm install eslint @singularit/eslint-config -D | ||
| ``` | ||
|
|
||
| ### Config .eslintrc.js | ||
|
|
||
| ```javascript | ||
| module.exports = { | ||
| extends: "@singularit" | ||
| } | ||
| ``` | ||
|
|
||
| ### Add script for package.json | ||
|
|
||
| For example: | ||
|
|
||
| ```json | ||
| { | ||
| "scripts": { | ||
| "lint": "eslint .", | ||
| "lint:fix": "eslint . --fix" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Githooks with `husky` and `lint-staged` | ||
|
|
||
| 1. Install and setup husky | ||
|
|
||
| ```bash | ||
| npx husky-init && npm install | ||
| ``` | ||
|
|
||
| 2. Add `lint-staged` to pre-commit hook | ||
|
|
||
| ```diff | ||
| # .husky/pre-commit | ||
|
|
||
| #!/usr/bin/env sh | ||
| . "$(dirname -- "$0")/_/husky.sh" | ||
|
|
||
| - npm test | ||
| + npx lint-staged | ||
| ``` | ||
|
|
||
| 3. Configure `lint-staged` | ||
|
|
||
| ```diff | ||
| // package.json | ||
| { | ||
| ... | ||
| + "lint-staged": { | ||
| + "*.{js,jsx,ts,tsx,vue,md,yml,yaml}": "eslint --fix --max-warnings 0" | ||
| + } | ||
| ... | ||
| } | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| MIT | ||
|
|
||
| ## Credits | ||
|
|
||
| - [antfu/eslint-config](https://github.com/antfu/eslint-config) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,71 @@ | ||
| # @singularit/eslint-config-basic [](https://npmjs.com/package/@singularit/eslint-config-basic) | ||
|
|
||
| ## Usage | ||
|
|
||
| ### Install | ||
|
|
||
| ```bash | ||
| npm install eslint @singularit/eslint-config-basic -D | ||
| ``` | ||
|
|
||
| ### Config .eslintrc.js | ||
|
|
||
| ```javascript | ||
| module.exports = { | ||
| extends: "@singularit" | ||
| } | ||
| ``` | ||
|
|
||
| ### Add script for package.json | ||
|
|
||
| For example: | ||
|
|
||
| ```json | ||
| { | ||
| "scripts": { | ||
| "lint": "eslint .", | ||
| "lint:fix": "eslint . --fix" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Githooks with `husky` and `lint-staged` | ||
|
|
||
| 1. Install and setup husky | ||
|
|
||
| ```bash | ||
| npx husky-init && npm install | ||
| ``` | ||
|
|
||
| 2. Add `lint-staged` to pre-commit hook | ||
|
|
||
| ```diff | ||
| # .husky/pre-commit | ||
|
|
||
| #!/usr/bin/env sh | ||
| . "$(dirname -- "$0")/_/husky.sh" | ||
|
|
||
| - npm test | ||
| + npx lint-staged | ||
| ``` | ||
|
|
||
| 3. Configure `lint-staged` | ||
|
|
||
| ```diff | ||
| // package.json | ||
| { | ||
| ... | ||
| + "lint-staged": { | ||
| + "*.{js,jsx,md,yml,yaml}": "eslint --fix --max-warnings 0" | ||
| + } | ||
| ... | ||
| } | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| MIT | ||
|
|
||
| ## Credits | ||
|
|
||
| - [antfu/eslint-config](https://github.com/antfu/eslint-config) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,71 @@ | ||
| # @singularit/eslint-config-typescript [](https://npmjs.com/package/@singularit/eslint-config-typescript) | ||
|
|
||
| ## Usage | ||
|
|
||
| ### Install | ||
|
|
||
| ```bash | ||
| npm install eslint @singularit/eslint-config-typescript -D | ||
| ``` | ||
|
|
||
| ### Config .eslintrc.js | ||
|
|
||
| ```javascript | ||
| module.exports = { | ||
| extends: "@singularit" | ||
| } | ||
| ``` | ||
|
|
||
| ### Add script for package.json | ||
|
|
||
| For example: | ||
|
|
||
| ```json | ||
| { | ||
| "scripts": { | ||
| "lint": "eslint .", | ||
| "lint:fix": "eslint . --fix" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Githooks with `husky` and `lint-staged` | ||
|
|
||
| 1. Install and setup husky | ||
|
|
||
| ```bash | ||
| npx husky-init && npm install | ||
| ``` | ||
|
|
||
| 2. Add `lint-staged` to pre-commit hook | ||
|
|
||
| ```diff | ||
| # .husky/pre-commit | ||
|
|
||
| #!/usr/bin/env sh | ||
| . "$(dirname -- "$0")/_/husky.sh" | ||
|
|
||
| - npm test | ||
| + npx lint-staged | ||
| ``` | ||
|
|
||
| 3. Configure `lint-staged` | ||
|
|
||
| ```diff | ||
| // package.json | ||
| { | ||
| ... | ||
| + "lint-staged": { | ||
| + "*.{js,jsx,ts,tsx,md,yml,yaml}": "eslint --fix --max-warnings 0" | ||
| + } | ||
| ... | ||
| } | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| MIT | ||
|
|
||
| ## Credits | ||
|
|
||
| - [antfu/eslint-config](https://github.com/antfu/eslint-config) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,71 @@ | ||
| # @singularit/eslint-config-vue [](https://npmjs.com/package/@singularit/eslint-config-vue) | ||
|
|
||
| ## Usage | ||
|
|
||
| ### Install | ||
|
|
||
| ```bash | ||
| npm install eslint @singularit/eslint-config-vue -D | ||
| ``` | ||
|
|
||
| ### Config .eslintrc.js | ||
|
|
||
| ```javascript | ||
| module.exports = { | ||
| extends: "@singularit" | ||
| } | ||
| ``` | ||
|
|
||
| ### Add script for package.json | ||
|
|
||
| For example: | ||
|
|
||
| ```json | ||
| { | ||
| "scripts": { | ||
| "lint": "eslint .", | ||
| "lint:fix": "eslint . --fix" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Githooks with `husky` and `lint-staged` | ||
|
|
||
| 1. Install and setup husky | ||
|
|
||
| ```bash | ||
| npx husky-init && npm install | ||
| ``` | ||
|
|
||
| 2. Add `lint-staged` to pre-commit hook | ||
|
|
||
| ```diff | ||
| # .husky/pre-commit | ||
|
|
||
| #!/usr/bin/env sh | ||
| . "$(dirname -- "$0")/_/husky.sh" | ||
|
|
||
| - npm test | ||
| + npx lint-staged | ||
| ``` | ||
|
|
||
| 3. Configure `lint-staged` | ||
|
|
||
| ```diff | ||
| // package.json | ||
| { | ||
| ... | ||
| + "lint-staged": { | ||
| + "*.{js,jsx,ts,tsx,vue,md,yml,yaml}": "eslint --fix --max-warnings 0" | ||
| + } | ||
| ... | ||
| } | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| MIT | ||
|
|
||
| ## Credits | ||
|
|
||
| - [antfu/eslint-config](https://github.com/antfu/eslint-config) |