microsoft / vscode-java-dependency

Manage Java projects in Visual Studio Code.

Project Manager for Java

Manage Java projects in Visual Studio Code

Overview

A lightweight extension to provide additional Java project explorer features. It works with Language Support for Java by Red Hat to provide the following features:

Project View

Create Java Projects

Export Jar

Note: For Spring Boot projects, please use the build tool to build the executable jar, for example: mvn package.

Manage Dependencies

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:

If you want to fine-tune this, go to settings.json and look for the java.project.referencedLibraries entry.

"java.project.referencedLibraries": [
    "library/**/*.jar",
    "/home/username/lib/foo.jar"
]

You can tell that the glob pattern is supported. And here's more - you can include/exclude certain files, and attach source JARs:

"java.project.referencedLibraries": {
    "include": [
        "library/**/*.jar",
        "/home/username/lib/foo.jar"
    ],
    "exclude": [
        "library/sources/**"
    ],
    "sources": {
        "library/bar.jar": "library/sources/bar-src.jar"
    }
}

Requirements

• VS Code (version 1.83.1+)
• Language Support for Java by Red Hat

Settings

Setting Name	Description	Default Value
java.dependency.showMembers	Specify whether to show the members in the Java Projects explorer.	false
java.dependency.syncWithFolderExplorer	Specify whether to link Java Projects Explorer with the active editor.	true
java.dependency.autoRefresh	Specify whether to automatically sync the change from editor to the Java Projects explorer.	true
java.dependency.refreshDelay	The delay time (ms) the auto refresh is invoked when changes are detected.	2000ms
java.dependency.packagePresentation	Specify how to display the package. Supported values are: flat, hierarchical.	flat
java.project.exportJar.targetPath	The output path of export jar. When this setting is empty , a file explorer will pop up to let the user select the output location.	${workspaceFolder}/${workspaceFolderBasename}.jar
java.project.explorer.showNonJavaResources	When enabled, the explorer shows non-Java resources.	true

Contribution

Build

• Prerequirement

  • Node.js
  • Java SDK 11 or above

• Go to root folder:

npm install
npm run build-server

Telemetry

VS Code collects usage data and sends it to Microsoft to help improve our products and services. Read our privacy statement to learn more. If you don't wish to send usage data to Microsoft, you can set the telemetry.enableTelemetry setting to false. Learn more in our FAQ.

---

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

vscode-java-dependency's Issues

There is no order about the substructure of string class

OS: Windows
Configurations: Vscode1.29.0&&JDK1.8.0_191

When I open the substructure of the string class, It is shown as below:
I think it could be sorted as alphabetical order.

0.2.0 Endgame

Summary

1. the target date for this release will be 11/16
2. Fix the following issues:

• #79 Files in 'src/main/resources/' do not display enhancement
• #83 The side bar keeps popping up when a new Java file opens
• #80 No way to link a java class definition back to the project explorer?

3. Left over issues:

• #106 No way to link a resource files back to the project explorer
• JDK class may not link back to the project explorer
• No outline for .class in jar without source

Build

• 11/19 - Bump version to 0.2.0 @andxu
• 11/19 - Add change log for 0.2.0 - @andxu
• 11/19- Signed RC Bits @andxu https://vscjavaci.cloudapp.net/job/vscode-java-dependency/job/vscode-java-dependency.vsix.withSign/12/

Test

• 11/19 - Run test plan and verify bugs listed in 0.2.0 milestone(windows and mac) - @

Release

• 11/19 - Add 0.2.0 tag - @andxu
• 11/19 - Release to marketplace - @andxu

Notes

Before you check an item, please reply to this issue with the following details:

What are the steps and details of your check?
What are the configurations?
What are the issues found in the process?
What's your conclusion?

Collect telemetry data

Dependency viewer should have a special icon for symbolic linked file/folder

Package content display should be ordered

Change extension name to "Java Dependency Viewer"

Here's the scenario where "Java Dependencies" does not work.

When we recommend extensions, we use "Install xxx..."
And for this extension, it will be "Install Java Dependencies", which is super confusing.

And the name "Java Dependencies" itself is not accurate and does not state its actual use.

Please make the change before we proceed with microsoft/vscode-java-pack#60

No way to link a resource files back to the project explorer

A folder or workspace opens multiple Maven projects with an exception

