You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ This repository contains packages and tools to generate code for [Language Serve
4
4
5
5
It simplifies the creation of language servers for different programming languages by providing a robust and easy-to-use type generation system.
6
6
7
-
➡️ For instructions on how to use the **code generator**, refer to the [Usage](#usage) section.
7
+
➡️ For instructions on how to use the **code generator**, refer to the [Usage](#code-generator-usage) section.
8
8
9
9
➡️ For instructions on existing **plugins and packages** for different languages, refer to the table in the [Existing packages/plugins](#existing-packagesplugins) section.
10
10
@@ -15,7 +15,7 @@ It simplifies the creation of language servers for different programming languag
15
15
You will need a Python environment to run the generator. Here are the steps:
16
16
17
17
1. Create a Python environment: `python -m venv .venv`
18
-
> **Note**: Python 3.8 is the minimum supported version
18
+
> **Note**: Python 3.8 is the minimum supported version
19
19
2. Activate the environment: `.venv\Scripts\activate` (Windows) or `source .venv/bin/activate` (Linux/macOS)
20
20
3. Install this repo's tool: `python -m pip install git+https://github.com/microsoft/lsprotocol.git`
21
21
4. Run your plugin. You can use the [command line](#command-line) or [Nox](#using-nox) to run the generator.
@@ -27,7 +27,7 @@ Clone this repository and run `generator` as a Python module.
27
27
For example: `python -m generator --plugin dotnet --output-dir ./code`
@@ -63,9 +63,9 @@ You can also use Nox to format code, run tests and run various tasks. Run `nox -
63
63
Follow these steps to generate boilerplate code for a new plugin:
64
64
65
65
1. Create a virtual environment for Python using Python >= 3.8 and activate that environment.
66
-
1. If you are using the Python extension for VS Code, you can just run the **Python: Create Environment** command from the Command Palette. Be sure to select all the `requirements.txt` files in the repo. This command will install all packages needed and select the newly created environment for you.
66
+
1. If you are using the Python extension for VS Code, you can just run the **Python: Create Environment** command from the Command Palette. Be sure to select all the `requirements.txt` files in the repo. This command will install all packages needed and select the newly created environment for you.
67
67
1. Ensure `nox` is installed.
68
-
1. Run `nox --list` in the terminal. If Nox is installed, you should see a list of all available sessions. Otherwise, run `python -m pip install nox` in the activated environment you created above.
68
+
1. Run `nox --list` in the terminal. If Nox is installed, you should see a list of all available sessions. Otherwise, run `python -m pip install nox` in the activated environment you created above.
69
69
1. Run `nox --session create_plugin` and follow the prompts to create a new plugin.
70
70
71
71
Example:
@@ -83,10 +83,10 @@ nox > Session create_plugin was successful.
83
83
84
84
Below is the list of plugins already created using this package, with their respective package links.
85
85
86
-
| Language | Plugin Module | Package | Status | Documentation |
| Python | generator.plugins.python |[](https://pypi.org/p/lsprotocol)| Active |[Python package README](./packages/python/README.md)|
89
-
| Rust | generator.plugins.rust |[](https://crates.io/crates/lsprotocol)| Active |[Rust package README](./packages/rust/lsprotocol/README.md)|
90
-
| Dotnet | generator.plugins.dotnet | <indevelopment> | Under development | <indevelopment> |
91
-
| Crystal ||[nobodywasishere/lsprotocol-crystal](https://github.com/nobodywasishere/lsprotocol-crystal)| Active |[CrystalDoc.info](https://crystaldoc.info/github/nobodywasishere/lsprotocol-crystal/main/index.html)|
92
-
| Golang ||[myleshyson/lsprotocol-go](https://github.com/myleshyson/lsprotocol-go)| Active |[myleshyson/lsprotocol-go](https://github.com/myleshyson/lsprotocol-go)|
86
+
| Language | Plugin Module | Package | Status | Documentation|
| Python | generator.plugins.python |[](https://pypi.org/p/lsprotocol)| Active |[Python package README](./packages/python/README.md)|
89
+
| Rust | generator.plugins.rust |[](https://crates.io/crates/lsprotocol)| Active |[Rust package README](./packages/rust/lsprotocol/README.md)|
90
+
| Dotnet | generator.plugins.dotnet | <indevelopment> | Under development | <indevelopment>|
91
+
| Crystal ||[nobodywasishere/lsprotocol-crystal](https://github.com/nobodywasishere/lsprotocol-crystal)| Active |[CrystalDoc.info](https://crystaldoc.info/github/nobodywasishere/lsprotocol-crystal/main/index.html)|
92
+
| Golang ||[myleshyson/lsprotocol-go](https://github.com/myleshyson/lsprotocol-go)| Active |[myleshyson/lsprotocol-go](https://github.com/myleshyson/lsprotocol-go)|
0 commit comments