Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
4,361,330
Community Members
 
Community Events
168
Community Groups

Using VSCode with the Atlassian SDK

VSCode has grown over the last few years into a pretty slick IDE and I see that Atlassian has given VSCode a little bit of love by providing integrations with Jira and Bitbucket. There are a couple of pages for setting up IDEA and Netbeans to work with the Atlassian SDK but sadly nothing for VSCode. So, I ask the community. Have you had success getting VSCode to work well with the Atlassian SDK ... especially with things like Intellisense, project builds, and debugging? If you have had success with using VSCode and the Atlassian SDK please share. Maybe we can set up an unofficial VSCode tutorial of sorts.

2 comments

Hello, I was struggling today and found a few things:

- for basic intellisense, the solution is basically to follow the Netbeans instructions that you linked to (it could use updating and Mac instructions BTW).

- for VSCode integration, someone has created tasks: https://gist.github.com/john20xdoe/ea48b9282e82e34de471ef0c9acde01c

A better solution may be to use `atlas-mvn` in VSCode. It's possible to set the binary in VSCode "Maven for Java" settings, but unfortunately it's broken on MacOS because of how `atlas-mvn` passes arguments to `mvn`.

Well it actually works to point VSCode's "Maven for Java" to use `atlas-mvn` binary, but on MacOS you need to run VSCode with `--user-data-dir="some/location/without/spaces"`

I managed to get this working. 

Start by installing the Java Extension Pack: https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack

Setting up Intellisense

  1. Find where the atlas-* programs are installed by running ls -l $(which atlas-mvn) to get the actual location.

    On my Mac I got /Applications/Atlassian/atlassian-plugin-sdk-6.3.6/bin
  2. Go to that directory to find the bundled version of Maven, it'll be above the bin folder.

    For me it was /Applications/Atlassian/atlassian-plugin-sdk-6.3.6/apache-maven-3.5.4.

  3. Inside that directory the settings.xml file is in the folder named conf.
  4. Set the Java > Configuration > Maven: User Settings option in VSCode to the full path to that settings.xml.

    In my case it was /Applications/Atlassian/atlassian-plugin-sdk-6.3.6/apache-maven-3.5.4/conf/settings.xml

Setup Maven

  1. See my comment below to set atlas-mvn as the executable.

 

Like # people like this

Awesome! That will make development with VSCode so much easier. I've submitted a ticket to Atlassian to consider creating an official walk-through for setting up the SDK with VSCode.

Thanks for doing that @Davin Studer Is that a public ticket that we can comment on or is it a private DEVHELP ticket?

Because I did figure out what needs to change in atlas-mvn so we can just drop it in instead of unwinding where everything's set up.

I don't think it is a public ticket. I just went to their documentation for IDEA and click the link to comment on the documentation. I think it is using a Jira issue collector to create tickets on the backside, but I don't think it is publicly accessible.

Like Satvik Sharma likes this

Thanks for the instructions

Like # people like this

Figured out a few more things:

* Set Maven > Executable: Path to the atlas-mvn binary

For me it was `/usr/bin/atlas-mvn/`

This makes the pom.xml file work properly in VSCode

* Install https://marketplace.visualstudio.com/items?itemName=dgileadi.java-decompiler so 'Go to Definition' isn't useless.

Like # people like this

Comment

Log in or Sign up to comment
TAGS
Community showcase
Published in Apps & Integrations

Apps for Confluence you won't want to miss: RSVP for September's Appy Hours

Calling all collaborators and Confluence users! Our Appy Hours event on September 29th features 4 presenters demoing functionality to superpower Confluence. Don't miss learning about these apps i...

122 views 0 9
Read article

Atlassian Community Events