Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jimmy-guzman/eslint-config
🔍 Another opinionated eslint config
https://github.com/jimmy-guzman/eslint-config
eslint eslint-config eslintconfig
Last synced: about 1 month ago
JSON representation
🔍 Another opinionated eslint config
- Host: GitHub
- URL: https://github.com/jimmy-guzman/eslint-config
- Owner: jimmy-guzman
- License: mit
- Created: 2024-04-06T16:34:50.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-04-13T18:16:24.000Z (9 months ago)
- Last Synced: 2024-04-13T21:57:17.119Z (9 months ago)
- Topics: eslint, eslint-config, eslintconfig
- Language: TypeScript
- Homepage: https://eslint-config.jimmy.codes
- Size: 204 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# @jimmy.codes/eslint-config
[](https://www.npmjs.com/package/@jimmy.codes/eslint-config)
[](http://www.npmtrends.com/@jimmy.codes/eslint-config)
[](https://semantic-release.gitbook.io/semantic-release)
[](https://github.com/prettier/prettier)
> 🔍 another opinionated [eslint](https://eslint.org) config
## 🛠️ Usage
> [!NOTE]
> For a better experience, make sure to use [@jimmy.codes/prettier-config](https://github.com/jimmy-guzman/prettier-config) as well.
### 🔨 Getting Started
First install the package, by running the following:
```
pnpm add -D @jimmy.codes/eslint-config
```
Then if you want a simple configuration:
```js
// eslint.config.mjs
import jimmyDotCodes from "@jimmy.codes/eslint-config";
export default jimmyDotCodes();
```
Or if you want to use [TypeScript configuration files](https://eslint.org/docs/latest/use/configure/configuration-files#typescript-configuration-files), you can do the following:
Add `--flag unstable_ts_config` to your eslint script, for example:
```json
{
"scripts": {
"lint": "eslint --flag unstable_ts_config ."
}
}
```
And add the following to your `.vscode/settings.json`:
```json
"eslint.options": {
"flags": ["unstable_ts_config"]
}
```
### 🔧 Configuration
> [!NOTE]
> By default all rules are enabled based on the project's dependencies.
This package contains rules that can be enabled or disabled as follows:
```js
import jimmyDotCodes from "@jimmy.codes/eslint-config";
export default jimmyDotCodes({
/**
* Are TypeScript rules enabled?
* @default false
*/
typescript: true,
/**
* Are React rules enabled?
* @default false
*/
react: true,
/**
* Are Astro rules enabled?
* @default false
*/
astro: true,
/**
* Are testing rules enabled?
* @default false
*/
testing: true,
});
```
Or you can turn off auto detection to disable rules based on a project's dependencies:
```js
import jimmyDotCodes from "@jimmy.codes/eslint-config";
export default jimmyDotCodes({ autoDetect: false });
```
#### TypeScript
You can also change the project location which can be helpful for monorepos:
> [!WARNING]
> This is [not recommended nor needed since the introduction of `projectService`](https://typescript-eslint.io/getting-started/typed-linting#can-i-customize-the-tsconfig-used-for-typed-linting) which this config uses by default.
```js
import jimmyDotCodes from "@jimmy.codes/eslint-config";
export default jimmyDotCodes({
typescript: {
project: ["./tsconfig.eslint.json", "./packages/*/tsconfig.json"],
},
});
```
#### Testing
By default [vitest](https://vitest.dev) is used as the testing framework but you can override and add additional rules for utilities:
```js
import jimmyDotCodes from "@jimmy.codes/eslint-config";
export default jimmyDotCodes({
testing: {
framework: "jest",
utilities: ["testing-library"],
},
});
```
#### React
You can add additional rules for utilities:
```js
import jimmyDotCodes from "@jimmy.codes/eslint-config";
export default jimmyDotCodes({
react: {
utilities: ["@tanstack/query"],
},
});
```
#### Extending the Configuration
You can also extend the configuration:
```js
import jimmyDotCodes from "@jimmy.codes/eslint-config";
export default jimmyDotCodes(
{
configs: [
{
files: ["**/*.js"],
rules: {
"prefer-spread": "error",
},
},
],
},
{
rules: {
"prefer-const": "error",
},
},
);
```
You can also extend what is ignored:
```ts
import jimmyDotCodes from "@jimmy.codes/eslint-config";
export default jimmyDotCodes({
ignores: ["**/*.mjs"],
});
```
## ❤️ Credits
- [@antfu/eslint-config](https://github.com/antfu/eslint-config) by [Anthony Fu](https://antfu.me)
- [@pvtnbr/eslint-config](https://github.com/privatenumber/eslint-config) by [Hiroki Osame](https://hirok.io/)