feat: add language server by lemonadern · Pull Request #236 · future-architect/uroborosql-fmt

lemonadern · 2026-04-13T11:59:13Z

Summary

LSP の言語サーバを実装しました。
Node-API 版にサーバ実装を追加しています。

主なライブラリとして以下を追加しています：

tower-lsp-server
- Language Server 実装のため
ropey （Rope 構造の Rust 実装）
- サーバ側でエディタのテキストを効率的に保持するため

言語サーバの機能

ドキュメントフォーマット / 範囲フォーマット
リント診断（open / save 時に publishDiagnostics）
設定解決：ワークスペースルート直下の .uroborosqlfmtrc.json / .uroborosqllintrc.json または明示指定されたパス

制限

現状では単一ワークスペースのみに対応しています

フォーマット機能について

現状の言語サーバは最低限の lint による検査とフォーマット処理を実装しています。

VS Code 上において、SQL ファイルの 1. 全文フォーマットおよび 2. 選択箇所のフォーマットはそれぞれ 1. Format Document, 2. Format Selection コマンドで実行可能になります。

一方、現状の実装では SQL 以外の言語のファイルに（埋め込まれたSQLへ）対するフォーマットは動作しません。
そちらについてはLSP のカスタムコマンドを実装して実現しようと考えています。（別 PR で対応します）

また、そのタイミングで uroborosql-fmt-napi crate で公開している runfmt()およびrunfmt_with_settings() が不要となるため削除する予定です。

Note

VS Code 側でこのサーバを利用する場合：feat: langauge server mode vscode-uroborosql-fmt#99

lemonadern · 2026-04-20T08:09:04Z

-              # This image ships an older Cargo, so pin Rust 1.86.0 here for edition 2024 support.
-              rustup install 1.86.0 &&
-              rustup default 1.86.0 &&
+              # This image ships an older Cargo, so pin Rust 1.88.0 here for edition 2024 support.
+              rustup install 1.88.0 &&
+              rustup default 1.88.0 &&


language server クレートで利用している let chains のビルドに失敗するため 1.88.0 にアップデートしました

lemonadern · 2026-04-20T08:09:59Z

language server と関係ない差分ですが、 clippy に指摘されていたため修正しました

https://rust-lang.github.io/rust-clippy/rust-1.95.0/index.html#collapsible_match

Add uroborosql-language-server crate implementing LSP over stdio. Supports textDocument/formatting, textDocument/rangeFormatting, and save-triggered lint diagnostics via uroborosql-lint.

Add run_language_server() NAPI function that starts the Rust language server over stdio using a multi-thread tokio runtime, and export it as runLanguageServer() from the npm package.

ppputtyo · 2026-04-21T03:19:04Z

+            doc.version = version;
+            if let Some(range) = change.range {
+                if let Some((start, end)) = rope_range_to_char_range(&doc.rope, &range) {
+                    doc.rope.remove(start..end);
+                    doc.rope.insert(start, &change.text);
+                }
+            } else {
+                doc.rope = Rope::from_str(&change.text);
+            }


rope_range_to_char_range() が失敗してNoneを返した場合、ropeの状態と doc.version の齟齬が発生し、その場合に publish_diagnostics の診断が不正になりそうです。

以下のようにしてropeが正常に更新された場合のみversionを更新するのはいかがでしょうか？

if let Some(range) = change.range { if let Some((start, end)) = rope_range_to_char_range(&doc.rope, &range) { doc.rope.remove(start..end); doc.rope.insert(start, &change.text); doc.version = version; } } else { doc.rope = Rope::from_str(&change.text); doc.version = version; }

ありがとうございます。 rope の更新が成功した場合のみ doc.version を更新するよう修正しました。

283a7bb

ppputtyo · 2026-04-21T03:46:00Z

+                .await;
+            return;
+        };
+


(現状はVSCodeのみ対応すると思うので優先度低です)

Neovim等のクライアントはconfigが設定されていない場合に received_config がnullになることがあるようです。

neovim/runtime/lua/vim/lsp/handlers.lua at master · neovim/neovim

