@atlassian-partner-engineering/eslint-config

@atlassian-partner-engineering/eslint-config

ESLint Shareable Config

Note

The idea was to have strict linter config which would fit the best for all the projects and not too annoying to work with.

ESLint recommended config was taken as a basis, expanded with Create React App ESLint config and with some custom rules requested by the team.

This config includes:

• ESLint recommended configuration (all rules with ✔️)
• Standard
• Create React App EsLint config
• Jest
• Security
• TypeScript ESLint
• Prettier
• custom rules

This config can be used both on server and client side.

Install

npm install -D @atlassian-partner-engineering/eslint-config

Usage

Shareable configs are designed to work with the extends feature of .eslintrc.json files. You can learn more about Shareable Config on the official ESLint website.

Add this to your .eslintrc.js file:

// This resolves https://github.com/eslint/eslint/issues/3458
require("@rushstack/eslint-patch/modern-module-resolution")

module.exports = {
  extends: '@atlassian-partner-engineering'
}

Note: We omitted the eslint-config from the full package name since it is automatically assumed by ESLint.

You can override settings from the shareable config by adding them directly into your .eslintrc.js file.

If you use VS Code as your code editor you can turn Auto Fix for ESLint:

"editor.codeActionsOnSave": {
  "source.fixAll.eslint": true
}

Check out detailed documentation of ESLint extension.

Publishing this library

To publish this library:

npm version <patch|minor|major>
npm publish

Don't forget to push commit and tag to the remote:

git push --follow-tags