Uplift

- lint
- build
- travis
- jest
- other deps

Skipping servlerless as it needs compatibility changes

Author: nfour

.travis.yml

@@ -0,0 +1,13 @@
+language: node_js
+
+node_js:
+  - "6"
+
+install:
+  - yarn install
+
+script:
+  - yarn lint
+  - yarn build
+  - yarn test
+  - yarn test:bench

.jestrc renamed to jest.config.js

@@ -1,4 +1,4 @@
-{
+module.exports = {
   "verbose": true,
   "transform": { ".(ts|tsx)": "<rootDir>/node_modules/ts-jest/preprocessor.js" },
   "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js)$",

package.json

@@ -4,48 +4,46 @@
   "description": "Serverless 1.0 plugin to generate OpenAPI V3 documentation from serverless configuration",
   "main": "dist/index.js",
   "author": "Abilio Henrique <[email protected]>",
+  "contributors": [
+    "Abilio Henrique <[email protected]>",
+    "nfour <[email protected]>"
+  ],
   "license": "MIT",
   "files": [
     "dist"
   ],
   "scripts": {
     "test": "yarn test:unit",
-    "test:unit": "jest -i --config .jestrc",
-    "lint": "eslint src",
-    "test:watch": "jest --config .jestrc -i -t '/[^/.]+\\.test' --watch",
-    "release:npm": "cd dist && npm publish",
-    "docs": "typedoc --out ./dist/docs --target es6 --readme README.md",
-    "build": "node scripts/package"
+    "test:unit": "jest",
+    "lint": "tslint 'src/**/*.ts'",
+    "test:watch": "jest -t '/[^/.]+\\.test' --watch",
+    "release": "cd dist && npm publish",
+    "build": "scripts/build.bash"
   },
   "devDependencies": {
-    "@types/jest": "^19.2.2",
-    "@types/node": "^7.0.12",
-    "@types/typescript": "^2.0.0",
-    "eslint": "^3.19.0",
-    "eslint-config-airbnb-base": "^11.1.3",
-    "eslint-plugin-import": "^2.2.0",
-    "jest": "^19.0.2",
-    "serverless": "^1.11.0",
-    "ts-jest": "^19.0.8",
-    "ts-node": "^3.0.2",
-    "tslint": "^5.1.0",
-    "tslint-eslint-rules": "^4.0.0",
-    "typedoc": "^0.5.10",
-    "typescript": "^2.2.2"
+    "@types/chalk": "^0.4.31",
+    "@types/fs-extra": "^3.0.3",
+    "@types/jest": "^20.0.2",
+    "@types/js-yaml": "^3.5.31",
+    "@types/node": "^8.0.7",
+    "@types/uuid": "^3.0.0",
+    "jest": "^20.0.4",
+    "serverless": "1.11",
+    "ts-jest": "^20.0.6",
+    "ts-node": "^3.1.0",
+    "tslint": "^5.4.3",
+    "tslint-config-temando": "^1.1.4",
+    "typescript": "^2.4.1"
   },
   "dependencies": {
-    "@jdw/jst": "^1.0.0-beta.10",
-    "@types/bluebird": "^3.5.2",
-    "@types/chalk": "^0.4.31",
-    "@types/fs-promise": "^1.0.3",
-    "@types/js-yaml": "^3.5.29",
-    "@types/uuid": "^2.0.29",
+    "@jdw/jst": "^1.0.0",
+    "@types/bluebird": "^3.5.8",
     "bluebird": "^3.5.0",
-    "chalk": "^1.1.3",
-    "fs-promise": "^2.0.2",
-    "js-yaml": "^3.8.3",
-    "lutils": "^1.2.5",
-    "swagger2openapi": "^2.0.3",
-    "uuid": "^3.0.1"
+    "chalk": "^2.0.1",
+    "fs-extra": "^3.0.1",
+    "js-yaml": "^3.8.4",
+    "lutils": "^2.4.0",
+    "swagger2openapi": "^2.5.0",
+    "uuid": "^3.1.0"
   }
 }

scripts/build.bash

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+# Clean
+rm -rf dist
+mkdir dist
+
+# Copy latent, belonging to the index module
+rsync -am . ./dist  --exclude '*/*' --include '*' 
+
+# Copy latent files from source, recursively
+rsync -am  ./src/* ./dist --exclude '*.ts'
+
+# Build typescript
+yarn tsc
+
+
+
+

scripts/package.js

@@ -28,7 +28,7 @@ export default class DocumentGenerator {
    * Constructor
    * @param serviceDescriptor IServiceDescription
    */
-  constructor(serviceDescriptor: IServiceDescription) {
+  constructor (serviceDescriptor: IServiceDescription) {
     this.serviceDescriptor = clone(serviceDescriptor);
 
     merge(this.config, {
@@ -51,7 +51,7 @@ export default class DocumentGenerator {
     }
   }
 
-  public generate() {
+  public generate () {
     const result: any = {};
     process.stdout.write(`${ c.bold.yellow('[VALIDATION]') } Validating OpenAPI generated output\n`);
     try {
@@ -71,7 +71,7 @@ export default class DocumentGenerator {
    * Add Paths to OpenAPI Configuration from Serverless function documentation
    * @param config Add
    */
-  public addPathsFromFunctionConfig(config: IServerlessFunctionConfig[]): void {
+  public addPathsFromFunctionConfig (config: IServerlessFunctionConfig[]): void {
     // loop through function configurations
     for (const funcConfig of config) {
       // loop through http events
@@ -103,7 +103,7 @@ export default class DocumentGenerator {
    * Cleans schema objects to make them OpenAPI compatible
    * @param schema JSON Schema Object
    */
-  private cleanSchema(schema) {
+  private cleanSchema (schema) {
     // Clone the schema for manipulation
     const cleanedSchema = clone(schema);
 
@@ -120,7 +120,7 @@ export default class DocumentGenerator {
    * Derives Path, Query and Request header parameters from Serverless documentation
    * @param documentationConfig
    */
-  private getParametersFromConfig(documentationConfig): IParameterConfig[] {
+  private getParametersFromConfig (documentationConfig): IParameterConfig[] {
     const parameters: IParameterConfig[] = [];
 
     // Build up parameters from configuration for each parameter type
@@ -164,11 +164,10 @@ export default class DocumentGenerator {
 
         if ('style' in parameter) {
           parameterConfig.style = parameter.style;
-          if (parameter.explode) {
-            parameterConfig.explode = parameter.explode;
-          } else {
-            parameterConfig.explode = parameter.explode || (parameter.style === 'form' ? true : false);
-          }
+
+          parameterConfig.explode = parameter.explode
+            ? parameter.explode
+            : parameter.style === 'form';
         }
 
         // console.log(parameter);
@@ -194,7 +193,7 @@ export default class DocumentGenerator {
    * Derives request body schemas from event documentation configuration
    * @param documentationConfig
    */
-  private getRequestBodiesFromConfig(documentationConfig) {
+  private getRequestBodiesFromConfig (documentationConfig) {
     const requestBodies = {};
 
     // Does this event have a request model?
@@ -242,7 +241,7 @@ export default class DocumentGenerator {
    * Gets response bodies from documentation config
    * @param documentationConfig
    */
-  private getResponsesFromConfig(documentationConfig) {
+  private getResponsesFromConfig (documentationConfig) {
     const responses = {};
     if (documentationConfig.methodResponses) {
       for (const response of documentationConfig.methodResponses) {
@@ -269,14 +268,14 @@ export default class DocumentGenerator {
 
         merge(responses, {
           [response.statusCode]: methodResponseConfig,
-         });
+        });
       }
     }
 
     return responses;
   }
 
-  private getResponseContent(response) {
+  private getResponseContent (response) {
     const content = {};
     for (const responseKey of Object.keys(response)) {
       const responseModel = this.serviceDescriptor.models.filter(
@@ -300,7 +299,7 @@ export default class DocumentGenerator {
     return content;
   }
 
-  private getHttpEvents(funcConfig) {
+  private getHttpEvents (funcConfig) {
     return funcConfig.filter((event) => event.http ? true : false);
   }
 }

src/generate.ts

@@ -20,7 +20,7 @@ export default class ServerlessOpenAPIDocumentation {
    * @param serverless
    * @param options
    */
-  constructor(serverless, options) {
+  constructor (serverless, options) {
     // pull the serverless instance into our class vars
     this.serverless = serverless;
     // pull the CLI options into our class vars
@@ -66,7 +66,7 @@ export default class ServerlessOpenAPIDocumentation {
    * Processes CLI input by reading the input from serverless
    * @returns config IConfigType
    */
-  private processCliInput(): IConfigType {
+  private processCliInput (): IConfigType {
     const config: IConfigType = {
       format: 'yaml',
       file: 'openapi.yml',
@@ -95,7 +95,7 @@ export default class ServerlessOpenAPIDocumentation {
   /**
    * Generates OpenAPI Documentation based on serverless configuration and functions
    */
-  private generate() {
+  private generate () {
     process.stdout.write(c.bold.underline('OpenAPI v3 Documentation Generator\n\n'));
     // Instantiate DocumentGenerator
     const dg = new DocumentGenerator(this.customVars.documentation);
@@ -118,13 +118,13 @@ export default class ServerlessOpenAPIDocumentation {
     // Output the OpenAPI document to the correct format
     let outputContent = '';
     switch (config.format.toLowerCase()) {
-      case 'json':
-        outputContent = JSON.stringify(outputObject, null, config.indent);
-        break;
-      case 'yaml':
-      default:
-        outputContent = YAML.safeDump(outputObject, { indent: config.indent });
-        break;
+    case 'json':
+      outputContent = JSON.stringify(outputObject, null, config.indent);
+      break;
+    case 'yaml':
+    default:
+      outputContent = YAML.safeDump(outputObject, { indent: config.indent });
+      break;
     }
 
     // Write to disk
@@ -134,4 +134,3 @@ export default class ServerlessOpenAPIDocumentation {
 }
 
 module.exports = ServerlessOpenAPIDocumentation;
-

src/index.ts

@@ -1,5 +1,4 @@
-import * as lutils from 'lutils';
+import { Clone, IMerge, Merge } from 'lutils';
 
-export const merge = (...args) => lutils.merge([...args], { depth: 100 });
-
-export const clone = (arg, options = {}) => lutils.clone(arg, { ...options, depth: 100 });
+export const merge = new Merge({ depth: 100 }).merge;
+export const clone = new Clone({ depth: 100 }).clone;

src/utils.ts

@@ -1,4 +1,4 @@
-import * as fs from 'fs-promise';
+import * as fs from 'fs-extra';
 import * as path from 'path';
 import * as Serverless from 'serverless';
 import DocumentGenerator from '../src/generate';

test/openapi-generate.test.ts

@@ -1,25 +1,17 @@
 {
   "compilerOptions": {
-    "target": "es5",
+    "target": "es6",
     "module": "commonjs",
     "moduleResolution": "node",
     "outDir":"./dist",
-    "inlineSourceMap": true,
-    "inlineSources": true,
-    "allowJs": false,
-    "allowSyntheticDefaultImports": true,
+    "sourceMap": true,
     "declaration": true,
     "lib": [
-      "es2015",
-      "es2016",
-      "es2017.object"
+      "es6",
+      "es7",
+      "dom"
     ]
   },
-  "exclude": [
-    "node_modules",
-    "dist"
-  ],
-  "include": [
-    "src/**/*"
-  ]
+  "exclude": [],
+  "include": [ "src/**/*" ]
 }