microsoft / vscode-spring-initializr

VSCode Extension for Spring Initializr

Spring Initializr Java Support

Overview

Spring Initializr is a lightweight extension to quickly generate a Spring Boot project in Visual Studio Code (VS Code). It helps you to customize your projects with configurations and manage Spring Boot dependencies.

Feature List

• Generate a Maven/Gradle Spring Boot project
• Customize configurations for a new project (language, Java version, group id, artifact id, boot version and dependencies)
• Search for dependencies
• Quickstart with last settings
• Edit Spring Boot dependencies of an existing Maven Spring Boot project

Requirements

• VS Code (version 1.19.0 or later)
• JDK (version 1.8.0 or later)

Install

Open VS Code and press F1 or Ctrl + Shift + P to open command palette, select Install Extension and type vscode-spring-initializr.

Or launch VS Code Quick Open (Ctrl + P), paste the following command, and press enter.

ext install vscode-spring-initializr

Use

• Launch VS Code
• Press Ctrl + Shift + P to open command palette.
• Type Spring Initializr to start generating a Maven or Gradle project.
• Follow the wizard.
• Right click inside the pom.xml file and choose Edit starters for dependency refactoring. (Gradle project is not supported yet, PR is welcome for it.)

Configuration

  // Default language.
  "spring.initializr.defaultLanguage": "Java",

  // Default Java version.
  "spring.initializr.defaultJavaVersion": "11",

  // Default value for Artifact Id.
  "spring.initializr.defaultArtifactId": "demo",

  // Default value for Group Id.
  "spring.initializr.defaultGroupId": "com.example",

  // Spring Initializr Service URL(s). If more than one url is specified, it requires you to select one every time you create a project.
  "spring.initializr.serviceUrl": [ "https://start.spring.io" ],

  // Default value for Packaging. Supported values are "JAR" and "WAR".
  "spring.initializr.defaultPackaging": "JAR",

  // Default value for the method of openining the newly generated project. Supported values are "", "Open" and "Add to Workspace".
  "spring.initializr.defaultOpenProjectMethod": "Add to Workspace",

Feedback and Questions

You can find the full list of issues at Issue Tracker. You can submit a bug or feature suggestion, and participate community driven

License

This extension is licensed under MIT License.

Data/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.

Contributing

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-spring-initializr's Issues

Support adding dependencies by search

please support filtering deependencies by keywords for the project

this way I could type in a word and get a more relevant match

Use official Checkbox API in dependency selection

Multiple-selection in QuickPick supported since v1.22.2

Ref:
https://code.visualstudio.com/updates/v1_22#_multiselect-quickpick

please somehow render any links for the dependencies

the dependencies (sometimes) have things like links to documentation or guides.

Maybe it could be rendered in the 2 line textbox for the suggested dependency?

Specify Spring Boot version bug in the initializr

Hi there!

I am not sure if it's a bug or not, I just installed Spring Boot Extension Pack and it's my first time using it.
The issue I am having is that I cannot pass the 'Specify Spring Boot version' when using Spring initializr.

Please see the gif below:

There is nothing said about it in the Configuration too:

1. Am I doing something wrong? What is the expected input?
2. Is it a bug? If yes, how I should proceed about it as a user?

I would really appreciate any help with this, thank you in advance!

0.3.0 Endgame

Dev

• Remove dependency of unzip package. @Eskibear
• Support to edit starters for existing Spring Boot Maven projects. @Eskibear
• Allow not to select extra dependencies when generate projects. @Eskibear

Test

• 4/28 New feature test.
• 5/2 Releasing test, following Test Plan

Release

• 5/4 Update Readme & changelog
• 5/4 Merge to master
• 5/4 Trigger release job
• 5/4 Add tag

Initializr Network Issues

As reported before here:
#84

I am having the same issue. I acknowledge this is not an extension bug, but I need to understand port / endpoints so I can request that the network paths are opened here at work.

