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

The official Payload ESLint config
https://github.com/payloadcms/eslint-config

Last synced: 9 months ago
JSON representation

The official Payload ESLint config

• Host: GitHub
• URL: https://github.com/payloadcms/eslint-config
• Owner: payloadcms
• License: mit
• Created: 2023-02-16T18:50:29.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-07-06T15:40:03.000Z (over 2 years ago)
• Last Synced: 2025-06-26T16:03:37.548Z (9 months ago)
• Language: JavaScript
• Homepage:
• Size: 39.1 KB
• Stars: 4
• Watchers: 4
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![NPM](https://img.shields.io/npm/v/@payloadcms/eslint-config)](https://www.npmjs.com/@payloadcms/eslint-config)

![Bundle Size](https://img.shields.io/bundlephobia/minzip/@payloadcms/eslint-config?label=zipped)

# Payload CMS ESLint Config

An [ESLint](https://github.com/eslint/eslint) config for [Payload](https://github.com/payloadcms/payload) projects.

### Installation

```bash

$ npm i --save-dev @payloadcms/eslint-config

$ npm info @payloadcms/eslint-config peerDependencies

$ npm i --save-dev @ # for each dependency in the above output

$ # or

$ yarn add --dev @payloadcms/eslint-config

$ yarn info @payloadcms/eslint-config peerDependencies

$ yarn add --dev @ # for each dependency in the above output

```

### Usage

In your ESLint config file, extend the config (`.eslintrc`, `.eslintrc.js`, `eslint.json`, etc):

```javascript

{

  "extends": "@payloadcms"

}

```

If using Webpack, install and configure `eslint-loader` to have loaded files automatically linted.

```javascript

{

  test: /\.js$/,

  exclude: /node_modules/,

  loader: 'eslint-loader',

  options: {

    fix: true,

    emitWarning: true,

  },

}

```

## Demo

```bash

$ git clone git@github.com:payloadcms/eslint-config.git

$ yarn

$ yarn demo

$ open http://localhost:3000

```

## License

[MIT](https://github.com/payloadcms/eslint-config/blob/master/LICENSE) Copyright (c) Payload