readability-cli 0.8.4__tar.gz → 0.8.6__tar.gz

{readability_cli-0.8.4 → readability_cli-0.8.6}/.github/workflows/ci.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Set up Python
         uses: astral-sh/setup-uv@v7
         with:
-          python-version: '3.14'
+          python-version: "3.14"
 
       - name: Install dependencies
         run: uv sync

{readability_cli-0.8.4 → readability_cli-0.8.6}/.github/workflows/publish.yml

@@ -2,7 +2,7 @@ name: Publish
 
 on:
   push:
-    tags: ['v*']
+    tags: ["v*"]
 
 jobs:
   publish:
@@ -17,7 +17,7 @@ jobs:
       - name: Set up Python
         uses: astral-sh/setup-uv@v7
         with:
-          python-version: '3.14'
+          python-version: "3.14"
 
       - name: Build distribution
         run: uv build

{readability_cli-0.8.4 → readability_cli-0.8.6}/.github/workflows/update-guides.yml

@@ -2,7 +2,7 @@ name: Update Style Guides
 
 on:
   schedule:
-    - cron: '0 0 * * 0' # Weekly on Sunday at midnight
+    - cron: "0 0 * * 0" # Weekly on Sunday at midnight
   workflow_dispatch: # Ad-hoc trigger
 
 jobs:
@@ -30,4 +30,4 @@ jobs:
         uses: stefanzweifel/git-auto-commit-action@v5
         with:
           commit_message: "chore: update style guides [skip ci]"
-          file_pattern: 'guides/*.md'
+          file_pattern: "guides/*.md"

readability_cli-0.8.6/.prettierignore

@@ -0,0 +1,2 @@
+# Synced upstream guides remain byte-for-byte faithful to their source.
+guides/

