sphinx-lua-ls 3.11.0__tar.gz → 3.12.0__tar.gz

sphinx_lua_ls-3.12.0/.coveragerc.toml

@@ -0,0 +1,22 @@
+[run]
+relative_files = true
+
+[report]
+include = ["sphinx_lua_ls/**/*.py"]
+omit = [
+    "sphinx_lua_ls/_version.py",
+    "test/**/*.py",
+]
+exclude_also = [
+    "def __repr__",
+    "def __rich_repr__",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+    "if (|_t\\.|typing\\.)TYPE_CHECKING:",
+    "@(abc\\.)?abstractmethod",
+    "except ImportError:",
+    "assert False",
+]
+
+[html]
+title = "Sphinx-LuaLs Coverage Report"

{sphinx_lua_ls-3.11.0 → sphinx_lua_ls-3.12.0}/.github/dependabot.yml

@@ -10,20 +10,30 @@ updates:
           - "beautifulsoup4"
           - "furo"
           - "myst-parser"
+          - "PyGithub"
           - "pyright"
-          - "pytest_image_diff"
           - "pytest-cov"
           - "pytest-regressions"
           - "pytest"
-          - "reportlab"
+          - "requests"
           - "sphinx_design"
-          - "svglib"
+          - "sphinx-autobuild"
+          - "sphinx"
           - "sybil"
+          - "tox"
+          - "tox-uv"
       style:
         patterns:
-          - "black"
-          - "isort"
-          - "pre-commit"
+          - "prek"
+          - "ruff"
+  - package-ecosystem: "pre-commit"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      pre-commit:
+        patterns:
+          - "*"
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:

{sphinx_lua_ls-3.11.0 → sphinx_lua_ls-3.12.0}/.github/workflows/ci.yaml

@@ -1,4 +1,4 @@
-name: Test package
+name: test
 on:
   push:
     branches:
@@ -8,7 +8,10 @@ on:
   pull_request:
     branches:
       - main
+
 jobs:
+  # Downloads LuaLs and EmmyLua binaries for all OSes and uploads them as an
+  # artifact so that the test job can re-use them without re-downloading.
   prepare:
     name: Download LuaLs
     runs-on: ubuntu-latest
@@ -44,6 +47,10 @@ jobs:
           path: ~/lua_ls_release
           include-hidden-files: true
           retention-days: 3
+
+  # Runs main tests for the package.
+  #
+  # Runs on all events except when closing a pull request.
   test:
     name: Test package
     needs:
@@ -81,25 +88,28 @@ jobs:
           path: ~/lua_ls_release
       - name: Test package
         if: ${{ matrix.type == 'test' }}
-        run: poe ci
+        run: |
+          poe ci
         env:
           LUA_LS_CACHE_PATH: ~/lua_ls_release/${{ matrix.os }}
       # Lint
       - name: Check code style
         if: ${{ matrix.type == 'code style' }}
