Transform Links

[daxpedda]

I wasn't able to get readme-sync to do any transformation of links. Here is a minimal example.

Cargo.toml:

[package]
name = "test-readme-sync"
version = "0.0.0"
edition = "2021"
publish = false
documentation = "https://docs.rs/test-readme-sync"
repository = "https://github.com/daxpedda/test-readme-sync"

[dev-dependencies]
readme-sync = "0.2"

lib.rs:

//! Test
//! [`Test`]
//! [`Test`](crate::Test)
//! [Test]
//!
//! [Test]: crate::Test

pub struct Test;

#[test]
fn readme_sync_test() {
    use readme_sync::{assert_sync, CMarkDocs, CMarkReadme, Config, Package};

    let package = Package::from_path(env!("CARGO_MANIFEST_DIR").into()).unwrap();
    let config = Config::from_package_docs_rs_features(&package);
    let readme = CMarkReadme::from_package(&package).unwrap();
    let docs = CMarkDocs::from_package_and_config(&package, &config).unwrap();

    let readme = readme
        .remove_badges_paragraph()
        .remove_documentation_section()
        .remove_codeblock_tag("no_sync")
        .disallow_absolute_repository_blob_links()
        .unwrap()
        .use_absolute_repository_blob_urls()
        .unwrap();

    let docs = docs
        .increment_heading_levels()
        .add_package_title()
        .remove_codeblock_rust_test_tags()
        .use_default_codeblock_rust_tag()
        .remove_hidden_rust_code()
        .disallow_absolute_package_docs_links()
        .unwrap()
        .use_absolute_package_docs_urls()
        .unwrap();

    assert_sync(&readme, &docs);
}

README.md:

# test-readme-sync

Test
[`Test`]
[`Test`](crate::Test)
[Test]

[Test]: crate::Test

I expected the test to fail, because of use_absolute_package_docs_urls, but it succeeds instead.

[zheland]

Thank you for report.
I fixed the absolute path check function, so now the error will occur.
However, at the moment intra-doc links (like crate::Test) are not natively supported in pulldown-cmark, that is probably logical.
I added a function with which you can map links (see example in README.md) so you can now use intra-doc links with them separately specified in the readme sync test.

[daxpedda]

Things like std::clone::Clone aren't working either, thinking about it I can't figure out how they would have been supported anyway. std::clone::Clone has to be somehow converted to https://doc.rust-lang.org/core/clone/trait.Clone.html, I can't do that with map_links either, unless I do it manually for each intra-doc link.

So currently my solution will be to manually map_links all intra-doc links, but the next issue I encountered is this:

README.md:

[`Clone`](https://doc.rust-lang.org/core/clone/trait.Clone.html) text.

lib.rs:

//! [`Clone`] text.

I expected this to match, but it doesn't. My current workaround is:
README.md:

[`Clone`] text.

[`Clone`]: https://doc.rust-lang.org/core/clone/trait.Clone.html

lib.rs:

//! [`Clone`] text.
//!
//! [`Clone`]: Clone

I guess whats necessary is a function that removes all links, including link sections ([`Clone`]: Clone, I don't actually know the right terms) so it can match resolved links instead of where the link is specified.