Anstyle-Roff by Calder-Ty · Pull Request #30 · rust-cli/anstyle

Calder-Ty · 2023-01-04T05:18:55Z

This is an Initial Stab at an implementation for a anstyle to roff converter. It uses the roff crate as the underlying engine. I went with using an intermediate "RoffStyle" struct, rather than converting directly to the roff::Roff struct, as the roff::Roff expects that there be text associated with it when you add certain effects (bold, italic and plain). Since anstyle::Style does not expect text, the RoffStyle can be created from Style and then text can be added later, prior to rendering the output.

Concerns:

Effects: ROFF (the tool) has support for more effects than what are implemented here. This is because roff (the crate) has limited support for inline escape sequences. Another issue is that roff (the crate) only allows for 1 effect to be applied at a time, via inline escapes. Multiple stylings may be possible via ROFF control requests, but they can have unintended results that are not seen with inline escapes. I'll have to experiment more with those.

Fixes #29

crates/anstyle-roff/Cargo.toml

crates/anstyle-roff/tests/test_roff.rs

crates/anstyle-roff/src/lib.rs

Calder-Ty · 2023-01-13T00:28:53Z

Thanks for your patience on this.

Calder-Ty · 2023-01-21T21:44:01Z

Any thoughts on these updates?

epage

Sorry for the delay, been putting in extra focus to get the toml release out

My main concern is that this overall feels like it has a lot of layers that make it harder to follow that seem like they could be removed.. I called out a few in my comments.

crates/anstyle-roff/src/lib.rs

crates/anstyle-roff/src/roff_styles.rs

crates/anstyle-roff/src/style_stream.rs

Calder-Ty · 2023-01-31T20:33:19Z

Sorry for the delay, been putting in extra focus to get the toml release out

No problem, sorry for the late response, end of month necessities have got my time limited. I'm going to try to get an update this week for this.

My main concern is that this overall feels like it has a lot of layers that make it harder to follow that seem like they could be
removed.. I called out a few in my comments.

I think those are valid critiques. I'll look at cleaning it up and simplifying it.

Initial stab at processing text and converting it into a Roff document

Extract the creation of effects form the generation of anstyle::Style for the style_stream.

This is really just a dataclass, so it's best to just make these public

There was a mistake in the way Underline was set during the StyledStr conversion.

epage

This is looking great, thanks!

crates/anstyle-roff/tests/roffs/rgb_color.roff

crates/anstyle-roff/tests/test_roff.rs

crates/anstyle-roff/src/lib.rs

inner isn't a good name, gave it a better one

Reflect that the primary value is not StyledStr

Calder-Ty · 2023-02-08T13:58:59Z

Fixed Commit Lint,
Removed owo-colors dependency
Changed Snapbox dependency to lower version for MSRV check

crates/anstyle-roff/src/lib.rs

crates/anstyle-roff/Cargo.toml

epage

This is great, thanks!

Just looking for clarification on snapbox and we can merge / release this!

crates/anstyle-roff/Cargo.toml

Cargo.toml

Calder-Ty · 2023-02-10T21:02:37Z

It doesn't like the merge commit. Would you like me to rebase and reword the merge commit? I can fix the Clippy mistakes, but not sure how you want to deal with the lint commit failure.

epage · 2023-02-10T21:27:56Z

It doesn't like the merge commit. Would you like me to rebase and reword the merge commit? I can fix the Clippy mistakes, but not sure how you want to deal with the lint commit failure.

I disallow merge commits, preferring rebasing.

However, I think I'm going to squash this PR so it doesn't matter.

Calder-Ty · 2023-02-10T21:48:30Z

Made the suggested clippy fixes. Thought about trying to fix the merge stuff, but since you are going to squash anyway, i'll let that deal with it.

epage · 2023-02-10T22:03:07Z

Well, I was going to squash...

Calder-Ty · 2023-02-10T22:06:23Z

Were you not able to squash? Hope I didn't screw it up.

Thanks for the feedback on the PR, been a lot of fun working on it!

This will allow crates like `clap_mangen` to render formatted text for man pages. Fixes #29

epage · 2023-02-10T22:08:42Z

