https://github.com/quodatum/vscode-basex

A VSCode extension providing tools to assist development using BaseX
https://github.com/quodatum/vscode-basex

basex vscode-extension xquery

Last synced: 8 months ago
JSON representation

A VSCode extension providing tools to assist development using BaseX

• Host: GitHub
• URL: https://github.com/quodatum/vscode-basex
• Owner: Quodatum
• License: mit
• Created: 2023-02-20T12:02:22.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-08-11T19:21:34.000Z (11 months ago)
• Last Synced: 2025-10-20T21:49:09.985Z (8 months ago)
• Topics: basex, vscode-extension, xquery
• Language: TypeScript
• Homepage: https://quodatum.github.io/vscode-basex/
• Size: 8.09 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![License](https://img.shields.io/github/license/quodatum/vscode-basex?style=for-the-badge)](https://github.com/quodatum/vscode-basex/blob/master/LICENSE)

[![Visual Studio Marketplace](https://img.shields.io/visual-studio-marketplace/v/quodatum.vscode-basex?style=for-the-badge&label=VS%20Marketplace&logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=quodatum.vscode-basex)

[![Installs](https://img.shields.io/visual-studio-marketplace/i/quodatum.vscode-basex?style=for-the-badge&logo=microsoft)](https://marketplace.visualstudio.com/items?itemName=quodatum.vscode-basex)

[![OpenVSX Registry](https://img.shields.io/open-vsx/dt/quodatum/vscode-basex?color=purple&label=OpenVSX%20Downloads&style=for-the-badge)](https://open-vsx.org/extension/quodatum/vscode-basex)

[![Build Status](https://img.shields.io/github/actions/workflow/status/quodatum/vscode-basex/CI.yaml?branch=main&style=for-the-badge&logo=github)](https://github.com/quodatum/vscode-basex/actions?query=workflow:CI)

# BaseX Tools for Visual Studio Code

The `vscode-basex` extension adds features to support [BaseX](https://basex.org/) development on VSCode.

A key feature is a parser for [XQuery](https://quodatum.github.io/basex-xqparse/) sources that supports all BaseX features, including XQuery Update and the Full text search syntax.  

# Status

* __Work in progress. Errors and changes to be expected.__

# Features

See the [documentation](https://quodatum.github.io/vscode-basex/) for more detail

* Works in a Browser using [Code-server](https://github.com/coder/code-server) or [Github code-server](https://github.com/codespaces)

## XQuery

* [Linting]

* [Code Completion]

* [Execution]

* [source formating]

* [Symbols]

* [Snippets]

* [Goto definition]

## XPath

* [XPath Evaluation]

## XML

* [XML Formatting]

* [XML Tree View]

# Requirements

* VS Code `1.76.0` or higher

# Release Notes

Detailed release notes are available [here](https://github.com/Quodatum/vscode-basex/releases).

# Issues

Run into a bug? Report it [here](https://github.com/Quodatum/vscode-basex/issues).

# Development

## build

```

npm install

npm install -g typescript #once

npm install --global @vscode/vsce

#

npm run compile

vsce package

```

## Documentation

Uses [mkdocs-material](https://github.com/squidfunk/mkdocs-material)

 

# Inspiration

## VSCode

This project was created from a fork of [DotJoshJohnson/vscode-xml](https://github.com/DotJoshJohnson/vscode-xml). Some of the `DotJoshJohnson` code dealing with XML has been removed and additional XQuery features added. 

## XQuery parsing

The code parsing uses [quodatum/xqlint](https://github.com/Quodatum/xqlint) which a fork of [wcandillon/xqlint](https://github.com/wcandillon/xqlint).

These both make use of Gunther Rademacher's [REx](https://www.bottlecaps.de/rex/) Parser Generator.

The EBNF is shown [here](https://quodatum.github.io/basex-xqparse/i-BaseX.xhtml)

## Icons 

Icons used in the XML Tree View are used under the Creative Commons 3.0 BY license.

* "Code" icon by Dave Gandy from www.flaticon.com

* "At" icon by FreePik from www.flaticon.com