Skip to content

Latest commit

 

History

History
29 lines (24 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

29 lines (24 loc) · 1.54 KB
Raw

Folder Structure

.
├── package.json // The extension manifest.
├── client // Language Client
│   ├── test // End to End tests for Language Client / Server
│   ├── src
│   │   └── extension.ts // Language Client entry point
├── syntaxes // The extension manifest.
│   └── fountain.tmLanguage.json // Grammar for syntax highlighting
├── server // Language Server
│   └── src
│       └── server.ts // Language Server entry point
└── webviews // VSCode UI Framework Webview, shows stats etc.

Running the Language Server and Extension

  • 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 start compiling the client and server in watch mode.
  • Switch to the Run and Debug View in the Sidebar (Ctrl+Shift+D).
  • Select Launch Client from the drop down (if it is not already).
  • Press ▷ to run the launch config (F5).
  • If you want to debug the server as well, use the launch configuration Attach to Server
  • In the Extension Development Host instance of VSCode, open a document in 'fountain' language mode.