blob: 5bcdce0c4dbfd82bc070b1d4c79d6d84f2264a7f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
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 |
|
