Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (53 loc) · 2.92 KB

CONTRIBUTING.md

File metadata and controls

70 lines (53 loc) · 2.92 KB

How to contribute to this project

If you are interested in contributing to the development and maintenance of this package, it is recommended that you use nvm for node version management.

🚀 Development

Prerequisites

  • Node.js 22.17+

Setup

# Clone the repository
git clone https://github.com/dynovaio/lark-parser-vscode.git
cd lark-parser-vscode

# Install Node.js dependencies
npm install

# Build the extension
npm run compile

Running

  1. Open the project in VS Code
  2. Press F5 to launch Extension Development Host
  3. Open a .lark file to test the extension

Architecture

This extension follows the Language Server Protocol (LSP) architecture:

  • TypeScript Client (src/extension.ts): VS Code extension that manages the language server
  • Python Server (lark_parser_language_server): Implements LSP features
  • Communication: JSON-RPC over stdio between client and server

The server is installed automatically by the extension and does not require manual setup for end users. The language server is provided by the lark-parser-language-server ↗ package developed by Dynova ↗.

Code of Conduct

Please note that this project is published with a Code of Conduct for collaborators. By participating in this project, you agree to abide by its terms.