README

Atlassian FECQ ESLint Configuration

The source of truth for Atlassian's JavaScript Style Guide.

This ESLint configuration is part of the Front End Code Quality project and should be used to extend your local ESLint config to pull in Atlassian's preferred styles and linting requirements for JavaScript.

Please take a look at the ESLint configuration in this project to understand the style and lint guidelines for Atlassian.

Requirements:

NodeJS >= 4
npm >= 3

To use this ESLint configuration in your project, extend it in your .eslintrc.

First install it as the npm module:

gt; npm install --save-dev @atlassian/eslint-config-atlassian-fecq

Then add it to the .eslintrc that you want to extend and override config properties for your project.

{
    "extends": "@atlassian/atlassian-fecq",

    // override default rules, envs, globals
    "rules": {
        ...
    }
}

Automatic setup

You can run the following command from your project directory to automatically set up your repo:

./node_modules/@atlassian/eslint-config-atlassian-fecq/setup.js

Just follow the prompts!

Publishing this package

This package is published to the public npm registry. Use npm run release.

Changelog

3.0.1

Replace vulnerable prompt library with inquirer (used by setup.js for interactive CLI)

3.0.0

Require eslint>=4.0.0
Dependency upgrades, jest test added
No longer explicitly published to the private registry

2.0.1

Add .npmrc for publishing to the public registry

2.0.0

Removed default rules (since ESLint 1.x all rules are turned off by default)
ESLint >= 1 is now a dependency to avoid conflicts with older versions where many rules were turned on by default
Removed the "env" and "globals" sections from config. "env" in particular was wrong to include in a base config.

1.0.1

Remove duplicated strict entry

1.0.0

Rename from "atlassian-style-guide" to "atlassian-fecq"

0.1.3

Add setup script

Usage no npm install needed!