https://github.com/neworbit/eslint-config
NewOrbit standard typescript ready eslint configuration
https://github.com/neworbit/eslint-config
hacktoberfest
Last synced: 7 months ago
JSON representation
NewOrbit standard typescript ready eslint configuration
- Host: GitHub
- URL: https://github.com/neworbit/eslint-config
- Owner: NewOrbit
- License: mit
- Created: 2019-05-28T14:29:49.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-01-14T00:31:42.000Z (over 1 year ago)
- Last Synced: 2025-01-17T18:01:11.777Z (over 1 year ago)
- Topics: hacktoberfest
- Language: JavaScript
- Homepage:
- Size: 693 KB
- Stars: 0
- Watchers: 21
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# eslint-config-neworbit
ESLint configuration for NewOrbit
## Installation
`npm install eslint eslint-config-neworbit --save-dev`
## Setup
Add `eslint.config.js` or extend existing one. Documentation: [Eslint documentation](https://eslint.org/docs/latest/use/getting-started#configuration)
```js
// @ts-check
import NewOrbitEslintConfig from "eslint-config-neworbit";
export default [
...NewOrbitEslintConfig,
/* rest of your config, e.g.:
{
plugins: {
"react-refresh": ReactRefreshPlugin,
},
rules: {
"react-refresh/only-export-components": "warn",
},
},
*/
];
```
You are ready to use it from [eslint CLI](https://eslint.org/docs/latest/use/command-line-interface), by e.g. adding a script to your `package.json`
```json
{
...
"scripts": {
...
"lint:ts": "eslint --max-warnings 0 -c eslint.config.js \"./**/*.{js,jsx,ts,tsx, mjs, mts, mjsx, mtsx}\"",
}
}
```
Or you can use it from VS Code by downloading [Microsoft ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
## License
Made with :sparkling_heart: by [NewOrbit](https://www.neworbit.co.uk/) in Oxfordshire, and licensed under the [MIT Licence](LICENCE).