Out of habit I merged, rather than squashed (the button is so easy; its right there).

Nice thing about a low visibility repo in its early stages is I can enable force pushes and rewrite history that only existed for 2 minutes...

epage · 2023-02-10T22:12:43Z

anstyle-roff-v0.1.0 is now out

Calder-Ty · 2023-02-10T22:28:09Z

Awesome!!

Coming soon: The Renovate bot (GitHub App) will be renamed to Mend. PRs from Renovate will soon appear from 'Mend'. Learn more [here](https://redirect.github.com/renovatebot/renovate/discussions/37842). This PR contains the following updates: | Package | Update | Change | |---|---|---| | [STABLE](https://redirect.github.com/rust-lang/rust) | minor | `1.89` -> `1.90` | --- ### Release Notes <details> <summary>rust-lang/rust (STABLE)</summary> ### [`v1.90`](https://redirect.github.com/rust-lang/rust/blob/HEAD/RELEASES.md#Version-1900-2025-09-18) [Compare Source](https://redirect.github.com/rust-lang/rust/compare/1.89.0...1.90.0) \=========================== <a id="1.90-Language"></a> ## Language - [Split up the `unknown_or_malformed_diagnostic_attributes` lint](https://redirect.github.com/rust-lang/rust/pull/140717). This lint has been split up into four finer-grained lints, with `unknown_or_malformed_diagnostic_attributes` now being the lint group that contains these lints: 1. `unknown_diagnostic_attributes`: unknown to the current compiler 2. `misplaced_diagnostic_attributes`: placed on the wrong item 3. `malformed_diagnostic_attributes`: malformed attribute syntax or options 4. `malformed_diagnostic_format_literals`: malformed format string literal - [Allow constants whose final value has references to mutable/external memory, but reject such constants as patterns](https://redirect.github.com/rust-lang/rust/pull/140942) - [Allow volatile access to non-Rust memory, including address 0](https://redirect.github.com/rust-lang/rust/pull/141260) <a id="1.90-Compiler"></a> ## Compiler - [Use `lld` by default on `x86_64-unknown-linux-gnu`](https://redirect.github.com/rust-lang/rust/pull/140525). - [Tier 3 `musl` targets now link dynamically by default](https://redirect.github.com/rust-lang/rust/pull/144410). Affected targets: - `mips64-unknown-linux-muslabi64` - `powerpc64-unknown-linux-musl` - `powerpc-unknown-linux-musl` - `powerpc-unknown-linux-muslspe` - `riscv32gc-unknown-linux-musl` - `s390x-unknown-linux-musl` - `thumbv7neon-unknown-linux-musleabihf` <a id="1.90-Platform-Support"></a> ## Platform Support - [Demote `x86_64-apple-darwin` to Tier 2 with host tools](https://redirect.github.com/rust-lang/rust/pull/145252) Refer to Rust's [platform support page][platform-support-doc] for more information on Rust's tiered platform support. [platform-support-doc]: https://doc.rust-lang.org/rustc/platform-support.html <a id="1.90-Libraries"></a> ## Libraries - [Stabilize `u*::{checked,overflowing,saturating,wrapping}_sub_signed`](https://redirect.github.com/rust-lang/rust/issues/126043) - [Allow comparisons between `CStr`, `CString`, and `Cow<CStr>`](https://redirect.github.com/rust-lang/rust/pull/137268) - [Remove some unsized tuple impls since unsized tuples can't be constructed](https://redirect.github.com/rust-lang/rust/pull/138340) - [Set `MSG_NOSIGNAL` for `UnixStream`](https://redirect.github.com/rust-lang/rust/pull/140005) - [`proc_macro::Ident::new` now supports `$crate`.](https://redirect.github.com/rust-lang/rust/pull/141996) - [Guarantee the pointer returned from `Thread::into_raw` has at least 8 bytes of alignment](https://redirect.github.com/rust-lang/rust/pull/143859) <a id="1.90-Stabilized-APIs"></a> ## Stabilized APIs - [`u{n}::checked_sub_signed`](https://doc.rust-lang.org/stable/std/primitive.usize.html#method.checked_sub_signed) - [`u{n}::overflowing_sub_signed`](https://doc.rust-lang.org/stable/std/primitive.usize.html#method.overflowing_sub_signed) - [`u{n}::saturating_sub_signed`](https://doc.rust-lang.org/stable/std/primitive.usize.html#method.saturating_sub_signed) - [`u{n}::wrapping_sub_signed`](https://doc.rust-lang.org/stable/std/primitive.usize.html#method.wrapping_sub_signed) - [`impl Copy for IntErrorKind`](https://doc.rust-lang.org/stable/std/num/enum.IntErrorKind.html#impl-Copy-for-IntErrorKind) - [`impl Hash for IntErrorKind`](https://doc.rust-lang.org/stable/std/num/enum.IntErrorKind.html#impl-Hash-for-IntErrorKind) - [`impl PartialEq<&CStr> for CStr`](https://doc.rust-lang.org/stable/std/ffi/struct.CStr.html#impl-PartialEq%3C%26CStr%3E-for-CStr) - [`impl PartialEq<CString> for CStr`](https://doc.rust-lang.org/stable/std/ffi/struct.CStr.html#impl-PartialEq%3CCString%3E-for-CStr) - [`impl PartialEq<Cow<CStr>> for CStr`](https://doc.rust-lang.org/stable/std/ffi/struct.CStr.html#impl-PartialEq%3CCow%3C'_,+CStr%3E%3E-for-CStr) - [`impl PartialEq<&CStr> for CString`](https://doc.rust-lang.org/stable/std/ffi/struct.CString.html#impl-PartialEq%3C%26CStr%3E-for-CString) - [`impl PartialEq<CStr> for CString`](https://doc.rust-lang.org/stable/std/ffi/struct.CString.html#impl-PartialEq%3CCStr%3E-for-CString) - [`impl PartialEq<Cow<CStr>> for CString`](https://doc.rust-lang.org/stable/std/ffi/struct.CString.html#impl-PartialEq%3CCow%3C'_,+CStr%3E%3E-for-CString) - [`impl PartialEq<&CStr> for Cow<CStr>`](https://doc.rust-lang.org/stable/std/borrow/enum.Cow.html#impl-PartialEq%3C%26CStr%3E-for-Cow%3C'_,+CStr%3E) - [`impl PartialEq<CStr> for Cow<CStr>`](https://doc.rust-lang.org/stable/std/borrow/enum.Cow.html#impl-PartialEq%3CCStr%3E-for-Cow%3C'_,+CStr%3E) - [`impl PartialEq<CString> for Cow<CStr>`](https://doc.rust-lang.org/stable/std/borrow/enum.Cow.html#impl-PartialEq%3CCString%3E-for-Cow%3C'_,+CStr%3E) These previously stable APIs are now stable in const contexts: - [`<[T]>::reverse`](https://doc.rust-lang.org/stable/std/primitive.slice.html#method.reverse) - [`f32::floor`](https://doc.rust-lang.org/stable/std/primitive.f32.html#method.floor) - [`f32::ceil`](https://doc.rust-lang.org/stable/std/primitive.f32.html#method.ceil) - [`f32::trunc`](https://doc.rust-lang.org/stable/std/primitive.f32.html#method.trunc) - [`f32::fract`](https://doc.rust-lang.org/stable/std/primitive.f32.html#method.fract) - [`f32::round`](https://doc.rust-lang.org/stable/std/primitive.f32.html#method.round) - [`f32::round_ties_even`](https://doc.rust-lang.org/stable/std/primitive.f32.html#method.round_ties_even) - [`f64::floor`](https://doc.rust-lang.org/stable/std/primitive.f64.html#method.floor) - [`f64::ceil`](https://doc.rust-lang.org/stable/std/primitive.f64.html#method.ceil) - [`f64::trunc`](https://doc.rust-lang.org/stable/std/primitive.f64.html#method.trunc) - [`f64::fract`](https://doc.rust-lang.org/stable/std/primitive.f64.html#method.fract) - [`f64::round`](https://doc.rust-lang.org/stable/std/primitive.f64.html#method.round) - [`f64::round_ties_even`](https://doc.rust-lang.org/stable/std/primitive.f64.html#method.round_ties_even) <a id="1.90-Cargo"></a> ## Cargo - [Add `http.proxy-cainfo` config for proxy certs](https://redirect.github.com/rust-lang/cargo/pull/15374/) - [Use `gix` for `cargo package`](https://redirect.github.com/rust-lang/cargo/pull/15534/) - [feat(publish): Stabilize multi-package publishing](https://redirect.github.com/rust-lang/cargo/pull/15636/) <a id="1.90-Rustdoc"></a> ## Rustdoc - [Add ways to collapse all impl blocks](https://redirect.github.com/rust-lang/rust/pull/141663). Previously the "Summary" button and "-" keyboard shortcut would never collapse `impl` blocks, now they do when shift is held - [Display unsafe attributes with `unsafe()` wrappers](https://redirect.github.com/rust-lang/rust/pull/143662) <a id="1.90-Compatibility-Notes"></a> ## Compatibility Notes - [Use `lld` by default on `x86_64-unknown-linux-gnu`](https://redirect.github.com/rust-lang/rust/pull/140525). See also <https://blog.rust-lang.org/2025/09/01/rust-lld-on-1.90.0-stable/>. - [Make `core::iter::Fuse`'s `Default` impl construct `I::default()` internally as promised in the docs instead of always being empty](https://redirect.github.com/rust-lang/rust/pull/140985) - [Set `MSG_NOSIGNAL` for `UnixStream`](https://redirect.github.com/rust-lang/rust/pull/140005) This may change program behavior but results in the same behavior as other primitives (e.g., stdout, network sockets). Programs relying on signals to terminate them should update handling of sockets to handle errors on write by exiting. - [On Unix `std::env::home_dir` will use the fallback if the `HOME` environment variable is empty](https://redirect.github.com/rust-lang/rust/pull/141840) - We now [reject unsupported `extern "{abi}"`s consistently in all positions](https://redirect.github.com/rust-lang/rust/pull/142134). This primarily affects the use of implementing traits on an `extern "{abi}"` function pointer, like `extern "stdcall" fn()`, on a platform that doesn't support that, like aarch64-unknown-linux-gnu. Direct usage of these unsupported ABI strings by declaring or defining functions was already rejected, so this is only a change for consistency. - [const-eval: error when initializing a static writes to that static](https://redirect.github.com/rust-lang/rust/pull/143084) - [Check that the `proc_macro_derive` macro has correct arguments when applied to the crate root](https://redirect.github.com/rust-lang/rust/pull/143607) </details> --- ### Configuration 📅 **Schedule**: Branch creation - Every minute ( * * * * * ) (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/epage/_rust).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

epage reviewed Jan 4, 2023

View reviewed changes

crates/anstyle-roff/Cargo.toml Outdated Show resolved Hide resolved

crates/anstyle-roff/tests/test_roff.rs Outdated Show resolved Hide resolved

crates/anstyle-roff/src/lib.rs Outdated Show resolved Hide resolved

Calder-Ty and others added 2 commits January 12, 2023 16:53

chore(roff): Setup anstyle-roff crate

2cec750

feat: Create style_stream to parse text to styles

9c43c35

Calder-Ty force-pushed the feat/29/anstyle-roff branch from 939a7d3 to e1c4131 Compare January 12, 2023 23:56

Calder-Ty changed the title ~~WIP: Anstyle-Roff~~ Anstyle-Roff Jan 16, 2023

Calder-Ty marked this pull request as draft January 16, 2023 11:52

Calder-Ty marked this pull request as ready for review January 16, 2023 18:25

epage reviewed Jan 24, 2023

View reviewed changes

Calder-Ty and others added 7 commits February 3, 2023 21:11

feat(roff): Implement into_iter for style_stream

dfefad0

feat(stream_parser): Use Stream parser for roff

287f773

Initial stab at processing text and converting it into a Roff document

test(roff): Add more tests

70bdd0c

refactor(roff): Extract create_effects

722c9da

Extract the creation of effects form the generation of anstyle::Style for the style_stream.

refactor(roff): Import anstyle namespacing

aca7ee0

fix(roff): Make styledstr fields public

aa7f093

This is really just a dataclass, so it's best to just make these public

fix(roff): Fix error in setting underline

01ec9a1

There was a mistake in the way Underline was set during the StyledStr conversion.

Calder-Ty force-pushed the feat/29/anstyle-roff branch from 42d1fb2 to 8c1a38c Compare February 4, 2023 04:18

epage reviewed Feb 6, 2023

View reviewed changes

Calder-Ty added 10 commits February 8, 2023 06:56

test(roff): Tests for cansi-anstyle conversion

2e86924

chore(roff): Apply rustfmt

45520c9

refactor(roff): Rename inner field

d5e2577

inner isn't a good name, gave it a better one

refactor: Remove roff_styles.rs

1e7ac6b

fix: Remove dbg statement

9b9a703

refactor: Eliminate RoffStyle

b8fe09f

refactor: Rename function

c2ce380

refactor: Do some formatting

fddb70a

refactor: Refactor some new functions

5fc4f89

refactor: Rename styled_stream module

cb1def3

Reflect that the primary value is not StyledStr

Calder-Ty added 2 commits February 8, 2023 06:57

docs(roff): Add doc-comments to styled_str

0d8ba3a

chore(roff): Drop owo-colors as dev dependency

9df6103

Calder-Ty force-pushed the feat/29/anstyle-roff branch from 1148458 to 9df6103 Compare February 8, 2023 13:57

epage reviewed Feb 8, 2023

View reviewed changes

crates/anstyle-roff/src/lib.rs Outdated Show resolved Hide resolved

Calder-Ty added 2 commits February 9, 2023 21:24

feat: Use non-lossy xterm conversion

ab39268

chore(tests): Pin snapbox-macros version

50fdc41

epage reviewed Feb 10, 2023

View reviewed changes

crates/anstyle-roff/Cargo.toml Outdated Show resolved Hide resolved

epage approved these changes Feb 10, 2023

View reviewed changes

epage reviewed Feb 10, 2023

View reviewed changes

crates/anstyle-roff/Cargo.toml Outdated Show resolved Hide resolved

chore(roff): Use workspace for cargo.toml data

5467348

epage reviewed Feb 10, 2023

View reviewed changes

Cargo.toml Show resolved Hide resolved

Cargo.toml Outdated Show resolved Hide resolved

Calder-Ty and others added 4 commits February 10, 2023 12:03

chore: Use workspace inheritance

9a99658

chore: Update MSRV to 1.64.0

c31faac

chore(roff): Fix categories in cargo.toml

cff8a5c

chore(roff): Fix malformed Cargo.toml

0d2c237

Calder-Ty force-pushed the feat/29/anstyle-roff branch from 8377762 to 0d2c237 Compare February 10, 2023 19:04

Merge branch 'main' into feat/29/anstyle-roff

0617b19

chore(roff): Fix clippy lints

5110e09

epage merged commit 42605f4 into rust-cli:main Feb 10, 2023

epage pushed a commit that referenced this pull request Feb 10, 2023

feat: Render ANSI codes as ROFF with anstyle-roff (#30)

84b3ba7

This will allow crates like `clap_mangen` to render formatted text for man pages. Fixes #29

Conversation

Calder-Ty commented Jan 4, 2023 • edited by epage Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Calder-Ty commented Jan 13, 2023

Uh oh!

Calder-Ty commented Jan 21, 2023

Uh oh!

epage left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Calder-Ty commented Jan 31, 2023

Uh oh!

epage left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Calder-Ty commented Feb 8, 2023

Uh oh!

Uh oh!

Uh oh!

epage left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Calder-Ty commented Feb 10, 2023

Uh oh!

epage commented Feb 10, 2023

Uh oh!

Calder-Ty commented Feb 10, 2023

Uh oh!

epage commented Feb 10, 2023

Uh oh!

Calder-Ty commented Feb 10, 2023

Uh oh!

epage commented Feb 10, 2023

Uh oh!

epage commented Feb 10, 2023

Uh oh!

Calder-Ty commented Feb 10, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Calder-Ty commented Jan 4, 2023 •

edited by epage

Loading