livery-extensions-ruff 0.1.0__tar.gz

livery_extensions_ruff-0.1.0/LICENSE

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

livery_extensions_ruff-0.1.0/PKG-INFO

@@ -0,0 +1,27 @@
+Metadata-Version: 2.4
+Name: livery-extensions-ruff
+Version: 0.1.0
+Summary: Ruff as a check of the livery workshop: the formatter and the linter, configured by the root ruff.toml.
+Author: Willem Kokke
+Author-email: Willem Kokke <mail@willem.net>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Typing :: Typed
+Requires-Dist: livery-toolroom>=0.11.0
+Requires-Dist: livery-workshop>=0.7.0
+Requires-Python: >=3.11
+Project-URL: Repository, https://github.com/willemkokke/livery
+Description-Content-Type: text/markdown
+
+<!-- Seeded from the package-python seeds at
+     birth; this file is the workspace's own. Edit it directly:
+     nothing rewrites it.
+-->
+# livery-extensions-ruff
+
+Ruff as a check of the livery workshop. Listed as `ruff` in a workspace's
+`[workspace] extensions`, it registers `format.ruff` and `lint.ruff` and
+writes the root `ruff.toml` both read.

livery_extensions_ruff-0.1.0/README.md

@@ -0,0 +1,9 @@
+<!-- Seeded from the package-python seeds at
+     birth; this file is the workspace's own. Edit it directly:
+     nothing rewrites it.
+-->
+# livery-extensions-ruff
+
+Ruff as a check of the livery workshop. Listed as `ruff` in a workspace's
+`[workspace] extensions`, it registers `format.ruff` and `lint.ruff` and
+writes the root `ruff.toml` both read.

livery_extensions_ruff-0.1.0/pyproject.toml

@@ -0,0 +1,36 @@
+[build-system]
+requires = ["uv_build>=0.11,<0.13"]
+build-backend = "uv_build"
+
+[project]
+name = "livery-extensions-ruff"
+version = "0.1.0"
+description = "Ruff as a check of the livery workshop: the formatter and the linter, configured by the root ruff.toml."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.11"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Typing :: Typed",
+]
+dependencies = [
+    "livery-toolroom>=0.11.0",
+    "livery-workshop>=0.7.0",
+]
+
+[[project.authors]]
+name = "Willem Kokke"
+email = "mail@willem.net"
+
+[project.urls]
+Repository = "https://github.com/willemkokke/livery"
+
+[project.entry-points."workshop.extensions"]
+ruff = "livery.extensions.ruff"
+
+[tool.uv.build-backend]
+module-name = "livery.extensions.ruff"
+namespace = true

livery_extensions_ruff-0.1.0/pyproject.toml.orig

@@ -0,0 +1,42 @@
+# Seeded from the package-python seeds at
+# birth; this file is the workspace's own. Edit it directly:
+# nothing rewrites it.
+[build-system]
+requires = ["uv_build>=0.11,<0.13"]
+build-backend = "uv_build"
+
+[project]
+name = "livery-extensions-ruff"
+version = "0.1.0"
+description = "Ruff as a check of the livery workshop: the formatter and the linter, configured by the root ruff.toml."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.11"
+authors = [{ name = "Willem Kokke", email = "mail@willem.net" }]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Typing :: Typed",
+]
+dependencies = [
+    "livery-toolroom>=0.11.0",
+    "livery-workshop>=0.7.0",
+]
+
+[project.urls]
+Repository = "https://github.com/willemkokke/livery"
+
+# The name a workspace lists in [workspace] extensions, and the package
+# whose extension.toml the workshop mounts it from. Nothing else: the
+# extension adds no verb of its own, and nothing activates by being
+# installed.
+[project.entry-points."workshop.extensions"]
+ruff = "livery.extensions.ruff"
+
+[tool.uv.build-backend]
+# PEP 420 namespace: the importable package is livery.extensions.ruff and
+# there is no livery/__init__.py anywhere in this repository.
+module-name = "livery.extensions.ruff"
+namespace = true

livery_extensions_ruff-0.1.0/src/livery/extensions/ruff/_docs/index.md

@@ -0,0 +1,51 @@
+<!-- Seeded from the package-base seeds at
+     birth; this file is the workspace's own. Edit it directly:
+     nothing rewrites it.
+-->
+# livery-extensions-ruff
+
+Ruff as a check of the workshop: `format.ruff` formats the python files a
+run reaches and `lint.ruff` lints them. A workspace turns them on by
+listing the extension:
+
+```toml
+[workspace]
+extensions = ["ruff"]
+```
+
+`fm format` and `fm lint` then run them, and `fm check` runs them with the
+rest of the gate: the formatter, then the linter, after the workshop's own
+rewriters and before every judge. Each reads the python files its claims
+reach: a python package's sources, tests and test support, its
+configuration, and a native package's `conanfile.py`. An example file is
+judged for its names alone, and a test needs no docstrings.
+`fm lint.ruff -- --statistics` hands `ruff check` the words after `--`, and
+`fm format.ruff -- --diff` hands them to `ruff format`.
+
+## The configuration
+
+`fm sync` writes the root `ruff.toml`, and a bare `ruff` in the repository
+reads the same file the checks do. It sets the line length, the python
+version the workspace supports, the rules, and the per-file ignores the
+checks' claims render. Ruff's cache is `.workshop/.cache/ruff/`.
+
+The file is the extension's: an edit outside its region is drift, which
+`fm check --fix` puts back. The repository's own settings go inside the
+region, as whole tables or through a key's `extend-` spelling:
+
+```toml
+# -- workshop: region tables, yours to edit; the render keeps it --
+[lint.extend-per-file-ignores]
+"**/generated.py" = ["E501"]
+# -- workshop: end tables --
+```
+
+A package that needs settings of its own carries a `ruff.toml` that
+extends the root's, with `extend = "../../ruff.toml"`, one `../` per
+directory level.
+
+## Fixing
+
+`fm check --fix` and `fm format --fix` rewrite what ruff can rewrite.
+`--safe-fix` removes no code: it applies every fix except deleting an
+unused import, which an edit in flight adds before the code that uses it.

livery_extensions_ruff-0.1.0/src/livery/extensions/ruff/_docs/nav.toml

@@ -0,0 +1,12 @@
+# This package's section of the workspace site, hand-authored.
+# Labels map to pages relative to this docs/ tree, or to nested
+# lists. Every authored page must appear here, and every entry must
+# name a real page. A generator owns a block between `# nav:begin
+# <name>` and `# nav:end <name>` markers (tasks, tools); the emitter's
+# own sections, changelog, coverage and api, are blocks too: place a
+# pair where one belongs, and a section without one lands after the
+# authored entries, changelog and coverage ahead of the tasks block,
+# api last.
+nav = [
+    { "Index" = "index.md" },
+]

livery_extensions_ruff-0.1.0/src/livery/extensions/ruff/content/root/ruff.toml.jinja