A folder or workspace opens multiple Maven projects. （A be dependent on B）:
1.A project mavenDependencies can not found B,[go to definition] is also directly to the source code of B,but maven package B and sourcecode are different.
2.This will cause debugging abnormaland,breakpoints may never hit.
The A project alone will not have such a problem.

[Public]0.1.0 Endgame

Summary

1. the target date for this release will be 10/19
2. the version will revert back to 0.1.0 (public)
3. fix the compatible issue with newest vscode

• The outline doesn't show any children under a .java/.class file(set true to the java.dependency.showOutline setting)

Build

• 10/18 - Bump version to 0.1.0 @andxu
• 10/18 - Add change log for 0.1.0 - @andxu
• 10/18- Signed RC Bits @andxu https://vscjavaci.cloudapp.net/job/vscode-java-dependency/job/vscode-java-dependency.vsix.withSign/

Test

• 10/19 - Run test plan and verify bugs listed in 0.1.0 milestone(windows and mac) - @bsaby

Release

• 10/19 - Add 0.1.0 tag - @andxu
• 10/19 - Release to marketplace - @andxu

Notes

Before you check an item, please reply to this issue with the following details:

What are the steps and details of your check?
What are the configurations?
What are the issues found in the process?
What's your conclusion?

Java dependencies window will not shown until open a java file

Bulid: 41

When open the simple project in vscode for the first time, the java dependencies window will not shown.

Better GIF Animations

Please use 1024*768 in dark theme to record the screen for better quality.

No way to link a java class definition back to the project explorer?

I find this dependency view of limited use unless I can link to it from an open class definition, e.g. to browse classes in the same package as one that I opened directly with CTRL-Click, or similar.

Support attaching source code for the third-party jar in dependency view

Class file can't show the symbols in the explorers

The extension name of details is different from the real name

For simple workspace, it is not necessary to display two levels.

Folder/Package folder icon should be open when user expands the tree node.

error: cannot read property 'then' of null

use the project https://github.com/spring-projects/spring-boot/tree/master/spring-boot-samples/spring-boot-sample-tomcat

click to the last node of maven dependencies:

MANIFEST.MF file shows in new tab, but en error pops up in the right bottom corner.

Use the latest version of vscode-extension-telemetry & vscode-extension-telemetry-wrapper dependencies

• replace vscode-extension-telemetry with telemetry-wrapper, see Eskibear/vscode-extension-telemetry-wrapper#20 for more details
• use vscode application insight to record telemetry

Handle default package content in the view

Display the dependency info for the vscode-java default project

It's better to show the dependency info for the default project.

Cannot read property 'manifest' of null

Error occurs in toggle developer tools after installing build.

The class which has no source can't show the substructure

OS: Windows
Configurations: Vscode 1.29.0&&JDK1.8.0_191

Sample project:
simple.zip

When I open the class in the jar,I can't see its substructure, the behavior has below:

Chinese Language Support

We have lots of Chinese developers. It would be great if we can provide a localized interface. This issue is to track the effort of building the localization story.
Supporting Chinese is a start. Once the solution is working, we can expand the support to other languages.

Test Plan

Test platform

Windows 10/Mac/Ubuntu 16.04 or 18.04

Features

Basic

• Can create java project from navigation command bar following the instructions
• Can not create java projects with conflicts name in same location
• Can press F5 to run the java project
• Can set breakpoints to debug the java project
• Can view all dependencies of the opened java project

Simple project

• Open the project under $repo/test/simple
• Can create java project from navigation command bar following the instructions
• Can show the package of the source code
• Can open source file
• Can show the external "JRE System Library"
• Can show the jar under the libarary
• Can show the package under the jar
• Can show the classfile under the package and open the classfile
• Can show the symbols in the explorers

Maven project

• Open the project under $repo/test/maven
• Can create java project from navigation command bar following the instructions
• Can show the package of the source code
• Can open source file
• Can show the external "Maven dependencies"
• Can show the jar under the libarary
• Can show the package under the jar
• Can show the classfile under the package and open the classfile
• Can show the symbols in the explorers

Gradle project

• Open the project under $repo/test/gradle
• Can create java project from navigation command bar following the instructions
• Can show the package of the source code
• Can open source file
• Can show the external "Project and External Dependencies"
• Can show the jar under the libarary
• Can show the package under the jar
• Can show the classfile under the package and open the classfile
• Can show the symbols in the explorers

Multiple project