-        run: poe lint --color always
-  publish_to_pypi:
-    name: Publish package to PyPi
-    needs:
-      - test
+        run: |
+          poe lint --color always
+
+  # Builds python packages.
+  #
+  # Only runs on tag pushes.
+  build:
+    name: Build package
     if: ${{ github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags') }}
     runs-on: ubuntu-latest
-    environment:
-      name: pypi
-      url: https://pypi.org/p/sphinx-lua-ls
-    permissions:
-      contents: write
-      id-token: write
+    outputs:
+      link: ${{ steps.metadata.outputs.link }}
+      is-pre-release: ${{ steps.changelog.outputs.is-pre-release }}
+      is-unreleased: ${{ steps.changelog.outputs.is-unreleased }}
+      changelog-text: ${{ steps.changelog.outputs.text }}
     steps:
       - name: Checkout source
         uses: actions/checkout@v6
@@ -110,35 +120,58 @@ jobs:
         run: |
           ref="${{ github.ref }}";
           version=${ref#refs/tags/v};
-          link="https://pypi.org/p/sphinx-lua-ls/${version}";
+          link="https://pypi.org/p/sphinx-lua-ls/${version}/";
           echo "link=${link}" >> $GITHUB_OUTPUT
       - name: Parse Changelog
         id: changelog
         uses: taminomara/cl-keeper@v1
         with:
           version: ${{ github.ref }}
-      - name: Set up python 3.12
-        uses: actions/setup-python@v6
-        with:
-          python-version: 3.12
-      - name: Install build
-        run: |
-          pip install build
+      - name: Install UV
+        uses: astral-sh/setup-uv@v7
       - name: Build project
         run: |
-          python3 -m build .
+          uv build
+      - name: Upload the build artifact
+        uses: actions/upload-artifact@v7
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  # Publishes python packages.
+  #
+  # Only runs on tag pushes.
+  publish_to_pypi:
+    name: Publish package to PyPi
+    needs:
+      - test
+      - build
+    if: ${{ github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags') }}
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/sphinx-lua-ls
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - name: Download build artifact
+        uses: actions/download-artifact@v8
+        with:
+          name: python-package-distributions
+          path: dist/
       - name: Publish to pypi
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           attestations: false
       - name: Create GitHub release
-        uses: softprops/action-gh-release@v2
+        uses: softprops/action-gh-release@v3
         with:
-          prerelease: ${{ fromJSON(steps.changelog.outputs.is-pre-release) }}
-          draft: ${{ fromJSON(steps.changelog.outputs.is-unreleased) }}
+          prerelease: ${{ fromJSON(needs.build.outputs.is-pre-release) }}
+          draft: ${{ fromJSON(needs.build.outputs.is-unreleased) }}
           body: |
             ## Changelog
 
-            ${{ steps.changelog.outputs.text }}
+            ${{ needs.build.outputs.changelog-text }}
 
-            [See release on PyPi](${{ steps.metadata.outputs.link }})
+            [See release on PyPi](${{ needs.build.outputs.link }})

{sphinx_lua_ls-3.11.0 → sphinx_lua_ls-3.12.0}/.pre-commit-config.yaml

@@ -4,26 +4,26 @@ repos:
       - id: ruff-check
         name: ruff check
         language: system
-        entry: scripts/resolve_venv.sh ruff check --force-exclude
+        entry: uv run --no-sync ruff check --force-exclude
         types_or: [python, pyi]
         require_serial: true
       - id: ruff-format
         name: ruff format
         language: system
-        entry: scripts/resolve_venv.sh ruff format --force-exclude
+        entry: uv run --no-sync ruff format --force-exclude
         types_or: [python, pyi]
         require_serial: true
+  - repo: https://github.com/taminomara/cl-keeper
+    rev: v1.0.0
+    hooks:
       - id: clk
-        name: changelog keeper
-        language: system
-        entry: scripts/resolve_venv.sh clk pre-commit-check
-        require_serial: true
-        types_or: [toml, yaml, markdown]
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v6.0.0
     hooks:
       - id: trailing-whitespace
+        exclude: "^(test/roots/.*|mre-sphinx-lua/.*)$"
       - id: end-of-file-fixer
+        exclude: "^(test/roots/.*|mre-sphinx-lua/.*)$"
       - id: fix-byte-order-marker
       - id: mixed-line-ending
         args: [--fix=lf]
@@ -33,6 +33,7 @@ repos:
       - id: check-json
       - id: check-merge-conflict
       - id: check-shebang-scripts-are-executable
+      - id: check-executables-have-shebangs
       - id: check-symlinks
       - id: destroyed-symlinks
       - id: check-vcs-permalinks

{sphinx_lua_ls-3.11.0 → sphinx_lua_ls-3.12.0}/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## [Unreleased]
 
+## [3.12.0] - 2026-05-12
+
+- Bumped dependencies.
+- Hardened build and publishing process to lower risk of supply-chain attacks.
+
 ## [3.11.0] - 2026-03-29
 
 - Added config option to print debug logs: `lua_ls_verbose`.
@@ -284,6 +289,7 @@ Initial release.
 [3.10.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.9.0...v3.10.0
 [3.10.1]: https://github.com/sphinx-contrib/lua-ls/compare/v3.10.0...v3.10.1
 [3.11.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.10.1...v3.11.0
+[3.12.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.11.0...v3.12.0
 [3.2.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.1.0...v3.2.0
 [3.3.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.2.0...v3.3.0
 [3.4.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.3.0...v3.4.0
@@ -299,4 +305,4 @@ Initial release.
 [@pieterlexis]: https://github.com/pieterlexis
 [emmylua]: https://github.com/EmmyLuaLs/emmylua-analyzer-rust/
 [luals#3301]: https://github.com/LuaLS/lua-language-server/issues/3301
-[unreleased]: https://github.com/sphinx-contrib/lua-ls/compare/v3.11.0...HEAD
+[unreleased]: https://github.com/sphinx-contrib/lua-ls/compare/v3.12.0...HEAD

{sphinx_lua_ls-3.11.0 → sphinx_lua_ls-3.12.0}/CONTRIBUTING.md

@@ -9,7 +9,8 @@ We use [`uv`] and [`poe`] to run tasks, but it is possible to use pure pip as we
 
 ### Using pip
 
-1. Create a virtual environment with python `3.12` or newer.
+1. Create a virtual environment with python `3.13` or newer
+   (some of dev tools don't work with older pythons).
 
 2. Make sure your pip is up to date:
 
@@ -61,10 +62,10 @@ We use [`uv`] and [`poe`] to run tasks, but it is possible to use pure pip as we
    uv tool install poethepoet
    ```
 
-5. If you're not on linux, install [EmmyLua Doc Cli].
+4. If you're not on linux, install [EmmyLua Doc Cli].
 
 
-## Run tests
+## Run commands
 
 We use `poe` for most of the tasks:
 
@@ -83,11 +84,11 @@ poe --help
 
 ## Build docs
 
-Just run `sphinx` as usual, nothing special is required:
+To build docs, just use `poe`:
 
 ```shell
-cd docs/
-make html
+poe doc  # Build HTML.
+poe doc-watch  # Run sphinx-autobuild.
 ```
 
 Sphinx-LuaLs will download the latest version of Lua Language Server for you.
@@ -95,7 +96,7 @@ Sphinx-LuaLs will download the latest version of Lua Language Server for you.
 
 ## Release
 
-1. Make sure that "Unreleased" section in `changelog.md` is up to date.
+1. Make sure that "Unreleased" section in `CHANGELOG.md` is up to date.
 
 2. Run `poe release major|minor|patch` to bump version in changelog
    and create a release tag.

{sphinx_lua_ls-3.11.0/sphinx_lua_ls.egg-info → sphinx_lua_ls-3.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sphinx-lua-ls
-Version: 3.11.0
+Version: 3.12.0
 Summary: Automatic documentation generation via EmmyLua/LuaLs
 Author-email: Tamika Nomara <taminomara@gmail.com>
 License-Expression: MIT
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Intended Audience :: Developers
 Classifier: Framework :: Sphinx
 Classifier: Framework :: Sphinx :: Domain

{sphinx_lua_ls-3.11.0 → sphinx_lua_ls-3.12.0}/docs/Makefile

@@ -3,18 +3,22 @@
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.
-SPHINXOPTS    ?= -j auto -n
+SPHINXOPTS    ?= -j 12 -n
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = source
 BUILDDIR      = build
+DOCTREEDIR    = build/doctrees
 
 # Put it first so that "make" without argument is like "make help".
 help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" -d "$(DOCTREEDIR)" $(SPHINXOPTS) $(O)
 
-.PHONY: help Makefile
+.PHONY: help watch Makefile
+
+watch:
+	sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)"/html -d "$(DOCTREEDIR)" --watch ../sphinx_lua_ls $(SPHINXOPTS) $(O)
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" -d "$(DOCTREEDIR)" $(SPHINXOPTS) $(O)

sphinx_lua_ls-3.12.0/poe_tasks.toml

@@ -0,0 +1,60 @@
+[executor]
+type = "uv"
+no-group = ["dev"]
+
+[tasks.lint]
+help = "Run pre-commit linters"
+cmd = "prek run --all-files"
+executor = { group = "lint" }
+
+[tasks.test]
+help = "Run tests"
+cmd = "tox -e 3.14,coverage-combine --"
+executor = { group = "ci" }
+
+[tasks.test-all]
+help = "Run tests for all pythons"
+cmd = "tox p --"
+executor = { group = "ci" }
+
+[tasks.cov-clear]
+help = "Erase coverage data (use this if you stop tests mid-flight)"
+cmd = "coverage erase"
+executor = { group = "test" }
+
+[tasks._cov-html]
+cmd = "coverage html -d htmlcov"
+executor = { group = "test" }
+
+[tasks._cov-html-serve]
+cmd = "python -m http.server -b localhost 8081"
+cwd = "htmlcov"
+
+[tasks.test-cov]
+help = "Run tests with coverage and serve HTML report on localhost:8081"
+sequence = ["test", "_cov-html", "_cov-html-serve"]
+
+[tasks.test-cov-all]
+help = "Run tests for all pythons with coverage and serve HTML report on localhost:8081"
+sequence = ["test-all", "_cov-html", "_cov-html-serve"]
+
+[tasks.ci]
+help = "For CI job"
+cmd = "tox --colored yes p --skip-env lint --"
+executor = { group = "ci" }
+
+[tasks.doc]
+help = "Build HTML docs"
+cmd = "sphinx-build -b html docs/source docs/build/html -d docs/build/doctrees -j 12 -n"
+executor = { group = "doc" }
+
+[tasks.doc-watch]
+help = "Start documentation server and rebuild HTML docs on every change"
+cmd = "sphinx-autobuild docs/source docs/build/html -d docs/build/doctrees --watch . -j 12 -n"
+executor = { group = "doc" }
+
+[tasks.release]
+help = "Bump version, create release commit and tag"
+cmd = "uvx --from cl-keeper clk bump --commit"
+use_exec = true
+executor = { type = "simple" }

{sphinx_lua_ls-3.11.0 → sphinx_lua_ls-3.12.0}/pyproject.toml

@@ -12,6 +12,7 @@ classifiers = [
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Intended Audience :: Developers",
     "Framework :: Sphinx",
     "Framework :: Sphinx :: Domain",
@@ -25,32 +26,35 @@ dependencies = ["sphinx>=8.0,<10.0", "PyGithub>=1.59,<3.0", "requests~=2.31"]
 
 [dependency-groups]
 dev = [
-    "pytest-cov==7.1.0",
-    { include-group = "test" },
-    { include-group = "lint" },
+    { include-group = "ci" },
     { include-group = "doc" },
-]
-lint = [
-    "cl-keeper==1.0.0",
-    "prek==0.3.8",
-    "ruff==0.15.8",
+    { include-group = "lint" },
+    { include-group = "test" },
 ]
 test = [
-    "pyright==1.1.408",
-    "pytest==9.0.2",
-    "sybil==10.0.1",
-    "pytest-regressions==2.10.0",
     "beautifulsoup4==4.14.3",
     "myst-parser==5.0.0",
-    "tox==4.34.1",
-    "tox-uv==1.29.0",
+    "pyright==1.1.409",
+    "pytest-cov==7.1.0",
+    "pytest-regressions==2.10.0",
+    "pytest==9.0.3",
+    "sybil==10.0.1",
 ]
 doc = [
-    "sybil==10.0.1",
     "furo==2025.12.19",
-    "sphinx_design==0.7.0",
     "myst-parser==5.0.0",
     "sphinx-autobuild==2025.8.25",
+    "sphinx_design==0.7.0",
+    "sybil==10.0.1",
+]
+lint = [
+    "prek==0.3.13",
+    "ruff==0.15.12",
+]
+ci = [
+    "pytest-cov==7.1.0",
+    "tox==4.53.1",
+    "tox-uv==1.35.2",
 ]
 
 [project.urls]
@@ -65,22 +69,19 @@ requires = ["setuptools>=60", "setuptools_scm[toml]>=8", "wheel>=0.40"]
 [tool.setuptools_scm]
 write_to = "sphinx_lua_ls/_version.py"
 
-[tool.pytest.ini_options]
-minversion = "7.0"
-addopts = ["--strict-markers", "-p no:doctest"]
-testpaths = ["test", "sphinx_lua_ls", "docs"]
-
 [tool.pyright]
 include = ["sphinx_lua_ls"]
-exclude = ["**/__pycache__"]
+exclude = [
+    "**/__pycache__",
+    "sphinx_lua_ls/_version.py",
+    "examples/docs/*",
+    "test/roots/*",
+    "mre-sphinx-lua/*",
+]
 typeCheckingMode = "strict"
-pythonVersion = "3.12"
+pythonVersion = "3.14"
 pythonPlatform = "All"
 
-# deprecateTypingAliases = true
-reportUnnecessaryTypeIgnoreComment = "warning"
-reportUnusedFunction = "none"
-reportPrivateUsage = "none"
 reportMissingParameterType = "none"
 reportUnknownParameterType = "none"
 reportUnknownVariableType = "none"
@@ -88,11 +89,16 @@ reportUnknownMemberType = "none"
 reportUnknownArgumentType = "none"
 reportUnknownLambdaType = "none"
 reportUnnecessaryIsInstance = "none"
+reportUnnecessaryTypeIgnoreComment = "warning"
+reportPrivateUsage = "none"
+reportUnusedFunction = "none"
 reportConstantRedefinition = "none"
 reportRedeclaration = "none"
+reportDeprecated = "none"
+deprecateTypingAliases = true
 
 [tool.ruff]
-exclude = ["examples/docs/*", "test/roots/*"]
+exclude = ["examples/docs/*", "test/roots/*", "mre-sphinx-lua/*"]
 target-version = "py312"
 
 [tool.ruff.lint]
@@ -131,3 +137,6 @@ required-imports = ["from __future__ import annotations"]
 
 [tool.ruff.format]
 docstring-code-format = true
+
+[tool.uv]
+default-groups = ["dev"]

sphinx_lua_ls-3.12.0/pytest.toml

@@ -0,0 +1,4 @@
+[pytest]
+minversion = "9.0"
+addopts = ["--strict-markers", "-p no:doctest"]
+testpaths = ["test", "sphinx_lua_ls", "docs"]

{sphinx_lua_ls-3.11.0 → sphinx_lua_ls-3.12.0}/sphinx_lua_ls/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '3.11.0'
-__version_tuple__ = version_tuple = (3, 11, 0)
+__version__ = version = '3.12.0'
+__version_tuple__ = version_tuple = (3, 12, 0)
 
-__commit_id__ = commit_id = 'gf59390e32'
+__commit_id__ = commit_id = 'g68304bf62'

{sphinx_lua_ls-3.11.0 → sphinx_lua_ls-3.12.0/sphinx_lua_ls.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sphinx-lua-ls
-Version: 3.11.0
+Version: 3.12.0
 Summary: Automatic documentation generation via EmmyLua/LuaLs
 Author-email: Tamika Nomara <taminomara@gmail.com>
 License-Expression: MIT
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Intended Audience :: Developers
 Classifier: Framework :: Sphinx
 Classifier: Framework :: Sphinx :: Domain

{sphinx_lua_ls-3.11.0 → sphinx_lua_ls-3.12.0}/sphinx_lua_ls.egg-info/SOURCES.txt

@@ -1,4 +1,5 @@
 .cl-keeper.yaml
+.coveragerc.toml
 .gitignore
 .pre-commit-config.yaml
 .readthedocs.yaml
@@ -9,6 +10,7 @@ README.md
 conftest.py
 poe_tasks.toml
 pyproject.toml
+pytest.toml
 tox.toml
 uv.lock
 .github/dependabot.yml
@@ -29,7 +31,6 @@ docs/source/troubleshooring.rst
 docs/source/_extra/robots.txt
 docs/source/example/.emmyrc.json
 docs/source/example/logging.lua
-scripts/resolve_venv.sh
 sphinx_lua_ls/__init__.py
 sphinx_lua_ls/_version.py
 sphinx_lua_ls/apidoc.py

{sphinx_lua_ls-3.11.0 → sphinx_lua_ls-3.12.0}/tox.toml

@@ -5,6 +5,8 @@ env_list = [
     "3.12",
     "type",
     "lint",
+    "coverage-clean",
+    "coverage-combine",
 ]
 depends = []
 
@@ -19,12 +21,16 @@ commands = [
         "--no-sync",
         "pytest",
         "--color=yes",
+        "--cov",
+        "--cov-append",
         { replace = "posargs", default = [
         ], extend = true },
     ],
 ]
 pass_env = ["PYTEST*", "COVERAGE*", "LUA_LS_CACHE_PATH"]
+depends = ["coverage-clean"]
 package = "uv"
+set_env = { COVERAGE_FILE = "{env:COVERAGE_FILE:.coverage}.{envname}" }
 
 [env.type]
 description = "Run type check"
@@ -38,3 +44,19 @@ dependency_groups = ["lint"]
 skip_install = true
 commands = [["prek", "run", "--all-files", "--color=always"]]
 depends = []
+
+[env.coverage-clean]
+description = "Delete coverage data"
+dependency_groups = ["test"]
+skip_install = true
+commands = [["coverage", "erase"]]
+depends = []
+set_env = { COVERAGE_FILE = "{env:COVERAGE_FILE:.coverage}" }
+
+[env.coverage-combine]
+description = "Combine coverage data"
+dependency_groups = ["test"]
+skip_install = true
+commands = [["coverage", "combine"]]
+depends = ["3.14", "3.13", "3.12"]
+set_env = { COVERAGE_FILE = "{env:COVERAGE_FILE:.coverage}" }