rhdunn / xquery-intellij-plugin Goto Github PK

View Code? Open in Web Editor NEW

24.0 9.0 9.0 46.17 MB

XQuery, XPath and XSLT Language Support for the IntelliJ IDE

Home Page: https://rhdunn.github.io/xquery-intellij-plugin/

License: Apache License 2.0

XQuery 10.76% Kotlin 88.74% XSLT 0.07% HTML 0.43%

xquery intellij xquery-intellij-plugin xquery-support basex saxon xpath-ng marklogic exist-db xslt

xquery-intellij-plugin's Introduction

XQuery and XSLT

This is a plugin for the IntelliJ IDE that adds support for the XML Query (XQuery) and XML Path (XPath) languages. This covers support for:

XPath 2.0, 3.0, and 3.1;
XQuery 1.0, 3.0, and 3.1;
XQuery and XPath Full Text extension;
XQuery Update Facility 1.0, and 3.0 extension;
XQuery Scripting extension;
EXPath extensions;
BaseX, MarkLogic, and Saxon vendor extensions.

This plugin also has limited support for the following XML-based languages that use XPath:

XSLT 1.0-3.0 (active when the IntelliJ XPathView plugin is disabled);
XProc 1.0-3.0.

See https://rhdunn.github.io/xquery-intellij-plugin/ for the plugin documentation and tutorials.

The latest development version of this plugin supports IntelliJ 2022.1 – 2024.1s. Older versions of the plugin are compatible with older versions of IntelliJ.

Query Processor and Database Integration

This plugin provides support for the following implementations of XQuery:

BaseX 7.0 – 9.3;
eXist-db 4.4 – 5.3;
FusionDB alpha;
MarkLogic 8.0 – 10.0;
Saxon 9.2 – 10.0.

For those XQuery implementations, this plugin supports:

Running XQuery, XSLT, XPath, SPARQL, SQL, and JavaScript queries where supported by the implementation;
Profiling XQuery and XSLT queries;
Debugging MarkLogic XQuery-based queries, with expression breakpoint support;
Viewing access and error log files.

This plugin provides additional integration support for the following query processor file types and standards:

MarkLogic rewriter XML files;
EXQuery RESTXQ 1.0.

Libraries and Frameworks

This plugin adds support for the following project frameworks:

MarkLogic Roxy – source root detection;
MarkLogic ml-gradle – source root detection.
Support running and profiling XRay unit tests.

IntelliJ Integration

This plugin provides support for the following IntelliJ features:

Resolving URI string literal, function, and variable references;
Code folding;
Find usages and semantic usage highlighting;
Rename refactoring for variables;
Code completion;
Parameter information;
Parameter inlay hints;
Structure view;
Breadcrumb navigation, including highlighting XML tags in the editor like the IntelliJ XML plugin;
Paired brace matching;
Commenting code;
Integrated function documentation ("Quick Documentation", Ctrl+Q);
Context information (Alt+Q) for XQuery function declarations;
Spellchecking support with bundle dictionaries with XPath, XQuery, and XSLT terms.
Language injection support on various elements, including string literals.

The plugin also supports the following IntelliJ Ultimate features:

Support displaying MarkLogic rewriter files in the Endpoints tool window;
Support displaying EXQuery RESTXQ endpoints in the Endpoints tool window.

The IntelliJ XQuery Plugin is licensed under the Apache 2.0 license.

xquery-intellij-plugin's People

Contributors

Stargazers

Watchers

Forkers

canofbees ryanjdew line-o kingking888 williammsawyer aerisnju ronaksomaiya genmetsaveer

xquery-intellij-plugin's Issues

XQuery and XPath Full Text 1.0

Full Text Extension

Support XQuery implementation profiles

Built-in Function Documentation

XQuery Update Facility 3.0

Update Facility Extension

(1) Both the XQuery 3.1 ArrowExpr and Update Facility 3.0 TransformWithExpr are inserted between XQuery 3.0 CastExpr and UnaryExpr. It is not currently clear what the order should be. See: https://www.w3.org/Bugs/Public/show_bug.cgi?id=30015. Until a decision is made, I have merged the two constructs as:

CastExpr ::= (ArrowExpr | TransformWithExpr) ( "cast" "as" SingleType )?

This conforms to both grammars, while not adding any additional functionality due to the precedence order of the two expressions.

IntelliJ Code Folding Support

http://www.jetbrains.org/intellij/sdk/docs/reference_guide/custom_language_support/additional_minor_features.html

Implementation: MarkLogic 7

Implementation: MarkLogic
Implementation Version: MarkLogic 7

Language Versions:

0.9-ml
1.0
1.0-ml [Default]

Dialects:

XQuery [Default]

Features:

IntelliJ Go To Symbol Support

http://www.jetbrains.org/intellij/sdk/docs/reference_guide/custom_language_support/go_to_class_and_go_to_symbol.html

Implementation: Saxon Home Edition

Implementation: Saxonica
Implementation Versions: Saxon Home Edition

Language Versions:

1.0 [Default]

Dialects:

XQuery [Default]

Features:

Minimal Conformance
Full Axis Feature
Module Feature
Serialization Feature

IntelliJ References and Resolve Support (Core Support)

http://www.jetbrains.org/intellij/sdk/docs/reference_guide/custom_language_support/references_and_resolve.html

URILiterals
QName prefices
Functions
Variables

Variable Providers:

Implementation: MarkLogic 8

Implementation: MarkLogic
Implementation Version: MarkLogic 8

Language Versions:

