@owenlamont/ryl 0.4.1 → 0.4.3

package/.github/workflows/update_linters.yml

@@ -1,56 +0,0 @@
-name: Update Linters
-on:
-  schedule:
-    - cron: '30 8 * * 6'  # Saturday 18:00 UTC+9:30
-  workflow_dispatch:
-
-jobs:
-  refresh-pre-commit-config:
-    runs-on: ubuntu-latest
-    environment: automation
-    permissions:
-      contents: write
-      pull-requests: write
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78
-
-      - name: Install prek
-        run: uv tool install prek --force
-
-      - name: Run prek autoupdate
-        run: prek autoupdate
-
-      - name: Check for changes in .pre-commit-config.yaml
-        id: check_diff
-        run: |
-          if git diff --quiet .pre-commit-config.yaml; then
-            echo "changed=false" >> $GITHUB_OUTPUT
-          else
-            echo "changed=true" >> $GITHUB_OUTPUT
-          fi
-
-      - name: Generate token
-        if: steps.check_diff.outputs.changed == 'true'
-        uses: actions/create-github-app-token@f8d387b68d61c58ab83c6c016672934102569859
-        id: generate-token
-        with:
-          app-id: ${{ secrets.AUTH_APP_CLIENT_ID }}
-          private-key: ${{ secrets.AUTH_APP_PRIVATE_KEY }}
-
-      - name: Create PR with updated .pre-commit-config.yaml
-        if: steps.check_diff.outputs.changed == 'true'
-        uses: peter-evans/create-pull-request@c0f553fe549906ede9cf27b5156039d195d2ece0
-        with:
-          token: ${{ steps.generate-token.outputs.token }}
-          commit-message: "chore: refresh .pre-commit-config.yaml"
-          title: "chore: refresh .pre-commit-config.yaml"
-          body: |
-            This PR updates `.pre-commit-config.yaml` by running `prek autoupdate`.
-            It was triggered automatically (or manually) to keep linters up-to-date.
-          branch: bot/pre-commit-config-refresh
-          author: GitHub Actions <actions@github.com>
-          delete-branch: true

package/.pre-commit-config.yaml

@@ -1,87 +0,0 @@
-# See https://pre-commit.com for more information
-# See https://pre-commit.com/hooks.html for more hooks
-repos:
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v6.0.0
-    hooks:
-      - id: trailing-whitespace
-      - id: end-of-file-fixer
-      - id: check-case-conflict
-      - id: destroyed-symlinks
-      - id: check-illegal-windows-names
-      - id: check-merge-conflict
-      - id: check-symlinks
-      - id: check-toml
-      - id: check-xml
-      - id: check-yaml
-      - id: check-added-large-files
-      - id: check-merge-conflict
-      - id: no-commit-to-branch
-      - id: pretty-format-json
-        args: [--autofix]
-      - id: mixed-line-ending
-        args: [--fix=lf]
-  - repo: https://github.com/shellcheck-py/shellcheck-py
-    rev: v0.11.0.1
-    hooks:
-      - id: shellcheck
-        args: [--severity=style]
-        files: ^scripts/.*\.sh$
-  - repo: local
-    hooks:
-      - id: cargo-check
-        name: cargo check
-        entry: cargo check --workspace
-        language: system
-        types: [rust]
-        pass_filenames: false
-      - id: cargo-fmt
-        name: cargo fmt
-        entry: cargo fmt --
-        language: system
-        types: [rust]
-        pass_filenames: false
-      - id: clippy-fix
-        name: cargo clippy --fix
-        entry: cargo clippy --fix --allow-dirty --allow-staged
-        language: system
-        types: [rust]
-        pass_filenames: false
-        require_serial: true
-      - id: clippy-enforce
-        name: cargo clippy (enforce warnings)
-        entry: cargo clippy --all-targets --all-features -- -D warnings
-        language: system
-        types: [rust]
-        pass_filenames: false
-        require_serial: true
-  - repo: https://github.com/rvben/rumdl-pre-commit
-    rev: v0.1.62
-    hooks:
-      - id: rumdl
-        args: [--fix]
-  - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.15.8
-    hooks:
-      - id: ruff-check
-        args: [--fix, --exit-non-zero-on-fix, --show-fixes]
-        types_or: [python, pyi, jupyter]
-      - id: ruff-format
-        types_or: [python, pyi, jupyter]
-  - repo: https://github.com/owenlamont/ryl-pre-commit
-    rev: v0.4.1
-    hooks:
-      - id: ryl
-  - repo: https://github.com/adhtruong/mirrors-typos
-    rev: v1.44.0
-    hooks:
-      - id: typos
-        args: [
-          --force-exclude,
-          # --write-changes (Don't use this to stop typos making auto-corrections)
-        ]
-  - repo: https://github.com/woodruffw/zizmor-pre-commit
-    rev: v1.23.1
-    hooks:
-    - id: zizmor
-      args: [ --min-severity, low, --min-confidence, medium, --fix=safe]

