Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/arslivinski/eslint-config

Personal set of ESLint configurations
https://github.com/arslivinski/eslint-config

eslint eslint-config eslintconfig

Last synced: about 22 hours ago
JSON representation

Personal set of ESLint configurations

Host: GitHub
URL: https://github.com/arslivinski/eslint-config
Owner: arslivinski
License: isc
Created: 2021-01-20T21:43:59.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2023-02-26T19:20:34.000Z (almost 2 years ago)
Last Synced: 2025-01-18T08:43:40.843Z (28 days ago)
Topics: eslint, eslint-config, eslintconfig
Language: JavaScript
Homepage:
Size: 969 KB
Stars: 3
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md

Awesome Lists containing this project

README

# @arslivinski/eslint-config

A very opinionated ESLint configuration, mostly focused on web development.

## Usage

This configuration requires ESLint >= 8.35.0

To install, run:

```sh
npm install -D eslint@^8.35.0 @arslivinski/eslint-config
```

Then create a `.eslintrc.js`:

```js
'use strict';

module.exports = {
extends: ['@arslivinski'],
};
```

Now you can run:

```sh
npm exec eslint -- ./
```

### React

This configuration also provides a set of rules for React projects. To use it,
you have to install these extra packages:

```sh
npm install -D eslint-plugin-react eslint-plugin-react-hooks
```

and extend this config on your `.eslintrc.js`

```js
'use strict';

module.exports = {
extends: ['@arslivinski/eslint-config', '@arslivinski/eslint-config/module', '@arslivinski/eslint-config/browser'],
overrides: [
{
files: ['*.jsx'],
extends: ['@arslivinski/eslint-config/react'],
},
],
};
```

### TypeScript

This configuration also provides a set of rules for TypeScript projects. To use
you have to install these extra packages:

```sh
npm install -D typescript @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-import-resolver-typescript
```

and extend this config on your `.eslintrc.js`

```js
'use strict';

module.exports = {
extends: ['@arslivinski/eslint-config'],
overrides: [
{
files: ['*.ts'],
parserOptions: {
tsconfigRootDir: __dirname,
project: ['./tsconfig.json'],
},
settings: {
'import/resolver': {
typescript: {
project: './tsconfig.json',
},
},
},
extends: ['@arslivinski/eslint-config/module', '@arslivinski/eslint-config/typescript'],
},
],
};
```

### React and TypeScript

It's possible to mix them both. To use this way you have to install these extra
packages:

```sh
npm install -D eslint-plugin-react eslint-plugin-react-hooks typescript @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-import-resolver-typescript
```

and extend this config on your `.eslintrc.js`

```js
'use strict';

module.exports = {
extends: ['@arslivinski/eslint-config'],
overrides: [
{
files: ['*.ts', '*.tsx'],
parserOptions: {
tsconfigRootDir: __dirname,
project: ['./tsconfig.json'],
},
settings: {
'import/resolver': {
typescript: {
project: './tsconfig.json',
},
},
},
extends: [
'@arslivinski/eslint-config/typescript',
'@arslivinski/eslint-config/module',
'@arslivinski/eslint-config/browser',
],
},
{
files: ['*.tsx'],
extends: ['@arslivinski/eslint-config/react'],
},
],
};
```

### Node

You can use this configuration for pure Node applications. For this, you need to
install the following extra package:

```sh
npm install -D eslint-plugin-n
```

Then, you need to set the Node version on the `engine` field of your `package.json`.
Example:

```json
{
"name": "your-module",
"version": "1.0.0",
"engines": {
"node": ">=18.14.0"
}
}
```

and finally, extend this config on your `.eslintrc.js`. If you are using modules:

```js
'use strict';

module.exports = {
extends: ['@arslivinski/eslint-config', '@arslivinski/eslint-config/module', '@arslivinski/eslint-config/node'],
};
```

...or if you are using CommonJS:

```js
'use strict';

module.exports = {
extends: ['@arslivinski/eslint-config', '@arslivinski/eslint-config/commonjs', '@arslivinski/eslint-config/node'],
};
```

## Modules

This package provide the following modules to be used