@@ -0,0 +1,34 @@
+# Written by `{{ prog }} sync` from the ruff extension; the gate keeps
+# it matching. Edit inside the region below, which is the repository's
+# own; an edit anywhere else is drift.
+line-length = 88
+target-version = "py{{ python_floor | replace('.', '') }}"
+src = [{% for package in py %}"packages/{{ package.dir }}/src", "packages/{{ package.dir }}/tests", {% endfor %}{% for path in root_tests %}"{{ path }}"{% if not loop.last %}, {% endif %}{% endfor %}]
+# The cache lives with the workshop's state, never in the root.
+cache-dir = ".workshop/.cache/ruff"
+
+[format]
+# A markdown page is prose: a python fence may hold a snippet directive
+# or code shown as it is, and a documentation example file keeps the
+# layout its page shows, so the formatter leaves both alone.
+exclude = ["*.md", "packages/**/docs/examples/**", "docs/examples/**"]
+
+[lint]
+select = ["E", "F", "I", "UP", "B", "SIM", "C4", "RUF", "D"]
+
+[lint.pydocstyle]
+convention = "google"
+
+[lint.per-file-ignores]
+# The claims: each line is a category's patterns for a present kind,
+# with the rules a check withholds there.
+{% for pattern, codes in per_file_ignores %}"{{ pattern }}" = [{% for code in codes %}"{{ code }}"{% if not loop.last %}, {% endif %}{% endfor %}]
+{% endfor %}# The composed tasks.py opens with the header the fragment engine
+# writes, whose lines it does not wrap.
+"tasks.py" = ["E501"]
+
+# The repository's own tables: a whole table of its own, or a key the
+# render writes through its `extend-` spelling, as
+# `[lint.extend-per-file-ignores]`.
+# -- workshop: region tables, yours to edit; the render keeps it --
+# -- workshop: end tables --

livery_extensions_ruff-0.1.0/src/livery/extensions/ruff/extension.toml

@@ -0,0 +1,59 @@
+# The ruff extension: the formatter, then the linter, over the python
+# files they claim. Both checks are ruff's words: the workshop selects
+# the paths a run reaches, appends the words after -- on the check's
+# verb and then the paths, and ruff's exit code is the verdict. A file
+# named to ruff follows the configured excludes under --force-exclude,
+# as a file ruff finds itself does.
+
+[extension]
+api-version = 1
+# Listed in the workspace's list alone: one configuration for every member.
+levels = ["workspace"]
+
+# The kinds whose python files ruff judges are a python package's, and a
+# native package's conanfile.py beside clang-format over its sources.
+[checks.ruff.format]
+judge = ["ruff", "format", "--check", "--force-exclude"]
+# Formatting removes no code, so --safe-fix rewrites as --fix does.
+fix = ["ruff", "format", "--force-exclude"]
+narrowing = "paths"
+kinds = ["python", "cpp-conan"]
+tools = ["ruff"]
+arguments = true
+editor-extension = "charliermarsh.ruff"
+claims = [
+    { category = "source", suffixes = [".py", ".pyi"] },
+    { category = "test", suffixes = [".py", ".pyi"] },
+    { category = "test-support", suffixes = [".py", ".pyi"] },
+    { category = "configuration", suffixes = [".py", ".pyi"] },
+]
+
+# The editor formats python with ruff, as the gate does.
+[checks.ruff.format.fragments]
+".vscode/settings.json" = '''
+{"[python]": {"editor.defaultFormatter": "charliermarsh.ruff"}}
+'''
+
+# Test bodies explain themselves by name and assertion, so the docstring
+# rules stop at the tests. An example keeps the layout its page shows:
+# ruff judges its names, and nothing of its style.
+[checks.ruff.lint]
+judge = ["ruff", "check", "--force-exclude"]
+fix = ["ruff", "check", "--fix", "--force-exclude"]
+# --safe-fix withholds the rule that deletes code an edit in flight has
+# not finished writing: an import added before the code that uses it.
+safe-fix = ["ruff", "check", "--fix", "--unfixable=F401", "--force-exclude"]
+narrowing = "paths"
+kinds = ["python", "cpp-conan"]
+tools = ["ruff"]
+arguments = true
+editor-extension = "charliermarsh.ruff"
+claims = [
+    { category = "source", suffixes = [".py", ".pyi"] },
+    { category = "test", ignore = ["D1"], suffixes = [".py", ".pyi"] },
+    { category = "example", suffixes = [".py", ".pyi"], ignore = [
+        "D", "E", "I", "UP", "B", "SIM", "C4", "RUF", "F401", "F811", "F841",
+    ] },
+    { category = "test-support", ignore = ["D1"], suffixes = [".py", ".pyi"] },
+    { category = "configuration", suffixes = [".py", ".pyi"] },
+]