XSLT/XPath for Visual Studio Code
This XSLT/XPath extension for VSCode provides comprehensive language support for XSLT 3.0 and XPath 3.1.
Screenshot showing XSLT symbol-outline, problem-reporting and syntax-highlighting:
* Problem-reporting currently depends upon the VSCode symbol-provider. To ensure problems are always reported in VSCode, use the following VSCode setting:
For lexical analysis, this extension processes code character-by-character. This analysis is exploited for all features including all syntax highlighting. Avoiding the much more common use of regular expressions on a line-by-line basis brings significant benefits. These benefits include improved responsiveness, lower CPU load, improved code maintainability and full integrity for syntax highlighting.
Auto-completion is available for XSLT and XPath, this includes contex-aware completion items for all code symbol names. XSLT and XPATH function signatures and descriptions are shown in the description alongside function completion items.
This extension performs a comprehensive set of checks on the code, before any XSLT compilation. Thsese checks ensure that any code symbols within XSLT or XPath with problems are accurately identified at the symbol-level. Asynchronous processing for xsl:include/xsl:import dependencies allows checking of references to symbol definitions regardless of the location of the definition.
XSLT transforms are configured and run as special VSCode Tasks. For more detail, see XSLT Tasks
See: Release Notes on the project wiki
See: XSLT/XPath Wiki
See: VSCode Settings
To use the task-provider for the Java Saxon XSLT Processor, the following setting is required (alter path to suit actual jar location):
The Saxon XSLT-Java and XSLT-JS TaskProviders are enabled by default. These can be enabled/disable using the following settings properties:
If your XSLT contains xsl:use-package instructions, XSLT package names are resolved to lookup symbols to support the following features:
To allow XSLT package names to be resolved to file paths, package details should be added to the setting:
An example of XSLT package name settings:
If file paths are relative they are resolved from the first Visual Studio Code Workspace folder
Note: Currently, XSLT Package versions are not used in package-name lookup
VSCode Formatting Command Keyboard Shortcuts
Editor Settings for Highlighting in Color Theme Extensions
Syntax highlighting is currently only enabled by default in VSCode's built-in themes. This is because some extension themes may not yet have specific language support for VSCode's 'Semantic Highlighting' as used by this extension.
To enable syntax highighting for a custom theme you need to change User Settings. For example, to enable syntax highlighting for XSLT in the City Lights theme use:
Or, to enable syntax highlighting for all themes:
Editor Settings For Formatting
Editor Settings For Word Selection/Navigation
For word selection/navigation, by default, names like $two-parts are treated as two words for selection purposes and $ is also excluded from the name. This behaviour can be altered using the VSCode setting:
For XSLT, keeping most of the default separator charators it is useful to disable
Code-folding currently works by indentation indicating the nesting level. So, if code-folding does not work as expected, try reformatting using (for MacOS) -
Region code-folding is also supported. This can be useful, for example, for blocks of templates for a specific mode. To set a region code-folding block, surround it with
Support for other languages with embedded XPath
In addition to XSLT, other XML-based languages/vocabularies with embedded XPath will be supported in future in this extension. Currently, DeltaXML's Document Comparison Pipeline (DCP) format is supported, acting as a pilot for other languages.
Project Sponsor Message: