@stedi/eslint-plugin-stedi-aws-rules

eslint-plugin-stedi-aws-rules

Best practices around using AWS SDK in Javascript & Typescript projects.

References:

• https://pages.awscloud.com/rs/112-TZM-766/images/2020_0316-SRV_Slide-Deck.pdf

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install @stedi/eslint-plugin-stedi-aws-rules:

npm install @stedi/eslint-plugin-stedi-aws-rules --save-dev

Usage

Add stedi to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
  "plugins": ["@stedi/stedi-aws-rules"]
}

Then configure the rules you want to use under the rules section.

{
  "rules": {
    "@stedi/stedi-aws-rules/no-aws-import": "error",
    "@stedi/stedi-aws-rules/instrument-aws-clients": "error",
    "@stedi/stedi-aws-rules/instrument-document-clients": "error"
  }
}

Supported Rules

• @stedi/stedi-aws-rules/no-aws-import
• @stedi/stedi-aws-rules/instrument-aws-clients
• @stedi/stedi-aws-rules/instrument-document-clients

Contributing

As Stedi uses this for own projects, we know this might not be the perfect approach for all the projects out there. If you have any ideas, just open an issue and tell us you think.

If you'd like to contribute, please fork the repository and make changes as you'd like. Pull requests are warmly welcome.

Adding a new rule

To follow our structure, when bootstraping new rule please use generator-eslint to do so.

Make sure you're in the top-level directory of this repo and type:

$ yo eslint:rule

Releases

New releases are generated with each commit to the master using semantic-release

License

MIT License © Stedi