diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..5bcdce0 --- /dev/null +++ b/README.md @@ -0,0 +1,78 @@ +# Language Server Protocol types code generator + +This repository contains code to generate Language Server Protocol types and classes for various languages. + +# Code Generator usage + +## Usage + +You will need a python environment to run the generator. Here are the steps: + +1. Create a python environment (min supported python 3.7): `python -m venv .venv` +2. Get this tool: `python -m pip install git+https://github.com/microsoft/lsprotocol.git` +3. Run your plugin: `python -m generator --plugin dotnet --output-dir ./code` + +### Command line + +Clone this repository and run `generator` like a module. + +```console +>python -m generator --help +usage: __main__.py [-h] [--model [MODEL [MODEL ...]]] --plugin PLUGIN + [--output-dir OUTPUT_DIR] + +Generate types from LSP JSON model. + +optional arguments: + -h, --help show this help message and exit + --model [MODEL [MODEL ...]], -m [MODEL [MODEL ...]] + Path to a model JSON file. By default uses packaged + model file. + --plugin PLUGIN, -p PLUGIN + Name of a builtin plugin module. By default uses all + plugins. + --output-dir OUTPUT_DIR, -o OUTPUT_DIR + Path to a directory where the generated content is +``` + +### using `nox` + +This project uses `nox` as a task runner to run the code generator. You can install `nox` and run `build_lsp` session to generate code from spec available in the repo. + +```console +> python -m pip install nox +> nox --session build_lsp +``` + +You can format code, run tests, and other tasks using `nox` as well. + +# Contributing plugins + +## Adding a new plugin + +Follow these steps to generate boiler plate code for new plugin: + +1. Create a virtual environment for python using python 3.7 and activate that environment. + 1. If you have python extension for VS Code installed then run `Python: Create Environment` command. Be sure to select all the `requirements.txt` files in the repo. This should, install all packages needed and select the environment for you. +1. Ensure `nox` is installed. + 1. Run `nox --list`, is nox is installed oyu should see a list of available sessions. Otherwise, run `python -m pip install nox` from the python 3.7 environment you created above. +1. Run `nox --session create_plugin` and follow the prompts to create a new plugin. + +Example: + +```console +> nox --session create_plugin +nox > Running session create_plugin +nox > Creating virtual environment (virtualenv) using python.exe in .nox\create_plugin +Enter the name of the plugin: java +nox > Created plugin java. +nox > Session create_plugin was successful. +``` + +# Supported plugins + +| Language | Plugin Module | Package | Notes | +| -------- | ------------------------ | --------------------------------------------------------------------------------------------------- | ----------- | +| Python | generator.plugins.python | [](https://pypi.org/p/lsprotocol) | Active | +| Rust | generator.plugins.rust | <in development> | Development | +| Dotnet | generator.plugins.dotnet | <in developemnt> | Development | |