First: VS Code is unable to fetch the avaliable Spring Versions as you can see here. It will sit and query forever without returning any versions.

Second: IF I use start.spring.io to create my project there and then try to open using visual studio code. I am unable to compile my Spring Boot project due to not being able to import the dependencies.

I was able to take my PC to a different network and download the dependencies, so things work now, but I will not be the first with this issue. Can you please provide the network credentials to the Spring.io sources that the extension uses? We can then request our company network firewall allows it.

Looking for [network path / ip] -- [port] -- [protocol] (ex: start.spring.io, 443, tcp) ??

Thanks

Proxy?!

This extension is not using my proxy settings.

[2018-03-30 15:30:11.474] [renderer1] [error] connect ETIMEDOUT 104.17.46.2:443: Error: connect ETIMEDOUT 104.17.46.2:443
	at Object.exports._errnoException (util.js:1050:11)
	at exports._exceptionWithHostPort (util.js:1073:20)
	at TCPConnectWrap.afterConnect [as oncomplete] (net.js:1097:14)

0.1.0 Engineering work

• Prototype
• Code style
• Branch model
• CI job

Générate spring boot package files

Is it possible to add support for generating spring boot files (service, controller, repository...) in a folder according to its name?

mvnw missing execute permission

In MacOSX, file mvnw doesn't have execute permission. But if I downloads a zip from start.spring.io, and unzip if myself, it works well.

Readability issue of POM file

After editing starters, the readability of the POM file will reduce.
BEFORE

AFTER

Edit Starts to ask less questions

At the end of the procedure, do not ask the users to 'Proceed'.

Suggested way:

1. Open pom.xml and make it active
2. Apply code changes to it WITHOUT saving

In this way, users are aware of the changes and can choose to Save or Cmd + Z

Spring Initializr generates .gitignore without /bin/

To reproduce the issue, just create a gradle project with Spring Initializr with latest Code.

Here is the .gitignore file:

HELP.md
.gradle
/build/
!gradle/wrapper/gradle-wrapper.jar

STS

.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache

IntelliJ IDEA

.idea
*.iws
*.iml
*.ipr
/out/

NetBeans

/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/

By default, it would be ideal to generate .gitignore file to exclude bin directory. Thanks.

cursor scroll to top after each dependency selected

After each dependency selected, cursor scroll up to top, if I need more dependency, I have to scroll down over and over, I think this is not a good experience。

DependencyManagement(bom) & dependencies in test scope can't be removed

1. Add some dependencies with bom information or repository information
2. Edit starter, remove these dependencies
   RESULT:
   The bom or repository information can't be removed while removing related dependencies

Dependencies in test scope have the same issue.

An unknown error occured

Build used: build36

1. Install the extension build
2. Open VS Code without opening any folder.
3. Open Command Palette, execute command Spring Initializr: Generate a Maven Project.
4. Input a valid Group Id, press Enter.
5. Input a valid Artifact Id, press Enter.
6. Select a spring boot version

Error occurred:

Support generate a new project from recommended settings

Generate a Project: Alert the user to ensure that the project of the same name is overwritten

Generate a Maven or Gradle Project, Alert the user to ensure that the project of the same name is overwritten。

For example：

Error occurs when creating a project to overwrite a different type of project

Environments

• OS: Windows 10/OS X
• VS Code version: 1.30.2
• Extension version Build RC/2

To Reproduce
Steps to reproduce the behavior:

1. Generate a Maven Project.
2. Generate a Gradle Project with a same artifactId and folder.
3. Then show a warning message:

  

4. Click continue button.
5. See error.

Current behavior

  

Expect behavior

  

This issue also reproduce on previous version.

0.1.0 endgame

[ Updating ]

• Documentation

• 1/2 - readme.md

• Telemetry

• 1/8 confirm telemetry data with BI team

• Test

• 1/8 - set up test pipeline
• 1/17- Run pre-release test according to Test plan

• Release

