qlue-ls 0.1.16

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ioannis Nezis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,156 @@
+> [!CAUTION]
+> This Project is still in an early stage.  
+> Only the format capability is production ready.  
+> The rest is experimental.
+
+<h1 align="center">
+  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 🦀.
+
+# 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/sparql-language-server.git
+cd sparql-language-server
+cargo build --release --bin qlue-ls
+```
+
+## Usage
+
+To run qlue-ls as **formatter** run:
+
+```shell
+qlue-ls format <PATH>
+```
+
+To run qlue-ls as **lanugage server** run:
+
+```shell
+qlue-ls server
+```
+
+This will create a language server listening on stdio.
+
+## Connect to Neovim
+
+After you installed the language server, add this to your `init.lua`:
+
+```lua
+vim.api.nvim_create_autocmd({ 'FileType' }, {
+  desc = 'Connect to sparql-language-server',
+  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
+
+**Status**: Full support
+
+Formats SPARQL queries to ensure consistent and readable syntax.
+Customizable options to align with preferred query styles are also implemented.
+
+## Diagnostics
+
+**Status**: Partial support
+
+Currently provides a few basic diagnostics for syntax errors and simple issues in SPARQL queries.
+Further enhancements are planned to cover a broader range of semantic and logic-related diagnostics.
+
+**Currently provided diagnostics**:
+
+- unused namespace (warning): A declared namespace is not used
+- undefined namespace (error): A used namespace is not declared
+
+**Planed diagnostics**:
+
+- path compresion possible (info): A declared namespace is not used
+
+## Completion
+
+**Status**: Rudimentary
+
+Basic auto-completion for SPARQL keywords and variables. Currently not context aware.  
+Future improvements will expand suggestions to include functions, predicates, and custom completions based on query context.
+
+## Code Actions
+
+**Status**: Planed
+
+Future support for code actions, such as quick fixes and refactoring suggestions, to improve productivity and code quality in SPARQL development.
+
+**Planed code actions**:
+
+- Consolidate property paths
+- Refactor iris into namespaces
+- Sort Prefixes
+
+# Configuration
+
+qlue-ls can be configured through a `qlue-ls.toml` or `qlue-ls.yml` file.
+
+Here is the full default configuration
+```toml
+[format]
+align_predicates = false
+align_prefixes = false
+separate_prolouge = true
+capitalize_keywords = true
+insert_spaces = true
+tab_size = 2
+where_new_line = true
+```
+
+# use in web
+
+If you want to connect from a web-based-editor, you can use this package as well.  
+For this purpouse this can be compiled to wasm and is availible on [npm](https://www.npmjs.com/package/@ioannisnezis/sparql-language-server):
+
+
+```shell
+npm i @ioannisnezis/sparql-language-server
+```
+
+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...
+
+## Demo
+
+In the mean time, check out the [demo](https://sparql.nezis.de).

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "qlue-ls",
+  "type": "module",
+  "collaborators": [
+    "Ioannis Nezis <ioannis@nezis.de>"
+  ],
+  "description": "A formatter for SPARQL queries",
+  "version": "0.1.16",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/IoannisNezis/sparql-language-server"
+  },
+  "files": [
+    "sparql_language_server_web_bg.wasm",
+    "sparql_language_server_web.js",
+    "sparql_language_server_web_bg.js",
+    "sparql_language_server_web.d.ts"
+  ],
+  "main": "sparql_language_server_web.js",
+  "types": "sparql_language_server_web.d.ts",
+  "sideEffects": [
+    "./sparql_language_server_web.js",
+    "./snippets/*"
+  ],
+  "keywords": [
+    "SPARQL",
+    "formatter",
+    "lsp",
+    "wasm"
+  ]
+}

package/sparql_language_server_web.d.ts

@@ -0,0 +1,4 @@
+/* tslint:disable */
+/* eslint-disable */
+export function format_raw(text: string): string;
+export function start_language_server(reader: ReadableStreamDefaultReader, writer: WritableStreamDefaultWriter): Promise<void>;

package/sparql_language_server_web.js

@@ -0,0 +1,5 @@
+import * as wasm from "./sparql_language_server_web_bg.wasm";
+export * from "./sparql_language_server_web_bg.js";
+import { __wbg_set_wasm } from "./sparql_language_server_web_bg.js";
+__wbg_set_wasm(wasm);
+wasm.__wbindgen_start();

package/sparql_language_server_web_bg.js

@@ -0,0 +1,356 @@
+let wasm;
+export function __wbg_set_wasm(val) {
+    wasm = val;
+}
+
+
+function addToExternrefTable0(obj) {
+    const idx = wasm.__externref_table_alloc();
+    wasm.__wbindgen_export_2.set(idx, obj);
+    return idx;
+}
+
+function handleError(f, args) {
+    try {
+        return f.apply(this, args);
+    } catch (e) {
+        const idx = addToExternrefTable0(e);
+        wasm.__wbindgen_exn_store(idx);
+    }
+}
+
+const lTextDecoder = typeof TextDecoder === 'undefined' ? (0, module.require)('util').TextDecoder : TextDecoder;
+
+let cachedTextDecoder = new lTextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+
+cachedTextDecoder.decode();
+
+let cachedUint8ArrayMemory0 = null;
+
+function getUint8ArrayMemory0() {
+    if (cachedUint8ArrayMemory0 === null || cachedUint8ArrayMemory0.byteLength === 0) {
+        cachedUint8ArrayMemory0 = new Uint8Array(wasm.memory.buffer);
+    }
+    return cachedUint8ArrayMemory0;
+}
+
+function getStringFromWasm0(ptr, len) {
+    ptr = ptr >>> 0;
+    return cachedTextDecoder.decode(getUint8ArrayMemory0().subarray(ptr, ptr + len));
+}
+
+function isLikeNone(x) {
+    return x === undefined || x === null;
+}
+
+const CLOSURE_DTORS = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(state => {
+    wasm.__wbindgen_export_3.get(state.dtor)(state.a, state.b)
+});
+
+function makeMutClosure(arg0, arg1, dtor, f) {
+    const state = { a: arg0, b: arg1, cnt: 1, dtor };
+    const real = (...args) => {
+        // First up with a closure we increment the internal reference
+        // count. This ensures that the Rust closure environment won't
+        // be deallocated while we're invoking it.
+        state.cnt++;
+        const a = state.a;
+        state.a = 0;
+        try {
+            return f(a, state.b, ...args);
+        } finally {
+            if (--state.cnt === 0) {
+                wasm.__wbindgen_export_3.get(state.dtor)(a, state.b);
+                CLOSURE_DTORS.unregister(state);
+            } else {
+                state.a = a;
+            }
+        }
+    };
+    real.original = state;
+    CLOSURE_DTORS.register(real, state, state);
+    return real;
+}
+
+let WASM_VECTOR_LEN = 0;
+
+const lTextEncoder = typeof TextEncoder === 'undefined' ? (0, module.require)('util').TextEncoder : TextEncoder;
+
+let cachedTextEncoder = new lTextEncoder('utf-8');
+
+const encodeString = (typeof cachedTextEncoder.encodeInto === 'function'
+    ? function (arg, view) {
+    return cachedTextEncoder.encodeInto(arg, view);
+}
+    : function (arg, view) {
+    const buf = cachedTextEncoder.encode(arg);
+    view.set(buf);
+    return {
+        read: arg.length,
+        written: buf.length
+    };
+});
+
+function passStringToWasm0(arg, malloc, realloc) {
+
+    if (realloc === undefined) {
+        const buf = cachedTextEncoder.encode(arg);
+        const ptr = malloc(buf.length, 1) >>> 0;
+        getUint8ArrayMemory0().subarray(ptr, ptr + buf.length).set(buf);
+        WASM_VECTOR_LEN = buf.length;
+        return ptr;
+    }
+
+    let len = arg.length;
+    let ptr = malloc(len, 1) >>> 0;
+
+    const mem = getUint8ArrayMemory0();
+
+    let offset = 0;
+
+    for (; offset < len; offset++) {
+        const code = arg.charCodeAt(offset);
+        if (code > 0x7F) break;
+        mem[ptr + offset] = code;
+    }
+
+    if (offset !== len) {
+        if (offset !== 0) {
+            arg = arg.slice(offset);
+        }
+        ptr = realloc(ptr, len, len = offset + arg.length * 3, 1) >>> 0;
+        const view = getUint8ArrayMemory0().subarray(ptr + offset, ptr + len);
+        const ret = encodeString(arg, view);
+
+        offset += ret.written;
+        ptr = realloc(ptr, len, offset, 1) >>> 0;
+    }
+
+    WASM_VECTOR_LEN = offset;
+    return ptr;
+}
+
+let cachedDataViewMemory0 = null;
+
+function getDataViewMemory0() {
+    if (cachedDataViewMemory0 === null || cachedDataViewMemory0.buffer.detached === true || (cachedDataViewMemory0.buffer.detached === undefined && cachedDataViewMemory0.buffer !== wasm.memory.buffer)) {
+        cachedDataViewMemory0 = new DataView(wasm.memory.buffer);
+    }
+    return cachedDataViewMemory0;
+}
+/**
+ * @param {string} text
+ * @returns {string}
+ */
+export function format_raw(text) {
+    let deferred2_0;
+    let deferred2_1;
+    try {
+        const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.format_raw(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 {ReadableStreamDefaultReader} reader
+ * @param {WritableStreamDefaultWriter} writer
+ * @returns {Promise<void>}
+ */
+export function start_language_server(reader, writer) {
+    const ret = wasm.start_language_server(reader, writer);
+    return ret;
+}
+
+function __wbg_adapter_22(arg0, arg1, arg2) {
+    wasm.closure494_externref_shim(arg0, arg1, arg2);
+}
+
+function __wbg_adapter_51(arg0, arg1, arg2, arg3) {
+    wasm.closure511_externref_shim(arg0, arg1, arg2, arg3);
+}
+
+export function __wbg_call_500db948e69c7330() { return handleError(function (arg0, arg1, arg2) {
+    const ret = arg0.call(arg1, arg2);
+    return ret;
+}, arguments) };
+
+export function __wbg_call_b0d8e36992d9900d() { return handleError(function (arg0, arg1) {
+    const ret = arg0.call(arg1);
+    return ret;
+}, arguments) };
+
+export function __wbg_debug_19114f11037e4658(arg0, arg1, arg2, arg3) {
+    console.debug(arg0, arg1, arg2, arg3);
+};
+
+export function __wbg_error_483d659117b6f3f6(arg0, arg1, arg2, arg3) {
+    console.error(arg0, arg1, arg2, arg3);
+};
+
+export function __wbg_error_fab41a42d22bf2bc(arg0) {
+    console.error(arg0);
+};
+
+export function __wbg_get_bbccf8970793c087() { return handleError(function (arg0, arg1) {
+    const ret = Reflect.get(arg0, arg1);
+    return ret;
+}, arguments) };
+
+export function __wbg_info_18e75e6ce8a36a90(arg0, arg1, arg2, arg3) {
+    console.info(arg0, arg1, arg2, arg3);
+};
+
+export function __wbg_log_bc77772961bf21bb(arg0, arg1, arg2, arg3) {
+    console.log(arg0, arg1, arg2, arg3);
+};
+
+export function __wbg_new_3d446df9155128ef(arg0, arg1) {
+    try {
+        var state0 = {a: arg0, b: arg1};
+        var cb0 = (arg0, arg1) => {
+            const a = state0.a;
+            state0.a = 0;
+            try {
+                return __wbg_adapter_51(a, state0.b, arg0, arg1);
+            } finally {
+                state0.a = a;
+            }
+        };
+        const ret = new Promise(cb0);
+        return ret;
+    } finally {
+        state0.a = state0.b = 0;
+    }
+};
+
+export function __wbg_newnoargs_fd9e4bf8be2bc16d(arg0, arg1) {
+    const ret = new Function(getStringFromWasm0(arg0, arg1));
+    return ret;
+};
+
+export function __wbg_queueMicrotask_2181040e064c0dc8(arg0) {
+    queueMicrotask(arg0);
+};
+
+export function __wbg_queueMicrotask_ef9ac43769cbcc4f(arg0) {
+    const ret = arg0.queueMicrotask;
+    return ret;
+};
+
+export function __wbg_read_4d173e86f707008c(arg0) {
+    const ret = arg0.read();
+    return ret;
+};
+
+export function __wbg_resolve_0bf7c44d641804f9(arg0) {
+    const ret = Promise.resolve(arg0);
+    return ret;
+};
+
+export function __wbg_static_accessor_GLOBAL_0be7472e492ad3e3() {
+    const ret = typeof global === 'undefined' ? null : global;
+    return isLikeNone(ret) ? 0 : addToExternrefTable0(ret);
+};
+
+export function __wbg_static_accessor_GLOBAL_THIS_1a6eb482d12c9bfb() {
+    const ret = typeof globalThis === 'undefined' ? null : globalThis;
+    return isLikeNone(ret) ? 0 : addToExternrefTable0(ret);
+};
+
+export function __wbg_static_accessor_SELF_1dc398a895c82351() {
+    const ret = typeof self === 'undefined' ? null : self;
+    return isLikeNone(ret) ? 0 : addToExternrefTable0(ret);
+};
+
+export function __wbg_static_accessor_WINDOW_ae1c80c7eea8d64a() {
+    const ret = typeof window === 'undefined' ? null : window;
+    return isLikeNone(ret) ? 0 : addToExternrefTable0(ret);
+};
+
+export function __wbg_then_0438fad860fe38e1(arg0, arg1) {
+    const ret = arg0.then(arg1);
+    return ret;
+};
+
+export function __wbg_then_0ffafeddf0e182a4(arg0, arg1, arg2) {
+    const ret = arg0.then(arg1, arg2);
+    return ret;
+};
+
+export function __wbg_warn_cb8be8bbf790a5d6(arg0, arg1, arg2, arg3) {
+    console.warn(arg0, arg1, arg2, arg3);
+};
+
+export function __wbg_write_0aea81ae26043440(arg0, arg1) {
+    const ret = arg0.write(arg1);
+    return ret;
+};
+
+export function __wbindgen_boolean_get(arg0) {
+    const v = arg0;
+    const ret = typeof(v) === 'boolean' ? (v ? 1 : 0) : 2;
+    return ret;
+};
+
+export function __wbindgen_cb_drop(arg0) {
+    const obj = arg0.original;
+    if (obj.cnt-- == 1) {
+        obj.a = 0;
+        return true;
+    }
+    const ret = false;
+    return ret;
+};
+
+export function __wbindgen_closure_wrapper2230(arg0, arg1, arg2) {
+    const ret = makeMutClosure(arg0, arg1, 495, __wbg_adapter_22);
+    return ret;
+};
+
+export function __wbindgen_init_externref_table() {
+    const table = wasm.__wbindgen_export_2;
+    const offset = table.grow(4);
+    table.set(0, undefined);
+    table.set(offset + 0, undefined);
+    table.set(offset + 1, null);
+    table.set(offset + 2, true);
+    table.set(offset + 3, false);
+    ;
+};
+
+export function __wbindgen_is_function(arg0) {
+    const ret = typeof(arg0) === 'function';
+    return ret;
+};
+
+export function __wbindgen_is_undefined(arg0) {
+    const ret = arg0 === undefined;
+    return ret;
+};
+
+export function __wbindgen_string_get(arg0, arg1) {
+    const obj = arg1;
+    const ret = typeof(obj) === 'string' ? obj : undefined;
+    var ptr1 = isLikeNone(ret) ? 0 : passStringToWasm0(ret, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+    var len1 = WASM_VECTOR_LEN;
+    getDataViewMemory0().setInt32(arg0 + 4 * 1, len1, true);
+    getDataViewMemory0().setInt32(arg0 + 4 * 0, ptr1, true);
+};
+
+export function __wbindgen_string_new(arg0, arg1) {
+    const ret = getStringFromWasm0(arg0, arg1);
+    return ret;
+};
+
+export function __wbindgen_throw(arg0, arg1) {
+    throw new Error(getStringFromWasm0(arg0, arg1));
+};
+