This package is deprecated, use eslint-config-generator instead.

eslint-config-yprox

ESLint configuration for our Yprox CMS apps

Features

• Include AirBnb standard
• Include Prettier (optional)
• Include Vue ESLint plugin
• Include @yproximite/eslint-config-base
• Configure indendation to 2 spaces
• Configure max length line to 180 chars
• Configure semicolon (always use ;, it's more safe)
• Disable rule no-param-reassign for props
• Disable rule func-names
• Disable rule import/prefer-default-export

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-yprox eslint@^7.0.0 babel-eslint@^10.0.0

Usage

Edit your ESLint configuration file with:

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

or with Prettier support:

{
  "extends": ["@yproximite/yprox/prettier"]
}

Note: you should install Prettier yourself with `yarn add --dev prettier@^2.0.0

---

How to contribute

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 GitHub Actions and semantic-release when you merge a pull request.