sqlakit-lsp 0.1.0__tar.gz

sqlakit_lsp-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Anton Ruhlov
+
+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.

sqlakit_lsp-0.1.0/PKG-INFO

@@ -0,0 +1,79 @@
+Metadata-Version: 2.4
+Name: sqlakit-lsp
+Version: 0.1.0
+Summary: The language server for SQLAKit templates.
+Keywords: sqlalchemy,sqlakit,lsp,language-server,sql
+Author: Anton Ruhlov
+Author-email: Anton Ruhlov <antonruhlov@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Database
+Classifier: Topic :: Text Editors :: Integrated Development Environments (IDE)
+Classifier: Typing :: Typed
+Requires-Dist: sqlakit>=0.21.0,<0.22
+Requires-Dist: pygls>=2.1,<3
+Requires-Python: >=3.11
+Project-URL: Repository, https://github.com/sqlakit/sqlakit-lsp
+Project-URL: Documentation, https://github.com/sqlakit/sqlakit-lsp#readme
+Description-Content-Type: text/markdown
+
+# sqlakit-lsp
+
+The language server for [SQLAKit](https://sqlakit.readthedocs.io/en/stable/)
+templates. In a `.sql` template:
+
+- the problems `sqlakit check` finds, as you type
+- completion after `tpl.` and in `tpl.include('`, and a macro's arguments while
+  you write them
+- on hover, the SQL a call writes, above the macro's signature and docstring
+- go to definition, implementation and references of a macro or a template
+- rename of a macro or a template across the project
+- the macros' calls and the parameters coloured
+- a parameter no call of the project passes, marked, with a quick fix for a
+  name close to one the calls pass
+- **Show rendered SQL**, the whole template as the SQL it writes
+- the outline of a template, and a search for a macro or a template
+
+In Python, the template name in `db.sql("...")` completes and links to its
+file, and a value the template does not read is marked.
+
+```console
+$ pip install sqlakit-lsp
+```
+
+Register `sqlakit-lsp` for `.sql` and `.py` files in your editor. It talks over
+stdio. In Neovim 0.11:
+
+```lua
+vim.lsp.config("sqlakit", {
+  cmd = { "sqlakit-lsp" },
+  filetypes = { "sql", "python" },
+  root_markers = { "pyproject.toml" },
+})
+vim.lsp.enable("sqlakit")
+```
+
+Zed colours the macros' calls and the parameters of a template from the
+server once its settings say `"semantic_tokens": "combined"`.
+
+It reads the project the way `sqlakit check` does, from the `Templates(...)`
+the code builds, without running it. [SQL
+templates](https://sqlakit.readthedocs.io/en/stable/sql/#template-validation)
+covers what it reads, and `[tool.sqlakit.templates]` for a project whose code
+builds its paths in a way it can't follow.
+
+## Development
+
+```console
+$ uv sync
+$ uv run poe test
+$ uv run poe lint
+```

sqlakit_lsp-0.1.0/README.md

@@ -0,0 +1,52 @@
+# sqlakit-lsp
+
+The language server for [SQLAKit](https://sqlakit.readthedocs.io/en/stable/)
+templates. In a `.sql` template:
+
+- the problems `sqlakit check` finds, as you type
+- completion after `tpl.` and in `tpl.include('`, and a macro's arguments while
+  you write them
+- on hover, the SQL a call writes, above the macro's signature and docstring
+- go to definition, implementation and references of a macro or a template
+- rename of a macro or a template across the project
+- the macros' calls and the parameters coloured
+- a parameter no call of the project passes, marked, with a quick fix for a
+  name close to one the calls pass
+- **Show rendered SQL**, the whole template as the SQL it writes
+- the outline of a template, and a search for a macro or a template
+
+In Python, the template name in `db.sql("...")` completes and links to its
+file, and a value the template does not read is marked.
+
+```console
+$ pip install sqlakit-lsp
+```
+
+Register `sqlakit-lsp` for `.sql` and `.py` files in your editor. It talks over
+stdio. In Neovim 0.11:
+
+```lua
+vim.lsp.config("sqlakit", {
+  cmd = { "sqlakit-lsp" },
+  filetypes = { "sql", "python" },
+  root_markers = { "pyproject.toml" },
+})
+vim.lsp.enable("sqlakit")
+```
+
+Zed colours the macros' calls and the parameters of a template from the
+server once its settings say `"semantic_tokens": "combined"`.
+
+It reads the project the way `sqlakit check` does, from the `Templates(...)`
+the code builds, without running it. [SQL
+templates](https://sqlakit.readthedocs.io/en/stable/sql/#template-validation)
+covers what it reads, and `[tool.sqlakit.templates]` for a project whose code
+builds its paths in a way it can't follow.
+
+## Development
+
+```console
+$ uv sync
+$ uv run poe test
+$ uv run poe lint
+```

sqlakit_lsp-0.1.0/pyproject.toml

@@ -0,0 +1,138 @@
+[project]
+name = "sqlakit-lsp"
+version = "0.1.0"
+description = "The language server for SQLAKit templates."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+keywords = [
+    "sqlalchemy",
+    "sqlakit",
+    "lsp",
+    "language-server",
+    "sql",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Database",
+    "Topic :: Text Editors :: Integrated Development Environments (IDE)",
+    "Typing :: Typed",
+]
+requires-python = ">=3.11"
+dependencies = [
+    "sqlakit>=0.21.0,<0.22",
+    "pygls>=2.1,<3",
+]
+
+[[project.authors]]
+name = "Anton Ruhlov"
+email = "antonruhlov@gmail.com"
+
+[project.scripts]
+sqlakit-lsp = "sqlakit_lsp._cli:main"
+
+[project.urls]
+Repository = "https://github.com/sqlakit/sqlakit-lsp"
+Documentation = "https://github.com/sqlakit/sqlakit-lsp#readme"
+
+[build-system]
+requires = ["uv_build>=0.11,<0.13"]
+build-backend = "uv_build"
+
+[tool.uv]
+default-groups = ["dev"]
+
+[tool.uv.build-backend]
+module-name = "sqlakit_lsp"
+module-root = ""
+
+[tool.pytest.ini_options]
+filterwarnings = [
+    "error",
+    "ignore:'asyncio.iscoroutinefunction' is deprecated:DeprecationWarning:pygls",
+]
+norecursedirs = [
+    ".*",
+    "build",
+    "dist",
+]
+
+[tool.ruff]
+include = [
+    "sqlakit_lsp/**/*.py",
+    "tests/**/*.py",
+    "pyproject.toml",
+]
+
+[tool.ruff.format]
+docstring-code-format = true
+docstring-code-line-length = 79
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+    "CPY001",
+    "D1",
+    "D203",
+    "D213",
+    "E501",
+    "COM812",
+    "ISC001",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*.py" = [
+    "S101",
+    "PLR2004",
+    "SLF001",
+    "PLC0415",
+]
+
+[tool.ty.src]
+include = [
+    "sqlakit_lsp/**/*",
+    "tests/**/*",
+]
+
+[tool.poe.tasks.fmt]
+help = "Format and auto-fix"
+sequence = [
+    "ruff format",
+    "ruff check --fix",
+]
+default_item_type = "cmd"
+
+[tool.poe.tasks.test]
+help = "Run the tests"
+cmd = "pytest"
+
+[tool.poe.tasks.lint]
+help = "Lint + type-check"
+sequence = [
+    "ruff format --check",
+    "ruff check",
+    "ty check",
+    "codespell",
+]
+default_item_type = "cmd"
+
+[tool.codespell]
+skip = "./.venv,./uv.lock,./.git"
+
+[dependency-groups]
+dev = [
+    "pytest>=9.1.1",
+    "pytest-cov>=7.1.0",
+    "anyio>=4.14.2",
+    "ty>=0.0.80",
+    "ruff>=0.16.6",
+    "poethepoet>=0.48.0",
+    "codespell>=2.4.3",
+]

sqlakit_lsp-0.1.0/pyproject.toml.orig

@@ -0,0 +1,113 @@
+[project]
+name = "sqlakit-lsp"
+version = "0.1.0"
+description = "The language server for SQLAKit templates."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Anton Ruhlov", email = "antonruhlov@gmail.com" }]
+keywords = ["sqlalchemy", "sqlakit", "lsp", "language-server", "sql"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Database",
+    "Topic :: Text Editors :: Integrated Development Environments (IDE)",
+    "Typing :: Typed",
+]
+requires-python = ">=3.11"
+dependencies = [
+    # The server reads the private modules of `sqlakit`, which a minor version
+    # may change.
+    "sqlakit>=0.21.0,<0.22",
+    "pygls>=2.1,<3",
+]
+
+[project.scripts]
+sqlakit-lsp = "sqlakit_lsp._cli:main"
+
+[project.urls]
+Repository = "https://github.com/sqlakit/sqlakit-lsp"
+Documentation = "https://github.com/sqlakit/sqlakit-lsp#readme"
+
+[build-system]
+requires = ["uv_build>=0.11,<0.13"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "sqlakit_lsp"
+module-root = ""
+
+[tool.uv]
+default-groups = ["dev"]
+
+[dependency-groups]
+dev = [
+    "pytest>=9.1.1",
+    "pytest-cov>=7.1.0",
+    "anyio>=4.14.2",
+    "ty>=0.0.80",
+    "ruff>=0.16.6",
+    "poethepoet>=0.48.0",
+    "codespell>=2.4.3",
+]
+
+[tool.pytest.ini_options]
+filterwarnings = [
+    "error",
+    # pygls on Python 3.14, until it moves to `inspect.iscoroutinefunction`.
+    "ignore:'asyncio.iscoroutinefunction' is deprecated:DeprecationWarning:pygls",
+]
+norecursedirs = [".*", "build", "dist"]
+
+[tool.ruff]
+include = ["sqlakit_lsp/**/*.py", "tests/**/*.py", "pyproject.toml"]
+
+[tool.ruff.format]
+docstring-code-format = true
+docstring-code-line-length = 79
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+    "CPY001", # copyright notice in every file
+    "D1", # docstrings are not mandatory
+    "D203", # incompatible with D211
+    "D213", # incompatible with D212
+    "E501", # line length is enforced by the formatter
+    "COM812", # conflicts with the formatter
+    "ISC001", # conflicts with the formatter
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*.py" = [
+    "S101",     # tests assert
+    "PLR2004",  # and compare against the values they mean
+    "SLF001",   # they read the internals they are testing
+    "PLC0415",  # a test imports what it is about, where it is about it
+]
+
+[tool.ty.src]
+include = ["sqlakit_lsp/**/*", "tests/**/*"]
+
+[tool.poe.tasks.fmt]
+help = "Format and auto-fix"
+sequence = ["ruff format", "ruff check --fix"]
+default_item_type = "cmd"
+
+[tool.poe.tasks.test]
+help = "Run the tests"
+cmd = "pytest"
+
+[tool.poe.tasks.lint]
+help = "Lint + type-check"
+sequence = ["ruff format --check", "ruff check", "ty check", "codespell"]
+default_item_type = "cmd"
+
+[tool.codespell]
+skip = "./.venv,./uv.lock,./.git"

sqlakit_lsp-0.1.0/sqlakit_lsp/__init__.py

@@ -0,0 +1,9 @@
+"""The language server for SQLAKit templates.
+
+`sqlakit-lsp` runs it over standard input and output, for an editor to start.
+It reads the project the way `sqlakit check` does, without running its code.
+"""
+
+from ._server import serve
+
+__all__ = ["serve"]

sqlakit_lsp-0.1.0/sqlakit_lsp/__main__.py

@@ -0,0 +1,5 @@
+import sys
+
+from ._cli import main
+
+sys.exit(main())

sqlakit_lsp-0.1.0/sqlakit_lsp/_cli.py

@@ -0,0 +1,22 @@
+"""`sqlakit-lsp`, the command line."""
+
+from __future__ import annotations
+
+import argparse
+from importlib.metadata import version
+
+from ._server import serve
+
+
+def main(argv: list[str] | None = None) -> int:
+    """Serve an editor over standard input and output until it hangs up."""
+    parser = argparse.ArgumentParser(
+        prog="sqlakit-lsp",
+        description="The language server for SQLAKit templates, over stdio.",
+    )
+    parser.add_argument("--version", action="version", version=version("sqlakit-lsp"))
+    # Some editors pass it to every server: stdio is the only way this one talks.
+    parser.add_argument("--stdio", action="store_true", help=argparse.SUPPRESS)
+    parser.parse_args(argv)
+    serve()  # pragma: no cover - run by an editor
+    return 0  # pragma: no cover