qlue-ls 0.9.1 → 0.10.0

package/README.md

@@ -2,109 +2,29 @@
   🦀 Qlue-ls 🦀
 </h1>
 
-⚡Qlue-ls (pronounced "clueless") is a *blazingly fast* [language server](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification) for [SPARQL](https://de.wikipedia.org/wiki/SPARQL), written in Rust 🦀.
+⚡Qlue-ls (pronounced "clueless") is a *blazingly fast* [language server](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification) for [SPARQL](https://de.wikipedia.org/wiki/SPARQL),  
+written in Rust 🦀, build for the web.
 
+If you want to use Qlue-ls, check out the [documentation](https://docs.qlue-ls.com).  
 To learn more about the origin story of this project, read the [blog post](https://ad-blog.cs.uni-freiburg.de/post/qlue-ls-a-sparql-language-server/).
 
-# 🚀 Getting Started
-
-## 📦 Installation
-
-Qlue-ls is available on [crate.io](https://crates.io/crates/qlue-ls):
-
-```shell
-cargo install qlue-ls
-```
-
-And on [PyPI](https://pypi.org/project/qlue-ls/):
-
-```shell
-pipx install qlue-ls
-```
-
-You can also build it from source:
-
-```shell
-git clone https://github.com/IoannisNezis/Qlue-ls.git
-cd Qlue-ls
-cargo build --release --bin qlue-ls
-```
-
-## CLI Usage
-
-To run Qlue-ls as **formatter** run:
-
-```shell
-qlue-ls format <PATH>
-```
-
-To run Qlue-ls as **language server** run:
-
-```shell
-qlue-ls server
-```
-
-This will create a language server listening on stdio.
-
-## with Neovim
-
-After you installed the language server, add this to your `init.lua`:
-
-```lua
-vim.api.nvim_create_autocmd({ 'FileType' }, {
-  desc = 'Connect to Qlue-ls',
-  pattern = { 'sparql' },
-  callback = function()
-    vim.lsp.start {
-      name = 'qlue-ls',
-      cmd = { 'qlue-ls', 'server' },
-      root_dir = vim.fn.getcwd(),
-      on_attach = function(client, bufnr)
-        vim.keymap.set('n', '<leader>f', vim.lsp.buf.format, { buffer = bufnr, desc = 'LSP: ' .. '[F]ormat' })
-      end,
-    }
-  end,
-})
-```
-
-Open a `.rq` file and check that the buffer is attached to th server:
-
-```
-:checkhealth lsp
-```
-
-Configure keymaps in `on_attach` function.
-
 # 🚀 Capabilities
 
-## 📐 Formatting
+Here is a quick overview what Qlue-ls can do.  
+A more detailed list can be found in the [documentation](https://docs.qlue-ls.com/03_capabilities/).
 
-**Status**: Full support
+## 📐 Formatting
 
 Formats SPARQL queries to ensure consistent and readable syntax.
 Customizable options to align with preferred query styles are also implemented.
 
 ## 🩺 Diagnostics
 
-**Status**: Partial support
-
 Diagnostics provide feadback on the query.  
 Diagnostics come in severity: error, warning and info
 
-** provided diagnostics**:
-
-| Type        | Name                        | Description                      |
-|:------------|:----------------------------|:---------------------------------|
-| ❌ error    | undefined prefix            | a used prefix is not declared    |
-| ❌ error    | ungrouped select variable   | selected variable is not grouped |
-| ❌ error    | invalid projection variable | projection variable is taken     |
-| ⚠️  warning | unused prefix               | a declared prefix is not used    |
-| ℹ️  info    | uncompacted uri             | a raw uncompacted uri is used    |
-
 ## ✨ Completion
 
-**Status**: Full support
-
 Completion provides suggestions how the query could continue.
 
 For completion of subjects, predicates or objects the language server sends
@@ -114,20 +34,27 @@ completion-queries to the backend and gets the completions from the knowledge-gr
 
 ## 🛠️ Code Actions
 
-**Status**: Partial support
+Code action suggest complex changes to your input.  
+Often in the form of a *quickfix*, to fix a diagnostic.
+
+## ℹ️ Hover
+
+Get information about a token on hover.
+
+## 🕳 Jump
+
+Quickly jump to the next or previous important location in the query.
 
-| name              | description                           | diagnostic        |
-|:------------------|:--------------------------------------|:------------------|
-| shorten uri       | shorten uri into compacted form       | uncompacted uri   |
-| declare prefix    | declares undeclared prefix (if known) | undeclared prefix |
-| shorten all uri's | shorten all uri's into compacted form |                   |
-| add to result     | add variable to selected result       |                   |
-| filter variable   | add filter for this variable          |                   |
+## ❓ operation identification
+
+Determine if a operation is a query or update.
 
 # ⚙️  Configuration
 
 Qlue-ls can be configured through a `qlue-ls.toml` or `qlue-ls.yml` file.
 
+Detailed exmplanations can be found in the [documentation](https://docs.qlue-ls.com/04_configuration/).
+
 Here is the full default configuration
 ```toml
 [format]
@@ -136,93 +63,21 @@ align_prefixes = true
 separate_prolouge = false
 capitalize_keywords = true
 insert_spaces = true
-tab_size = 10
+tab_size = 2
 where_new_line = true
 filter_same_line = true
 
 [completion]
 timeout_ms = 5000
-result_size_limit = 42
-```
-
-# 🌐 use in web
-
-If you want to connect from a web-based-editor, you can use this package as well.  
-For this purpose this can be compiled to wasm and is available on [npm](https://www.npmjs.com/package/@ioannisnezis/sparql-language-server):
-
-
-```shell
-npm i qlue-ls
-```
-
-You will have to wrap this in a Web Worker and provide a language server client.
-There will be more documentation on this in the future...
-
-Until then you can check out the demo in ./editor/
-
-# 🏗 Development Setup
-
-Here is a quick guide to set this project up for development.
-
-## Requirements
-
- - [rust](https://www.rust-lang.org/tools/install) >= 1.83.0
- - [wasm-pack](https://rustwasm.github.io/wasm-pack/) >= 0.13.1
- - [node & npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) >= 22.14.0 & >= 11.3.0
- - \[Optional\] [just](https://github.com/casey/just)
- - \[Optional\] [watchexec](https://github.com/watchexec/watchexec)
-
-## Initial Setup
-
-You will only have to do this once.
-
-In the `justfile` and `Makefile` you will find the target `init_dev`, run it:
+result_size_limit = 100
 
-```bash
-just init_dev
+[prefixes]
+add_missing = true
+remove_unused = true
 ```
 
-or 
-
-```bash
-make init_dev
-```
-
-It will:
-  - install node dependencies
-  - build wasm binaries
-  - link against local packages
-  - run the vite dev server
-
-If you don't have [just](https://github.com/casey/just) or [make](https://wiki.ubuntuusers.de/Makefile/) installed:
-
-**Install [just](https://github.com/casey/just)**
-
-
-## Automatically rebuild on change
-
-When developping the cycle is:
-
-- Change the code
-- Compile to wasm (or run tests)
-- Evaluate
-
-To avoid having to run a command each time to Compile I strongly recommend setting up a
-auto runner like [watchexec](https://github.com/watchexec/watchexec).
-
-```bash
-watchexec --restart --exts rs --exts toml just build-wasm
-```
-
-or just:
-
-```bash
-just watch-and-run build-wasm
-```
-
-have fun!
-
 # 🙏 Special Thanks
 
 * [TJ DeVries](https://github.com/tjdevries) for the inspiration and great tutorials
 * [Chris Biscardi](https://github.com/christopherbiscardi) for teaching me Rust
+* [Hannah Bast](https://ad.informatik.uni-freiburg.de/staff/bast) for the guidance.

package/package.json

@@ -5,7 +5,7 @@
     "Ioannis Nezis <ioannis@nezis.de>"
   ],
   "description": "A language server for SPARQL",
-  "version": "0.9.1",
+  "version": "0.10.0",
   "license": "SEE LICENSE IN LICENSE",
   "repository": {
     "type": "git",

package/qlue_ls.d.ts

@@ -3,7 +3,6 @@
 export function format_raw(text: string): string;
 export function init_language_server(writer: WritableStreamDefaultWriter): Server;
 export function listen(server: Server, reader: ReadableStreamDefaultReader): Promise<void>;
-export function determine_operation_type(input: string): string;
 export function get_parse_tree(input: string, offset: number): any;
 export class Server {
   private constructor();
@@ -14,11 +13,10 @@ export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembl
 
 export interface InitOutput {
   readonly memory: WebAssembly.Memory;
+  readonly __wbg_server_free: (a: number, b: number) => void;
   readonly format_raw: (a: number, b: number) => [number, number, number, number];
   readonly init_language_server: (a: any) => number;
   readonly listen: (a: number, b: any) => any;
-  readonly determine_operation_type: (a: number, b: number) => [number, number];
-  readonly __wbg_server_free: (a: number, b: number) => void;
   readonly get_parse_tree: (a: number, b: number, c: number) => any;
   readonly __wbindgen_exn_store: (a: number) => void;
   readonly __externref_table_alloc: () => number;
@@ -28,8 +26,8 @@ export interface InitOutput {
   readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
   readonly __wbindgen_export_6: WebAssembly.Table;
   readonly __externref_table_dealloc: (a: number) => void;
-  readonly closure1210_externref_shim: (a: number, b: number, c: any) => void;
-  readonly closure1579_externref_shim: (a: number, b: number, c: any, d: any) => void;
+  readonly closure1217_externref_shim: (a: number, b: number, c: any) => void;
+  readonly closure1587_externref_shim: (a: number, b: number, c: any, d: any) => void;
   readonly __wbindgen_start: () => void;
 }
 

package/qlue_ls.js

@@ -254,25 +254,6 @@ export function listen(server, reader) {
     return ret;
 }
 
-/**
- * @param {string} input
- * @returns {string}
- */
-export function determine_operation_type(input) {
-    let deferred2_0;
-    let deferred2_1;
-    try {
-        const ptr0 = passStringToWasm0(input, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-        const len0 = WASM_VECTOR_LEN;
-        const ret = wasm.determine_operation_type(ptr0, len0);
-        deferred2_0 = ret[0];
-        deferred2_1 = ret[1];
-        return getStringFromWasm0(ret[0], ret[1]);
-    } finally {
-        wasm.__wbindgen_free(deferred2_0, deferred2_1, 1);
-    }
-}
-
 /**
  * @param {string} input
  * @param {number} offset
@@ -286,11 +267,11 @@ export function get_parse_tree(input, offset) {
 }
 
 function __wbg_adapter_24(arg0, arg1, arg2) {
-    wasm.closure1210_externref_shim(arg0, arg1, arg2);
+    wasm.closure1217_externref_shim(arg0, arg1, arg2);
 }
 
-function __wbg_adapter_100(arg0, arg1, arg2, arg3) {
-    wasm.closure1579_externref_shim(arg0, arg1, arg2, arg3);
+function __wbg_adapter_99(arg0, arg1, arg2, arg3) {
+    wasm.closure1587_externref_shim(arg0, arg1, arg2, arg3);
 }
 
 const __wbindgen_enum_RequestMode = ["same-origin", "no-cors", "cors", "navigate"];
@@ -419,7 +400,7 @@ function __wbg_get_imports() {
                 const a = state0.a;
                 state0.a = 0;
                 try {
-                    return __wbg_adapter_100(a, state0.b, arg0, arg1);
+                    return __wbg_adapter_99(a, state0.b, arg0, arg1);
                 } finally {
                     state0.a = a;
                 }
@@ -571,8 +552,8 @@ function __wbg_get_imports() {
         const ret = false;
         return ret;
     };
-    imports.wbg.__wbindgen_closure_wrapper5403 = function(arg0, arg1, arg2) {
-        const ret = makeMutClosure(arg0, arg1, 1211, __wbg_adapter_24);
+    imports.wbg.__wbindgen_closure_wrapper5441 = function(arg0, arg1, arg2) {
+        const ret = makeMutClosure(arg0, arg1, 1218, __wbg_adapter_24);
         return ret;
     };
     imports.wbg.__wbindgen_debug_string = function(arg0, arg1) {