Skip to content

Commit 713a0b9

Browse files
authored
chore: Refine document (#513)
* fix document
1 parent 90cc9aa commit 713a0b9

File tree

6 files changed

+41
-9
lines changed

6 files changed

+41
-9
lines changed

README.md

Lines changed: 39 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,56 @@
22

33
> Manage Java projects in Visual Studio Code
44
5-
[![GitHub Actions](https://img.shields.io/github/workflow/status/microsoft/vscode-java-dependency/CI/master?style=flat-square)](https://github.com/microsoft/vscode-java-dependency/actions?query=workflow%3ACI+branch%3Amaster)
5+
[![GitHub Actions](https://img.shields.io/github/workflow/status/microsoft/vscode-java-dependency/CI/main?style=flat-square)](https://github.com/microsoft/vscode-java-dependency/actions?query=workflow%3ACI+branch%3Amain)
66

77
## Overview
88

99
A lightweight extension to provide additional Java project explorer features. It works with [Language Support for Java by Red Hat](https://marketplace.visualstudio.com/items?itemName=redhat.java) to provide the following features:
1010

11-
* Project View
11+
### Project View
1212

13-
![project-view](https://raw.githubusercontent.com/Microsoft/vscode-java-dependency/master/images/project-explorer.png)
13+
![project-view](https://raw.githubusercontent.com/Microsoft/vscode-java-dependency/main/images/project-explorer.png)
1414

15-
* Create Java Projects
15+
### Create Java Projects
1616

17-
![create project](https://raw.githubusercontent.com/Microsoft/vscode-java-dependency/master/images/create-project.png)
17+
![create project](https://raw.githubusercontent.com/Microsoft/vscode-java-dependency/main/images/create-project.png)
1818

19-
* Export Jar
19+
### Export Jar
2020
> Note: For Spring Boot projects, please use the build tool to build the executable jar, for example: `mvn package`.
2121
22-
![export jar](https://raw.githubusercontent.com/Microsoft/vscode-java-dependency/master/images/export-jar.png)
22+
![export jar](https://raw.githubusercontent.com/Microsoft/vscode-java-dependency/main/images/export-jar.png)
23+
24+
### Manage Dependencies
25+
26+
You can work with JAR files directly without any build tools. Go to `JAVA PROJECTS` view, find the `Referenced Libraries` node and click the `+` icon:
27+
28+
![Reference JAR Files](https://raw.githubusercontent.com/Microsoft/vscode-java-dependency/main/images/manage-dependencies.gif)
29+
30+
If you want to fine-tune this, go to `settings.json` and look for the `java.project.referencedLibraries` entry.
31+
32+
```json
33+
"java.project.referencedLibraries": [
34+
"library/**/*.jar",
35+
"/home/username/lib/foo.jar"
36+
]
37+
```
38+
39+
You can tell that the glob pattern is supported. And here's more - you can include/exclude certain files, and attach source JARs:
40+
41+
```json
42+
"java.project.referencedLibraries": {
43+
"include": [
44+
"library/**/*.jar",
45+
"/home/username/lib/foo.jar"
46+
],
47+
"exclude": [
48+
"library/sources/**"
49+
],
50+
"sources": {
51+
"library/bar.jar": "library/sources/bar-src.jar"
52+
}
53+
}
54+
```
2355

2456
## Requirements
2557

images/create-project.png

12.3 KB
Loading

images/export-jar.png

28.1 KB
Loading

images/manage-dependencies.gif

1.18 MB
Loading

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
"type": "git",
1919
"url": "https://github.com/Microsoft/vscode-java-dependency.git"
2020
},
21-
"homepage": "https://github.com/Microsoft/vscode-java-dependency/blob/master/README.md",
21+
"homepage": "https://github.com/Microsoft/vscode-java-dependency/blob/main/README.md",
2222
"icon": "logo.png",
2323
"capabilities": {
2424
"virtualWorkspaces": false,

templates/invisible-project/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ The workspace contains two folders by default, where:
1111

1212
## Dependency Management
1313

14-
The `JAVA DEPENDENCIES` view allows you to manage your dependencies. More details can be found [here](https://github.com/microsoft/vscode-java-pack/blob/master/release-notes/v0.9.0.md#work-with-jar-files-directly).
14+
The `JAVA PROJECTS` view allows you to manage your dependencies. More details can be found [here](https://github.com/microsoft/vscode-java-dependency#manage-dependencies).

0 commit comments

Comments
 (0)