surrealql-language-server 0.5.1

Language Server Protocol implementation for SurrealQL
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

# Makefile for the SurrealQL Language Server.
#
# Convenience wrapper around the native cargo builds and the browser
# WebAssembly packaging pipeline (scripts/build-wasm.sh).
#
# The tree-sitter grammar must be available as a sibling checkout at
# ../surrealql-tree-sitter (or via TREE_SITTER_SURREALQL_DIR). Run
# `make grammar` once to fetch it before building.
#
# The builtin catalogue targets need a SurrealDB checkout instead, at the
# revision `src/grammar_generated.rs` records. They do not need the grammar:
# `cargo run --package xtask` never builds the root package, so build.rs does
# not run. Override the path with `make builtins SURREALDB=/path/to/surrealdb`.

CARGO       ?= cargo
SURREALDB   ?= ../surrealdb
WASM_TARGET := wasm32-unknown-unknown
OUT_NAME    := surrealql_language_server

.DEFAULT_GOAL := help

.PHONY: help
help: ## Show this help
	@awk 'BEGIN {FS = ":.*## "; printf "Usage: make <target>\n\nTargets:\n"} /^[a-zA-Z0-9_-]+:.*## / {printf "  \033[36m%-16s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)

.PHONY: grammar
grammar: ## Clone/update the sibling tree-sitter grammar
	bash scripts/setup-grammar.sh

.PHONY: build
build: ## Build the native binary + library (debug)
	$(CARGO) build

.PHONY: debug
debug: build ## Alias for `build` (debug profile)

.PHONY: release
release: ## Build the native binary + library (release)
	$(CARGO) build --release

.PHONY: wasm
wasm: ## Build the browser WASM module and refresh pkg/
	bash scripts/build-wasm.sh

.PHONY: wasm-setup
wasm-setup: ## Install the WASM toolchain prerequisites (target, CLIs, clang)
	rustup target add $(WASM_TARGET)
	$(CARGO) install -f wasm-bindgen-cli --version 0.2.108
	$(CARGO) install wasm-opt
	@if [ "$$(uname)" = "Darwin" ] && ! ls /opt/homebrew/opt/llvm/bin/clang /usr/local/opt/llvm/bin/clang /usr/local/llvm/bin/clang >/dev/null 2>&1; then \
		echo "Installing Homebrew LLVM (provides a wasm-capable clang)"; \
		brew install llvm; \
	fi

.PHONY: builtins
builtins: ## Regenerate src/grammar_generated.rs from a SurrealDB checkout
	$(CARGO) xtask generate-builtins --surrealdb $(SURREALDB)

.PHONY: builtins-check
builtins-check: ## Fail if the committed catalogue is stale (CI parity)
	$(CARGO) xtask generate-builtins --surrealdb $(SURREALDB) --check

# Compiles surrealdb-core, so the first run takes a few minutes. Worth it after
# a SurrealDB version bump: the engine never reads its own return-type registry,
# so calling the functions is the only way to catch a wrong declaration.
.PHONY: verify-returns
verify-returns: ## Check the catalogue's return types against a live engine
	$(CARGO) run --package xtask --features probe -- \
		verify-returns --surrealdb $(SURREALDB)

.PHONY: test
test: ## Run the test suite
	$(CARGO) test

.PHONY: fmt
fmt: ## Format the code
	$(CARGO) fmt

.PHONY: fmt-check
fmt-check: ## Check formatting without modifying files (CI parity)
	$(CARGO) fmt --check

.PHONY: clean
clean: ## Remove cargo artifacts and generated pkg/ output
	$(CARGO) clean
	rm -f pkg/$(OUT_NAME).js pkg/$(OUT_NAME).d.ts \
		pkg/$(OUT_NAME)_bg.wasm pkg/$(OUT_NAME)_bg.wasm.d.ts pkg/LICENSE