Skip to main content

Maximally-strict ruff + pyright + ESLint configs for sarj-ai Python/TypeScript projects.

Project description

sarj-lint-configs

Ships the maximally-strict ruff / pyright / ESLint configs from sarj-ai/standards as a pip-installable package.

uv add --dev sarj-lint-configs
uv run sarj-lint-configs sync --only ruff      # writes .ruff-strict.toml
uv run sarj-lint-configs sync --only pyright   # writes .pyright-strict.json
uv run sarj-lint-configs sync --only eslint    # writes eslint.strict.mjs
uv run sarj-lint-configs check .                # runs every Python/SQL/IaC custom registry

Polyglot repositories can route the Python and TypeScript configs to their respective tool roots in one canonical sync:

uv run sarj-lint-configs sync \
  --python-dest python \
  --typescript-dest typescript \
  --force

Use the same command with --check in CI or a Git hook to detect drift without writing to the worktree.

The check command discovers every rule from the exact registry versions installed with this package: sarj-python-lint==0.26.0, sarj-sql-lint==0.5.0, and sarj-iac-lint==0.3.0. Files and recursively discovered directory contents are routed to the applicable registry by suffix. The command is deliberately zero-tolerance: it does not accept suppression baselines that a change could inflate to conceal new findings.

For commit-time feedback, pin Lefthook and install the hook during setup:

uv add --dev lefthook==2.1.10 sarj-lint-configs==0.10.0
uv run lefthook install
# lefthook.yml
min_version: 2.1.10
assert_lefthook_installed: true
pre-commit:
  jobs:
    - name: strict config drift
      run: uv run --frozen sarj-lint-configs sync --check
      fail_text: "Strict configs drifted. Re-run sync --force, stage the result, and retry."
    - name: sarj standards
      run: uv run --frozen sarj-lint-configs check -- {staged_files}
      fail_text: "Standards checks failed. Fix the issue, stage the result, and retry."

Do not copy the runner into consumer repositories. Keeping it inside the wheel ensures the CLI implementation and its exact registry dependencies upgrade as one tested unit.

Peer version floors for the bundled ESLint config

Peer Floor Why
@sarj/eslint-plugin 3.0.0 Contains every custom TypeScript rule referenced by the config.
eslint-plugin-unicorn >= 72 Hard floor since 0.16.0. The config enables 199 unicorn rules; 121 of them do not exist in unicorn 64 and 96 do not exist in 65.
eslint >= 10.4 Transitive: it is eslint-plugin-unicorn@72's own peer floor.

@sarj/eslint-plugin@3.0.0 is a breaking release: it removes no-unsafe-cast, prefer-shadcn, no-sequential-await, require-schema-validate-search and single-public-export. An eslint-disable naming any of them reports "Definition for rule was not found" until the comment is dropped. Do not pin below 2.17.0 — the config references @sarj/prefer-zod-enum, which does not exist in 2.16.0.

The unicorn floor used to be advisory: the config ran 12 unicorn rules, all of which exist as far back as 64, and the only thing needing a newer plugin was the checkDirectories option that unicorn/filename-case deliberately does not pass. Since 0.16.0 the floor is real and load-bearing.

Upgrading is not optional and it is not silent. eslint.strict.mjs re-derives the rule names it needs from its own rule objects and throws at config load with the count and the first few missing names if the installed plugin is too old, rather than emitting "Definition for rule ... was not found" once per rule per file. One first-party consumer is pinned to an exact 64.0.0 and must move to >= 72 (and therefore eslint >= 10.4) before taking 0.16.0; the others are already on 72.

Then reference the synced file:

# pyproject.toml
[tool.ruff]
extend = ".ruff-strict.toml"
// pyrightconfig.json
{ "extends": ".pyright-strict.json" }
// eslint.config.mjs
import strict from "./eslint.strict.mjs";
export default [...strict];

Re-run sync with --force after upgrading. Programmatic access via from sarj_lint_configs import RUFF_STRICT, PYRIGHT_STRICT, ESLINT_STRICT (returns pathlib.Path into the wheel).

0.8.0 — PLC2701 moved out of ruff

PLC2701 import-private-name is now in the ignore list. It cannot tell a private name of ours from a private name of a dependency's: its exemption is "same top-level package", so from livekit.agents.inference_runner import _InferenceRunner — an API livekit made private in 1.6.6, with no public replacement — is flagged identically to a first-party helper someone forgot to export. Ruff has no configuration surface that separates them.

The check is replaced by SARJ048 in sarj-python-lint ≥ 0.19.0, which resolves the imported module against your project tree and fires only on first-party modules:

- repo: https://github.com/sarj-ai/standards
  rev: python-v0.19.0
  hooks:
    - id: sarj-no-first-party-private-import

If you are not running the sarj-python-lint hooks, re-enable PLC2701 in your own [tool.ruff.lint] extend-select — an over-firing check beats no check.

Attribute access (session._stt) is unchanged: ruff's SLF001 and pyright's reportPrivateUsage both still fire, and neither can make the first/third-party distinction. Both configs carry the rationale and the escape hatches inline.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sarj_lint_configs-0.17.0.tar.gz (32.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sarj_lint_configs-0.17.0-py3-none-any.whl (36.4 kB view details)

Uploaded Python 3

File details

Details for the file sarj_lint_configs-0.17.0.tar.gz.

File metadata

  • Download URL: sarj_lint_configs-0.17.0.tar.gz
  • Upload date:
  • Size: 32.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.0 {"installer":{"name":"uv","version":"0.12.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for sarj_lint_configs-0.17.0.tar.gz
Algorithm Hash digest
SHA256 59b3bc4604d526ab8c2f31df02c16863cca54843ec7cd0837427f33b8793d907
MD5 53326a46bf5f27eb9247511f6947657e
BLAKE2b-256 e3d2f4020880c3497aae20e3c0fba5c5e8c7023585a790f86f0de5946d5e03ef

See more details on using hashes here.

File details

Details for the file sarj_lint_configs-0.17.0-py3-none-any.whl.

File metadata

  • Download URL: sarj_lint_configs-0.17.0-py3-none-any.whl
  • Upload date:
  • Size: 36.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.0 {"installer":{"name":"uv","version":"0.12.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for sarj_lint_configs-0.17.0-py3-none-any.whl
Algorithm Hash digest
SHA256 79a3c556aa36f848fd226b049886d94f546af397ee682335ea19ebbd40a43548
MD5 ad0847633579fdb2f0e3415b31afe2be
BLAKE2b-256 71e8c466e0fda279172aea795591ef6c948ba038491d9b6f357aa281c86e6a7f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page