https://github.com/inveniem/eslint-config
Inveniem's reusable ESLint configuration
https://github.com/inveniem/eslint-config
Last synced: 3 months ago
JSON representation
Inveniem's reusable ESLint configuration
- Host: GitHub
- URL: https://github.com/inveniem/eslint-config
- Owner: Inveniem
- License: mit
- Created: 2022-09-09T16:01:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-24T17:33:19.000Z (about 2 years ago)
- Last Synced: 2025-02-15T21:08:04.713Z (4 months ago)
- Language: JavaScript
- Size: 16.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @inveniem/eslint-config
This package provides Inveniem's ESLint configuration as an extensible shared
configuration.
## Setup
1. Install this package
* If using Yarn, run `yarn add --dev @inveniem/eslint-config`
* If using npm, run `npm install --save-dev @inveniem/eslint-config`
2. Run `npx install-peerdeps --dev @inveniem/eslint-config`
3. Create an _.eslintrc.js_ file with the following contents:
```javascript
module.exports = {
extends: '@inveniem/eslint-config',
};
```
## Usage
To run ESLint with this configuration, consider adding a `lint:js:eslint` script
to the `scripts` section of _package.json_ with the following value:
```
eslint --no-error-on-unmatched-pattern --report-unused-disable-directives --max-warnings=0 --ext .js --ext .ts --ext .jsx --ext .tsx .
```
Then, run `yarn lint:js:eslint` (if using Yarn) or `npm run lint:js:eslint` (if
using npm) to run it.