Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
75 lines (49 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

75 lines (49 loc) · 2.06 KB

Contribution Guide

Welcome to VS Code Tools for AXAML! We appreciate your interest in contributing. This guide will help you get started with contributing to our project. Please read it carefully.

System Requirements

  1. .NET 10.0 SDK, you can download it from here

  2. Node.js, npm
    You can get Node.js and npm using NVM (Node Version Manager) by running the following command:

    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash

    See: https://github.com/nvm-sh/nvm for the latest version of this command.

  3. Install Node package manager (npm) and use it for scripts The repository uses npm (installed with Node.js). Use npm for installing and running scripts.

  4. Latest Visual Studio Code

Set up

  1. Fork and Clone the repository

    git clone --recursive https://github.com/lextudio/vscode-axaml

  2. Update submodules
    This extension uses git submodules to pull in the Solution Parser and the AXAML Visual Studio repo. Run the following to pull in the submodules:

    git submodule update --init --recursive

  3. Run the build.sh, currently repo does not have build script for Windows

How to contribute

  1. Create a new issue or use the existing to contribute (assign it yourself)
  2. Create a new branch for the issue
  3. Send the PR with description

Run and Debug

Hit F5 this will a new vscode window with the dev extension running. Open an Avalonia project to use it.

Package Extension

Ensure you have vsce installed:

npm install -g @vscode/vsce

Build & package (outputs VSIX under ./output):

./package.sh

Or specify a custom output directory:

./package.sh /path/to/out

The script will:

  • Copy the root README and LICENSE into src/vscode-axaml temporarily
  • Build the language server (Release) & solution parser
  • Compile the TypeScript client
  • Run vsce package and place the .vsix in the output folder
  • Remove the temporary README / LICENSE copies from the extension folder