kwinner

trek10-package-manager

serverless-graph

Serverless Graph - A plugin for creating a graph usable by graphviz.

    this.provider = this.serverless.getProvider('providerName');

        usage: "Creates a graph representation of the output for use with tools like graphviz.",

        usage: "Creates graphviz compatible graph output of nodes and edges. Saves to graph.out file.",

            usage: 'Graph nodes from left to right instead of top down.',

            usage: 'Graph nodes from left to right instead of top down.'

            usage: 'Whether or not to display edgelabels',

            usage: 'Display edgelabels in graph.',

      'before:graph:graph': () => BbPromise.bind(this)

        if (!this.options.package && !this.serverless.service.package.path) {

          return this.serverless.pluginManager.spawn('package');

      'graph:graph': () => BbPromise.bind(this)

    fs.readFile(`${currentDir}/.serverless/cloudformation-template-update-stack.json`, 'utf8', function(err, data) {

          `The file "cloudformation-template-update-stack.json" could not be opened.`,

        throw new serverless.classes.Error(errorMessage);

      var obj = lib.extractGraph(template.Description, template.Resources, serverless)

      graph.edges = graph.edges.concat(obj.edges);

      lib.handleTerminals(template, graph, 'Parameters', 'source')

      serverless.cli.log("Rendering graph...");

      serverless.cli.log("Graph saved to graph.out.");

  "description": "Serverless Graph - A plugin for creating a graph usable by graphviz.",

    "url": "https://github.com/trek10/serverless-graph"

This project was adapted from [CFVIZ](https://github.com/benbc/cloud-formation-viz/blob/master/cfviz). Serverless Graph outputs your serverless architecture and resources as a [Graphviz](http://www.graphviz.org/) dot compatible output. Currently only supports the AWS provider.

**Note:** Serverless *v1.x.x* or higher is required.

* cd into your Serverless Project's root folder and run:

* Add serverless-graph to the plugins section of your serverless.yml

If you have any commandline params that don't have defaults you will have to pass in any opt variables as this plugin hooks into the package step and then reads the output

  * `cat graph.out | dot -Tsvg -oexample.svg`

  * `cat graph.out | dot -Tpng -oexample.png`

* See [Graphviz](http://www.graphviz.org/pdf/dot.1.pdf) for more information.

### TODO: Getting started - make npm package

* `sls graph {--opts} | dot -Tsvg -oexample.svg`

		@@ -19,3 +19,3 @@ 'use strict';
		graph: {
		usage: "Creates a graph representation of the output for use with tools like graphviz.",
		usage: "Creates graphviz compatible graph output of nodes and edges. Saves to graph.out file.",
		lifecycleEvents: [
		@@ -26,7 +26,6 @@ 'graph',
		horizontal: {
		usage: 'Graph nodes from left to right instead of top down.',
		shortcut: 'l',
		usage: 'Graph nodes from left to right instead of top down.'
		},
		edgelabels: {
		usage: 'Whether or not to display edgelabels',
		usage: 'Display edgelabels in graph.',
		shortcut: 'e',
		@@ -33,0 +32,0 @@ }

		{
		"name": "serverless-graph",
		"version": "0.1.0",
		"version": "0.2.0",
		"engines": {
		@@ -5,0 +5,0 @@ "node": ">=4.0"

		@@ -9,11 +9,3 @@ Serverless Plugin Boilerplate
		### Get Started
		* cd into serverless-graph and run:
		```
		npm link
		```

		* cd into your Serverless Project's root folder and run:
		```
		npm link serverless-graph
		```
		* `npm install --save serverless-graph`
		* Install graphviz
		@@ -31,8 +23,1 @@ * Homebrew - brew install graphviz
		* See [Graphviz](http://www.graphviz.org/pdf/dot.1.pdf) for more information.

		### TODO: Getting started - make npm package
		* `npm install --save serverless-graph`
		* Add serverless-graph to the plugins section of your serverless.yml
		* Install graphviz
		* Homebrew - brew install graphviz
		* `sls graph {--opts} \| dot -Tsvg -oexample.svg`

Worsened metrics