Use TypeScript and compile to JS on release (#4)

* Use TypeScript and compile to JS on release

* clean up

* Update package.json

* Make list of hooks public

Author: sbstjn

.gitignore

@@ -1,2 +1,3 @@
 coverage
-node_modules
+node_modules
+dist

.npmignore

@@ -0,0 +1 @@
+!dist

circle.yml

@@ -10,9 +10,12 @@ test:
   pre:
     - yarn lint
   override:
+    - yarn build
     - yarn test:cover
   post:
     - yarn coveralls
+  cache_directories:
+    - ~/.cache/yarn
 
 deployment:
   release:

package.json

@@ -3,12 +3,13 @@
   "description": "Serverless plugin to process AWS CloudFormation Stack Output",
   "license": "MIT",
   "author": "Sebastian Müller <[email protected]>",
-  "main": "src/plugin.js",
+  "main": "dist/plugin.js",
   "scripts": {
-    "test": "yarn lint && jest test",
-    "test:cover": "yarn lint && jest test --coverage",
+    "test": "jest",
+    "test:cover": "jest --coverage",
     "coveralls": "cat ./coverage/lcov.info | coveralls",
-    "lint": "standard | snazzy"
+    "lint": "tslint {src,test}/**/*.ts",
+    "build": "tsc"
   },
   "repository": {
     "type": "git",
@@ -27,27 +28,29 @@
     "output"
   ],
   "dependencies": {
-    "jasmine-data-provider": "^2.2.0",
-    "nativefier": "^7.4.0",
-    "sinon": "^2.3.6",
     "tomlify-j0.4": "^2.0.0",
     "yamljs": "^0.3.0"
   },
   "devDependencies": {
+    "sinon": "^2.3.6",
+    "jasmine-data-provider": "^2.2.0",
+    "@types/jest": "^20.0.5",
+    "@types/node": "^8.0.19",
     "coveralls": "^2.13.1",
     "dot-json": "^1.0.3",
     "jest": "^20.0.4",
-    "snazzy": "^7.0.0",
-    "standard": "^10.0.2"
+    "ts-jest": "^20.0.7",
+    "tslint": "^5.5.0",
+    "typescript": "^2.4.2"
   },
-  "standard": {
-    "envs": [
-      "node",
-      "jest"
-    ],
-    "ignore": [
-      "node_modules/",
-      "coverage"
+  "jest": {
+    "transform": {
+      ".*": "<rootDir>/node_modules/ts-jest/preprocessor.js"
+    },
+    "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(ts)$",
+    "moduleFileExtensions": [
+      "ts",
+      "js"
     ]
   }
 }

src/file.js src/file.tssrc/file.js renamed to src/file.ts

@@ -1,12 +1,10 @@
-const fs = require('fs')
+import * as fs from 'fs'
 
-class File {
-  constructor (path) {
-    this.path = path
-  }
+export default class StackOutputFile {
+  constructor (private path: string) { }
 
-  format (data) {
-    const ext = this.path.split('.').pop()
+  public format (data: {}) {
+    const ext = this.path.split('.').pop() || ''
 
     switch (ext.toUpperCase()) {
       case 'JSON':
@@ -21,7 +19,7 @@ class File {
     }
   }
 
-  save (data) {
+  public save (data: {}) {
     const content = this.format(data)
 
     try {
@@ -31,5 +29,3 @@ class File {
     }
   }
 }
-
-module.exports = File

src/plugin.js src/plugin.tssrc/plugin.js renamed to src/plugin.ts

@@ -1,18 +1,18 @@
-'use strict'
+import * as  assert from 'assert'
+import * as  util from 'util'
 
-const util = require('util')
-const assert = require('assert')
+import StackOutputFile from './file'
 
-const File = require('./file.js')
-
-class Plugin {
-  constructor (serverless, options) {
-    this.options = options
-    this.serverless = serverless
+class StackOutputPlugin {
+  public hooks: {}
+  private output: OutputConfig
 
+  constructor (private serverless: Serverless, private options: Serverless.Options) {
     this.hooks = {
-      'after:deploy:deploy': () => this.process()
+      'after:deploy:deploy': this.process.bind(this)
     }
+
+    this.output = this.serverless.service.custom.output
   }
 
   get file () {
@@ -24,47 +24,47 @@ class Plugin {
   }
 
   get stackName () {
-    return this.serverless.service.service + '-' + this.serverless.getProvider('aws').getStage()
+    return this.serverless.service.getServiceName() + '-' + this.serverless.getProvider('aws').getStage()
   }
 
-  hasConfig (key) {
-    return !!this.serverless.service.custom.output && !!this.serverless.service.custom.output[key]
+  private hasConfig (key: string) {
+    return !!this.output && !!this.output[key]
   }
 
-  hasHandler () {
+  private hasHandler () {
     return this.hasConfig('handler')
   }
 
-  hasFile () {
+  private hasFile () {
     return this.hasConfig('file')
   }
 
-  getConfig (key) {
-    return this.serverless.config.servicePath + '/' + this.serverless.service.custom.output[key]
+  private getConfig (key: string) {
+    return this.serverless.config.servicePath + '/' + this.output[key]
   }
 
-  callHandler (data) {
+  private callHandler (data: {}) {
     const splits = this.handler.split('.')
-    const func = splits.pop()
+    const func = splits.pop() || ''
 
-    return new Promise(resolve => {
+    return new Promise((resolve) => {
       require(splits.join('.'))[func](data)
 
       resolve()
     })
   }
 
-  saveFile (data) {
-    const f = new File(this.file)
+  private saveFile (data: {}) {
+    const f = new StackOutputFile(this.file)
 
-    return new Promise(resolve => {
+    return new Promise((resolve) => {
       f.save(data)
 
       resolve()
     })
   }
 
-  fetch () {
+  private fetch (): Promise<StackDescriptionList> {
     return this.serverless.getProvider('aws').request(
       'CloudFormation',
       'describeStacks',
@@ -76,21 +76,24 @@ class Plugin {
     )
   }
 
-  beautify (data) {
-    return data.Stacks.pop().Outputs.reduce(
-      (obj, item) => Object.assign(obj, {[item.OutputKey]: item.OutputValue}),
+  private beautify (data: {Stacks: Array<{ Outputs: Array<{}> }>}) {
+    const stack = data.Stacks.pop() || { Outputs: [] }
+    const output = stack.Outputs || []
+
+    return output.reduce(
+      (obj: {}, item: StackOutputPair) => Object.assign(obj, {[item.OutputKey]: item.OutputValue}),
       {}
     )
   }
 
-  handle (data) {
-    let promises = []
+  private handle (data: {}) {
+    const promises = []
 
     if (this.hasHandler()) {
       promises.push(
         this.callHandler(data).then(
           () => this.serverless.cli.log(
-            util.format('Stack Output processed with handler: %s', this.serverless.service.custom.output.handler)
+            util.format('Stack Output processed with handler: %s', this.output.handler)
           )
         )
       )
@@ -100,7 +103,7 @@ class Plugin {
       promises.push(
         this.saveFile(data).then(
           () => this.serverless.cli.log(
-            util.format('Stack Output saved to file: %s', this.serverless.service.custom.output.file)
+            util.format('Stack Output saved to file: %s', this.output.file)
           )
         )
       )
@@ -109,7 +112,7 @@ class Plugin {
     return Promise.all(promises)
   }
 
-  validate () {
+  private validate () {
     assert(this.serverless, 'Invalid serverless configuration')
     assert(this.serverless.service, 'Invalid serverless configuration')
     assert(this.serverless.service.provider, 'Invalid serverless configuration')
@@ -119,19 +122,21 @@ class Plugin {
     assert(this.options && !this.options.noDeploy, 'Skipping deployment with --noDeploy flag')
   }
 
-  process () {
+  private process () {
+    console.log('running stack-output-plugin')
+
     return Promise.resolve().then(
       () => this.validate()
     ).then(
       () => this.fetch()
     ).then(
-      res => this.beautify(res)
+      (res: StackDescriptionList) => this.beautify(res)
     ).then(
-      res => this.handle(res)
+      (res) => this.handle(res)
     ).catch(
-      err => this.serverless.cli.log(util.format('Cannot process Stack Output: %s!', err.message))
+      (err) => this.serverless.cli.log(util.format('Cannot process Stack Output: %s!', err.message))
     )
   }
 }
 
-module.exports = Plugin
+module.exports = StackOutputPlugin

test/file.spec.js test/file.spec.tstest/file.spec.js renamed to test/file.spec.ts

@@ -1,7 +1,7 @@
 'use strict'
 
-const using = require('jasmine-data-provider')
-const File = require('../src/file.js')
+import * as using from 'jasmine-data-provider'
+import File from '../src/file'
 
 describe('File', () => {
   describe('Constructor', () => {
@@ -20,7 +20,7 @@ describe('File', () => {
         {file: 'test.toml', valid: true, type: 'toml', data: 'foo = "bar"'},
         {file: 'test.zip', valid: false}
       ],
-      data => {
+      (data) => {
         it('detects' + (data.valid ? ' valid ' : ' invalid ') + data.file, () => {
           const f = new File(data.file)
 

test/plugin.spec.js test/plugin.spec.tstest/plugin.spec.js renamed to test/plugin.spec.ts

@@ -1,12 +1,12 @@
 'use strict'
 
-const sinon = require('sinon')
-const Plugin = require('../')
+import * as sinon from 'sinon'
+import * as Plugin from '../src/plugin'
 
 describe('Plugin', () => {
   let providerMock = null
   let getProvider = null
-  let provider = {
+  const provider = {
     request: () => true,
     sdk: {
       VERSION: '2.21.0'
@@ -25,22 +25,22 @@ describe('Plugin', () => {
   describe('Configuration', () => {
     it('hasHandler', () => {
       const config = {
+        cli: { log: () => null },
         config: {
           servicePath: ''
         },
-        cli: { log: () => {} },
+        getProvider,
         region: 'us-east-1',
         service: {
-          provider: {
-            name: 'aws'
-          },
           custom: {
             output: {
               handler: 'foo/bar.baz'
             }
+          },
+          provider: {
+            name: 'aws'
           }
-        },
-        getProvider
+        }
       }
 
       const test = new Plugin(config)
@@ -55,22 +55,22 @@ describe('Plugin', () => {
   describe('Configuration', () => {
     it('hasFile', () => {
       const config = {
+        cli: { log: () => null },
         config: {
           servicePath: ''
         },
-        cli: { log: () => {} },
+        getProvider,
         region: 'us-east-1',
         service: {
-          provider: {
-            name: 'aws'
-          },
           custom: {
             output: {
               file: 'foo/bar.toml'
             }
+          },
+          provider: {
+            name: 'aws'
           }
-        },
-        getProvider
+        }
       }
 
       const test = new Plugin(config)