Hyperledger Composer Extension for VSCode

⚠️ ⚠️ ⚠️

As of the 29th August 2019, the Hyperledger Composer project is in deprecated status. None of the maintainers are actively developing new features. None of the maintainers are actively providing support via GitHub issues. However, if you wish to submit code changes via pull requests, these will be merged.

It is highly recommended that you use Hyperledger Fabric v1.4+ instead, which features significant improvements to the developer experience, including a new programming model.

More information available here: What's new in Hyperledger Fabric v1.4

⚠️ ⚠️ ⚠️

Validate Composer model files that define the structure of your business network in terms of Assets, Participants and Transactions.

The extension parses Composer model (.cto) files and reports any validation errors. It is currently in beta; please raise any problems you find as an issue.

Manual Build and Install

Generate the installable VSIX file:

git clone https://github.com/hyperledger/composer-vscode-plugin.git
cd composer-vscode-plugin/server
npm install
npm run compile:server
cd ../client
npm install
npm run package:vsix

1. Launch VSCode
2. View > Extensions
3. Press the ... and select "Install from VSIX"
4. Browse to the VSIX file
5. Install and restart VSCode
6. Open a .cto file

Travis CI build

Developers no longer need a manual build, once you have pulled a request from your private Github repository. The build will be automatically performed by Travis. A successful build will create an installable VSIX file on the build machine. The public release version number is defined in the Client package.json file.

Publish Release

Below are steps for publishing a release.

1. Go to https://github.com/hyperledger/composer-vscode-plugin
2. Click Releases tab
3. Click Draft a new release on the right
4. Type a Tag version in the Tag version field. e.g. v0.5.7.1
5. Type a Release title in the Release title field e.g v0.5.7.1
6. Provide a short description of this release under the Write tab
7. Uncheck the box for This is a pre-release at the end of this page
8. Click Publish release button to publish the VSIX file to the VSCode Marketplace

Check the published release

1. Go to the VSCode Marketplace: https://marketplace.visualstudio.com/
2. Type Composer in the search field and hit return key or search button
3. This will bring you to https://marketplace.visualstudio.com/search?term=Composer&target=VSCode&category=All%20categories&sortBy=Relevance

Install a new release

1. Open Visual Studio Code in your desktop
2. Open the Extensions by View-->Extensions or Ctrl(cmd)+Shift+x
3. Search for Composer
4. The new published Hyperledger Composer 0.7.1 is showing on the list
5. Click Install button to install it
6. Update button will be shown if you have already installed the same plugin before.

License

Hyperledger Project source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the LICENSE file. Hyperledger Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0), available at http://creativecommons.org/licenses/by/4.0/.