0.9-ml
1.0
1.0-ml [Default]

Dialects:

XQuery [Default]

Features:

MarkLogic object-node allows variables as key types.

The following is valid MarkLogic syntax:

object-node { $key: $value }

This is reported as an error by the plugin.

XQuery and XPath Full Text 3.0

Full Text Extension

NOTE: The changes here are adapting the XQuery 1.0 based grammar to the XQuery 3.0 grammar.

XQuery 1.0 Lexer and Syntax Highlighting

XQuery 1.0: First Edition - Second Edition

Lexical structure:

IntelliJ XML and Function Breadcrumb Support

Add support for the new IntelliJ breadcrumbs feature.

Navigation to declaration for unprefixed function doesn't work

For a scenario

declare default function namespace 'http://www.w3.org/2005/xquery-local-functions';
declare function x() {'a'};
x()

trying to navigate from function call to declaration doesn't work.

Implementation: Saxon Professional Edition

Implementation: Saxonica
Implementation Version: Saxon Professional Edition

Language Versions:

1.0
3.0 [Default]
3.1

Dialects:

XQuery [Default]

Features:

Find usages not working at all or not working properly

#30 mentions support for finding usages.
For a simple scenario like:

let $x := ''
return $x

navigation to declaration place works fine but finding usage on $x in first line doesn't do anything.
Same for:

declare variable $x := '';
$x

For scenario with function like below:

declare default function namespace 'http://www.w3.org/2005/xquery-local-functions';
declare function x() {'a'};
x()

Find usages on function declaration gives results for completely unrelated usages of global and local variables with name $x.

IntelliJ Paired Brace Matcher Support

http://www.jetbrains.org/intellij/sdk/docs/reference_guide/custom_language_support/additional_minor_features.html

Built-in Function Support

This has been split into issue #52, #53, #54, #55 and #56.

Implementation: W3C Standard

Implementation Versions:

First Edition
Second Edition [Default]

Language Versions:

1.0
3.0 [Default]
3.1

Dialects:

XQuery [Default]
XQuery Full Text
XQuery Update Facility
XQuery Scripting

Implementation: MarkLogic 9 (Early Access Preview)

Implementation: MarkLogic
Implementation Version: MarkLogic 9

Language Versions:

0.9-ml
1.0
1.0-ml [Default]

Dialects:

XQuery [Default]

Features:

Builtin Functions and Types:

XPath and XQuery Functions and Operators 3.0
MarkLogic 9 Extensions

XQuery Error Conditions

XQuery 1.0

XQuery 3.0

XQuery 3.1

err:XQDY0137

XQuery 3.0

XQuery 3.0: Recommendation

NOTE: MarkLogic supports many XQuery 3.0 features in the 1.0-ml version, but does not meet the minimal conformance for XQuery 3.0.

Valid expression of form ... <function-call() highlights an issue

With expression like this one:

1 <fn:abs(1)

I'm getting errors highlighted:

1 <fn:abs(1)
  ^      ^^^
  |     XPST0003: Expected '>', '/>' or attribute name.
XPST0003: Expected end of file.

Implementation: Zorba 3.0

Implementation: Zorba
Implementation Version: Zorba 3.0

Language Versions:

1.0
3.0 [Default]

Dialects:

Features:

Minimal Conformance
Full Axis Feature (Language Version: 1.0)
Module Feature
Serialization Feature
Higher Order Functions (Language Version: 3.0 | 3.1)
Schema Aware (Import and Validation) Feature
Typed Data Feature

Builtin Functions and Types:

XQuery 1.0 and XPath 2.0 Functions and Operators (First Edition | Second Edition)
XPath and XQuery Functions and Operators 3.0
XPath and XQuery Functions and Operators 3.1
Zorba Extensions

IntelliJ Rename Refactoring Support

http://www.jetbrains.org/intellij/sdk/docs/reference_guide/custom_language_support/rename_refactoring.html

Implementation: MarkLogic 6

Implementation: MarkLogic
Implementation Version: MarkLogic 6

Language Versions:

0.9-ml
1.0
1.0-ml [Default]

Dialects:

XQuery [Default]

Features:

XQuery 3.1

XQuery 3.1: Candidate Recommendation

Saxon 9.4 introduced a version of the map syntax:

MapType : http://dev.saxonica.com/blog/mike/2012/01/maps.html (Saxon-PE 9.4)
MapExpr : http://dev.saxonica.com/blog/mike/2012/01/maps.html (Saxon-PE 9.4)

NOTE: As of Saxon 9.7, XQuery 3.1 is supported and the := map syntax is not supported.

IntelliJ Find Usages Support

http://www.jetbrains.org/intellij/sdk/docs/reference_guide/custom_language_support/find_usages.html

Support refactoring/code style/lint inspections

The XQuery grammar has isomorphic (i.e. equivalent) constructs, with one being the long form and the other being the short form. For example:

span

is equivalent to:

child::span

This also includes things like replacing concat(...) with StringConcatExpr (XQuery 3.0) and StringConcatExpr with StringConstructor (XQuery 3.1).

NOTE: These equivalences are described in the XQuery specifications.

This should also include replacing proprietary and older constructs with standard compliant constructs (e.g. Saxon map { "a" := "b" } with map { "a": "b" }).

The inspections should have an option to specify which form is preferred. This makes it easier for the developer to specify the coding style they want to use, and makes it possible to refactor a codebase from different XQuery versions and implementations.

NOTE: This is a top-level tracking issue. Other issues should be raised to track progress within different specifications and for different implementations.