#1167: automatic project import vscode by QuangAnhLe · Pull Request #2263 · devonfw/IDEasy

QuangAnhLe · 2026-08-04T12:19:20Z

This PR fixes #1167

Implemented changes:

Adds automatic VSCode workspace settings import for Maven and Gradle projects. When a repository is imported, the Vscode.importRepository() method:

Detects whether the project uses Maven (pom.xml) or Gradle (build.gradle).
Merges the VSCode settings template from vscode/workspace/repository/.vscode/settings.json (in the settings repository) into the workspace's .vscode/settings.json.
Resolves environment variables (e.g. ${PROJECT_PATH}) in the template with the relative project path.
Creates the .vscode folder if it does not already exist.

Testing instructions

Run the unit tests:
mvn -Dtest="VscodeTest#testVscodeMvnRepositoryImport,VscodeTest#testVscodeGradleRepositoryImport" test -pl cli
Both tests should pass, verifying Maven and Gradle project import.
Run all VSCode tests to ensure no regression:
mvn -Dtest="VscodeTest" test -pl cli
Manual test (requires a settings repository with vscode/workspace/repository/.vscode/settings.json):
- Clone a Maven or Gradle project into <IDE_HOME>/workspaces//.
- Run ide import (or whichever command triggers importRepository).
- Verify that /.vscode/settings.json has been created and contains the merged settings with resolved variables (e.g.
  ${PROJECT_PATH} replaced with the

Checklist for this PR

Make sure everything is checked before merging this PR. For further info please also see
our DoD.

When running mvn clean test locally all tests pass and build is successful
PR title is of the form #«issue-id»: «brief summary» (e.g. #921: fixed setup.bat). If no issue ID exists, title only.
PR top-level comment summarizes what has been done and contains link to addressed issue(s)
PR and issue(s) have suitable labels
Issue is set to In Progress and assigned to you or there is no issue (might happen for very small PRs)
You followed all coding conventions
You have added the issue implemented by your PR in CHANGELOG.adoc unless issue is labeled
with internal
You have formulated clear instructions on how to test your contribution under "Testing instructions"

coveralls · 2026-08-04T13:03:04Z

Coverage Report for CI Build 32835932971

Coverage increased (+0.008%) to 73.663%

Details

Coverage increased (+0.008%) from the base build.
Patch coverage: No coverable lines changed in this PR.
20 coverage regressions across 3 files.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

20 previously-covered lines in 3 files lost coverage.

File	Lines Losing Coverage	Coverage
com/devonfw/tools/ide/tool/ide/IdeToolCommandlet.java	15	86.36%
com/devonfw/tools/ide/tool/vscode/Vscode.java	4	86.67%
com/devonfw/tools/ide/version/VersionSegment.java	1	91.08%

Coverage Stats


Relevant Lines:	18082
Covered Lines:	13927
Line Coverage:	77.02%
Relevant Branches:	8030
Covered Branches:	5308
Branch Coverage:	66.1%
Branches in Coverage %:	Yes
Coverage Strength:	3.28 hits per line

💛 - Coveralls

JoelAdbu

Tested manually, looks good to me.

…tic-project-import-vscode

hohwille

@QuangAnhLe thanks for your PR. You got the general idea right but this cannot work as is yet. I left some review comments to address before we can merge. Thanks 👍

hohwille · 2026-08-17T13:27:14Z

+  @Override
+  public void importRepository(Path repositoryPath) {
+    CommandletManager commandletManager = this.context.getCommandletManager();
+    for (Entry<Class<? extends LocalToolCommandlet>, String> entry : BUILD_TOOL_TO_TEMPLATE.entrySet()) {
+      LocalToolCommandlet buildTool = commandletManager.getCommandlet(entry.getKey());
+      Path buildDescriptor = buildTool.findBuildDescriptor(repositoryPath);
+      if (buildDescriptor != null) {
+        String templateFilename = entry.getValue();
+        LOG.debug("Found build descriptor {} so merging template {}", buildDescriptor, templateFilename);
+        mergeSettings(repositoryPath, templateFilename);
+        return;
+      }
+    }
+    LOG.warn("No supported build descriptor was found for project import in {}", repositoryPath);
+  }


Correct, but we are coming back to copy&paste culture.
My suggestion would be to move this entire method to IdeToolCommandlet.
Then instead of accessing the map from constant (BUILD_TOOL_TO_TEMPLATE), simply use getBuildTool2TemplateMap() add a method in the same class:

protected Map<Class<? extends LocalToolCommandlet>, String> getBuildTool2TemplateMap() { return Map.of(); }

Then Intellij and Vscode can override this method and return their constant.

BTW: Why was importRepository API Signature declared in ToolCommandlet - this only makes sense for IdeToolCommandlet so I would even move the declaration there and fix the usage in RepositoryCommandlet accordingly as everything else does not make any sense to me.

hohwille · 2026-08-17T13:29:23Z

+  /**
+   * Merges the VSCode settings template into the workspace's {@code .vscode/settings.json}.
+   *
+   * @param repositoryPath the {@link Path} to the repository to import.
+   * @param configFilePath the filename of the config file (e.g. {@code settings.json}).
+   */
+  private void mergeSettings(Path repositoryPath, String configFilePath) {
+    Path templatePath = this.context.getSettingsPath().resolve(TEMPLATE_LOCATION);
+    Path templateFile = templatePath.resolve(configFilePath);
+    if (!Files.exists(templateFile)) {
+      throw new CliException(
+          "Cannot import project into workspace: template file not found at " + templateFile + "\n"
+              + "Please do an upstream merge of your settings git repository.");
+    }
+    Path workspacesPath = this.context.getIdeHome().resolve(IdeContext.FOLDER_WORKSPACES);
+    Path workspacePath = this.context.getFileAccess().findAncestor(repositoryPath, workspacesPath, 1);
+    if (workspacePath == null) {
+      throw new CliException(
+          "Cannot import project into workspace: could not find workspace from " + repositoryPath);
+    }
+    JsonMerger jsonMerger = new JsonMerger(this.context);
+    EnvironmentVariables environmentVariables = getVscodeEnvironmentVariables(workspacePath.relativize(repositoryPath));
+    Path vscodeFolder = workspacePath.resolve(FOLDER_VSCODE);
+    Path workspaceFile = vscodeFolder.resolve(configFilePath);
+
+    // Ensure .vscode folder exists
+    this.context.getFileAccess().mkdirs(vscodeFolder);
+
+    // Merge template into workspace settings (template acts as "setup" for creation, also as "update" for variable resolution)
+    jsonMerger.merge(templateFile, templateFile, environmentVariables, workspaceFile);
+
+    LOG.debug("Merged VSCode settings into {} for repository at {}", workspaceFile, repositoryPath);
+  }


The same here. Seems like a complete copy of Intellij.mergeConfig.
Move and centralise in IdeToolCommandlet. Instead of using TEMPLATE_LOCATION constant, build it dynamically.
p.s.: I already gave that feedback for the initial Intellij project import to avoid such redundancies since I saw all this coming - but it seems my review comments where not properly addressed (see PR #1466).

hohwille · 2026-08-17T13:40:25Z

@@ -0,0 +1,3 @@
+{
+  "java.project.rootPath": "$[PROJECT_PATH]"


This is not the way how to "import" a project.
Please note that you can import multiple projects into the same workspace and here you only have a single property that the 2nd import would override from the 1st one.
Further, if that template is complete and correct, you first need to create a PR for ide-settings that has to be merged before this PR can be merged as otherwise we will always end up in the CliException that you are throwing if the template file is not present.

hi @hohwille

Manual test for #1167 — result: no-op is the correct implementation

Manual test setup (as suggested in the issue):

Created a full mirror backup of workspaces/main/.vscode (user-data-dir + settings.json, ~1.3 GB).

Created a brand-new Maven project (test_mvn, minimal pom.xml + one class) that VSCode had never seen.

Started the IDEasy-managed VSCode instance (ide vscode, workspace main).

Recursively diffed the backup against the live .vscode state after the import completed.

Observation: No manual "import" step exists in VSCode. The Java language server (redhat.java / Eclipse m2e) automatically detected test_mvn/pom.xml during workspace scan at startup and imported it as a Maven project. No CLI feature or menu action is required (and none exists) — confirming the issue author's note that no VSCode CLI feature can archive this.

Diff result — what "import" actually writes:

All project state is created by the language server inside VSCode's user-data-dir, e.g. .userdata/User/workspaceStorage//redhat.java/jdt_ws/.metadata/.plugins/org.eclipse.core.resources/.projects/test-mvn/ containing .project (with maven2Nature/maven2Builder), .classpath (all entries maven.pomderived=true), .location, compiler/m2e prefs, plus m2e lifecycle/container state and JDT indexes.

Nothing is written to .vscode/settings.json or any other IDEasy-managed workspace file. The only workspace-level VSCode setting involved in Java project handling (java.jdt.ls.java.home for the language-server JDK) is already delivered by the workspace update template, independently of project import.

Conclusion / rationale for the no-op implementation:

Unlike IntelliJ (which reads per-project configuration from .idea/ files that IDEasy must create/merge), VSCode's import mechanism is fully autonomous inside the language server; there is no IDEasy-controlled file to apply, no CLI command to invoke, and no per-project setting that the IDE consumes.

Merging a template into .vscode/settings.json would produce a file that VSCode does not use for importing projects, i.e. it would not achieve the issue's goal ("project is recognized and built by VSCode") and could not be verified as done.

Therefore Vscode#importRepository correctly does not merge any template; it logs a success message stating that VSCode imports Maven/Gradle projects automatically, so the "Importing repository … into vscode" step completes cleanly when import=vscode is configured. The centralized import logic in IdeToolCommandlet remains and continues to serve IntelliJ.

Could you please confirm that this solution is acceptable, or let me know if you expect different behavior for the VS Code import step?

hohwille · 2026-08-17T13:40:44Z

 * https://github.com/devonfw/IDEasy/issues/2056[#2056]: Replaced progress bar with general progress information for installing plugins in VSCode
 * https://github.com/devonfw/IDEasy/issues/1659[#1659]: Abort runTool with warning when global tool installer runs in background
 * https://github.com/devonfw/IDEasy/issues/1720[#1720]: Integrate SoapUI
+* https://github.com/devonfw/IDEasy/issues/1167[#1167]: Automatic project import for vs code


Please move this entry up to the latest release.

Quang Anh Le and others added 4 commits August 4, 2026 14:06

implementation for automatic project import for VSvode

0873fd7

changelog

9b00265

changelog

0c252a4

changelog

de97b7c

github-project-automation Bot added this to IDEasy board Aug 4, 2026

github-project-automation Bot moved this to 🆕 New in IDEasy board Aug 4, 2026

QuangAnhLe added 3 commits August 4, 2026 14:24

devonfw#1167: fix missing Files import in Vscode.java

e8a4755

devonfw#1167: fix missing Path import in VscodeTest.java

cf6747b

fix seetings

4d2c243

QuangAnhLe added vscode Microsoft visual studio code enhancement New feature or request repository Commandlet to clone, build or import git repositories labels Aug 4, 2026

QuangAnhLe moved this from 🆕 New to Team Review in IDEasy board Aug 4, 2026

QuangAnhLe self-assigned this Aug 4, 2026

JoelAdbu self-assigned this Aug 5, 2026

JoelAdbu reviewed Aug 6, 2026

View reviewed changes

JoelAdbu moved this from Team Review to 👀 In review in IDEasy board Aug 6, 2026

hohwille changed the title ~~Feature/1167 automatic project import vscode~~ #1167: automatic project import vscode Aug 11, 2026

Merge remote-tracking branch 'upstream/main' into feature/1167-automa…

bdccc81

…tic-project-import-vscode

hohwille approved these changes Aug 17, 2026

View reviewed changes

hohwille added this to the release:2026.08.002 milestone Aug 17, 2026

QuangAnhLe added 4 commits August 24, 2026 10:28

Merge branch 'main' into feature/1167-automatic-project-import-vscode

7818987

deduplicate IDE repository import into IdeToolCommandlet

0ae5521

centralise IDE repository import template merge in IdeToolCommandlet

8f0feab

Merge branch 'main' into feature/1167-automatic-project-import-vscode

69070c3

Navigation Menu

Uh oh!

#1167: automatic project import vscode - #2263

#1167: automatic project import vscode#2263
QuangAnhLe wants to merge 12 commits into
devonfw:mainfrom
QuangAnhLe:feature/1167-automatic-project-import-vscode

QuangAnhLe commented Aug 4, 2026 •

edited by hohwille

Loading

Uh oh!

coveralls commented Aug 4, 2026 •

edited

Loading

Uh oh!

JoelAdbu left a comment •

edited

Loading

Uh oh!

hohwille left a comment

Uh oh!

hohwille Aug 17, 2026

Uh oh!

hohwille Aug 17, 2026

Uh oh!

hohwille Aug 17, 2026

Uh oh!

QuangAnhLe Aug 25, 2026

Uh oh!

hohwille Aug 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

QuangAnhLe commented Aug 4, 2026 • edited by hohwille Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

This PR fixes #1167

Implemented changes:

Testing instructions

Checklist for this PR

Uh oh!

coveralls commented Aug 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report for CI Build 32835932971

Coverage increased (+0.008%) to 73.663%

Details

Uncovered Changes

Coverage Regressions

Coverage Stats

💛 - Coveralls

Uh oh!

JoelAdbu left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hohwille left a comment

Choose a reason for hiding this comment

Uh oh!

hohwille Aug 17, 2026

Choose a reason for hiding this comment

Uh oh!

hohwille Aug 17, 2026

Choose a reason for hiding this comment

Uh oh!

hohwille Aug 17, 2026

Choose a reason for hiding this comment

Uh oh!

QuangAnhLe Aug 25, 2026

Choose a reason for hiding this comment

Uh oh!

hohwille Aug 17, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

QuangAnhLe commented Aug 4, 2026 •

edited by hohwille

Loading

coveralls commented Aug 4, 2026 •

edited

Loading

JoelAdbu left a comment •

edited

Loading