Skip to content

Latest commit

 

History

History
85 lines (59 loc) · 2.24 KB

README.md

File metadata and controls

85 lines (59 loc) · 2.24 KB
Raw

Eslint Config Amex - One Amex

npm Health Check

American Express' eslint config.

👩‍💻 Hiring 👨‍💻

Want to get paid for your contributions to eslint-config-amex?

Send your resume to oneamex.careers@aexp.com

📖 Table of Contents

🤹‍ Usage

Installation

npm install --save-dev eslint-config-amex

Extend your .eslintrc

To use the base config:

{
    "extends": "amex"
}

To use the Prettier compatible config:

{
    "extends": "amex/prettier"
}

(Optionally) Create an .eslintrc file in your test directory

{
    "extends": "amex/test"
}

If you are using Prettier use the prettier/test config:

{
    "extends": "amex/prettier/test"
}

This gives you the jest global and some jest specific rules.

🏆 Contributing

We welcome Your interest in the American Express Open Source Community on Github. Any Contributor to any Open Source Project managed by the American Express Open Source Community must accept and sign an Agreement indicating agreement to the terms below. Except for the rights granted in this Agreement to American Express and to recipients of software distributed by American Express, You reserve all right, title, and interest, if any, in and to Your Contributions. Please fill out the Agreement.

Please feel free to open pull requests and see CONTRIBUTING.md to learn how to get started contributing.

🗝️ License

Any contributions made under this project will be governed by the Apache License 2.0.

🗣️ Code of Conduct

This project adheres to the American Express Community Guidelines. By participating, you are expected to honor these guidelines.