Add a way to ignore links about cargo-intraconv HOT 10 CLOSED

Oh nice, if TOML is usable I'll juste use the toml crate and it will be easier (and more solid) than parsing a wonky format.

from cargo-intraconv.

❯ cg intraconv -i intraconv.toml tracing-core
/Users/alexis/Projects/rust/tracing/tracing-core/src/collect.rs
===============================================================

  443:  "    /// [`downcast_ref`]: #method.downcast_ref"
        "    /// [`downcast_ref`]: Collect::downcast_ref()"

/Users/alexis/Projects/rust/tracing/tracing-core/src/event.rs
=============================================================

   20:  "/// [span]: ../span"
        "/// [span]: super::span"

   21:  "/// [fields]: ../field"
        "/// [fields]: super::field"

/Users/alexis/Projects/rust/tracing/tracing-core/src/lib.rs
===========================================================

   93:  "//! [`libstd`]: https://doc.rust-lang.org/std/index.html"
        "//! [`libstd`]: crate"

  107:  "//! [`liballoc`]: https://doc.rust-lang.org/alloc/index.html"
        "//! [`liballoc`]: alloc"

~/P/r/tracing on  master via  v1.47.0 
❯ cg intraconv tracing-core    
+/Users/alexis/Projects/rust/tracing/tracing-core/src/collect.rs
+===============================================================
+
+  443:  "    /// [`downcast_ref`]: #method.downcast_ref"
+        "    /// [`downcast_ref`]: Collect::downcast_ref()"
+
/Users/alexis/Projects/rust/tracing/tracing-core/src/event.rs
=============================================================

   20:  "/// [span]: ../span"
        "/// [span]: super::span"

   21:  "/// [fields]: ../field"
        "/// [fields]: super::field"

/Users/alexis/Projects/rust/tracing/tracing-core/src/lib.rs
===========================================================

   93:  "//! [`libstd`]: https://doc.rust-lang.org/std/index.html"
        "//! [`libstd`]: crate"

  107:  "//! [`liballoc`]: https://doc.rust-lang.org/alloc/index.html"
        "//! [`liballoc`]: alloc"

With and without the ignore file. I just have to document it properly in the README and I'll push the changes.

from cargo-intraconv.

This may become verbose quickly if this is a command line option.

I'm not sure how to do it properly, maybe through a file and a --ignore-links [FILE]

from cargo-intraconv.

Yeah, a file sounds nice - I was imagining this as configurable per-file and per-link so it would definitely be annoying to type by hand.

from cargo-intraconv.

What would you want from such a file ? I have no idea about the format I'll use

Edit: What features are you thinking about ?

from cargo-intraconv.

I was imagining something like this:

[ignore]
[["tracing/src/lib.rs"]]
"`downcast_ref`" = "#method.downcast_ref"

(I checked and that's valid toml.)

from cargo-intraconv.

I'm wondering, would it be more intuitive to use suffixes (mod.rs can match multiple times) or canonicalised paths (mod.rs has been expanded to exactly one file) for the configuration file and the behaviour of intraconv ? What would you expect ?

from cargo-intraconv.

Maybe it should use .gitignore syntax? Where you can say /tracing/src/mod.rs to mean an absolute path and mod.rs to mean a relative one, possibly matching many files.

from cargo-intraconv.

Nice idea, I'll go with that !

from cargo-intraconv.

   93:  "//! [`libstd`]: https://doc.rust-lang.org/std/index.html"
        "//! [`libstd`]: crate"

Another instance of #32 😓

from cargo-intraconv.