• Open the project under $repo/test/multiple
• Should have correct behavior for both projects in the following scenarios:
• Can create java project from navigation command bar following the instructions
• Can show the package of the source code
• Can open source file
• Can show the external "JRE System Library"
• Can show the jar under the libarary
• Can show the package under the jar
• Can show the classfile under the package and open the classfile
• Can show the symbols in the explorers

The display of the jar under library is not expected on Windows

Build: 44
Vscode1.28.2
JDK10.0.2

Open the simple java project, the jar under library as below:

Mac-expected:

and the eclipse on Windows is that:

"JAVA DEPENDENCIES" View should always show

Current Behavior

Currently, the view only shows up when the Java LS finishes loading the project.

Expected Behavior

• The view needs to be statically showing in the file explorer view. Its visibility should be controlled by users.
• When the view is loading and has nothing to show, show icon or text to indicate the loading status just like other views.

Create new class and package from explorer

Is it possible to add a context menu for functions such as new class and new package?

The source file container sometime need refresh to populate the children

Open the classfile under the package, an unknown error occured

Build: 41
Platform: all

Open any class file under package in the explorers

Error in toggle developer tools:

Windwos:

Mac and Linux:

Attached logs:
logs.txt

Use the latest version of vscode-extension-telemetry & vscode-extension-telemetry-wrapper dependencies

As per Eskibear/vscode-extension-telemetry-wrapper#22, the vscode-extension-telemetry-wrapper needs to be updated to 0.3.4 and the vscode-extension-telemetry needs to be updated to 0.1.0

different lib jars will be displayed as independent package container

Add this extension to Java Extension Pack?

This Extension is currently part of the Java Extension Pack. Should it be added?

Files in 'src/main/resources/' do not display

Will it support this feature?

Java explorer extension will not be activated unless open a java file

Steps to reproduce:

1. Open the simple project in vscode
2. Java explorer extension will not be activated unless open a java file

Create Java Project

Refresh

The cursor jumps is not accurate if there are comments

Configuration:

Vscode: 1.29.0
JDK: 1.8.0_181
OS: Win10

Repro Steps：

1. Open a project and click a class file which have comment of function and variable.
2. Click function or variable.

Actual:

Expect:

The side bar keeps popping up when a new Java file opens

• Open a java file in a java project
• close the side bar (cmd+b on mac)
• navigate to a new file from the same project
• side bar pops up
• repeat ...

This is extremely irritating when trying to step debugging into another file, the debug view is replaced by the explorer. Also looks bad when performing a live demo with limited screen real estate.

Dependency view sync with opened files should only work when the side bar is visible.

Should have a option for hierarchical tree view other than flat view for package.

vscode-java-dependency should be loose coupled with vscode-java

For features like create new java project, I don't see there is any necessary to depend on java language server.

Create java project error "EEXIST:file already exists, mkdir 'd:\vscode-java-dependency\demo2'"

Build: 41
Plat: windows/Mac/Linux

Steps:

1. F1, open the command palette
2. Select Java: Create Java Project
3. Select the location
4. Input the project name

The result as below:

The created folder details as below:

The normal one as below:

0.3.0 Endgame

Pre-release

• Fix critical issues
• Update system icons
• Add change log and update readme
• Bump version

Test

• Build test bits
• Test the bits following the test plan

Publish

• Add publish CI
• Unpublish the private extension
• Publish the extension under Microsoft

Open Source

• Check internal open source status
• Make the repo public

No JAVA PACKAGES explorer sidebar on symlink folders

I can't see the JAVA PACKAGES explorer sidebar showed in doc. I can see a JAVA DEPENDENCIES sidebar that is always empty (except for multi-project workspace where I can see folder with project names but empty inside those folders).

The attached image is for a just created java project using command Java:Create Java Project.

OS: Linux 4.15.0-38-generic Ubuntu SMP Wed Oct 10 10:59:38 UTC 2018 x86_64 x86_64 x86_64
GNU/Linux

Extension	Version
vscjava.vscode-java-dependency	0.1.0
redhat.java	0.33.0

Status line shows building workspace when click on types in dependency viewer

Characters are not recognized

Open ORACLE_J.RSA from the explorers.

Result:

Support manage the dependencies in single file project

One use case is to run single file tests.

See: microsoft/vscode-java-test#348

Java file can't show the symbols in the explorers

Differentiate Runtime and Test scoped Maven dependencies

they are currently all mixed in the same "Maven Dependencies" node tree

setup travis ci for guarding bad PR merges

Add a command to reveal the currently open editor in the ClassPath/Dependency view

Automatically synchronize the change in file explorer to the class path view