Skip to content
VS Code extension for editing Cicero templates and Ergo logic
TypeScript Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
.travis
.vscode
assets
client chore(dep) Switch to Cicero 0.20.1 Nov 8, 2019
server
.gitignore
.travis.yml
CHARTER.md
CONTRIBUTING.md
DEVELOPERS.md docs(*): update markdown files and fix typos - I257 Oct 19, 2019
HEADER
LICENSE
README.md
ThirdPartyNotices.txt

README.md

Accord Project Extension for VSCode

Build Status GitHub license Join the Accord Project Slack

Validates that Cicero templates conform to the Accord Project Template Specification:

  • Validates the model for the template ('.cto' files), downloading referenced external models as required
  • Validates the logic of the template ('.ergo' files)
  • Validates that the template archive can be built
  • Validates that the 'text/sample.md' file for the template can be parsed using the grammar ('text/grammar.tem.md' file)
  • Syntax highlighting for all files

For Template Authors

If you want to use this plugin:

  1. Download and install VSCode from https://code.visualstudio.com/download
  2. Remove any existing versions of the Ergo extension and the Hyperledger Composer extension
  3. From the extensions view in VSCode, search for "Accord Project", click the Install button to install it

The extension is available from the Visual Studio Marketplace at https://marketplace.visualstudio.com/items?itemName=accordproject.cicero-vscode-extension

For Contributors

Manual Build and Install

Generate the installable VSIX file:

git clone https://github.com/accordproject/cicero-vscode-extension.git
cd cicero-vscode-extension/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 or .ergo file

Travis CI build

Developers no longer need a manual build, once you have created a pull 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/accordproject/cicero-vscode-extension
  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 Accord Project in the search field and hit return key or search button
  3. This will bring you to https://marketplace.visualstudio.com/search?term=Accord%20Project&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 Accord Project
  4. The new published Accord Project plugin 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.

Acknowledgments

Thanks to our friends at Hyperledger Composer for inspiring us with their existing plugin, https://github.com/hyperledger/composer-vscode-plugin/


Accord Project Logo

Accord Project is an open source, non-profit, initiative working to transform contract management and contract automation by digitizing contracts. Accord Project operates under the umbrella of the Linux Foundation. The technical charter for the Accord Project can be found here.

Learn More About Accord Project

Overview

Documentation

Ecosystem

Core libraries:

Projects Package name Version Description
Cicero cicero-core npm version Templates Core
cicero-cli npm version Cicero CLI
cicero-engine npm version Node.js VM based implementation of Accord Protocol Template Specification execution
cicero-server npm version Wraps the Cicero Engine and exposes it as a RESTful service
cicero-test npm version Testing support for Cicero based on cucumber
cicero-tools npm version Cicero Tools
generator-cicero-template npm version Code generator for a Cicero Template
Concerto concerto-core npm version Core Implementation for the Concerto Modeling Language
concerto-tools npm version Tools for the Concerto Modeling Language
concerto-cli npm version command-line interface for Concerto
Ergo ergo-cli npm version Ergo CLI
ergo-compiler npm version Ergo compiler
ergo-test npm version Ergo test
ergo-engine npm version Ergo engine
Markdown markdown-common npm version A framework for transforming markdown
markdown-slate npm version Transform markdown to/from CommonMark DOM
markdown-cli npm version CLI for markdown transformations.
markdown-cicero npm version CiceroDOM: Markdown extensions for contracts, clauses, variables etc.
markdown-html npm version Transform CiceroDOM to HTML

UI Components:

Projects Package name Version Description
Markdown Editor markdown-editor npm version WYSIWYG rich text web editor that persists text as markdown. Based on Slate.js
Cicero UI cicero-ui npm version WYSIWYG contract editor, template library browser, error panel component
Concerto UI concerto-ui npm version Dynamic web forms generated from Concerto models

Template Editors:

Projects Cicero ver. Description
Template Studio v1 0.13.4 Web UI for creating, editing and testing Accord Project templates
Template Studio v2 0.13.4 Web UI for creating, editing and testing Accord Project templates
VSCode Extension 0.13.4 VS Code extension for editing Cicero templates and Ergo logic

Public templates and models:

Projects Description
Models Accord Project Model Library
Template Library Accord Project Template Library

Documentation:

Project Repo
Documentation techdocs

Contributing

The Accord Project technology is being developed as open source. All the software packages are being actively maintained on GitHub and we encourage organizations and individuals to contribute requirements, documentation, issues, new templates, and code.

Find out what’s coming on our blog.

Join the Accord Project Technology Working Group Slack channel to get involved!

For code contributions, read our CONTRIBUTING guide and information for DEVELOPERS.

License

Accord Project source code files are made available under the Apache License, Version 2.0. Accord Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0).

Copyright 2018-2019 Clause, Inc. All trademarks are the property of their respective owners. See LF Projects Trademark Policy.

You can’t perform that action at this time.