Skip to content

Latest commit

 

History

History
75 lines (59 loc) · 2.5 KB

README.md

File metadata and controls

75 lines (59 loc) · 2.5 KB
Raw

Flowmaker

Flowmaker is an VSCode extension used to generate a flowchart in SVG format of javascript code to demonstrate Code flow scheme from different level of conduct.

Flowmaker features

onBrowser demo

Note: For only using the onEditor SVG generation follow the livepreview branch code.

For showing in both Browser and Editor follow the onBrowser branch code.

Instructions

  • Write Javascript.
  • Select a function or object or entire file.
  • Hit ctrl-f1.
  • Choose either 'Flowmaker: Preview' or 'Flowmaker: Save'.
  • 'Flowmaker: Preview' generates the SVG layout in side column of editor itself.
  • 'Flowmaker: Save' allows the user to download the SVG code in the same directory as the file.

Installation

From VS Code Market Install Flowmaker: Install Flowmaker extension:

Launch VS Code Quick Open (Ctrl+P), paste the following command:
ext install speks.flowmaker

Then,

Open any .js file
hit Fn+f1 or F1
choose Flowmake onEditor or Flowmake onBrowser

or, Clone the source locally:

$ git clone https://github.com/aryaminus/flowmaker
$ cd flowmaker
$ npm install

and, Start the application in development mode

hit Ctrl+f5
hit Fn+f1 or F1
choose Flowmaker: Save or Flowmaker: Preview

Packages:

  1. js2flowchart
  2. atom-js-code-to-svg-to-preview

Features

onEditor demo

TODO:

  • JSX support
  • Flow,CLI and Typescript support
  • Chrome extension for dev-tools
  • Fetching SVG to generate and manipulate code to genrate code from flowchart

Contributing

  1. Fork it (https://github.com/aryaminus/flowmaker/fork)
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request

Enjoy!