mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Auto merge of #13148 - xFrednet:lintcheck-link-correction-again, r=Alexendoo

Browse Source 
Lintcheck: Support underscores replacement in URL crate names

The generated URLs use `{krate}` for the crate name. This works well for the first part of the docs.rs domain, but the second part is actually the root module, which requires a replacement of all dashes with underscores. This PR adds `{krate_}` for the root module name.

Diff:

```diff
 Removed `clippy::needless_borrows_for_generic_args` in `rustls-pemfile` at
-https://docs.rs/rustls-pemfile/2.1.2/src/rustls-pemfile/pemfile.rs.html#194
+https://docs.rs/rustls-pemfile/2.1.2/src/rustls_pemfile/pemfile.rs.html#194
```

> Example before: https://github.com/xFrednet/rust-clippy/actions/runs/10054236377?pr=4
> Example after: https://github.com/xFrednet/rust-clippy/actions/runs/10054878594?pr=4

---

changelog: none

r? `@Alexendoo`
This commit is contained in:
bors 2024-07-23 11:51:53 +00:00
commit bd1224d8aa
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
lintcheck/src/input.rs
View File

@ -10,7 +10,7 @@
use crate::{Crate, LINTCHECK_DOWNLOADS, LINTCHECK_SOURCES}; use crate::{Crate, LINTCHECK_DOWNLOADS, LINTCHECK_SOURCES};
const DEFAULT_DOCS_LINK: &str = "https://docs.rs/{krate}/{version}/src/{krate}/{file}.html#{line}"; const DEFAULT_DOCS_LINK: &str = "https://docs.rs/{krate}/{version}/src/{krate_}/{file}.html#{line}";
const DEFAULT_GITHUB_LINK: &str = "{url}/blob/{hash}/src/{file}#L{line}"; const DEFAULT_GITHUB_LINK: &str = "{url}/blob/{hash}/src/{file}#L{line}";
const DEFAULT_PATH_LINK: &str = "{path}/src/{file}:{line}"; const DEFAULT_PATH_LINK: &str = "{path}/src/{file}:{line}";
@ -39,6 +39,7 @@ struct TomlCrate {
options: Option<Vec<String>>, options: Option<Vec<String>>,
/// Magic values: /// Magic values:
/// * `{krate}` will be replaced by `self.name` /// * `{krate}` will be replaced by `self.name`
/// * `{krate_}` will be replaced by `self.name` with all `-` replaced by `_`
/// * `{version}` will be replaced by `self.version` /// * `{version}` will be replaced by `self.version`
/// * `{url}` will be replaced with `self.git_url` /// * `{url}` will be replaced with `self.git_url`
/// * `{hash}` will be replaced with `self.git_hash` /// * `{hash}` will be replaced with `self.git_hash`
@ -55,6 +56,7 @@ impl TomlCrate {
fn file_link(&self, default: &str) -> String { fn file_link(&self, default: &str) -> String {
let mut link = self.online_link.clone().unwrap_or_else(|| default.to_string()); let mut link = self.online_link.clone().unwrap_or_else(|| default.to_string());
link = link.replace("{krate}", &self.name); link = link.replace("{krate}", &self.name);
link = link.replace("{krate_}", &self.name.replace('-', "_"));
if let Some(version) = &self.version { if let Some(version) = &self.version {
link = link.replace("{version}", version); link = link.replace("{version}", version);