Changes

Jump to navigation Jump to search
1,257 bytes added ,  11:45, 7 May 2019
no edit summary
This section focuses on Reece H. Dunn's [https://plugins.jetbrains.com/plugin/8612-xquery-intellij-plugin xquery-intellij-plugin].
 
The plugin is very well maintained! It adds support for various XQuery Implementations to the IntelliJ IDEA (among them BaseX). It provides syntax highlighting for XQuery and XML and detects syntactical errors while you type offering a description for each error. Queries are executed using Run Configurations for which you can configure various query processors, e.g. BaseX.
 
The plugin contains some minor flaws regarding the static binding of BaseX namespaces. A few namespaces are marked as unknown in the code, however, query execution in the BaseX backend works fine in spite of them. Also, the IntelliJ ''Find Usages'' and ''Go To'' options did not work as expected in some cases, especially with regard to functions and across modules. The plugin does not yet include a code completion feature.
 
Note that the usage of functions from imported or declared namespaces that do not exist in the namespace might not be marked as unknown. To highlight invalid functions, you may enable the ''XPath and XQuery > XPST: XPath static errors > XPST0017: Undefined function'' inspection in the ''Editor > Inspections'' section.
==Installation==
* If the configuration does not run as a standalone instance, make sure that BaseX is up and running.
* Click the ''Run'' button to execute your query.
 
==Conclusion==
 
The plugin is very well maintained! It adds support for various XQuery Implementations to the IntelliJ IDEA (among them BaseX). It provides syntax highlighting for XQuery and XML and detects syntactical errors while you type offering a description for each error. Queries are executed using Run Configurations for which you can configure various query processors, e.g. BaseX.
 
The plugin contains some minor flaws regarding the static binding of BaseX namespaces. A few namespaces are marked as unknown in the code, however, query execution in the BaseX backend works fine in spite of them. Also, the IntelliJ ''Find Usages'' and ''Go To'' options did not work as expected in some cases, especially with regard to functions and across modules. The plugin does not yet include a code completion feature.
 
Note that the usage of functions from imported or declared namespaces that do not exist in the namespace might not be marked as unknown. To highlight invalid functions, you may enable the ''XPath and XQuery > XPST: XPath static errors > XPST0017: Undefined function'' inspection in the ''Editor > Inspections'' section.
=XQuery Support Plugin=
* Now, the configuration should be set and the green ''Run'' button should be available below the IntelliJ IDEA menu bar.
[[File:Intellij-run-button.png]]
 
'''Execute Your Query'''
* If the configuration does not run as a standalone instance, make sure that BaseX is up and running.
* Click the ''Run'' button to execute your query.
 
==Conclusion==
The plugin adds support for various XQuery Implementations to the IntelliJ IDEA (among them BaseX). It provides syntax highlighting for XQuery and XML and detects syntactical errors while you type offering a description for each error. Queries are executed using Run Configurations for which you can configure various query processors, e.g. BaseX. The plugin offers code completion for XQuery functions, integrated library modules, such as FunctX or the BaseX Module Library, and user-defined modules. IntelliJ’s Find Usages and Go To options seem to work fine for variables and functions, even across modules. Users can set XQuery-specific code style preferences.
 
This plugin also has a few minor drawbacks. If no path is specified, syntax highlighting marks user-defined modules as unknown, even if they reside in the designated BaseX module repository. However, the BaseX query processor, resolves them correctly during query execution. Error messages in the editor seem to be kept rather general and should me more specific.
Parameter lists of code completion may be quite extensive and clog the screen.
Leading tab space can be increased in user-defined steps, but neither decreased in single, nor user-defined steps.
administrator, editor
162

edits

Navigation menu