Merge pull request #158 from ACloudGuru/add-github-actions

Add GitHub actions

.commitlintrc

@@ -0,0 +1,2 @@
+extends:
+  - '@commitlint/config-conventional'

.eslintrc

@@ -0,0 +1,38 @@
+extends:
+  - airbnb-base
+  - prettier
+  - plugin:import/errors
+  - plugin:import/warnings
+  - plugin:jest/recommended
+
+globals:
+  Atomics: readonly
+  SharedArrayBuffer: readonly
+
+parserOptions:
+  ecmaVersion: 2020
+  sourceType: module
+
+plugins:
+  - jest
+  - prettier
+
+rules: {
+  "prettier/prettier": "error",
+  "import/prefer-default-export": 0,
+  "jest/no-focused-tests": 0,
+
+  # eventually want to remove everything below this
+  "class-methods-use-this": 0,
+  "prefer-object-spread": 0,
+  "prefer-destructuring": 0,
+  "no-return-assign": 0,
+  "array-callback-return": 0,
+  "global-require": 0,
+  "consistent-return": 0,
+  "no-param-reassign": 0,
+  "no-underscore-dangle": 0,
+  "no-plusplus": 0,
+  "guard-for-in": 0,
+  "no-restricted-syntax": 0
+}

.github/workflows/build.yml

@@ -0,0 +1,32 @@
+name: Build
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 14.x]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Use node ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install packages
+        run: yarn install --frozen-lockfile
+
+      - name: Run lint
+        run: yarn lint
+
+      - name: Run tests
+        run: yarn test
+
+      - name: Generate code coverage
+        uses: codecov/codecov-action@v1

.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: Publish
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  publish:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Use node 14.x
+        uses: actions/setup-node@v1
+        with:
+          node-version: '14.x'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install packages
+        run: yarn install --frozen-lockfile
+
+      - name: Publish to npm
+        run: yarn release
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn commitlint --edit.

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "tabWidth": 2,
+  "printWidth": 80,
+  "singleQuote": true
+}

README.md

@@ -2,12 +2,14 @@
   [![NPM version][npm-image]][npm-url]
   [![Build Status][travis-image]][travis-url]
   [![Dependency Status][daviddm-image]][daviddm-url]
-  [![Coverage percentage][coveralls-image]][coveralls-url]
+  [![codecov][codecov-image]][codecov-url]
 
 A Serverless plugin to easily add CloudWatch alarms to functions
 
 ## Installation
 `npm i serverless-plugin-aws-alerts`
+OR
+`yarn add --dev serverless-plugin-aws-alerts`
 
 ## Usage
 
