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

My default ESLint config
https://github.com/willclarktech/eslint-config-willclarktech

Last synced: 17 days ago
JSON representation

My default ESLint config

• Host: GitHub
• URL: https://github.com/willclarktech/eslint-config-willclarktech
• Owner: willclarktech
• Created: 2023-01-06T18:07:08.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-27T12:59:45.000Z (3 months ago)
• Last Synced: 2024-10-28T13:41:33.496Z (3 months ago)
• Language: JavaScript
• Size: 478 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# eslint-config-willclarktech

Default ESLint configuration for personal projects.

## Installation

Install the package:

```sh

npm install --save-dev https://github.com/willclarktech/eslint-config-willclarktech

```

Install the required peer dependencies:

```sh

npm install --save-dev eslint eslint-config-prettier eslint-plugin-functional eslint-plugin-import eslint-plugin-jest eslint-plugin-prettier

```

For TS projects also install these optional dependencies:

```sh

npm install --save-dev @typescript-eslint/eslint-plugin @typescript-eslint/parser

```

For React projects also install these optional dependencies:

```sh

npm install --save-dev eslint-config-react-app eslint-plugin-i18next eslint-plugin-react

```

## Usage

In JS/TS projects extend from the default config in your ESLint configuration file `eslint.config.mjs`:

```js

import willclarktechConfig from "eslint-config-willclarktech";

const config = [...willclarktechConfig];

export default config;

```

For TS projects, mark the `tsconfigRootDir` for detecting the location of the correct `tsconfig.json`:

```js

import willclarktechConfig from "eslint-config-willclarktech";

const config = [

	...willclarktechConfig,

	// Make sure correct `tsconfig.json` is found eg in a monorepo

	{ parserOptions: { tsconfigRootDir: __dirname } },

];

export default config;

```

In React projects extend from the `react` config:

```js

module.exports = {

	extends: ["eslint-config-willclarktech/react"],

};

```

If you are using this config in a monorepo, and experiencing the error `ESLint couldn't determine the plugin "xxx" uniquely`, you can apply this patch in your `eslint.config.mjs` file to solve the issue:

```js

import "eslint-config-willclarktech/patch/modern-module-resolution.mjs";

```

This is just a wrapper around [`@rushstack/eslint-patch/modern-module-resolution`](https://github.com/microsoft/rushstack/tree/76315fdd164c3afb61813f03b571858d547965b5/eslint/eslint-patch#modern-module-resolution-feature).

## Known issues

1. ESLint has some issues in monorepos as a result of its [dependency resolution method](https://eslint.org/blog/2022/08/new-config-system-part-2/#:~:text=Use%20native%20loading,JavaScript%20runtime%20directly), which requires us to install ESLint plugins in both the client project and the ESLint config itself.

   1. This should be solved by ESLint's [new flat config system](https://eslint.org/blog/2022/08/new-config-system-part-1/).