payloadcms/eslint-config

The official Payload ESLint config

Payload CMS ESLint Config

An ESLint config for Payload projects.

Installation

$ npm i --save-dev @payloadcms/eslint-config
$ npm info @payloadcms/eslint-config peerDependencies
$ npm i --save-dev <dependency>@<version> # for each dependency in the above output
$ # or
$ yarn add --dev @payloadcms/eslint-config
$ yarn info @payloadcms/eslint-config peerDependencies
$ yarn add --dev <dependency>@<version> # for each dependency in the above output

Usage

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

{
  "extends": "@payloadcms"
}

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

{
  test: /\.js$/,
  exclude: /node_modules/,
  loader: 'eslint-loader',
  options: {
    fix: true,
    emitWarning: true,
  },
}

Demo

$ git clone git@github.com:payloadcms/eslint-config.git
$ yarn
$ yarn demo
$ open http://localhost:3000

License

MIT Copyright (c) Payload