@@ -187,7 +189,7 @@ custom:
 #### CloudFormation support
 
 ```yaml
-custom: 
+custom:
   alerts:
     topics:
       alarm:
@@ -204,7 +206,6 @@ custom:
       insufficientData:
         topic:
           Ref: ExampleInsufficientdataTopic
-          
 
 resources:
   Resources:
@@ -473,5 +474,5 @@ MIT © [A Cloud Guru](https://acloud.guru/)
 [travis-url]: https://travis-ci.org/ACloudGuru/serverless-plugin-aws-alerts
 [daviddm-image]: https://david-dm.org/ACloudGuru/serverless-plugin-aws-alerts.svg?theme=shields.io
 [daviddm-url]: https://david-dm.org/ACloudGuru/serverless-plugin-aws-alerts
-[coveralls-image]: https://coveralls.io/repos/ACloudGuru/serverless-plugin-aws-alerts/badge.svg
-[coveralls-url]: https://coveralls.io/r/ACloudGuru/serverless-plugin-aws-alerts
+[codecov-image]: https://codecov.io/gh/ACloudGuru/serverless-plugin-aws-alerts/branch/master/graph/badge.svg?token=uC4maLoz3W
+[codecov-url]: https://codecov.io/gh/ACloudGuru/serverless-plugin-aws-alerts

codecov.yml

@@ -0,0 +1,15 @@
+coverage:
+  status:
+    project:
+      default:
+        target: auto
+        threshold: null
+
+comment:
+  layout: "reach, diff, flags, files"
+  behavior: default
+  require_changes: false
+  require_base: no
+  require_head: yes
+  branches:
+    - master

example/error.js

@@ -1,6 +1,3 @@
-exports.handler = (event, context, cb) => {
-  console.log('Received event', event);
-  console.log('Blah');
-
+exports.handler = (_, __, cb) => {
   cb(new Error('This is an error'));
 };

example/foo.js

@@ -1,9 +1,7 @@
-exports.handler = async (event) => {
-  console.log('Received event', event);
-
+exports.handler = async () => {
   const response = {
     statusCode: 200,
-    body: JSON.stringify({ message: `success - ${Date.now()}` })
+    body: JSON.stringify({ message: `success - ${Date.now()}` }),
   };
 
   return response;

example/slow.js

@@ -1,9 +1,5 @@
-exports.handler = (event, context, cb) => {
-  console.log('Received event', event);
-  console.log('Sleeping');
-
+exports.handler = (_, __, cb) => {
   setTimeout(() => {
-    console.log('Awake');
     cb(null, { message: 'success' });
   }, 10000);
-}
+};

package.json

@@ -7,31 +7,39 @@
     "lint": "eslint .",
     "lint-fix": "eslint . --fix",
     "test": "jest --coverage",
-    "test:watch": "jest --watch"
+    "test:watch": "jest --watch",
+    "postinstall": "husky install",
+    "prepublishOnly": "pinst --disable",
+    "postpublish": "pinst --enable"
   },
   "repository": {
     "url": "https://github.com/ACloudGuru/serverless-plugin-aws-alerts.git",
     "type": "git"
   },
   "author": "John McKim <[email protected]>",
   "license": "MIT",
-  "peerDependencies": {
-    "serverless": "^2.4.0"
-  },
   "dependencies": {
     "lodash": "^4.17.10"
   },
   "devDependencies": {
-    "coveralls": "^2.11.16",
-    "eslint": "^4.7.1",
-    "eslint-config-standard": "^6.2.0",
-    "eslint-plugin-node": "^4.0.0",
-    "eslint-plugin-promise": "^3.4.1",
-    "eslint-plugin-standard": "^2.0.1",
-    "jest": "^19.0.2"
+    "@commitlint/config-conventional": "^11.0.0",
+    "commitlint": "^11.0.0",
+    "eslint": "^7.19.0",
+    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-config-prettier": "^7.2.0",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-jest": "^24.1.3",
+    "eslint-plugin-prettier": "^3.3.1",
+    "husky": "^5.0.9",
+    "jest": "^19.0.2",
+    "pinst": "^2.1.4",
+    "prettier": "^2.2.1"
+  },
+  "peerDependencies": {
+    "serverless": "^2.4.0"
   },
   "engines": {
-    "node": ">=6.10.0"
+    "node": ">=8.10.0"
   },
   "jest": {
     "testMatch": [

src/dashboards/index.js

@@ -1,10 +1,8 @@
-'use strict';
-
 const widgetFactory = require('./widgets/factory');
 
 const dashboards = {
-  'default': require('./configs/default'),
-  'vertical': require('./configs/vertical'),
+  default: require('./configs/default'),
+  vertical: require('./configs/vertical'),
 };
 
 const createDashboard = (service, stage, region, functions, name) => {
@@ -22,7 +20,7 @@ const createDashboard = (service, stage, region, functions, name) => {
       region,
       coordinates: w.coordinates,
       title: w.title,
-      functions
+      functions,
     };
 
     return widget.createWidget(config);

src/dashboards/widgets/api-gw/latency/numbers.js

@@ -1,5 +1,3 @@
-'use strict';
-
 const createWidget = (config) => {
   const apiName = `${config.stage}-${config.service}`;
 
@@ -13,12 +11,34 @@ const createWidget = (config) => {
       title: config.title,
       view: 'singleValue',
       metrics: [
-        [ 'AWS/ApiGateway', 'IntegrationLatency', 'ApiName', apiName, { stat: 'Average', period: 2592000, region: config.region, label: 'IntegrationLatency' } ],
-        [ 'AWS/ApiGateway', 'Latency', 'ApiName', apiName, { stat: 'Average', period: 2592000, region: config.region, label: 'Latency' } ]
+        [
+          'AWS/ApiGateway',
+          'IntegrationLatency',
+          'ApiName',
+          apiName,
+          {
+            stat: 'Average',
+            period: 2592000,
+            region: config.region,
+            label: 'IntegrationLatency',
+          },
+        ],
+        [
+          'AWS/ApiGateway',
+          'Latency',
+          'ApiName',
+          apiName,
+          {
+            stat: 'Average',
+            period: 2592000,
+            region: config.region,
+            label: 'Latency',
+          },
+        ],
       ],
       region: config.region,
-      period: 300
-    }
+      period: 300,
+    },
   };
 
   return widget;