diff --git a/.gitignore b/.gitignore index 38a5ec0..6a082d9 100644 --- a/.gitignore +++ b/.gitignore @@ -4,4 +4,4 @@ node_modules log client/out server/out - +.DS_Store diff --git a/CHANGELOG.md b/CHANGELOG.md index f0c49a1..0d5f3f9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ ## Change Log +### 0.21.5 + +- Updated the README + ### 0.21.4 - Fixed packaging issue with export CTA and download models commands diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c84f301..ecb42b8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,4 +3,83 @@ ## ❗ Accord Project Contribution Guide ❗ We'd love for you to contribute to our source code and to make Accord Project Cicero VSCode Extension technology even better than it is today! Please refer to the [Accord Project Contribution guidelines][apcontribute] we'd like you to follow. -[apcontribute]: https://github.com/accordproject/techdocs/blob/master/CONTRIBUTING.md \ No newline at end of file +[apcontribute]: https://github.com/accordproject/techdocs/blob/master/CONTRIBUTING.md + +## Contributors + +Please update CHANGELOG.md when you make changes. + +### Code Structure + +``` +. +├── client // Language Client +│ ├── src +│ │ ├── test // End to End tests for Language Client / Server +│ │ └── extension.ts // Language Client entry point +├── package.json // The extension manifest. +└── server // Language Server + └── src + └── server.ts // Language Server entry point +``` + +### Running + +- Run `npm install` in this folder. This installs all necessary npm modules in both the client and server folder +- Open VS Code on this folder. +- Press Ctrl+Shift+B to compile the client and server. +- Switch to the Debug viewlet. +- Select `Launch Client` from the drop down. +- Run the launch config. +- If you want to debug the server as well use the launch configuration `Attach to Server` + +### Manual Build and Install + +Generate the installable VSIX file: + +``` +git clone https://github.com/accordproject/cicero-vscode-extension.git +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 package.json file. The 3 package.json files should all have the same version number (root/client and server). + +#### 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. \ No newline at end of file diff --git a/README.md b/README.md index d2f316b..96d0423 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,39 @@

- Accord Project Extension for VSCode + Accord Project Extension for VS Code

- Build Status - GitHub license + Version number + Installation count GitHub license Join the Accord Project Slack