• 1/12 licences and OSS
• 1/18- set version to v0.1.0
• 1/18 update new icon #21
• 1/18 - merge code to master branch
• 1/18 - publish to marketplace (https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-spring-initializr)
• 1/18 - tag v0.1.0

• Customer

• 1/18 Recruit 10 early adopters

proxy problem

Extension doesn't seem to work behind a company proxy. Getting:
[2018-08-14 14:11:24.194] [renderer1] [error] connect ECONNREFUSED 104.17.46.2:80: Error: connect ECONNREFUSED 104.17.46.2:80
at Object._errnoException (util.js:1024:11)
at _exceptionWithHostPort (util.js:1046:20)
at TCPConnectWrap.afterConnect [as oncomplete] (net.js:1182:14)

Final dialog is not responding to mouse input on Linux

Hi, i'm experiencing a problem like the one mentioned at electron/electron#9942 with the final dialog of the Initializr.

Please let me know if there is a workaround for users. I'm using Ubuntu 18.04 LTS.

Allow user to select Spring Boot version

... and other things. But that's the one that I miss the most.

Support adding Spring Boot starter to an existing project

Please set a well-defined User-Agent for each request to the service

As described in the reference guide, please make sure to add a User-Agent header for all requests to start.spring.io.

We can discuss about the appropriate format for the value.

Remember the groupid/artifactid between runs.

If i re-run the generation a number of times I am probably wanting to generate a series of related projects - likely with a common groupId, possibly with related artifactIds. It should remember what I used before and pre-populate the first 2 stages with that data (that I can edit).

0.2.0 Endgame

Dev

• Allow user to select Spring Boot version #24
• Allow to specify default group/artifact Id #28
• Allow configuration of service endpoint #29
• Add User-Agent header for requests #25
• Improve dependencies filtering #26 ( keywords not supported, now filter name and description )
• Update Extension Icon @Matthew-Dong #48

Test

• 2/8 Follow Test Plan

Release

• 2/9 Update Readme & changelog #48
• 2/9 Merge to master
• 2/9 Trigger release job
• 2/9 Add tag

Failed to build after removing a dependency

Steps to reproduce:

1. Generate a maven project , select some dependencies.
   e.g. Select "DevTools"and "Security" dependencies.
2. Open pom.xml file, right click on the editing area of the file, choose Edit starters.
3. In the QuickPick box, unselect "Security", and proceed following the prompt messages.
4. mvn package

The input rules of group Id and artifact Id should be informed for user

Generate a Maven Project, the user was not told the entry rule of Group Id and Artifact Id.

Result:

Command to expose 'Edit Starters' functionality

'Edit Starters' is an essential feature. The current entry of this functionality is hard to find - open pom.xml and right click.

A command needs to be added to VS Code - Spring Initializr: Edit Starters
The target pom.xml can be in different status. And here are some common scenarios:

1. A pom.xml is opened and active - work with that file directly
2. A project has only one pom.xml - work with that file directly
3. A project has more than one pom.xml - list all the pom files with hierarchical representation, let user choose one
4. Regarding 2 and 3, when the active editor is NOT a pom.xml, open the target file and make it active

Support packaging type of WAR when scaffolding a project

The spring boot version will not change by the version selection

The spring boot version is always 1.5.9-RELEASE in the pom.xml / build.gradle file

Failed to build after removing security dependency

1. Generate a maven project , select "Security" dependency.
2. Open pom.xml file, verify current value of dependencies node.
3. Right click on the editing area of the file, choose Edit starters.
4. In the QuickPick box, unselect "Security", and proceed following the prompt messages.
5. mvn package
   

Is it illegal to have atifactid with numbers?

Result:

I have tried this name on sping initializr: https://start.spring.io/, the atifactid with numbers can pass the validation.

Should add the version selection step in the steps message

In addition, It is better to add a hint to tell the user what will do at this step.

Support generate a new project from last settings

"end of central directory record signature not found" when extracting demo.zip file

Probably caused by early extraction before the writeStream "close" event.

