Skip to content

Latest commit

 

History

History
87 lines (64 loc) · 3.59 KB

CONTRIBUTING.md

File metadata and controls

87 lines (64 loc) · 3.59 KB
Raw

Accord Project Cicero VSCode Extension Contribution Guide

❗ 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 we'd like you to follow.

Contributors

Please update CHANGELOG.md when you make changes.

Code Structure

This is a VSCode WEB Extension, meaning that it is composed on two parts: the client and the server. The client and server communicate using JSON over HTTP, and use the Language Server Protocol. When running on the web the language server runs in a web worker, while the language client runs on the web page.

Note that this means that you must be careful what assumptions you make and the 3rd-party packages you use - as they must be webpacked to build the web extension package for distribution. In particular the language server cannot access the underlying file system, but must request files from the language client, over RPC.

.
├── client // Language Client
│   ├── src
│   │   ├── test // End to End tests for Language Client / Server
│   │   └── browserClientMain.ts // Language Client entry point
├── package.json // The extension manifest.
└── server // Language Server
    └── src
        └── browserServerMain.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 (in the command palette type > View: Show Run and Debug)
  • 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

Run in Browser

  • Run npm run run-in-browser to open the extension in Chrome.

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

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.