README.md

eslint-config-wordpress

ESLint configuration for our Wordpress projects

Features

• Include AirBnb standard
• Include Prettier
• Include @yproximite/eslint-config-base
• Configure jQuery as a global dependency ($ and jQuery vars)

Installation

This package is hosted on GitHub Packages, so you must tell to npm/yarn where to download it. Please read Authenticating to GitHub Packages.

You can run npm login --registry=https://npm.pkg.github.com --scope=@yproximite or create a .npmrc file with the following content:

@yproximite:registry=https://npm.pkg.github.com/
//npm.pkg.github.com/:_authToken=<access token>

Then run:

$ yarn add --dev @yproximite/eslint-config-wordpress eslint@^6.0.0 babel-eslint@^10.0.0 prettier@^1.18.0

Usage

Edit your ESLint configuration file with:

{
  "extends": ["@yproximite/wordpress"]
}

Development workflow

You need to install some dependencies first:

$ yarn

Contribution

• Make a pull request, its title should follows Angular commit message convention
• You should Squash and Merge your pull request

Publishing a new release

This is automatically done by Travis and semantic-release when you merge a pull request.