ESLint configuration for ECMAScript 6+

The purpose of this package is to share JavaScript Code Styling within Isaac BV for ECMAScript 6 and higher. The configuration extends the airbnb configuration.

How to configure

Install npm package

npm i -D @isaac.frontend/eslint-config-es6

Create .eslintrc.json

{
	"extends": "@isaac.frontend/eslint-config-es6"
}

Sync your IDE JavaScript Code Style with the ESLint rules

PHPStorm

If you have not done already, create a new ECMAScript 6 Isaac Scheme in your IDE JavaScript Code Style:

1. Go to your project preferences ⇢ Editor ⇢ Code Style ⇢ JavaScript
2. Select a scheme stored in your IDE
3. Then click the settings icon and select Duplicate
4. Rename your scheme, example: Isaac ES6

PHPStorm 2017.3+ supports auto apply rules from eslint to your code style scheme, see import eslint configuration.

1. Open the created file .eslintrc.json
2. Right click and select the Apply ESLint Code Style Rules

Now you're done, happy coding

Visual Studio Code

Install the following extensions:

• ESLint
• Prettier - Code Formatter

Now we want Prettier to format our code based on our ESLint rules. Therefore you'll need to install prettier-eslint:

npm i -D prettier-eslint

Now setup Visual Studio Code to use autoformat on file save. Open VS Code Workspace Settings (on a mac CMD + ,) and update the following settings fields:

// Use autoformat on save
"editor.formatOnSave": true,

// Use `prettier-eslint` instead of `prettier`
"prettier.eslintIntegration": true

Updating this package

Please make sure you've created an user on npmjs and you have the rights to publish this package within the organisation @isaac.frontend. If not, please contact one of the contributors, defined in the package.json.

For release a new version use release-it.

After you've cloned this repository, did a npm install, edited and you're ready for a new release, just use npm run release ${patch|minor|major} in order to update git and publish to npmjs registry. Make shure you're registered with you SSH key to git and have a valid npm user to publish.