Conversation
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>
Signed-off-by: Jean Mertz <git@jeanmertz.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Cache downloaded crate docs in the OS-specific user cache directory (
~/Library/Caches/bookworm/crateson macOS,~/.cache/bookworm/crateson 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 bydirectories::ProjectDirs) centralises this logic and is used by both thedownloadfunction and thequeryclient, replacing the two independentenv::temp_dir()calls that were scattered across the codebase.The
sanitizefunction 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_lexerships docs underra_ap_rustc_lexer/) or a custom[lib] name = "…"declaration. The new logic keeps any directory that contains a top-levelindex.html(which is what rustdoc emits for real crate docs), plussrc/andimplementors/by allow-list. Target-triple wrapper directories produced by multi-platform docsets lack a directindex.htmland are removed.