Skip to content

Commit

Permalink
docs: add common troubleshooting steps
Browse files Browse the repository at this point in the history
  • Loading branch information
thomasmichaelwallace committed Oct 15, 2022
1 parent 371d7e6 commit ca6643b
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 18 deletions.
18 changes: 0 additions & 18 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
* configuration.
*/

const { rules: airbnbEs6Rules } = require('eslint-config-airbnb-base/rules/es6');
const { rules: airbnbImportRules } = require('eslint-config-airbnb-base/rules/imports');
const { rules: airbnbStyleRules } = require('eslint-config-airbnb-base/rules/style');

// https://eslint.org/docs/user-guide/configuring
Expand All @@ -25,22 +23,6 @@ const js = {
'airbnb-base',
],
rules: {
// es6
'sort-imports': [
'warn',
{
...airbnbEs6Rules['sort-imports'][1],
ignoreDeclarationSort: true, // import/order handles this better
},
],
// imports
'import/order': [
'error',
{
alphabetize: { order: 'asc' },
...airbnbImportRules['import/order'][1], //
},
],
// style
'object-curly-newline': [
'error',
Expand Down
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,12 @@ Where:
## Help and Support

If you have an issue, suggestion, or want to contribute, please open an issue or create a pull request and I'll take a look.

### Troubleshooting

There are a handful of common issues that people have trying to run this plugin. Mostly they surround either the confusing way that AWS resolves credentials, or the way that the Serverless Framework loads plugins.

It's always worth trying the following steps (but feel free to raise an issue if you're still having problems):

* If you're using an `~/.aws/config` file, make sure you have `AWS_SDK_LOAD_CONFIG=1` set in your environment
* Make sure you're not using a global installation of serverless (e.g. run `npm install --save-dev serverless` in your project directory)

0 comments on commit ca6643b

Please sign in to comment.