theoludwig/eslint-config-conventions
theoludwig/eslint-config-conventions
1
1
Fork 0
mirror of https://github.com/theoludwig/eslint-config-conventions.git synced 2024-12-18 21:45:04 +01:00
Code Issues Releases Activity

docs: simplify README

Browse Source
This commit is contained in:
Théo LUDWIG 2023-07-02 16:02:28 +02:00
parent f5a69d69f5
commit 34ec74cff7
Signed by: theoludwig
GPG Key ID: ADFE5A563D718F3B
1 changed files with 8 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -35,9 +35,6 @@ More information about **formatting rules** vs **code-quality rules** can be fou
### Installation ### Installation
`npm@<7` does not automatically install `peerDependencies`, so if that's what you're using, install them manually.
Here is an example, but use it only for reference, because your decisions regarding version ranges and range specifiers may vary.
```sh ```sh
npm install --save-dev \ npm install --save-dev \
eslint@^8.44.0 \ eslint@^8.44.0 \
@ -47,7 +44,7 @@ npm install --save-dev \
eslint-config-conventions@latest eslint-config-conventions@latest
``` ```
Yes, this is a large number of packages. This is due to [a known limitation in ESLint](https://github.com/eslint/eslint/issues/3458). This is a large number of packages due to [a known limitation in ESLint](https://github.com/eslint/eslint/issues/3458).
This list of dependencies are: This list of dependencies are:
@ -63,15 +60,15 @@ If you want to use **TypeScript**, you also need to install:
```sh ```sh
npm install --save-dev \ npm install --save-dev \
typescript@^5.0.4 \ typescript@^5.0.4 \
@typescript-eslint/eslint-plugin@^5.59.5 \ @typescript-eslint/eslint-plugin@^5.60.1 \
@typescript-eslint/parser@^5.59.5 @typescript-eslint/parser@^5.60.1
``` ```
Dependencies are: Dependencies are:
- [TypeScript](https://github.com/Microsoft/TypeScript) - [TypeScript](https://github.com/Microsoft/TypeScript)
- [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint); ESLint rules for TypeScript. - [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint): ESLint rules for TypeScript.
- [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint); ESLint parser for TypeScript. - [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint): ESLint parser for TypeScript.
### Configuration with [Prettier](https://prettier.io/) (recommended) ### Configuration with [Prettier](https://prettier.io/) (recommended)
@ -82,7 +79,7 @@ npm install --save-dev prettier eslint-config-prettier eslint-plugin-prettier
# Create an empty config file to let editors and other tools know you are using Prettier # Create an empty config file to let editors and other tools know you are using Prettier
# You can personalize it with your own rules # You can personalize it with your own rules
echo {}> .prettierrc.json echo "{}" > .prettierrc.json
``` ```
#### `.eslintrc.json` #### `.eslintrc.json`
@ -109,8 +106,8 @@ echo {}> .prettierrc.json
```jsonc ```jsonc
{ {
"scripts": { "scripts": {
"lint:eslint": "eslint \"**/*.{js,jsx,ts,tsx}\" --ignore-path \".gitignore\"", "lint:eslint": "eslint . --ignore-path .gitignore",
"lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\"" "lint:prettier": "prettier . --check --ignore-path .gitignore"
} }
} }
``` ```