-
Notifications
You must be signed in to change notification settings - Fork 55
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc - Update doc after merge language server (#1528)
- Loading branch information
Showing
4 changed files
with
28 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,30 +6,36 @@ Start by opening an issue using one of the issue templates, or propose a change | |
|
||
## Running the Project | ||
|
||
### Build Gradle Server and Gradle Language Server. | ||
### Prerequisites | ||
1. Install [nvm](https://github.com/nvm-sh/nvm) | ||
2. Install [Java version >= 17](https://adoptium.net/) | ||
3. Change directory to the root of the project | ||
4. Select Node version: `nvm use` | ||
5. If using an Apple M1: | ||
3. Select Node version: `nvm use` | ||
4. If using an Apple M1: | ||
- Add `npm_arch=x64` to $HOME/.gradle/gradle.properties | ||
- Add `protoc_platform=osx-x86_64` to $HOME/.gradle/gradle.properties | ||
6. If using Windows: | ||
5. If using Windows: | ||
- The extension uses `[email protected]` dependency which does not work out-of-the-box in Windows (check [this issues](https://github.com/grpc/grpc-node/issues/2338) for details), so you'll need to install some aditional DLLs if the project build is failed. | ||
- Download and start [Build Tools for Visual Studio 2022](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022). | ||
- Go to the **Individual Components** tab and select the following: | ||
- `MSVC v143 - VS 2022 C++ x64/x86 build tools (latest)` (replacing `x64/x86` with your arch) | ||
- `Windows Universal CRT SDK` | ||
- Click `Install` to add the components. | ||
7. Build project files: `./gradlew build` | ||
|
||
Running the build for the first time can take a bit of time, but subsequent builds should be fast. | ||
### Build Gradle Build Server & Gradle Project Importer | ||
Before proceeding with the build steps for Build Task Server & Language Server, you need to build the Gradle Build Server and its client (Gradle Project Importer) first. | ||
|
||
1. `cd extension` | ||
2. `git clone https://github.com/microsoft/build-server-for-gradle.git ` | ||
3. Build the Importer and Build Server jars: `../gradlew buildJars` | ||
|
||
### Build Task Server & Language Server | ||
After building the Gradle Build Server and its client, proceed with the following steps. | ||
|
||
1. Change directory to the root of the project | ||
|
||
### Build Gradle Project Importer | ||
1. Install [Java version >= 17](https://adoptium.net/) | ||
2. `cd extension` | ||
3. `git clone https://github.com/microsoft/build-server-for-gradle.git ` | ||
4. Build the Importer and Build Server jars: `../gradlew buildJars` | ||
2. Build project files: `./gradlew build` | ||
|
||
Running the build for the first time can take a bit of time, but subsequent builds should be fast. | ||
|
||
## Debugging Gradle plugin | ||
|
||
|
@@ -51,11 +57,6 @@ The extension uses a Gradle plugin (`com.microsoft.gradle.GradlePlugin`) to get | |
> ``` | ||
> it indicates that the connection attempt to the Gradle Server was too slow. The [GradleBuildClient](/extension/jdtls.ext/com.microsoft.gradle.bs.importer/src/com/microsoft/gradle/bs/importer/ImporterPlugin.java#L107) requires an active Gradle Server to successfully establish a connection. If you encounter this issue, please retry the connection promptly to avoid this error. | ||
## Debugging Gradle Language Server (editing feature related) | ||
1. Run vscode launch configuration `Debug Language Server: Launch Extension`. | ||
2. Run vscode launch configuration `Debug Language Server: Launch Language Server`. | ||
## Development Workflow | ||
Open the root of the project in VS Code. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.