Skip to content

Latest commit

 

History

History
45 lines (26 loc) · 2.38 KB

ide-setup.md

File metadata and controls

45 lines (26 loc) · 2.38 KB

Contributing to Composer

IDE setup for Hyperledger Composer development

Both Atom.io and VS Code are popular editors amongst the Hyperledger Composer contributors.

Using Atom

Atom is the preferred code editor for contributors the Hyperledger Composer project. Many developers find Atom especially productive due to the wide range of plugins availability to assist with code development activities. These include syntax highlighting for node.js code, JavaScript and the Hyperledger Composer modelling language, or linting to help eliminate potential bugs and ensure a consistent coding style. Developers can also develop their own plugins. Here's a list of Atom plugins for you consider as you develop within the Hyperledger Composer project.

JavaScript and Node.js linting

Use the linter-eslint plugin to help with linting node.js and JavaScript code. For an example of the eslinter config file see here.

Hyperledger Composer modelling language

Use the composer-atom plugin for syntax highlighting of the Hyperledger Composer modelling language. Follow the instructions in the README to install the plugin.

Find unfinished work items

Use the todo-show plugin to find indicators that code might not be complete by finding instances of indicative text, such as TODO, FUTURE, BUG etc.

Match selected keywords

Use the highlight-selected plugin to find all matches of a keyword in the current file.

Documentation assistance

Use the docblockr plugin to create pretty comments, function prototypes and other helpful code decorations.

File type visualization

Use the file-icons plugin to assign visual representations to file extension to help locate files of a given type.

Using VSCode

to do

Next step

Move on to read Coding Guidelines