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
astro eslint eslint-config eslint-flat-compatibility eslintconfig javascript jest jsdoc lint linting nextjs playwright storybook typescript vitest
Last synced: 25 days 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 (10 months ago)
- Default Branch: main
- Last Pushed: 2024-12-12T03:22:46.000Z (about 2 months ago)
- Last Synced: 2024-12-17T00:44:49.647Z (about 2 months ago)
- Topics: astro, eslint, eslint-config, eslint-flat-compatibility, eslintconfig, javascript, jest, jsdoc, lint, linting, nextjs, playwright, storybook, typescript, vitest
- Language: TypeScript
- Homepage: https://eslint-config.jimmy.codes
- Size: 1.24 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
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 all you need to in your `eslint.config.js` is:
```mjs
import eslintConfig from "@jimmy.codes/eslint-config";
export default eslintConfig();
```
Which will enable rules based on your project dependencies.
### 🔧 Configuration
This package contains rules that can be enabled or disabled as follows:
```ts
import eslintConfig from "@jimmy.codes/eslint-config";
export default eslintConfig({
astro: false,
jest: false,
nextjs: false,
playwright: false,
react: false,
storybook: false,
tanstackQuery: false,
testingLibrary: false,
typescript: false,
vitest: false,
});
```
Or you can turn off auto detection to disable rules based on a project's dependencies:
```ts
import eslintConfig from "@jimmy.codes/eslint-config";
export default eslintConfig({ autoDetect: false });
```
#### Extending/overriding the Configuration
You can also extend or override the configuration:
```ts
import eslintConfig from "@jimmy.codes/eslint-config";
export default eslintConfig({
overrides: [
{
files: ["**/*.js"],
rules: {
"prefer-spread": "error",
},
},
{
files: ["**/*.ts"],
rules: {
"prefer-const": "error",
},
},
],
});
```
Or pass configs as additional arguments:
```ts
import eslintConfig from "@jimmy.codes/eslint-config";
export default eslintConfig(
{},
{
files: ["**/*.js"],
rules: {
"prefer-spread": "error",
},
},
{
files: ["**/*.ts"],
rules: {
"prefer-const": "error",
},
},
);
```
#### Ignores
You can also extend what is ignored:
```ts
import eslintConfig from "@jimmy.codes/eslint-config";
export default eslintConfig({
ignores: ["**/*.mjs"],
});
```
### TypeScript Configuration Files
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"]
}
}
```
## ❤️ 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/)