Use TypeScript and build JS on release (#3)

* Use TypeScript and build JS on release

* Build plugin after running tests

* Update serverless plugin declaration

* Update serverless declaration

* Update declarations

* Rename plugin class

Author: sbstjn

.gitignore

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

circle.yml

@@ -11,6 +11,8 @@ test:
     - yarn lint
   override:
     - yarn test
+  post:
+    - yarn build
 
 deployment:
   release:

package.json

@@ -2,12 +2,13 @@
   "name": "serverless-s3bucket-sync",
   "description": "Serverless Plugin to sync local folders with an S3 bucket",
   "version": "0.0.0",
-  "main": "src/plugin.js",
+  "main": "dist/plugin.js",
   "scripts": {
-    "test": "jest test",
-    "test:cover": "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"
   },
   "keywords": [
     "serverless",
@@ -34,20 +35,28 @@
     "s3": "^4.4.0"
   },
   "devDependencies": {
+    "@types/jest": "^20.0.5",
+    "@types/node": "^8.0.17",
+    "ts-jest": "^20.0.7",
+    "tslint": "^5.5.0",
+    "typescript": "^2.4.2",
     "coveralls": "^2.13.1",
     "dot-json": "^1.0.3",
-    "jest": "^20.0.4",
-    "snazzy": "^7.0.0",
-    "standard": "^10.0.2"
+    "jest": "^20.0.4"
   },
-  "standard": {
-    "envs": [
-      "node",
-      "jest"
+  "jest": {
+    "transform": {
+      ".*": "<rootDir>/node_modules/ts-jest/preprocessor.js"
+    },
+    "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(ts)$",
+    "moduleFileExtensions": [
+      "ts",
+      "js"
     ],
-    "ignore": [
-      "node_modules/",
-      "coverage"
-    ]
+    "globals": {
+      "__TS_CONFIG__": {
+        "module": "commonjs"
+      }
+    }
   }
 }

src/main.d.ts

@@ -0,0 +1,4 @@
+declare interface BucketConfig {
+  bucket: string
+  folder: string
+}

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

@@ -1,10 +1,11 @@
-const s3 = require('s3')
-const util = require('util')
+import * as s3 from 's3'
+import * as util from 'util'
 
-class Plugin {
-  constructor (serverless) {
-    this.serverless = serverless
+class S3BucketPlugin {
+  private commands: {}
+  private hooks: {}
 
+  constructor (private serverless: Serverless) {
     this.commands = {
       sync: { lifecycleEvents: [ 'buckets' ] }
     }
@@ -15,31 +16,31 @@ class Plugin {
     }
   }
 
-  options () {
+  private options () {
     return {
       maxAsyncS3: 20,
-      s3RetryCount: 3,
-      s3RetryDelay: 1000,
-      multipartUploadThreshold: 20971520,
       multipartUploadSize: 15728640,
+      multipartUploadThreshold: 20971520,
       s3Options: {
         region: this.serverless.getProvider('aws').getRegion()
-      }
+      },
+      s3RetryCount: 3,
+      s3RetryDelay: 1000
     }
   }
 
-  client () {
+  private client () {
     return s3.createClient(this.options())
   }
 
-  upload (config) {
-    return new Promise(resolve => {
+  private upload (config: BucketConfig) {
+    return new Promise((resolve) => {
       this.serverless.cli.log(util.format('Syncing folder "%s" to S3 bucket "%s"', config.folder, config.bucket))
 
       const uploader = this.client().uploadDir(
         {
-          localDir: this.serverless.config.servicePath + '/' + config.folder,
           deleteRemoved: true,
+          localDir: this.serverless.config.servicePath + '/' + config.folder,
           s3Params: {
             Bucket: config.bucket
           }
@@ -51,11 +52,11 @@ class Plugin {
     })
   }
 
-  sync () {
+  private sync () {
     return Promise.all(
       this.serverless.service.custom['s3-sync'].map(this.upload.bind(this))
     )
   }
 }
 
-module.exports = Plugin
+module.exports = S3BucketPlugin

tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "forceConsistentCasingInFileNames": true,
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "noImplicitAny": true,
+    "noImplicitReturns": true,
+    "noImplicitThis": true,
+    "noUnusedLocals": true,
+    "outDir": "dist",
+    "sourceMap": true,
+    "strictNullChecks": true,
+    "suppressImplicitAnyIndexErrors": true,
+    "target": "esnext"
+  },
+  "include": [
+    "src/**/*",
+    "vendor/**/*"
+  ],
+  "exclude": [
+    "node_modules/**/*"
+  ]
+}

tslint.json

@@ -0,0 +1,17 @@
+{
+  "defaultSeverity": "error",
+  "extends": [
+    "tslint:recommended"
+  ],
+  "jsRules": {},
+  "rules": {
+    "no-console": [ false, "error" ],
+    "quotemark": [ true, "single", "avoid-escape" ],
+    "semicolon": [ true, "never" ],
+    "trailing-comma": [ true, { "multiline": "never", "singleline": "never" } ],
+    "space-before-function-paren": [ true, { "anonymous": "always", "named": "never", "asyncArrow": "always" } ],
+    "indent": [ true, "spaces", 2 ],
+    "interface-name": [ true, "never-prefix" ]
+  },
+  "rulesDirectory": []
+}

vendor/s3.d.ts

@@ -0,0 +1,32 @@
+declare module 's3' {
+  namespace s3 {
+    interface ClientConfig {
+      maxAsyncS3: number,
+      multipartUploadSize: number,
+      multipartUploadThreshold: number,
+      s3Options: {
+        region: string
+      },
+      s3RetryCount: number,
+      s3RetryDelay: number
+    }
+
+    interface UploadConfig {
+      deleteRemoved: boolean,
+      localDir: string,
+      s3Params: {
+        Bucket: string
+      }
+    }
+
+    interface Upload {
+      on(event: string, handler: () => any): null
+    }
+
+    interface Client {
+      uploadDir(config: s3.UploadConfig): s3.Upload
+    }
+  }
+
+  export function createClient(config: s3.ClientConfig): s3.Client
+}

vendor/serverless.d.ts

@@ -0,0 +1,17 @@
+declare interface Serverless {
+  cli: {
+    log(message: string): null
+  }
+
+  config: {
+    servicePath: string
+  }
+
+  service: {
+    custom: {}
+  }
+
+  getProvider(name: string): {
+    getRegion: () => string
+  }
+}