{readability_cli-0.8.4 → readability_cli-0.8.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: readability-cli
-Version: 0.8.4
+Version: 0.8.6
 Summary: A CLI to lint, format, and type-check code with Google-style defaults, and pull Google style guides in markdown format.
 Project-URL: Homepage, https://github.com/owahltinez/readability
 Project-URL: Repository, https://github.com/owahltinez/readability
@@ -17,22 +17,21 @@ Description-Content-Type: text/markdown
 A CLI tool that keeps code aligned with Google style conventions. It runs the
 right linters, formatters, and type checkers for your project with sensible
 defaults, and serves the official Google style guides in Markdown format. This
-is ideal for AI agents or developers who want consistent code quality checks
-and quick access to style conventions without browsing HTML pages.
+is ideal for AI agents or developers who want consistent code quality checks and
+quick access to style conventions without browsing HTML pages.
 
 ## Features
 
 - **Linting & Formatting**: A `check` command that automatically detects and
   runs relevant tools (Ruff, Pyrefly, Biome, Prettier, gofmt) for your project.
-- **Sensible Defaults**: Bundled Google-style configurations for Ruff,
-  Pyrefly, and Biome are used automatically when a project does not define its
-  own.
+- **Sensible Defaults**: Google-style defaults for Ruff, Pyrefly, Biome, and
+  Prettier are used automatically when a project does not define its own.
 - **Style Guides**: A `guide` command that fetches the latest Google style
-  guides (Python, Shell, C++, Java, JS/TS, Go, etc.) converted to Markdown,
-  and outlines, addresses, and searches them by section rather than serving
-  200 KB to be read whole.
-- **Offline Mode**: Local caching of style guides for fast, offline access,
-  kept fresh with a single `sync` command.
+  guides (Python, Shell, C++, Java, JS/TS, Go, etc.) converted to Markdown, and
+  outlines, addresses, and searches them by section rather than serving 200 KB
+  to be read whole.
+- **Offline Mode**: Local caching of style guides for fast, offline access, kept
+  fresh with a single `sync` command.
 
 ## Quick Start
 
@@ -95,38 +94,39 @@ readability check . --fix
 
 ### Supported Tools
 
-| Tool | Supported Extensions | Config Needed | Fetched By |
-|------|----------------------|---------------|------------|
-| **Ruff** | `.py` | none, bundled | `uvx` |
-| **Pyrefly** | `.py` | none, bundled | `uvx` |
-| **Biome** | `.js`, `.ts`, `.jsx`, `.tsx`, `.json`, `.jsonc`, `.css`, `.html` | none, bundled | `npx` |
-| **Prettier** | `.js`, `.ts`, `.jsx`, `.tsx`, `.json`, `.css`, `.scss`, `.html`, `.md`, `.yml`, `.yaml` | `.prettierrc*` or `prettier.config.*` | `npx` |
-| **gofmt** | `.go` | `go.mod` | — |
+| Tool         | Supported Extensions                                                                    | Config Needed                     | Fetched By |
+| ------------ | --------------------------------------------------------------------------------------- | --------------------------------- | ---------- |
+| **Ruff**     | `.py`                                                                                   | none, bundled                     | `uvx`      |
+| **Pyrefly**  | `.py`                                                                                   | none, bundled                     | `uvx`      |
+| **Biome**    | `.js`, `.ts`, `.jsx`, `.tsx`, `.json`, `.jsonc`, `.css`, `.html`                        | none, bundled                     | `npx`      |
+| **Prettier** | `.js`, `.ts`, `.jsx`, `.tsx`, `.json`, `.css`, `.scss`, `.html`, `.md`, `.yml`, `.yaml` | none for Markdown, YAML, and SCSS | `npx`      |
+| **gofmt**    | `.go`                                                                                   | `go.mod`                          | —          |
 
 **You do not need to install any of these.** Each is resolved in order: a
-project-local install (`node_modules/.bin`, `.venv/bin`) first, then whatever
-is on your `PATH`, and only then fetched by `uvx` or `npx`. The runners cache
-what they download, so the fetch happens once per machine and later runs are
-served from disk and work offline.
+project-local install (`node_modules/.bin`, `.venv/bin`) first, then whatever is
+on your `PATH`, and only then fetched by `uvx` or `npx`. The runners cache what
+they download, so the fetch happens once per machine and later runs are served
+from disk and work offline.
 
-That keeps this package at ~4 MB rather than the ~54 MB it would take to
-carry Ruff and Pyrefly itself — a cost that would fall on everyone using only
-`guide`. An installed copy always wins over a fetched one, so a project that
-pinned a version is linted against the rules it chose.
+That keeps this package at ~4 MB rather than the ~54 MB it would take to carry
+Ruff and Pyrefly itself — a cost that would fall on everyone using only `guide`.
+An installed copy always wins over a fetched one, so a project that pinned a
+version is linted against the rules it chose.
 
 Fetched tools carry a minimum version, enough to understand the bundled
 configurations, and no maximum. A ceiling would freeze anyone who installed
-nothing at whatever was current when this package shipped, and tie its
-releases to Ruff's — which has published seventeen minor series, roughly one
-every six weeks. If you need a fixed version, install it: an installed tool
-always wins over a fetched one.
+nothing at whatever was current when this package shipped, and tie its releases
+to Ruff's — which has published seventeen minor series, roughly one every six
+weeks. If you need a fixed version, install it: an installed tool always wins
+over a fetched one.
 
-Set `UV_OFFLINE=1` to forbid fetching. A tool that then cannot be reached
-fails the run rather than passing it.
+Set `UV_OFFLINE=1` to forbid fetching. A tool that then cannot be reached fails
+the run rather than passing it.
 
 Ruff, Pyrefly, and Biome ship with bundled configurations, so they run on any
-file they handle without the project arranging anything. Prettier and gofmt
-bring no defaults here, so they wait until the project asks with a config file.
+file they handle without the project arranging anything. Prettier does the same
+for Markdown, YAML, and SCSS; a Prettier configuration opts its overlapping web
+formats into Prettier too. Gofmt waits for a `go.mod` file.
 
 A tool that could not be reached at all is never skipped quietly:
 
@@ -141,8 +141,8 @@ $ readability check src/
 Error: Every tool for 1 path(s) is missing, so nothing was verified.
 ```
 
-That second case needs neither the tool nor a runner to be present, which is
-the state a container image is usually in.
+That second case needs neither the tool nor a runner to be present, which is the
+state a container image is usually in.
 
 `check` exits non-zero on findings, tool failures, and when every applicable
 tool is absent, so it can gate CI without a clean exit meaning required tools
@@ -165,27 +165,28 @@ if report.findings or report.failed or not report.ran:
 ```
 
 The returned `CheckReport` records only whether findings occurred and which
-tools ran, were skipped, or failed. Detailed tool findings are still written
-as each tool runs. Every path is validated before any tool runs, and a missing
-one raises `FileNotFoundError` rather than being misreported as a finding.
-Relative paths remain relative to the process working directory;
-`project_root` controls configuration discovery only.
+tools ran, were skipped, or failed. Detailed tool findings are still written as
+each tool runs. Every path is validated before any tool runs, and a missing one
+raises `FileNotFoundError` rather than being misreported as a finding. Relative
+paths remain relative to the process working directory; `project_root` controls
+configuration discovery only.
 
 ### Default Configurations
 
 Ruff and Pyrefly defaults follow the
 [Google Python style guide](https://google.github.io/styleguide/pyguide.html):
-80-column lines, Google docstrings, import ordering, and full type checking.
-The Biome default applies the 80-column lines and two-space indentation of the
+80-column lines, Google docstrings, import ordering, and full type checking. The
+Biome default applies the 80-column lines and two-space indentation of the
 [Google JavaScript style guide](https://google.github.io/styleguide/jsguide.html)
-and enables Biome's recommended lint rules. These defaults apply only when the
-project does not define its own configuration. To override them, add a
-`[tool.ruff]` or `[tool.pyrefly]` section to your `pyproject.toml`, or a
-dedicated `ruff.toml`, `pyrefly.toml`, `biome.json`, or `biome.jsonc` — any
-project-level configuration takes full precedence. The bundled Biome file
-intentionally uses only settings supported by both Biome 1.x and 2.x, so a
-project-local installation remains authoritative without creating a schema
-mismatch.
+and enables Biome's recommended lint rules. Prettier wraps prose at 80 columns,
+following the
+[Google Markdown style guide](https://google.github.io/styleguide/docguide/style.html#character-line-limit).
+These defaults apply only when the project does not define its own
+configuration. To override them, add a `[tool.ruff]` or `[tool.pyrefly]` section
+to your `pyproject.toml`, or a dedicated `ruff.toml`, `pyrefly.toml`,
+`biome.json`, `biome.jsonc`, or Prettier configuration — any project-level
+configuration takes full precedence. The bundled Biome file requires Biome 2.5
+or later, matching the version floor used by the fallback runner.
 
 ## Style Guides
 
@@ -211,17 +212,17 @@ readability guide python --full | grep -i f-string
 
 A guide can exceed 200 KB, so the outline is what a bare invocation prints:
 listing the sections and fetching the one you need beats reading the lot.
-Nothing is written to disk, which is what a coding agent should do rather
-than redirecting a guide into the repository it is working on — use a shell
-redirect if you do want a copy.
+Nothing is written to disk, which is what a coding agent should do rather than
+redirecting a guide into the repository it is working on — use a shell redirect
+if you do want a copy.
 
-`REF` and `--full` cannot be combined; that is refused rather than resolved
-by a precedence rule you would have to know.
+`REF` and `--full` cannot be combined; that is refused rather than resolved by a
+precedence rule you would have to know.
 
 ### Navigating a Guide
 
-The outline gives each section an index to fetch it by, and flags the ones
-large enough to be worth knowing about first:
+The outline gives each section an index to fetch it by, and flags the ones large
+enough to be worth knowing about first:
 
 ```bash
 $ readability guide cpp
@@ -235,28 +236,28 @@ Google C++ Style Guide
 # 140 sections · print one:  readability guide cpp 4.5.1
 ```
 
-Sizes appear only at 1200 words and above — the 4% of sections expensive
-enough that you would want warning. They include subsections, since that is
-what the reference returns. The trailing line goes to stderr, so it never
-contaminates a piped outline.
+Sizes appear only at 1200 words and above — the 4% of sections expensive enough
+that you would want warning. They include subsections, since that is what the
+reference returns. The trailing line goes to stderr, so it never contaminates a
+piped outline.
 
 A section reference can be any of the following:
 
-| Reference | Example |
-|-----------|---------|
-| Section index, as shown by the outline | `2.2.4` |
-| Heading text, case-insensitive, or its slug | `"function comments"` |
+| Reference                                   | Example                |
+| ------------------------------------------- | ---------------------- |
+| Section index, as shown by the outline      | `2.2.4`                |
+| Heading text, case-insensitive, or its slug | `"function comments"`  |
 | A parent-scoped path, spaces around the `>` | `"Imports > Decision"` |
 
-Whole matches are preferred; a reference that matches nothing in full is
-retried as a substring of the heading text.
+Whole matches are preferred; a reference that matches nothing in full is retried
+as a substring of the heading text.
 
 Three of the shipped guides — Python, JavaScript, and Java — number their own
 sections, and those numbers are the index. A rule cited from the outline then
-matches the published guide exactly, including where the guide skips a
-number: the Python guide has no 2.15 at all, so its 2.16 is listed as 2.16
-rather than renumbered. The other eleven guides number nothing, so their
-index comes from each heading's position in the tree.
+matches the published guide exactly, including where the guide skips a number:
+the Python guide has no 2.15 at all, so its 2.16 is listed as 2.16 rather than
+renumbered. The other eleven guides number nothing, so their index comes from
+each heading's position in the tree.
 
 Either way the index is unique, which is what makes a repeated heading
 addressable — `Definition`, `Pros`, `Cons`, and `Decision` appear under every
@@ -279,8 +280,8 @@ Error: 'Decision' matches 19 headings in the 'python' guide. Repeat with one of:
 
 A guide discusses plenty that no heading is named after, so a reference that
 matches nothing is usually a vocabulary mismatch rather than a mistake. The
-sections that mention the words are reported, which turns the miss into the
-next command:
+sections that mention the words are reported, which turns the miss into the next
+command:
 
 ```bash
 $ readability guide python f-string
@@ -290,22 +291,21 @@ It appears in these sections:
   3.10.1  Python Style Rules > Strings > Logging
 ```
 
-This locates a rule; it does not search text. For that, pipe `--full` to
-`grep`, which you already know and which brings its own `-i`, `-A`, `-c` and
-the rest:
+This locates a rule; it does not search text. For that, pipe `--full` to `grep`,
+which you already know and which brings its own `-i`, `-A`, `-c` and the rest:
 
 ```bash
 readability guide python --full | grep -in -A2 "f-string"
 ```
 
-Content goes to stdout and diagnostics to stderr, so every form is safe to
-pipe. Headings inside fenced code blocks are ignored, which matters for the
-Shell and Python guides where `#` starts a comment.
+Content goes to stdout and diagnostics to stderr, so every form is safe to pipe.
+Headings inside fenced code blocks are ignored, which matters for the Shell and
+Python guides where `#` starts a comment.
 
 ### Supported Languages
 
-Run `readability guide` with no language for the full list and which guides
-are cached:
+Run `readability guide` with no language for the full list and which guides are
+cached:
 
 ```bash
 $ readability guide
@@ -338,17 +338,16 @@ readability sync
 
 ### Offline Mode
 
-The tool stores local copies of the style guides in the `guides/` directory
-and the `guide` command uses these local files when they exist. The bundled
-copies are automatically synchronized weekly from the official
+The tool stores local copies of the style guides in the `guides/` directory and
+the `guide` command uses these local files when they exist. The bundled copies
+are automatically synchronized weekly from the official
 [Google Style Guides](https://google.github.io/styleguide/) repository via
-GitHub Actions, and you can refresh your local cache at any time with the
-`sync` command.
+GitHub Actions, and you can refresh your local cache at any time with the `sync`
+command.
 
 You can override the default `guides/` directory by setting the
 `READABILITY_CACHE` environment variable. This is useful if you want to store
-the guides in a specific location or share them across different
-installations:
+the guides in a specific location or share them across different installations:
 
 ```bash
 export READABILITY_CACHE=/path/to/my/guides

{readability_cli-0.8.4 → readability_cli-0.8.6}/README.md

@@ -3,22 +3,21 @@
 A CLI tool that keeps code aligned with Google style conventions. It runs the
 right linters, formatters, and type checkers for your project with sensible
 defaults, and serves the official Google style guides in Markdown format. This
-is ideal for AI agents or developers who want consistent code quality checks
-and quick access to style conventions without browsing HTML pages.
+is ideal for AI agents or developers who want consistent code quality checks and
+quick access to style conventions without browsing HTML pages.
 
 ## Features
 
 - **Linting & Formatting**: A `check` command that automatically detects and
   runs relevant tools (Ruff, Pyrefly, Biome, Prettier, gofmt) for your project.
-- **Sensible Defaults**: Bundled Google-style configurations for Ruff,
-  Pyrefly, and Biome are used automatically when a project does not define its
-  own.
+- **Sensible Defaults**: Google-style defaults for Ruff, Pyrefly, Biome, and
+  Prettier are used automatically when a project does not define its own.
 - **Style Guides**: A `guide` command that fetches the latest Google style
-  guides (Python, Shell, C++, Java, JS/TS, Go, etc.) converted to Markdown,
-  and outlines, addresses, and searches them by section rather than serving
-  200 KB to be read whole.
-- **Offline Mode**: Local caching of style guides for fast, offline access,
-  kept fresh with a single `sync` command.
+  guides (Python, Shell, C++, Java, JS/TS, Go, etc.) converted to Markdown, and
+  outlines, addresses, and searches them by section rather than serving 200 KB
+  to be read whole.
+- **Offline Mode**: Local caching of style guides for fast, offline access, kept
+  fresh with a single `sync` command.
 
 ## Quick Start
 
@@ -81,38 +80,39 @@ readability check . --fix
 
 ### Supported Tools
 
-| Tool | Supported Extensions | Config Needed | Fetched By |
-|------|----------------------|---------------|------------|
-| **Ruff** | `.py` | none, bundled | `uvx` |
-| **Pyrefly** | `.py` | none, bundled | `uvx` |
-| **Biome** | `.js`, `.ts`, `.jsx`, `.tsx`, `.json`, `.jsonc`, `.css`, `.html` | none, bundled | `npx` |
-| **Prettier** | `.js`, `.ts`, `.jsx`, `.tsx`, `.json`, `.css`, `.scss`, `.html`, `.md`, `.yml`, `.yaml` | `.prettierrc*` or `prettier.config.*` | `npx` |
-| **gofmt** | `.go` | `go.mod` | — |
+| Tool         | Supported Extensions                                                                    | Config Needed                     | Fetched By |
+| ------------ | --------------------------------------------------------------------------------------- | --------------------------------- | ---------- |
+| **Ruff**     | `.py`                                                                                   | none, bundled                     | `uvx`      |
+| **Pyrefly**  | `.py`                                                                                   | none, bundled                     | `uvx`      |
+| **Biome**    | `.js`, `.ts`, `.jsx`, `.tsx`, `.json`, `.jsonc`, `.css`, `.html`                        | none, bundled                     | `npx`      |
+| **Prettier** | `.js`, `.ts`, `.jsx`, `.tsx`, `.json`, `.css`, `.scss`, `.html`, `.md`, `.yml`, `.yaml` | none for Markdown, YAML, and SCSS | `npx`      |
+| **gofmt**    | `.go`                                                                                   | `go.mod`                          | —          |
 
 **You do not need to install any of these.** Each is resolved in order: a
-project-local install (`node_modules/.bin`, `.venv/bin`) first, then whatever
-is on your `PATH`, and only then fetched by `uvx` or `npx`. The runners cache
-what they download, so the fetch happens once per machine and later runs are
-served from disk and work offline.
+project-local install (`node_modules/.bin`, `.venv/bin`) first, then whatever is
+on your `PATH`, and only then fetched by `uvx` or `npx`. The runners cache what
+they download, so the fetch happens once per machine and later runs are served
+from disk and work offline.
 
-That keeps this package at ~4 MB rather than the ~54 MB it would take to
-carry Ruff and Pyrefly itself — a cost that would fall on everyone using only
-`guide`. An installed copy always wins over a fetched one, so a project that
-pinned a version is linted against the rules it chose.
+That keeps this package at ~4 MB rather than the ~54 MB it would take to carry
+Ruff and Pyrefly itself — a cost that would fall on everyone using only `guide`.
+An installed copy always wins over a fetched one, so a project that pinned a
+version is linted against the rules it chose.
 
 Fetched tools carry a minimum version, enough to understand the bundled
 configurations, and no maximum. A ceiling would freeze anyone who installed
-nothing at whatever was current when this package shipped, and tie its
-releases to Ruff's — which has published seventeen minor series, roughly one
-every six weeks. If you need a fixed version, install it: an installed tool
-always wins over a fetched one.
+nothing at whatever was current when this package shipped, and tie its releases
+to Ruff's — which has published seventeen minor series, roughly one every six
+weeks. If you need a fixed version, install it: an installed tool always wins
+over a fetched one.
 
-Set `UV_OFFLINE=1` to forbid fetching. A tool that then cannot be reached
-fails the run rather than passing it.
+Set `UV_OFFLINE=1` to forbid fetching. A tool that then cannot be reached fails
+the run rather than passing it.
 
 Ruff, Pyrefly, and Biome ship with bundled configurations, so they run on any
-file they handle without the project arranging anything. Prettier and gofmt
-bring no defaults here, so they wait until the project asks with a config file.
+file they handle without the project arranging anything. Prettier does the same
+for Markdown, YAML, and SCSS; a Prettier configuration opts its overlapping web
+formats into Prettier too. Gofmt waits for a `go.mod` file.
 
 A tool that could not be reached at all is never skipped quietly:
 
@@ -127,8 +127,8 @@ $ readability check src/
 Error: Every tool for 1 path(s) is missing, so nothing was verified.
 ```
 
-That second case needs neither the tool nor a runner to be present, which is
-the state a container image is usually in.
+That second case needs neither the tool nor a runner to be present, which is the
+state a container image is usually in.
 
 `check` exits non-zero on findings, tool failures, and when every applicable
 tool is absent, so it can gate CI without a clean exit meaning required tools
@@ -151,27 +151,28 @@ if report.findings or report.failed or not report.ran:
 ```
 
 The returned `CheckReport` records only whether findings occurred and which
-tools ran, were skipped, or failed. Detailed tool findings are still written
-as each tool runs. Every path is validated before any tool runs, and a missing
-one raises `FileNotFoundError` rather than being misreported as a finding.
-Relative paths remain relative to the process working directory;
-`project_root` controls configuration discovery only.
+tools ran, were skipped, or failed. Detailed tool findings are still written as
+each tool runs. Every path is validated before any tool runs, and a missing one
+raises `FileNotFoundError` rather than being misreported as a finding. Relative
+paths remain relative to the process working directory; `project_root` controls
+configuration discovery only.
 
 ### Default Configurations
 
 Ruff and Pyrefly defaults follow the
 [Google Python style guide](https://google.github.io/styleguide/pyguide.html):
-80-column lines, Google docstrings, import ordering, and full type checking.
-The Biome default applies the 80-column lines and two-space indentation of the
+80-column lines, Google docstrings, import ordering, and full type checking. The
+Biome default applies the 80-column lines and two-space indentation of the
 [Google JavaScript style guide](https://google.github.io/styleguide/jsguide.html)
-and enables Biome's recommended lint rules. These defaults apply only when the
-project does not define its own configuration. To override them, add a
-`[tool.ruff]` or `[tool.pyrefly]` section to your `pyproject.toml`, or a
-dedicated `ruff.toml`, `pyrefly.toml`, `biome.json`, or `biome.jsonc` — any
-project-level configuration takes full precedence. The bundled Biome file
-intentionally uses only settings supported by both Biome 1.x and 2.x, so a
-project-local installation remains authoritative without creating a schema
-mismatch.
+and enables Biome's recommended lint rules. Prettier wraps prose at 80 columns,
+following the
+[Google Markdown style guide](https://google.github.io/styleguide/docguide/style.html#character-line-limit).
+These defaults apply only when the project does not define its own
+configuration. To override them, add a `[tool.ruff]` or `[tool.pyrefly]` section
+to your `pyproject.toml`, or a dedicated `ruff.toml`, `pyrefly.toml`,
+`biome.json`, `biome.jsonc`, or Prettier configuration — any project-level
+configuration takes full precedence. The bundled Biome file requires Biome 2.5
+or later, matching the version floor used by the fallback runner.
 
 ## Style Guides
 
@@ -197,17 +198,17 @@ readability guide python --full | grep -i f-string
 
 A guide can exceed 200 KB, so the outline is what a bare invocation prints:
 listing the sections and fetching the one you need beats reading the lot.
-Nothing is written to disk, which is what a coding agent should do rather
-than redirecting a guide into the repository it is working on — use a shell
-redirect if you do want a copy.
+Nothing is written to disk, which is what a coding agent should do rather than
+redirecting a guide into the repository it is working on — use a shell redirect
+if you do want a copy.
 
-`REF` and `--full` cannot be combined; that is refused rather than resolved
-by a precedence rule you would have to know.
+`REF` and `--full` cannot be combined; that is refused rather than resolved by a
+precedence rule you would have to know.
 
 ### Navigating a Guide
 
-The outline gives each section an index to fetch it by, and flags the ones
-large enough to be worth knowing about first:
+The outline gives each section an index to fetch it by, and flags the ones large
+enough to be worth knowing about first:
 
 ```bash
 $ readability guide cpp
@@ -221,28 +222,28 @@ Google C++ Style Guide
 # 140 sections · print one:  readability guide cpp 4.5.1
 ```
 
-Sizes appear only at 1200 words and above — the 4% of sections expensive
-enough that you would want warning. They include subsections, since that is
-what the reference returns. The trailing line goes to stderr, so it never
-contaminates a piped outline.
+Sizes appear only at 1200 words and above — the 4% of sections expensive enough
+that you would want warning. They include subsections, since that is what the
+reference returns. The trailing line goes to stderr, so it never contaminates a
+piped outline.
 
 A section reference can be any of the following:
 
-| Reference | Example |
-|-----------|---------|
-| Section index, as shown by the outline | `2.2.4` |
-| Heading text, case-insensitive, or its slug | `"function comments"` |
+| Reference                                   | Example                |
+| ------------------------------------------- | ---------------------- |
+| Section index, as shown by the outline      | `2.2.4`                |
+| Heading text, case-insensitive, or its slug | `"function comments"`  |
 | A parent-scoped path, spaces around the `>` | `"Imports > Decision"` |
 
-Whole matches are preferred; a reference that matches nothing in full is
-retried as a substring of the heading text.
+Whole matches are preferred; a reference that matches nothing in full is retried
+as a substring of the heading text.
 
 Three of the shipped guides — Python, JavaScript, and Java — number their own
 sections, and those numbers are the index. A rule cited from the outline then
-matches the published guide exactly, including where the guide skips a
-number: the Python guide has no 2.15 at all, so its 2.16 is listed as 2.16
-rather than renumbered. The other eleven guides number nothing, so their
-index comes from each heading's position in the tree.
+matches the published guide exactly, including where the guide skips a number:
+the Python guide has no 2.15 at all, so its 2.16 is listed as 2.16 rather than
+renumbered. The other eleven guides number nothing, so their index comes from
+each heading's position in the tree.
 
 Either way the index is unique, which is what makes a repeated heading
 addressable — `Definition`, `Pros`, `Cons`, and `Decision` appear under every
@@ -265,8 +266,8 @@ Error: 'Decision' matches 19 headings in the 'python' guide. Repeat with one of:
 
 A guide discusses plenty that no heading is named after, so a reference that
 matches nothing is usually a vocabulary mismatch rather than a mistake. The
-sections that mention the words are reported, which turns the miss into the
-next command:
+sections that mention the words are reported, which turns the miss into the next
+command:
 
 ```bash
 $ readability guide python f-string
@@ -276,22 +277,21 @@ It appears in these sections:
   3.10.1  Python Style Rules > Strings > Logging
 ```
 
-This locates a rule; it does not search text. For that, pipe `--full` to
-`grep`, which you already know and which brings its own `-i`, `-A`, `-c` and
-the rest:
+This locates a rule; it does not search text. For that, pipe `--full` to `grep`,
+which you already know and which brings its own `-i`, `-A`, `-c` and the rest:
 
 ```bash
 readability guide python --full | grep -in -A2 "f-string"
 ```
 
-Content goes to stdout and diagnostics to stderr, so every form is safe to
-pipe. Headings inside fenced code blocks are ignored, which matters for the
-Shell and Python guides where `#` starts a comment.
+Content goes to stdout and diagnostics to stderr, so every form is safe to pipe.
+Headings inside fenced code blocks are ignored, which matters for the Shell and
+Python guides where `#` starts a comment.
 
 ### Supported Languages
 
-Run `readability guide` with no language for the full list and which guides
-are cached:
+Run `readability guide` with no language for the full list and which guides are
+cached:
 
 ```bash
 $ readability guide
@@ -324,17 +324,16 @@ readability sync
 
 ### Offline Mode
 
-The tool stores local copies of the style guides in the `guides/` directory
-and the `guide` command uses these local files when they exist. The bundled
-copies are automatically synchronized weekly from the official
+The tool stores local copies of the style guides in the `guides/` directory and
+the `guide` command uses these local files when they exist. The bundled copies
+are automatically synchronized weekly from the official
 [Google Style Guides](https://google.github.io/styleguide/) repository via
-GitHub Actions, and you can refresh your local cache at any time with the
-`sync` command.
+GitHub Actions, and you can refresh your local cache at any time with the `sync`
+command.
 
 You can override the default `guides/` directory by setting the
 `READABILITY_CACHE` environment variable. This is useful if you want to store
-the guides in a specific location or share them across different
-installations:
+the guides in a specific location or share them across different installations:
 
 ```bash
 export READABILITY_CACHE=/path/to/my/guides

{readability_cli-0.8.4 → readability_cli-0.8.6}/configs/biome-default.json

@@ -10,5 +10,10 @@
     "rules": {
       "recommended": true
     }
+  },
+  "html": {
+    "parser": {
+      "interpolation": true
+    }
   }
 }

{readability_cli-0.8.4 → readability_cli-0.8.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "readability-cli"
-version = "0.8.4"
+version = "0.8.6"
 description = "A CLI to lint, format, and type-check code with Google-style defaults, and pull Google style guides in markdown format."
 readme = "README.md"
 requires-python = ">=3.12"

{readability_cli-0.8.4 → readability_cli-0.8.6}/readability.py

@@ -1288,27 +1288,27 @@ def _should_run_tool(
     Returns:
         True if the tool should run, False otherwise.
     """
-    # A tool shipping bundled defaults needs nothing from the project, so
-    # requiring a config file made those defaults unreachable by exactly the
-    # projects they exist for: an empty pyproject.toml was the difference
-    # between checking a file and checking nothing. Tools without defaults
-    # still wait to be asked, since there is no sane way to run them.
-    has_trigger = _bundled_config(tool["name"]).exists() or any(
+    # Project configuration opts a tool into every extension it supports;
+    # otherwise it handles only the formats with safe readability defaults.
+    has_project_config = any(
         (project_root / t).exists() for t in tool["trigger"]
     )
+    extensions = (
+        tool["extensions"] if has_project_config else tool["default_extensions"]
+    )
 
     # Files must match one of the tool's supported extensions.
     if path.is_file():
-        return has_trigger and path.suffix in tool["extensions"]
+        return path.suffix in extensions
 
-    if not has_trigger:
+    if not extensions:
         return False
 
     # A directory trigger alone is not evidence that the tool checked a file.
     # Several tools deliberately exit zero when nothing matches, which would
     # otherwise turn an unsupported-only tree into a reported clean result.
     return any(
-        candidate.is_file() and candidate.suffix in tool["extensions"]
+        candidate.is_file() and candidate.suffix in extensions
         for candidate in path.rglob("*")
     )
 
@@ -1518,6 +1518,11 @@ def _get_tool_definitions(
     pyrefly = _tool_command("pyrefly", project_root)
     biome = _tool_command("biome", project_root)
     prettier = _tool_command("prettier", project_root)
+    prettier_defaults = [
+        "--print-width=80",
+        "--prose-wrap=always",
+        "--config-precedence=prefer-file",
+    ]
 
     return [
         {
@@ -1554,6 +1559,7 @@ def _get_tool_definitions(
             ],
             "trigger": ["pyproject.toml", "ruff.toml", ".ruff.toml"],
             "extensions": [".py"],
+            "default_extensions": [".py"],
         },
         {
             # Type checker only: it reports findings but cannot fix or format
@@ -1567,6 +1573,7 @@ def _get_tool_definitions(
             **({"cwd": project_root} if pyrefly_project_mode else {}),
             "trigger": ["pyproject.toml", "pyrefly.toml"],
             "extensions": [".py"],
+            "default_extensions": [".py"],
         },
         {
             "name": "biome",
@@ -1611,18 +1618,30 @@ def _get_tool_definitions(
                 ".css",
                 ".html",
             ],
+            "default_extensions": [
+                ".js",
+                ".ts",
+                ".jsx",
+                ".tsx",
+                ".json",
+                ".jsonc",
+                ".css",
+                ".html",
+            ],
         },
         {
             "name": "prettier",
             "check_format": [
                 *prettier,
                 "--check",
+                *prettier_defaults,
                 "--no-error-on-unmatched-pattern",
                 path_str,
             ],
             "format": [
                 *prettier,
                 "--write",
+                *prettier_defaults,
                 "--no-error-on-unmatched-pattern",
                 path_str,
             ],
@@ -1648,6 +1667,7 @@ def _get_tool_definitions(
                 ".yml",
                 ".yaml",
             ],
+            "default_extensions": [".md", ".yml", ".yaml", ".scss"],
         },
         {
             "name": "go fmt",
@@ -1655,6 +1675,7 @@ def _get_tool_definitions(
             "format": ["go", "fmt", path_str],
             "trigger": ["go.mod"],
             "extensions": [".go"],
+            "default_extensions": [],
         },
     ]
 
@@ -1741,7 +1762,7 @@ def _tool_checked_files(
     if tool_name != "biome":
         return True
     output = f"{result.stdout or ''}\n{result.stderr or ''}"
-    # Biome 1.x and 2.x use these summaries for an unmatched target.
+    # Biome 2.x uses these summaries for an unmatched target.
     zero_file_summaries = ("Checked 0 files", "Formatted 0 files")
     return not any(summary in output for summary in zero_file_summaries)
 

{readability_cli-0.8.4 → readability_cli-0.8.6}/test_readability.py

@@ -653,6 +653,7 @@ def test_bundled_default_configs_are_valid() -> None:
         "lineWidth": 80,
     }
     assert biome_config["linter"]["rules"]["recommended"] is True
+    assert biome_config["html"]["parser"]["interpolation"] is True
 
     # The ruff defaults follow the Google Python style guide
     ruff_config = tomllib.loads(_bundled_config("ruff").read_text())
@@ -1978,6 +1979,88 @@ def test_check_runs_biome_without_a_project_config(
     )
 
 
+@pytest.mark.parametrize("extension", (".md", ".yml", ".yaml", ".scss"))
+@patch("shutil.which")
+@patch("subprocess.run")
+def test_check_runs_prettier_for_unsupported_biome_formats_without_config(
+    mock_run: MagicMock,
+    mock_which: MagicMock,
+    tmp_path: Path,
+    extension: str,
+) -> None:
+    """Prettier covers its default formats without project configuration."""
+    mock_which.side_effect = lambda name: name
+    mock_run.return_value = MagicMock(returncode=0, stdout="", stderr="")
+
+    runner = CliRunner()
+    with runner.isolated_filesystem(temp_dir=tmp_path):
+        Path(f"document{extension}").touch()
+
+        result = runner.invoke(cli, ["check", f"document{extension}"])
+
+    assert result.exit_code == 0
+    commands = [invocation.args[0] for invocation in mock_run.call_args_list]
+    assert len(commands) == 1
+    assert commands[0][0] == "prettier"
+
+
+def test_prettier_uses_google_markdown_defaults(tmp_path: Path) -> None:
+    """CLI defaults wrap Markdown while deferring to project configuration."""
+    tools = {
+        tool["name"]: tool
+        for tool in _get_tool_definitions(Path("document.md"), tmp_path)
+    }
+
+    for command_name in ("check_format", "format"):
+        command = tools["prettier"][command_name]
+        assert "--print-width=80" in command
+        assert "--prose-wrap=always" in command
+        assert "--config-precedence=prefer-file" in command
+
+
+@patch("shutil.which")
+@patch("subprocess.run")
+def test_check_runs_prettier_for_configless_markdown_directory(
+    mock_run: MagicMock, mock_which: MagicMock, tmp_path: Path
+) -> None:
+    """Default applicability also works when checking a directory."""
+    mock_which.side_effect = lambda name: name
+    mock_run.return_value = MagicMock(returncode=0, stdout="", stderr="")
+
+    runner = CliRunner()
+    with runner.isolated_filesystem(temp_dir=tmp_path):
+        Path("docs").mkdir()
+        Path("docs/guide.md").touch()
+
+        result = runner.invoke(cli, ["check", "docs"])
+
+    assert result.exit_code == 0
+    commands = [invocation.args[0] for invocation in mock_run.call_args_list]
+    assert len(commands) == 1
+    assert commands[0][0] == "prettier"
+
+
+@patch("shutil.which")
+@patch("subprocess.run")
+def test_prettier_project_config_opts_in_javascript(
+    mock_run: MagicMock, mock_which: MagicMock, tmp_path: Path
+) -> None:
+    """A project configuration retains Prettier's existing broad coverage."""
+    mock_which.side_effect = lambda name: name
+    mock_run.return_value = MagicMock(returncode=0, stdout="", stderr="")
+
+    runner = CliRunner()
+    with runner.isolated_filesystem(temp_dir=tmp_path):
+        Path(".prettierrc").touch()
+        Path("script.js").touch()
+
+        result = runner.invoke(cli, ["check", "script.js"])
+
+    assert result.exit_code == 0
+    commands = [invocation.args[0][0] for invocation in mock_run.call_args_list]
+    assert commands.count("prettier") == 1
+
+
 @patch("shutil.which")
 @patch("subprocess.run")
 def test_bundled_tools_do_not_claim_an_unsupported_directory(
@@ -1989,7 +2072,7 @@ def test_bundled_tools_do_not_claim_an_unsupported_directory(
 
     runner = CliRunner()
     with runner.isolated_filesystem(temp_dir=tmp_path):
-        Path("notes.md").touch()
+        Path("notes.txt").touch()
 
         result = runner.invoke(cli, ["check", "."])
 
@@ -2023,7 +2106,7 @@ def test_biome_zero_file_result_is_not_reported_as_clean(
         Path(".gitignore").write_text("node_modules/\n")
         Path("node_modules/example").mkdir(parents=True)
         Path("node_modules/example/index.js").touch()
-        Path("README.md").touch()
+        Path("README.txt").touch()
 
         for extra_args, expected_calls in (([], 2), (["--fix"], 3)):
             mock_run.side_effect = (

{readability_cli-0.8.4 → readability_cli-0.8.6}/uv.lock

@@ -194,7 +194,7 @@ wheels = [
 
 [[package]]
 name = "readability-cli"
-version = "0.8.4"
+version = "0.8.6"
 source = { editable = "." }
 dependencies = [
     { name = "beautifulsoup4" },