package/.yamllint

@@ -1,4 +0,0 @@
-extends: relaxed
-
-rules:
-  line-length: disable

package/AGENTS.md

@@ -1,200 +0,0 @@
-# Coding Agent Instructions
-
-Guidance on how to navigate and modify this codebase.
-
-## What This Tool Does
-
-ryl is a CLI tool for linting yaml files
-
-## Project Structure
-
-- **/src/** – All application code lives here.
-- **/tests/** – Unit and integration tests.
-- **pyproject.toml** - Package configuration
-- **.pre-commit-config.yaml** - Prek managed linters and some configuration
-
-## Coding Standards
-
-- Code maintainability is the top priority - ideally a new agent can be onboarded onto
-  using this repo and able to get all the necessary context from the documentation and
-  code with no surprising behaviour or pitfalls (this is the pit of success principle -
-  the most likely way to do something is also the correct way).
-- In relation to maintainability / readability keep the code as succinct as practical.
-  Every line of code has a maintenance and read time cost (so try to keep code readable
-  with good naming of files, functions, structures, and variable instead of using
-  comments). Remember every new conditional added has a significant testing burden as it
-  will likely require a new test to be added and maintained. We want to keep code bloat
-  to a minimum and the best refactors generally are those that remove lines of code
-  while maintaining functionality.
-- Comments should only be used to explain unavoidable code smells (arising from third
-  party crate use), or the reason for temporary dependency version pinning (e.g.
-  linking an unresolved GitHub issues) or lastly explaining opaque code or non-obvious
-  trade-offs or workarounds.
-- Leverage the provided linters and formatters to fix code, configuration, and
-  documentation often - it's much cheaper to have the linters and formatters auto fix
-  issues than correcting them yourself. Only correct what the linters and formatters
-  can't automatically fix.
-- No unsafe Rust code. Do not introduce `unsafe` in application code or tests. If a
-  change appears to require `unsafe`, propose an alternative design that keeps code
-  safe. The crate is built with `#![forbid(unsafe_code)]` and tests should follow the
-  same principle.
-- Remember the linter/formatter prek won't scan any new modules until they are added to
-  git so don't forget to git add any new modules you create before running prek.
-- Use the most modern Rust idioms and syntax allowed by the Rust version (currently this
-  is Rust 1.93.1).
-- Keep `clippy.toml` `msrv` in sync with `rust-toolchain.toml` whenever the Rust
-  toolchain channel is changed.
-- Don't rely on your memory of libraries and APIs. All external dependencies evolve fast
-  so ensure current documentation and/or repo is consulted when working with third party
-  dependencies.
-- When mirroring yamllint behaviour, spot-check tricky inputs with the yamllint CLI so
-  our diagnostics and message text match (e.g., mixed newline styles or config keys of
-  type int/bool/null/tagged scalar).
-
-## Code Change Requirements
-
-- Whenever any files are edited ensure all prek linters pass (run:
-  `prek run --all-files`).
-- `prek` already runs the key tooling (e.g., trim/fix whitespace, `cargo fmt`,
-  `cargo clippy --fix`, `cargo clippy`, `rumdl` for Markdown/docs, etc.), so skip
-  invoking those individually—just run `prek` once after code *or* docs updates.
-- Whenever source files are edited ensure the full test suite passes (run
-  `./scripts/coverage-missing.sh` (Unix) or
-  `pwsh ./scripts/coverage-missing.ps1` (Windows) to regenerate coverage; it reports
-  uncovered ranges and confirms when coverage is complete)
-- For any behaviour or feature changes ensure all documentation is updated
-  appropriately.
-
-## Development Environment / Terminal
-
-- This repo runs on Mac, Linux, and Windows. Don't make assumptions about the shell
-  you're running on without checking first (it could be a Posix shell like Bash or
-  Windows Powershell).
-- `prek`, `rg`, `rumdl`, `typos`, `yamllint`, and `zizmor` should be installed as global
-  tools (if they don't appear to be installed raise that with the user).
-- `gh` will be available in most, but not all environments to inspect GitHub.
-- When reviewing PR feedback, prefer `gh pr view <number> --json comments,reviews` for
-  summary threads and `gh api repos/<owner>/<repo>/pulls/<number>/comments` when you
-  need inline review details without guesswork. Avoid flags that the GitHub CLI does not
-  support (e.g., `--review-comments`).
-- Linters and tests may write outside the workspace (e.g., `~/.cache/prek`). If
-  sandboxed, request permission escalation when running `prek`, `cargo test`,
-  or coverage commands.
-- Allow at least a 1-minute timeout per linter/test invocation; increase as
-  needed for larger runs or CI.
-
-## Automated Tests
-
-- Don't use comments in tests, use meaningful function names, and variable names to
-  convey the test purpose.
-- Every line of code has a maintenance cost, so don't add tests that don't meaningfully
-  increase code coverage. Aim for full branch coverage but also minimise the tests code
-  lines to src code lines ratio.
-- Do not add `#[cfg(test)]` test modules directly inside files under `src/`. Unit tests
-  compiled alongside the library create duplicate LLVM coverage instantiations and break
-  the "zero missed regions" guarantee enforced by CI. Add new coverage via CLI/system
-  tests in `tests/` instead.
-
-## Coverage Workflow
-
-The CI enforces zero missed lines and zero missed regions. Use this workflow instead of
-hunting through scattered tips:
-
-1. Quick status before pushing: run `./scripts/coverage-missing.sh` (Unix) or
-   `pwsh ./scripts/coverage-missing.ps1` (Windows). It reruns the coverage suite and
-   prints any uncovered ranges, or explicitly confirms when coverage is complete.
-2. If the script reports files, extend CLI/system tests targeting those ranges until
-   the script produces no output.
-3. For richer artifacts (HTML, LCOV, etc.), follow the cargo-llvm-cov documentation
-   after running the script. HTML is not easily machine readable though so not
-   recommended.
-4. When coverage points to tricky regions, prefer CLI/system tests in `tests/`
-   that drive `env!("CARGO_BIN_EXE_ryl")` so you exercise the same paths as users.
-5. When you need to observe the exact flow through an uncovered branch, run the
-   failing test under `rust-lldb` (ships with the toolchain). Start with
-   `cargo test --no-run` and then
-   `rust-lldb target/debug/deps/<test-binary> -- <filter args>` to set breakpoints
-   on the problematic lines.
-6. If cached coverage lingers, clear `target/llvm-cov-target` and rerun.
-
-### Coverage-Friendly Rust Idioms
-
-- Guard invariants with `expect` (or an early `return Err(...)`) when the
-  “else” branch is truly unreachable. Leaving a `return` in the unreachable path
-  often shows up as a permanent uncovered region even though the condition is
-  ruled out. Reserve `assert!` for test-only code or cases where a runtime panic
-  is acceptable.
-- When walking indices backwards, call `checked_sub(1).expect("…")` instead of
-  matching on `checked_sub`; the `expect` documents the invariant and removes
-  the uncovered `None` branch that instrumentation reports.
-- When collecting spans, store the raw tuple `(start, end)` and filter once at
-  the end instead of pushing `Range` conditionally; this keeps the guard logic
-  centralized and ensures LLVM records the conversion branch exactly once.
-- Normalize prefix checks with `strip_prefix(...).expect(...)` when downstream
-  code already guarantees the prefix; this removes the otherwise uncovered
-  `return` path that instrumentation would highlight.
-
-Windows/MSVC: ensure the `llvm-tools-preview` component is installed (already listed in
-`rust-toolchain.toml`). Run from a Developer Command Prompt if linker tools go missing.
-
-### Common hotspots
-
-- Configuration discovery: use the `Env` abstraction (`discover_config_with`) and fake
-  envs to hit inline data, explicit files (success and YAML failure), and env-var paths.
-- Project configuration search: cover empty inputs, single files without parents, and
-  multiple files in the same directory to trigger dedup logic.
-- YAML parsing: drive `from_yaml_str` through string vs sequence options and ensure rule
-  merges hit both update and insert branches.
-- CLI context resolution: pass an empty `PathBuf` into `resolve_ctx` to trigger the
-  fallback to `.`.
-- Flow scanners in rules: always reconcile parser byte spans with `char_indices()` via
-  `crate::rules::span_utils` to avoid off-by-byte bugs when UTF-8 characters appear.
-
-CI will fail the build on any missed line or region, so keep local runs green by
-sticking to the quick-status step above.
-
-## Testing Tips
-
-- For Unicode-heavy fixtures, assert behaviour with multibyte characters and reuse the
-  helpers in `crate::rules::span_utils` instead of reinventing byte/char conversions.
-  When writing tests, prefer inputs like `"café"` or `"å"` to ensure coverage of
-  character vs byte offset logic.
-- Use meaningful function and variable names in tests—comments are discouraged.
-- `#[cfg(test)]` modules inside `src/` is forbidden; add coverage through integration
-   tests in `tests/` so LLVM regions stay unique.
-
-## Release Checklist
-
-- Bump versions in lockstep:
-  - Cargo: update `Cargo.toml` `version`.
-  - Python: update `pyproject.toml` `[project].version`.
-- Refresh lockfile and validate:
-  - Run `cargo generate-lockfile` (or `cargo check`) to refresh `Cargo.lock`.
-  - Stage: `git add Cargo.toml Cargo.lock pyproject.toml`.
-  - Run `prek run --all-files` (re-run if files were auto-fixed).
-- Docs and notes:
-  - Update README/AGENTS for behavior changes.
-  - Summarize notable changes in the PR description or changelog (if present).
-- Tag and push (when releasing):
-  - `git tag -a vX.Y.Z -m "vX.Y.Z"`
-  - `git push && git push --tags`
-  - `.github/workflows/release.yml` validates that the pushed tag version
-    matches both `Cargo.toml` and `pyproject.toml` versions before release jobs run.
-  - Publishing uses Trusted Publishing for both registries:
-    - crates.io via GitHub OIDC (`rust-lang/crates-io-auth-action`)
-    - PyPI via Trusted Publishing (`pypa/gh-action-pypi-publish`)
-  - GitHub release creation is deferred until the end of the workflow, after
-    crates.io and PyPI publishing succeed.
-  - GitHub release notes are generated automatically by GitHub when the release
-    draft is created.
-  - The workflow keeps GitHub releases as drafts until assets are uploaded and
-    supports reruns by skipping crates.io/PyPI publish steps when that exact
-    version already exists.
-
-## CLI Behavior
-
-- Accepts one or more inputs: files and/or directories.
-- Directories: recursively scan `.yml`/`.yaml` files, honoring git ignore and
-  git exclude; does not follow symlinks.
-- Files: parsed as YAML even if the extension is not `.yml`/`.yaml`.
-- Exit codes: `0` (ok/none), `1` (invalid YAML), `2` (usage error).