-Validates that Cicero templates conform to the [Accord Project Template Specification](https://docs.accordproject.org): +The Accord Project extension helps developers to create, test and debug [Accord Project](https://accordproject.org) templates. -- 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 'text/sample.md' file for the template can be parsed using the grammar ('text/grammar.tem.md' file) -- Command to download model dependencies -- Command to generate a Cicero Template Archive ('.cta') file for a template -- Syntax highlighting for all files +For a step-by-step guide on getting started with the extension's features, access our [Beginner Tutorial](https://docs.accordproject.org). For more comprehensive documentation, [follow this link.](https://docs.accordproject.org) + +![Accord Project Extension Homepage](assets/VSCodeImage.png) -## For Template Authors +## Installation -If you want to use this plugin: +Please visit the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=accordproject.cicero-vscode-extension) for installation and more details. -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 +## Features -The extension is available from the Visual Studio Marketplace at https://marketplace.visualstudio.com/items?itemName=accordproject.cicero-vscode-extension +- Create data models for templates using the Concerto modelling language +- Develop the logic for templates using the Ergo domain specific language +- Write the natural language text for templates using the CiceroMark extended markdown syntax +- Run unit tests for templates using the Cucumber BDD testing framework +- Work offline by downloading data model dependencies +- Package templates into Cicero Template Archive (cta) files +- Syntax highlighting for all files +- Compilation and problem markers ### Concerto Snippets -The extention adds snippets for the following elements of the Concerto language. +The extention adds code snippets for the following elements of the Concerto language. | Element | Prefix | | :---------- | :---------: | @@ -52,94 +54,19 @@ The extention adds snippets for the following elements of the Concerto language. ### Ergo Snippets -The extention adds snippets for the following elements of the Ergo language. +The extention adds code snippets for the following elements of the Ergo language. | Element | Prefix | | :---------- | :---------: | | Clause | clause | | Contract | contract | -## Contributors - -### Code Structure - -``` -. -├── client // Language Client -│ ├── src -│ │ ├── test // End to End tests for Language Client / Server -│ │ └── extension.ts // Language Client entry point -├── package.json // The extension manifest. -└── server // Language Server - └── src - └── server.ts // Language Server entry point -``` - -### Running - -- Run `npm install` in this folder. This installs all necessary npm modules in both the client and server folder -- Open VS Code on this folder. -- Press Ctrl+Shift+B to compile the client and server. -- Switch to the Debug viewlet. -- Select `Launch Client` from the drop down. -- Run the launch config. -- If you want to debug the server as well use the launch configuration `Attach to Server` - -### Manual Build and Install - -Generate the installable VSIX file: - -``` -git clone https://github.com/accordproject/cicero-vscode-extension.git -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 package.json file. The 3 package.json files should all have the same version number (root/client and server). - -#### 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. +## Contact Us +If you have find any problems or want to make suggestions for future features please create [issues and suggestions on Github](https://github.com/accordproject/cicero-vscode-extension/issues). For any questions please [join](https://accord-project-slack-signup.herokuapp.com/) the Accord Project Slack community and post questions to the `#technology-cicero` channel. ## Acknowledgments -Thanks to our friends at Hyperledger Composer for inspiring us with their existing plugin, -https://github.com/hyperledger/composer-vscode-plugin/ +Thanks to our friends at IBM Blockchain Platform for inspiring us with their [existing plugin](https://github.com/IBM-Blockchain/blockchain-vscode-extension/). --- @@ -149,291 +76,4 @@ https://github.com/hyperledger/composer-vscode-plugin/

-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][linuxfound]. The technical charter for the Accord Project can be found [here][charter]. - -## Learn More About Accord Project - -### Overview - -- [Accord Project][apmain] -- [Accord Project News][apnews] -- [Accord Project Blog][apblog] -- [Accord Project Slack][apslack] -- [Accord Project Technical Documentation][apdoc] -- [Accord Project GitHub][apgit] - -### Documentation - -- [Getting Started with Accord Project][docwelcome] -- [Concepts and High-level Architecture][dochighlevel] -- [How to use the Cicero Templating System][doccicero] -- [How to Author Accord Project Templates][docstudio] -- [Ergo Language Guide][docergo] - -### Ecosystem - -#### Core libraries: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ProjectsPackage nameVersionDescription
Cicero cicero-core npm versionTemplates Core
cicero-cli npm version Cicero CLI
cicero-engine npm versionNode.js VM based implementation of Accord Project Template Specification execution
cicero-server npm versionWraps the Cicero Engine and exposes it as a RESTful service -
cicero-test npm version Testing support for Cicero based on cucumber
cicero-tools npm versionCicero Tools
generator-cicero-template npm versionCode generator for a Cicero Template
Concertoconcerto-core npm version Core Implementation for the Concerto Modeling Language
concerto-tools npm version Tools for the Concerto Modeling Language
concerto-cli npm versioncommand-line interface for Concerto
Ergoergo-clinpm versionErgo CLI
ergo-compilernpm versionErgo compiler
ergo-testnpm versionErgo test
ergo-enginenpm versionErgo engine
Markdownmarkdown-commonnpm versionA framework for transforming markdown
markdown-slatenpm versionTransform markdown to/from CommonMark DOM
markdown-cli npm version CLI for markdown transformations.
markdown-ciceronpm versionCiceroDOM: Markdown extensions for contracts, clauses, variables etc.
markdown-htmlnpm versionTransform CiceroDOM to HTML
- -#### UI Components: - - - - - - - - - - - - - - - - - - - - - - - - - - -
ProjectsPackage nameVersionDescription
Markdown Editormarkdown-editor - npm versionWYSIWYG rich text web editor that persists text as markdown. Based on Slate.js
Cicero UIcicero-ui npm versionWYSIWYG contract editor, template library browser, error panel component
Concerto UIconcerto-ui npm versionDynamic web forms generated from Concerto models
- -#### Template Editors: - - - - - - - - - - - - - - - - - - - - - - -
ProjectsCicero ver.Description
Template Studio v1 0.13.4Web UI for creating, editing and testing Accord Project templates
Template Studio v2 0.13.4Web UI for creating, editing and testing Accord Project templates
VSCode Extension0.13.4VS Code extension for editing Cicero templates and Ergo logic
- -#### Public templates and models: - - - - - - - - - - - - - - - -
ProjectsDescription
ModelsAccord Project Model Library
Template LibraryAccord Project Template Library
- -#### Documentation: - - - - - - - - - - -
ProjectRepo
Documentationtechdocs
- -## 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][apblog]. - -Join the Accord Project Technology Working Group [Slack channel][apslack] to get involved! - -For code contributions, read our [CONTRIBUTING guide][contributing] and information for [DEVELOPERS][developers]. - -### README Badge - -Using Accord Project? Add a README badge to let everyone know: [![accord project](https://img.shields.io/badge/powered%20by-accord%20project-19C6C8.svg)](https://www.accordproject.org/) - -``` -[![accord project](https://img.shields.io/badge/powered%20by-accord%20project-19C6C8.svg)](https://www.accordproject.org/) -``` - -## License - -Accord Project source code files are made available under the [Apache License, Version 2.0][apache]. -Accord Project documentation files are made available under the [Creative Commons Attribution 4.0 International License][creativecommons] (CC-BY-4.0). - -Copyright 2018-2019 Clause, Inc. All trademarks are the property of their respective owners. See [LF Projects Trademark Policy](https://lfprojects.org/policies/trademark-policy/). - -[apmain]: https://accordproject.org/ -[apworkgroup]: https://calendar.google.com/calendar/event?action=TEMPLATE&tmeid=MjZvYzIzZHVrYnI1aDVzbjZnMHJqYmtwaGlfMjAxNzExMTVUMjEwMDAwWiBkYW5AY2xhdXNlLmlv&tmsrc=dan%40clause.io -[apblog]: https://medium.com/@accordhq -[apnews]: https://www.accordproject.org/news/ -[apgit]: https://github.com/accordproject/ -[apdoc]: https://docs.accordproject.org/ -[apslack]: https://accord-project-slack-signup.herokuapp.com -[docspec]: https://docs.accordproject.org/docs/spec-overview.html -[docwelcome]: https://docs.accordproject.org/docs/accordproject.html -[dochighlevel]: https://docs.accordproject.org/docs/spec-concepts.html -[docergo]: https://docs.accordproject.org/docs/logic-ergo.html -[docstart]: https://docs.accordproject.org/docs/accordproject.html -[doccicero]: https://docs.accordproject.org/docs/basic-use.html -[docstudio]: https://docs.accordproject.org/docs/advanced-latedelivery.html -[contributing]: https://github.com/accordproject/cicero-vscode-extension/blob/master/CONTRIBUTING.md -[developers]: https://github.com/accordproject/cicero-vscode-extension/blob/master/DEVELOPERS.md -[linuxfound]: https://www.linuxfoundation.org -[charter]: https://github.com/accordproject/cicero-vscode-extension/blob/master/CHARTER.md -[npmpkg]: https://www.npmjs.com/package/@accordproject/ergo-cli -[coq]: https://coq.inria.fr -[ocaml]: https://ocaml.org -[qcert]: https://querycert.github.io -[repl]: https://ergorepl.netlify.com -[studio]: https://studio.accordproject.org -[nodejs]: https://nodejs.org/ -[apache]: https://github.com/accordproject/cicero-vscode-extension/blob/master/LICENSE -[creativecommons]: http://creativecommons.org/licenses/by/4.0/ - +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](https://linuxfoundation.org). \ No newline at end of file diff --git a/assets/VSCodeImage.afphoto b/assets/VSCodeImage.afphoto new file mode 100644 index 0000000..9aef7af Binary files /dev/null and b/assets/VSCodeImage.afphoto differ diff --git a/assets/VSCodeImage.png b/assets/VSCodeImage.png new file mode 100644 index 0000000..f551e17 Binary files /dev/null and b/assets/VSCodeImage.png differ diff --git a/client/package-lock.json b/client/package-lock.json index 367d2ec..da45a44 100644 --- a/client/package-lock.json +++ b/client/package-lock.json @@ -1,6 +1,6 @@ { "name": "cicero-vscode-extension-client", - "version": "0.21.4", + "version": "0.21.5", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/client/package.json b/client/package.json index 904f2f8..bd10540 100755 --- a/client/package.json +++ b/client/package.json @@ -4,7 +4,7 @@ "description": "Accord Project extension for Visual Studio Code, providing tools for template development.", "author": "Accord Project", "license": "Apache-2.0", - "version": "0.21.4", + "version": "0.21.5", "publisher": "accordproject", "repository": { "type": "git", diff --git a/package-lock.json b/package-lock.json index b6dd79d..8d727c5 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "cicero-vscode-extension", - "version": "0.21.4", + "version": "0.21.5", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index b6451fe..e3ed5d9 100644 --- a/package.json +++ b/package.json @@ -4,7 +4,7 @@ "description": "Accord Project extension for Visual Studio Code, providing tools for template development.", "author": "Accord Project", "license": "Apache-2.0", - "version": "0.21.4", + "version": "0.21.5", "icon": "icon.png", "repository": { "type": "git", diff --git a/server/package-lock.json b/server/package-lock.json index 383545e..c801036 100644 --- a/server/package-lock.json +++ b/server/package-lock.json @@ -1,6 +1,6 @@ { "name": "cicero-vscode-extension-server", - "version": "0.21.4", + "version": "0.21.5", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/server/package.json b/server/package.json index 220fd40..4c5754f 100755 --- a/server/package.json +++ b/server/package.json @@ -1,7 +1,7 @@ { "name": "cicero-vscode-extension-server", "description": "A language server for Accord Project templates", - "version": "0.21.4", + "version": "0.21.5", "license": "Apache-2.0", "engines": { "node": "*"