Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/americanexpress/eslint-config-amex
✨ This is American Express' eslint config
https://github.com/americanexpress/eslint-config-amex
eslint linting one-app style-guide
Last synced: 2 months ago
JSON representation
✨ This is American Express' eslint config
- Host: GitHub
- URL: https://github.com/americanexpress/eslint-config-amex
- Owner: americanexpress
- License: apache-2.0
- Created: 2017-06-01T17:24:04.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-03-26T12:39:40.000Z (10 months ago)
- Last Synced: 2024-04-14T13:05:28.887Z (9 months ago)
- Topics: eslint, linting, one-app, style-guide
- Language: JavaScript
- Homepage:
- Size: 1.74 MB
- Stars: 38
- Watchers: 21
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/eslint-config-amex)
[](https://github.com/americanexpress/eslint-config-amex/actions/workflows/ci.yml)
> ESLint configurations used at American Express.
## 👩💻 Hiring 👨💻
Want to get paid for your contributions to `eslint-config-amex`?
> Send your resume to [email protected]
## 📖 Table of Contents
* [Usage](#-usage)
* [Contributing](#-contributing)
* [License](#️-license)
* [Code of Conduct](#️-code-of-conduct)
## 🤹 Usage
### Installation
```bash
npm install --save-dev eslint eslint-config-amex
```
The default config provides support for React applications. ESLint configs are also provided for:
* Jest
* Prettier
Install required peer dependencies before [extending your ESLint config](#extend-your-eslintrc):
Jest:
```bash
npm install --save-dev typescript eslint-plugin-jest eslint-plugin-jest-dom
```
Prettier:
```bash
npm install --save-dev prettier eslint-plugin-prettier
```
### Extend your `.eslintrc`
To use the base config:
```json
{
"extends": "amex"
}
```
To use the Prettier compatible config:
```json
{
"extends": "amex/prettier"
}
```
### (Optionally) Create an `.eslintrc` file in your test directory
```json
{
"extends": "amex/test"
}
```
If you are using Prettier use the `prettier/test` config:
```json
{
"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](https://cla-assistant.io/americanexpress/eslint-config-amex).
Please feel free to open pull requests and see [CONTRIBUTING.md](./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](./LICENSE.txt).
## 🗣️ Code of Conduct
This project adheres to the [American Express Community Guidelines](./CODE_OF_CONDUCT.md).
By participating, you are expected to honor these guidelines.