Skip to content
Quarkus Tools for Visual Studio Code, by Red Hat
TypeScript HTML JavaScript CSS
Branch: master
Clone or download
xorye and fbricon Have RESTEasy JAX-RS always selected in the extensions picker
Signed-off-by: David Kwon <dakwon@redhat.com>
Latest commit f363ba2 Jan 24, 2020

README.md

Marketplace Version

Quarkus Tools for Visual Studio Code

Description

This Visual Studio Code extension provides support for Quarkus development via:

Quarkus VS Code Commands

The following commands are supported for both Maven and Gradle Quarkus projects:

  • Quarkus: Generate a Quarkus project: Generate a Quarkus project, based on https://code.quarkus.io/
  • Quarkus: Add extensions to current project: Add Quarkus extensions to currently opened Quarkus project
  • Quarkus: Debug current Quarkus project: Launches the Maven quarkus:dev plugin or the Gradle quarkusDev command and automatically attaches a debugger

Quarkus application.properties Features

  • Completion support for Quarkus properties
  • Hover support for Quarkus properties
  • Validation support for Quarkus properties
  • Support for Quarkus profiles
  • Outline support (flat or tree view)

Quarkus code snippets

This extension provides several code snippets, available when editing Java files:

  • qrc - Create a new Quarkus resource class
  • qrm - Create a new Quarkus resource method
  • qtrc - Create a new Quarkus test resource class
  • qntrc - Create a new Quarkus native test resource class

When editing application.properties files, you have access to:

  • qds - Configure a Quarkus datasource
  • qj - Configure a Jaeger tracer

Requirements

Supported VS Code settings

The following settings are supported:

  • quarkus.tools.alwaysShowWelcomePage : Determines whether to show the welcome page on extension startup.
  • quarkus.tools.debug.terminateProcessOnExit : Determines whether to terminate the quarkus:dev task after closing the debug session.
  • quarkus.tools.formatting.surroundEqualsWithSpaces : Insert spaces around the equals sign when formatting the application.properties file. Default is false.
  • quarkus.tools.trace.server : Trace the communication between VS Code and the Quarkus Language Server in the Output view.
  • quarkus.tools.symbols.showAsTree : Show Quarkus properties as tree (Outline). Default is true.
  • quarkus.tools.validation.enabled : Enables Quarkus validation. Default is true.
  • quarkus.tools.validation.duplicate.severity : Validation severity for duplicate Quarkus properties. Default is warning.
  • quarkus.tools.validation.syntax.severity : Validation severity for Quarkus property syntax checking. Default is error.
  • quarkus.tools.validation.required.severity : Validation severity for required Quarkus properties. Default is none.
  • quarkus.tools.validation.unknown.severity : Validation severity for unknown Quarkus properties. Default is warning.
  • quarkus.tools.validation.unknown.excluded : Array of properties to ignore for unknown Quarkus properties validation. Patterns can be used ('*' = any string, '?' = any character). Default is [].

Since 1.3.0:

  • quarkus.tools.codeLens.urlCodeLensEnabled : Enable/disable the URL code lenses for REST services. Default istrue.
  • quarkus.tools.starter.showExtensionDescriptions: Determines whether to show the Quarkus extension descriptions when selecting Quarkus extensions. Default is true.

Articles

Contributing

This is an open source project open to anyone. Contributions are extremely welcome!

For information on getting started, refer to the CONTRIBUTING instructions.

CI builds can be installed manually by following these instructions:

  1. Download the latest development VSIX archive from here. (vscode-quarkus-XXX.vsix)

  2. Click View/Command Palette

  3. Type 'VSIX'

  4. Select 'Install from VSIX...' and choose the .vsix file.

Feedback

File a bug in GitHub Issues.

License

Apache License 2.0. See LICENSE file.

You can’t perform that action at this time.