https://github.com/robot-inventor/eslint-config
My ESLint config preset
https://github.com/robot-inventor/eslint-config
Last synced: 8 months ago
JSON representation
My ESLint config preset
- Host: GitHub
- URL: https://github.com/robot-inventor/eslint-config
- Owner: Robot-Inventor
- License: mit
- Created: 2024-04-09T15:59:34.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-07T21:50:21.000Z (9 months ago)
- Last Synced: 2025-03-08T21:03:54.035Z (9 months ago)
- Language: TypeScript
- Size: 785 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-config
[@Robot-Inventor](https://github.com/Robot-Inventor/)'s ESLint config preset.
## Installation
Then, install the package:
```bash
npm install --save-dev @robot-inventor/eslint-config
```
## Usage
Add the following to your ``eslint.config.js`` file:
```javascript
// ESModule
import { eslintConfig } from "@robot-inventor/eslint-config";
export default eslintConfig;
```
```javascript
// CommonJS
const { eslintConfig } = require("@robot-inventor/eslint-config");
module.exports = eslintConfig;
```
If you don't need JSDoc rules, you can use the ``eslintConfigNoJSDoc`` instead.
```javascript
// ESModule
import { eslintConfigNoJSDoc } from "@robot-inventor/eslint-config";
export default eslintConfigNoJSDoc;
```
```javascript
// CommonJS
const { eslintConfigNoJSDoc } = require("@robot-inventor/eslint-config");
module.exports = eslintConfigNoJSDoc;
```
You can extend or override the config as needed.
```javascript
// ESModule
import { eslintConfig } from "@robot-inventor/eslint-config";
export default [
...eslintConfig,
{
rules: {
// Your rules here
}
}
];
```
```javascript
// CommonJS
const { eslintConfig } = require("@robot-inventor/eslint-config");
module.exports = [
...eslintConfig,
{
rules: {
// Your rules here
}
}
];
```