Skip to content

georgejecook/vscode-xml

 
 

Repository files navigation

XML Language Support by Red Hat

Join the chat at https://gitter.im/redhat-developer/vscode-xml Marketplace Version

Description

This VS Code extension provides support for creating and editing XML documents, based on the LSP4XML language server, running with Java.

Basic features

Features

  • Syntax error reporting
  • General code completion
  • Auto-close tags
  • Automatic node indentation
  • Symbol highlighting
  • Document folding
  • Document links
  • Document symbols and outline
  • Renaming support
  • Document Formatting
  • DTD validation
  • XSD validation
  • XSD based hover
  • XSD based code completion
  • XSL support
  • XML catalogs
  • File associations
  • Code actions
  • Schema Caching

See the changelog for the latest release. You might also find useful information in the project Wiki.

Requirements

  • Java JDK 8 or more recent
  • Ensure Java path is set in either:
    • java.home in VSCode preferences
    • Environment variable JAVA_HOME or JDK_HOME

Supported VS Code settings

The following settings are supported:

  • xml.trace.server : Trace the communication between VS Code and the XML language server in the Output view.
  • xml.catalogs : Register XML catalog files.
  • xml.logs.client : Enable/disable logging to the Output view.
  • xml.fileAssociations : Associate XML Schemas to XML file patterns.
  • xml.format.splitAttributes : Set to true to split node attributes onto multiple lines during formatting. Defaults to false.
  • xml.format.joinCDATALines : Set to true to join lines in CDATA content during formatting. Defaults to false.
  • xml.format.joinContentLines : Set to true to join lines in node content during formatting. Defaults to false.
  • xml.format.joinCommentLines : Set to true to join lines in comments during formatting. Defaults to false.
  • xml.format.enabled : Enable/disable formatting.
  • xml.autoCloseTags.enabled : Enable/disable automatic tag closing.
    Note 'editor.autoClosingBrackets' must be turned off to work.
  • xml.server.vmargs: Extra VM arguments used to launch the XML Language Server. Requires VS Code restart.

Since 0.3.0:

  • xml.format.spaceBeforeEmptyCloseTag: Set to true to insert space before the end of a self closing tag.
  • xml.problems.noGrammar: Set the message severity when a document has no associated grammar. Default is hint.

More detailed info in the Wiki.

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-xml-XXX.vsix)

  2. Go to the Extensions section in VSCode.

  3. At the top right click the ... icon.

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

Feedback

License

EPL 1.0, See LICENSE file.

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 95.2%
  • JavaScript 4.8%