なので、以下のようにnullであればdefaultを返す処理を入れても良いかもしれないです。

if received_config.is_null() { *self.client_config.write().unwrap() = ClientConfig::default(); return; }

ありがとうございます。フォールバックはあったほうが良いと思ったので、 received_config.is_null() の場合に ClientConfig::default() を返す処理を追加しました。

94ea5a6

tanzaku · 2026-04-21T02:47:23Z

+    version: i32,
+}
+
+pub(crate) fn rope_position_to_char(rope: &Rope, position: Position) -> Option<usize> {


to_charで関数名が終わるとcharに変換して返すのかと思ってしまうので、char_indexのように明示したいです。
以下もあわせて変えたいです。

rope_position_to_char

rope_char_to_position

rope_range_to_char_range

それぞれ、rope_position_to_char_index、rope_char_index_to_position、rope_range_to_char_index_range に改名しました。

da3f9b6

tanzaku · 2026-04-21T02:49:49Z

+            },
+            server_info: Some(ServerInfo {
+                name: "uroborosql-language-server".into(),
+                version: None,


以下のようにバージョン指定しておきませんか。
不具合報告の際にも、ユーザーが利用しているバージョンも追いやすくなるかなと。

version: Some(env!("CARGO_PKG_VERSION").into()),

バージョン情報を指定するよう修正しました。

94ea5a6

tanzaku · 2026-04-21T02:55:13Z

+
+        let registrations = vec![Registration {
+            id: "uroborosql-fmt-watcher".to_string(),
+            method: "workspace/didChangeWatchedFiles".to_string(),


文字列を自分で書かずに、以下のように書けるようです。
method: DidChangeWatchedFiles::METHOD.to_string(),

同様に修正しました。

da3f9b6

tanzaku · 2026-04-21T04:10:18Z

+#[serde(rename_all(serialize = "snake_case", deserialize = "camelCase"))]
+pub(crate) struct ClientConfig {
+    pub debug: Option<bool>,
+    pub tab_size: Option<usize>,


フォーマッター本体で定義しているConfigと被りがあるのが気になりました。
可能ならうまく集約したいです

…sion - handle null received_config from clients like Neovim - replace expect() with if-let in resolve_config_path - expose CARGO_PKG_VERSION in server_info

- ClientConfig の formatter フィールドに PartialConfig を flatten で埋め込み、フィールド重複を解消 - rename_all を廃止し alias 方式に統一（flatten との干渉を回避） - client_config_json_explicit_only を PartialConfig の直接 serialize に簡素化

…ages

…its methods

lemonadern · 2026-04-21T08:24:11Z

@tanzaku. config の重複解消について、以下のように変更しました。

config の変更について

uroborosql-fmt クレートに PartialConfig 構造体を新設し、language server の ClientConfig から #[serde(flatten)] で再利用する方式に変更しました。

変更前は language server が ClientConfig にフォーマッタの設定フィールドを重複定義していましたが、変更後は PartialConfig が唯一の定義元になります。

【変更前】

uroborosql-fmt::Config: serde あり、全フィールド確定値
language-server::ClientConfig: フォーマッタフィールドを重複定義

【変更後】

uroborosql-fmt::PartialConfig: serde あり、全フィールド Option<T>
- PartialConfig どうしの merge() や resolve() で以下の構造体を生成
uroborosql-fmt::Config: serde なし、全フィールド確定値（フォーマッタ内部で利用）
language-server::ClientConfig: PartialConfig を flatten で再利用（言語サーバで利用）

副作用

現状では、 CLI や設定ファイルで camelCase のキーを受け付けるように なりました。
これは、VS Code Extension Client の設定値を解釈するため PartialConfig で camelCase のエイリアスを（tabSize, keywordCase など）を付与しており、それを言語サーバとフォーマッタでフォーマッタで共用しているためです。

既存の動作への破壊的変更はありませんが、この変更については意見があればいただきたいです。

tanzaku · 2026-04-21T09:45:28Z

現状では、 CLI や設定ファイルで camelCase のキーを受け付けるようになりました。
これは、VS Code Extension Client の設定値を解釈するため PartialConfig で camelCase のエイリアスを（tabSize, keywordCase など）を付与しており、それを言語サーバとフォーマッタでフォーマッタで共用しているためです。

既存の動作への破壊的変更はありませんが、この変更については意見があればいただきたいです。

対応ありがとうございます。
以下の理由から、camelCaseのキーを受け付けるのは許容して良いと考えています。

本フォーマッターにおいては、そこまで厳密に仕様に沿う必要はなく、VS Code Extension Clientの設定値を解釈するときだけcamelCaseを受け付けるためにコストを払う必要はない
README.mdに書かなければcamelCaseのキーを受け付けるとユーザーは気づかない、また仮にcamelCaseのキーを指定したところ実害はない

lemonadern force-pushed the feat/linter-language-server branch from fb02ca5 to 5c12d11 Compare April 17, 2026 08:59

lemonadern changed the title ~~Feat/linter language server~~ feat: add language server Apr 20, 2026

lemonadern commented Apr 20, 2026

View reviewed changes

lemonadern marked this pull request as ready for review April 20, 2026 08:13

lemonadern requested review from ppputtyo and tanzaku April 20, 2026 08:13

lemonadern added 5 commits April 20, 2026 19:31

feat(lsp): add language server crate

08664b9

Add uroborosql-language-server crate implementing LSP over stdio. Supports textDocument/formatting, textDocument/rangeFormatting, and save-triggered lint diagnostics via uroborosql-lint.

feat(napi): expose runLanguageServer via NAPI bindings

65095f5

Add run_language_server() NAPI function that starts the Rust language server over stdio using a multi-thread tokio runtime, and export it as runLanguageServer() from the npm package.

test(language-server): split lsp flow integration tests

3a3c83e

chore: upgrade cargo on ci image to enable let chains

c98dc0c

style: fix clippy warning in two way sql merge

b276ef8

lemonadern force-pushed the feat/linter-language-server branch from b7e4066 to b276ef8 Compare April 20, 2026 10:35

ppputtyo reviewed Apr 21, 2026

View reviewed changes

tanzaku reviewed Apr 21, 2026

View reviewed changes

fix(language-server): update doc.version only when rope change succeeds

283a7bb

lemonadern force-pushed the feat/linter-language-server branch from 3e1bfd1 to 6977d3b Compare April 21, 2026 07:25

lemonadern added 5 commits April 21, 2026 16:45

refactor(language-server): rename char functions and use METHOD constant

da3f9b6

feat(language-server): handle null config, use if-let, and expose ver…

94ea5a6

…sion - handle null received_config from clients like Neovim - replace expect() with if-let in resolve_config_path - expose CARGO_PKG_VERSION in server_info

refactor(fmt): introduce PartialConfig and remove default_* helpers

47e7079

style(fmt): apply cargo fmt

38d385f

lemonadern force-pushed the feat/linter-language-server branch from 6977d3b to 38d385f Compare April 21, 2026 07:47

lemonadern added 2 commits April 21, 2026 16:57

refactor(language-server): use LSP request type constants in log mess…

ecd33b7

…ages

refactor(config): improve documentation for PartialConfig struct and …

5273073

…its methods

lemonadern requested review from ppputtyo and tanzaku April 21, 2026 08:24

Conversation

lemonadern commented Apr 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

言語サーバの機能

制限

フォーマット機能について

Note

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lemonadern Apr 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lemonadern Apr 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lemonadern Apr 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lemonadern Apr 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lemonadern commented Apr 21, 2026

config の変更について

【変更前】

【変更後】

副作用

Uh oh!

tanzaku commented Apr 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

lemonadern commented Apr 13, 2026 •

edited

Loading

lemonadern Apr 21, 2026 •

edited

Loading

lemonadern Apr 21, 2026 •

edited

Loading

lemonadern Apr 21, 2026 •

edited

Loading

lemonadern Apr 21, 2026 •

edited

Loading