pikers
/
piker
4
1
Fork 0
Code Issues 19 Pull Requests 14 Packages Projects Releases Wiki Activity

claudy_writes_ruff_conf: a skill for linting to our (my) "wonky code style" #88

Open
goodboy wants to merge 3 commits from claudy_writes_ruff_conf into main
pull from: claudy_writes_ruff_conf
merge into: pikers:main
Conversation 0 Commits 3 Files Changed 3

3 Commits (main)

Author SHA1 Message Date
Gud Boi e5a91faac7 Add `/lint` skill with `scripts/check.py` 
Add a user-invocable `/lint` skill that wraps
`ruff check` with staged-file defaults and piker's
`ruff.toml` config via a PEP 723 script.

The `ruff.toml` (from prior commit) now enforces
piker's `'''` multiline docstring convention with
`D2xx` formatting rules: summary on second line
(D213), closing quotes on separate line (D209), blank
line between summary and description (D205), plus
`W` trailing-whitespace and cherry-picked `D4xx`
content checks.

Deats,
- `scripts/check.py`: pure-stdlib wrapper that
  defaults to staged `.py` files via
  `git diff --cached`, with `--all`, `--fix`,
  `--diff`, and `--stats` flags.
- calls `ruff` from `$PATH` (works with nixpkgs,
  nvim-bundled, or pip-installed).
- prints clear install guidance if `ruff` not found.
- `SKILL.md`: documents usage, common violations
  (D213, D205, D204), and fix patterns for
  converting to piker's docstring style.

(this patch was generated in some part by [`claude-code`][claude-code-gh])
[claude-code-gh]: https://github.com/anthropics/claude-code
 2026-03-11 21:04:19 -04:00
Gud Boi cec6d19156 Add pydocstyle and `W` rules to `ruff.toml` 
Enable `D2xx` formatting rules to enforce piker's `'''`
multiline docstring convention: summary on second line
(D213), closing quotes on separate line (D209), blank
line between summary and description (D205).

Deats,
- select `D2` (whitespace/formatting) rule group plus
  cherry-picked `D402`/`D403`/`D419` content checks.
- ignore `D200` (allow multiline for short docstrings),
  `D203` (use `D211` instead), `D212` (use `D213`).
- skip `D1xx` (missing-docstring) to avoid noise and
  `D3xx` since `D300` conflicts with `'''` convention.
- add `W` rules for trailing-whitespace detection.

Also,
- enable `docstring-code-format` with 67-char width
  for code examples inside docstrings.

(this patch was generated in some part by [`claude-code`][claude-code-gh])
[claude-code-gh]: https://github.com/anthropics/claude-code
 2026-03-11 21:04:19 -04:00
Gud Boi e0a46fbb93 WIP get him to write a ruff conf to match our code 2026-03-11 21:04:19 -04:00