americanexpress / eslint-config-amex Goto Github PK

View Code? Open in Web Editor NEW

38.0 21.0 13.0 1.78 MB

✨ This is American Express' eslint config

License: Apache License 2.0

JavaScript 100.00%

linting eslint style-guide one-app

eslint-config-amex's People

Stargazers

Watchers

Forkers

coqe patneedham enuchi kandykad sva1 marcusrbrown smackfu markbello notabotokays georgetown-cset ghas-results tejusunkara

eslint-config-amex's Issues

Create a pull request template

Create a pull request template
an example can be found at https://github.com/americanexpress/one-app/blob/main/.github/pull_request_template.md

This tutorial can be followed

https://docs.github.com/en/free-pro-team@latest/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository

Reporting a vulnerability

Hello!

I hope you are doing well!

We are a security research team. Our tool automatically detected a vulnerability in this repository. We want to disclose it responsibly. GitHub has a feature called Private vulnerability reporting, which enables security research to privately disclose a vulnerability. Unfortunately, it is not enabled for this repository.

Can you enable it, so that we can report it?

Thanks in advance!

PS: you can read about how to enable private vulnerability reporting here: https://docs.github.com/en/code-security/security-advisories/repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository

Use @babel/eslint-parser

$ npm install --save-dev eslint eslint-config-amex prettier eslint-plugin-prettier
npm WARN deprecated [email protected]: babel-eslint is now @babel/eslint-parser. This package will no longer receive updates.
...
$ npm ls babel-eslint
...
└─┬ [email protected]
  └── [email protected]

Most rule ignore comments need a 'max-len' ignore immediately preceding them because of the describe rule

    // eslint-disable-next-line max-len -- ignores are too long
    // eslint-disable-next-line no-return-await -- if we don't explicitly await, the exception is not thrown within the function
    expect(async () => await somePromise).toThrow('mockError');