Initial commit

Abilio Henrique · Abilio Henrique · commit dd9b28cce123 · 2017-03-29T18:02:21.000+10:00
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,6 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+insert_final_newline = true
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,6 @@
+node_modules
+/npm-*
+/dist
+
+.directory
+.DS_STORE*
diff --git a/.jestrc b/.jestrc
@@ -0,0 +1,10 @@
+{
+  "verbose": true,
+  "transform": { ".(ts|tsx)": "<rootDir>/node_modules/ts-jest/preprocessor.js" },
+  "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js)$",
+  "moduleFileExtensions": [ "ts", "tsx", "js" ],
+  "testPathIgnorePatterns": [
+    "/node_modules/",
+    "./dist"
+  ]
+}
diff --git a/.node-version b/.node-version
@@ -0,0 +1 @@
+6
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -0,0 +1,47 @@
+{
+  // Use IntelliSense to learn about possible Node.js debug attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "compounds": [
+    {
+      "name": "Compound",
+      "configurations": [
+        "Project1"
+      ]
+    }
+  ],
+  "configurations": [
+    {
+      "type": "node",
+      "request": "attach",
+      "name": "Attach (Inspector Protocol)",
+      "port": 9229,
+      "protocol": "inspector"
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "protocol": "legacy",
+      "name": "Jest (Legacy)",
+      "cwd": "${workspaceRoot}",
+      "stopOnEntry": false,
+      "runtimeExecutable": null,
+      "runtimeArgs": [
+        "--debug-brk",
+        "${workspaceRoot}/node_modules/.bin/jest",
+        "-i",
+        "-c", ".jestrc"
+      ],
+      "smartStep": true,
+      "outDir": null,
+      "sourceMaps": true,
+      "port": 5858,
+      "address": "127.0.0.1",
+      "skipFiles": [
+        "<node_internals>/**/*.js",
+        "node_modules/**/*.js"
+      ]
+    }
+  ]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+  "typescript.tsdk": "./node_modules/typescript/lib"
+}
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -0,0 +1,8 @@
+{
+  "version": "0.1.0",
+  "command": "tsc",
+  "isShellCommand": true,
+  "args": [],
+  "showOutput": "silent",
+  "problemMatcher": "$tsc"
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/README.md b/README.md
diff --git a/package.json b/package.json
@@ -0,0 +1,41 @@
+{
+  "name": "serverless-openapi-documentation",
+  "version": "0.0.0",
+  "description": "Serverless 1.0 plugin to generate OpenAPI V3 documentation from serverless configuration",
+  "main": "dist/index.js",
+  "author": "Abilio Henrique <abilio.henrique@temando.com>",
+  "license": "MIT",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "test": "jest --config ./.jestrc",
+    "lint": "eslint src",
+    "test:watch": "yarn test -- -i --watch",
+    "release:npm": "cd dist && npm publish",
+    "docs": "typedoc --out ./dist/docs --target es6 --readme README.md",
+    "build": "node scripts/package"
+  },
+  "devDependencies": {
+    "@types/node": "^7.0.12",
+    "eslint": "^3.18.0",
+    "eslint-config-airbnb-base": "^11.1.2",
+    "eslint-plugin-import": "^2.2.0",
+    "jest": "^19.0.2",
+    "serverless": "^1.9.0",
+    "ts-jest": "^19.0.6",
+    "ts-node": "^3.0.2",
+    "tslint": "^4.5.1",
+    "tslint-eslint-rules": "^3.5.1",
+    "typescript": "^2.2.2"
+  },
+  "dependencies": {
+    "@types/bluebird": "^3.5.2",
+    "@types/fs-promise": "^1.0.1",
+    "@types/js-yaml": "^3.5.29",
+    "bluebird": "^3.5.0",
+    "fs-promise": "^2.0.2",
+    "js-yaml": "^3.8.2",
+    "lutils": "^1.2.5"
+  }
+}
diff --git a/scripts/package.js b/scripts/package.js
@@ -0,0 +1,14 @@
+/**
+ * `package` script.
+ *
+ * - Builds `./dist` for a `npm publish` by merging
+ *   the project root and files built from `./src`.
+ */ 
+
+const exec = require('shelljs').exec;
+
+exec('rm -rf dist');
+exec('mkdir dist');
+// exec('cp * dist');
+// exec('cp .* dist');
+exec('tsc');
diff --git a/src/generate.ts b/src/generate.ts
@@ -0,0 +1,81 @@
+import { merge } from 'lutils';
+
+type ServiceDescriptionType = {
+  description: string,
+  version: string,
+  summary: string,
+  termsOfService?: string,
+  contact?: {
+    name?: string,
+    email?: string,
+    url?: string,
+  },
+  license?: {
+    name: string,
+    url: string,
+  },
+};
+
+export default class DocumentGenerator {
+  private config: ServiceDescriptionType = {
+    description: '',
+    version: '0.0.0',
+    summary: '',
+  };
+
+  constructor(serviceDescriptor: ServiceDescriptionType) {
+    merge([this.config, serviceDescriptor], { depth: 32 });
+  }
+
+  public generate() {
+    return {
+      openapi: '3.0.0-RC0',
+      servers: this.getServers(),
+      info: {
+        description: this.getDescription(),
+        version: this.getVersion(),
+        title: this.getTitle(),
+        termsOfService: this.getTermsOfService(),
+      },
+      tags: this.getTags(),
+      paths: {},
+      components: {
+        schemas: this.getSchemas(),
+        requestBodies: {},
+        responses: {},
+        parameters: {},
+        examples: {},
+        securitySchemes: {},
+      },
+    };
+  }
+
+  private getDescription() {
+    return this.config.description;
+  }
+
+  private getSchemas() {
+    return {};
+  }
+
+  private getServers() {
+    return [{ url: 'nothing' }];
+  }
+
+  private getTermsOfService() {
+    return this.config.termsOfService;
+  }
+
+  private getTags() {
+    return [];
+  }
+
+  private getTitle() {
+    return this.config.summary;
+  }
+
+  private getVersion() {
+    return this.config.version;
+  }
+
+}
diff --git a/src/index.ts b/src/index.ts
@@ -0,0 +1,45 @@
+import * as DocumentGenerator from './generate';
+
+class ServerlessOpenAPIDocumentation {
+  public hooks;
+  private serverless;
+  private options;
+  private provider;
+  private customVars;
+  private getMethodLogicalId;
+  private normalizePath;
+
+  constructor(serverless, options) {
+    this.serverless = serverless;
+    this.options = options;
+    this.provider = 'aws';
+
+    this.customVars = this.serverless.variables.service.custom;
+    const naming = this.serverless.providers.aws.naming;
+    this.getMethodLogicalId = naming.getMethodLogicalId.bind(naming);
+    this.normalizePath = naming.normalizePath.bind(naming);
+
+    this.hooks = {
+      'before:deploy:deploy': this.beforeDeploy.bind(this),
+      'after:deploy:deploy': this.afterDeploy.bind(this),
+    };
+  }
+
+  private beforeDeploy() {
+    const dg = new DocumentGenerator(this.customVars.documentation);
+
+    const funcConfigs = this.serverless.service.getAllFunctions().map((functionName) => {
+      const func = this.serverless.service.getFunction(functionName);
+      console.log(func.events);
+      return func;
+    });
+
+    return Promise.reject(new Error('fuck'));
+  }
+
+  private afterDeploy() {
+    console.log('bye');
+  }
+}
+
+module.exports = ServerlessOpenAPIDocumentation;
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "target": "es2016",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "outDir":"./dist",
+    "inlineSourceMap": true,
+    "inlineSources": true,
+    "allowJs": false,
+    "allowSyntheticDefaultImports": true
+  },
+  "exclude": [
+    "node_modules",
+    "dist"
+  ],
+  "include": [
+    "src/**/*"
+  ]
+}
diff --git a/tslint.json b/tslint.json
@@ -0,0 +1,15 @@
+{
+	"extends":[
+    "tslint:latest",
+    "tslint-eslint-rules"
+  ],
+  "rules": {
+    "quotemark": ["single"],
+    "only-arrow-functions": [false],
+    "curly": false,
+    "object-curly-spacing": [ true, "always" ],
+    "space-in-parens": [true, "never"],
+    "no-multi-spaces": [true],
+    "object-literal-sort-keys": false
+  }
+}
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "typescript.tsdk": "./node_modules/typescript/lib"`
	`3`	`+}`