Support Kotlin，Thanks

Support Kotlin，and that can easy to start and stop Gradle or Maven project like idea

Cannot read property 'id' of undefined

Build used: build38

1. Open VS Code without opening any folder.
2. Open Command Palette, execute command Spring Initializr: Generate a Maven Project.
3. Input a valid Group Id, press Enter.
4. Input a valid Artifact Id, press Enter.
5. Then show the spring boot version view, Press Esc

Support Edit Starters for gradle project

I'd like Edit Starters command to support gradle projects. It appears to only support maven projects (searches for pom.xml) files. It says it works by clicking on build.gradle and running Edit Starters, but I don't believe it works.

I think the gradle language server could help in this regard. I posted a question to their repository to ask them about it. It seems like the parsing of gradle files is something that we wouldn't want to just do a search and replace on. It seems like it would be straightforward based upon the dependencies that it pulls down. i.e. we'd need to map runtime -> runtimeOnly, compile -> compileOnly, etc. and handle the toRemove and to Add by appropriately.

How should it decide to handle the maven or gradle project? Should we only look for build.gradle if pom.xml can't be found? We could change the error msg to cannot find pom.xml or build.gradle. If it finds build.gradle, we'll use the language server to remove unwanted dependencies and add needed ones.

Is this something we can implement?

Error "Cannot read property 'fsPath' of null"

This error occurs when debugging the extension.
It's caused by inconsistency. If the user cancel the selection of the target folder, the wrapper returns null instead of undefined.

Unable to 'edit starters' in child project

I am unable to use the 'edit starters' feature from inside the pom of the child project.

Steps:
Created a spring boot project via Spring Initializr
Opened pom -> right click -> Edit starters

Error:
Fail to edit starters. Error: Not a valid Spring Boot project.

VScode version: 1.31.0-insider
Spring Initializr version: 0.4.4

Note: I am able to do this from the parent project pom, but it does not work from the child project pom

Please use the latest version of vscode-extension-telemetry-wrapper dependency

This extension uses version 0.3.1 of vscode-extension-telemetry-wrapper module.

The latest version of vscode-extension-telemetry-wrapper module (0.3.2) uses the latest version of vscode-extension-telemetry module (0.0.22) which has the fix to prevent unnecessary patching of the require and other 3rd party modules.

For more details, please see Eskibear/vscode-extension-telemetry-wrapper#20

adjust order of bootVersion candidate, put default version ahead.

Provide a simple way to run/debug Spring Boot apps

Currently, it requires user to go to Terminal and use the Maven Spring Boot plugin mvn spring-boot:run. It also requires extra setup for debugging.

Please avoid node dependency to "natives" module

Hi,

I am a developer on VSCode and wanted to reach out to inform you that this extension is either using or having a dependency to a node module "natives" that will soon no longer be supported in VSCode once we updated to node.js 8.x (as part of our Electron 2.0 update which is planned for the near term).

The full graph is:

└─┬ [email protected]
  └─┬ [email protected]
    └─┬ [email protected]
      └── [email protected] 

It would be great if this dependency could be avoided by either not depending on it anymore or updating the dependencies to newer versions so that this module is no longer pulled in.

As soon as any code in your extension (including node_modules) calls require("natives") we will throw an exception to prevent this module from getting loaded.

If this is just a devDependency and the module is never loaded in production, then you can ignore this issue and just close it!

More details in microsoft/vscode#47569

Thanks!
Ben
VSCode Team

Create a folder named after the artifactId

Currently, when VS Code generates a project, it simply drops the files in the selected folder. Ideally, a new folder (with the same name as artifactId) should be created in the selected folder.

Please use the latest version of vscode-extension-telemetry-wrapper dependency

As per Eskibear/vscode-extension-telemetry-wrapper#22, we now need to update to version 0.3.4

Allow configuration of start.spring.io endpoint

There should be JSON preferences to configure the endpoint that the wizard talks to in order to gather available dependency info.