https://github.com/pilaton/eslint-eco

Monorepository with all necessary ESLint configurations
https://github.com/pilaton/eslint-eco

eslint eslint-config eslint-flat-config eslint-plugin eslint-rules markdown nextjs react

Last synced: about 1 month ago
JSON representation

Monorepository with all necessary ESLint configurations

• Host: GitHub
• URL: https://github.com/pilaton/eslint-eco
• Owner: Pilaton
• License: mit
• Created: 2023-12-10T17:37:42.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-05-06T12:27:36.000Z (7 months ago)
• Last Synced: 2024-10-11T05:45:12.006Z (about 1 month ago)
• Topics: eslint, eslint-config, eslint-flat-config, eslint-plugin, eslint-rules, markdown, nextjs, react
• Language: JavaScript
• Homepage:
• Size: 522 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# eslint-eco

Monorepository with all necessary ESLint configurations.

---

> [!IMPORTANT]

> Only ESM and ESLint FlatConfig

---

Includes the following sub-packages:

1. [`@pilaton/eslint-config-base`](./packages/base/README.md)  

   The configuration includes basic JS and TS code checks.

   ![npm](https://img.shields.io/npm/v/%40pilaton%2Feslint-config-base?style=flat-square&logo=npm&labelColor=%236a6eff&color=%236a6eff)

2. [`@pilaton/eslint-config-react`](./packages/react/README.md)  

   Additional config on top of the base config if you use React in your project.

   ![npm](https://img.shields.io/npm/v/%40pilaton%2Feslint-config-react?style=flat-square&logo=npm&labelColor=%236a6eff&color=%236a6eff)

3. [`@pilaton/eslint-config-next`](./packages/next/README.md)  

   Additional config on top of react config if you use Next.js in your project.

   ![npm](https://img.shields.io/npm/v/%40pilaton%2Feslint-config-next?style=flat-square&logo=npm&labelColor=%236a6eff&color=%236a6eff)

4. [`@pilaton/eslint-config-markdown`](./packages/markdown/README.md)  

   Config for linting .md and .mdx files.

   ![npm](https://img.shields.io/npm/v/%40pilaton%2Feslint-config-markdown?style=flat-square&logo=npm&labelColor=%236a6eff&color=%236a6eff)

## Install

```bash

npm i @pilaton/eslint-config-[NAME] --save-dev

```

[NAME]: **base**, **react**, **next** or **markdown**

## Usage

### [`eslint.config.js`](https://eslint.org/docs/latest/use/configure/configuration-files-new) (eslint>=v8.23.1)

```js

import base from '@pilaton/eslint-config-base';

import markdown from '@pilaton/eslint-config-markdown';

import next from '@pilaton/eslint-config-next';

import react from '@pilaton/eslint-config-react';

export default [

  ...base,

  ...react,

  ...next,

  ...markdown,

  {

    // Your config

  },

];

```