XULE Editor
A language syntax highlighter and code completion extension for editing Xule with Visual Studio Code.
Workspace, Settings and Taxonomy Files
The settings .zip file below includes a Visual Studio Code .code-workspace and settings files corresponding to the reference implementation code (source folder) included in every Data Quality Committee Rules release (DQC).
The files in the .zip linked below include:
- a DQC.code-workspace file defining folders corresponding to the reference implementation
- settings.json files that define imports and namespaces required by the Xule Editor in each workspace folder, and
- US GAAP (2014 - 2022) and IFRS (2018 - 2022) Taxonomies in .json format called by the settings.json files.
Together, these resources enable highlighting and code completion in the Xule Editor.
- Install the latest Xule Editor.
- Download and extract all folders and files from the dqc-xule-settings.zip archive into the
dqc_us_rules subdirectory of the release, so that the taxonomy folder is at the same level as the existing source folder.
Proceed with caution - the extract process will create or replace existing workspace, settings and taxonomy files in the DQC reference implementation source folder structure. If you are not sure how to proceed safely, consider manually copying from the files in the .zip into the appropriate settings file. XBRL US is not responsible for overwritten settings.
Confirming the Xule Editor extension
Once the DQC.code-workspace and .json files are extracted, open the DQC.code-workspace file from Visual Studio Code's "Open Workspace..." prompt under the program's File menu. Browse the folders by year (US GAAP above IFRS, separated by a common lib folder), and open a .xule file for one of the DQC Rules. If the Visual Studio Code view includes underlined text in the body of the editor, warnings or errors listed for the file (like the image at left below), try the following steps:
- Check the location of the settings.json file(s) and the contents of the file itself against the corresponding file(s) in the .zip, to be sure the xule.autoImports and xule.namespaces.definitions are correct.
- Check the location of the
taxonomy folder and its contents, to be sure it matches the contents of the .zip archive.
- MacOS users might need to remove the '../../lib/' string from the functions.xule and version.xule entries in the settings.json files.
- Check that the settings.json file is being read properly by the Xule Editor extension - open the settings for the extension, then browse to the corresponding folder(s) using the dropdown, to confirm that the Auto Imports and Namespaces: Definitions are listed (like the image at right below). If not, try uninstalling and reinstalling the Xule Editor extension.
About the Xule Editor Extension
Requirements
All dependencies are available from npm and the build process installs them automatically.
Extension Settings
There are no settings so far.
Known Issues
None so far.
Release Notes
See the Changelog.
Building and Testing
To compile the extension use: npm run compile. This will also rebuild the lexer and the parser from the grammar (nb: if you receive a 'JavaScript heap out of memory' error run the following command to increase the memory limit for the session - Windows: set NODE_OPTIONS=--max_old_space_size=8192 Linux export NODE_OPTIONS=--max_old_space_size=4096)
To package it: vsce package.
To run the tests: npm run test.
Development and Debugging
If we open the extension directory with VSCode, we can:
- Build and watch for modifications: on OSX, Cmd+Shift+B
- Launch a new VSCode window with the development extension installed: "Run" panel (Cmd+Shift+D on OSX) and launch the configuration "Client + Server". With this, VSCode should attach the debugger and stop at breakpoints.
Notable extension points
- Built-in taxonomies are defined in builtInNamespaces.ts.
- Built-in variables, constants, and some keywords are defined as wellKnownVariables in symbols.ts.
- Built-in functions and properties and other identifiers/keywords are defined at the bottom of semanticCheckVisitor.ts.
- These are used by the semantic checker.
- Syntax highlighting is defined in syntaxes/xule.tmLanguage.json. It includes both keywords and known identifiers (functions, constants, variables).
