dcdpr / jp / 26401591354

66%

push

github

fix(bookworm): Use OS cache dir and fix multi-platform sanitize (#662)

Cache downloaded crate docs in the OS-specific user cache directory
(`~/Library/Caches/bookworm/crates` on macOS, `~/.cache/bookworm/crates`
on Linux) rather than the system temp directory. This makes downloaded
documentation persist across reboots and easy to locate or wipe.

A new `default_crates_root()` function (backed by
`directories::ProjectDirs`) centralises this logic and is used by both
the `download` function and the `query` client, replacing the two
independent `env::temp_dir()` calls that were scattered across the
codebase.

The `sanitize` function was also rewritten to use structural detection
instead of matching against the crate name. Previously it kept only a
directory whose name exactly matched the crate name, which silently
deleted docs for crates with hyphenated names (e.g. `ra-ap-rustc_lexer`
ships docs under `ra_ap_rustc_lexer/`) or a custom `[lib] name = "…"`
declaration. The new logic keeps any directory that contains a top-level
`index.html` (which is what rustdoc emits for real crate docs), plus
`src/` and `implementors/` by allow-list. Target-triple wrapper
directories produced by multi-platform docsets lack a direct
`index.html` and are removed.

---------

Signed-off-by: Jean Mertz <git@jeanmertz.com>

11 of 19 new or added lines in 2 files covered. (57.89%)

31386 of 47692 relevant lines covered (65.81%)

294.69 hits per line