Hello,

I started using the project (thank you!) and also packaged it to Arch User Repository

Arch Linux user can simply;

paru -S fsrx-git

Or using any other AUR helper they use. This can be added to the README.md if you'd like.

The -git tag (sorry if you already know this) says that the package tracks this repository directly. AUR Submission Guidelines says that the fsrx package can be submitted to AUR when there's an official release on upstream (here). On a potential fsrx, the AUR package will download the release .tar.gz (instead of cloning the repository) and build the package using that.

Currently the repository is using prereleases, if you'd like you can start releasing full releases (feedback: as far as I can tell the program is stable and ready for use) and that can be packaged as well

Cheers

Description

When the file is provided as an argument, the newlines are handled correctly. But when fsrx reads from standard input the newlines are stripped away.

To Reproduce

$ fsrx .bashrc # as expected
$ cat .bashrc | fsrx # a mess

Expected behavior

The newline handling should be consistent between those two methods.

Screenshots

Additional context

Fixing this would make it possible to use fmt to reflow incoming text to a managable width, like so:

$ fmt -w 60 long_lines.txt | fsrx | less -R

Right now the newlines created by fmt are deleted.

Problem

Some terminal themes slightly or greatly obscure the effect.

Hoping to request guidance at least for which settings could help replicate the awesome readme image : )

Solution

Examples of color settings, possibly hex codes for font, bold-font, and background for reproducing the readme image.

What:

Adds an installation part for Nix.

Why:

Improves user experience for users with nix installed.

How:

Checklist:

• [x] Allow edits from maintainers option checked
• [x] Branch name is prefixed with [your_username]/ (ex. thatvegandev/featureX)
• [x] Documentation added
• [ ] Tests added N/A
• [ ] No failing actions N/A
• [x] Merge ready

Add default feature to build bin Update cli to use fsrx_lib

Bump dependencies

What: Migrated the functionality of FSRX into a library that the CLI app uses to mark-up the text.

Why: Moving fsrx functionality into a library would allow it to be used as a dependency as well to offer the flow state reading conversion of any text. I was looking to add fsrx into my own fork of the himalaya command line webmail client and, instead of just piping the output to fsrx, I wanted to implement it as an output mode.

Another application would be to quickly make a wasm based browser extension to manipulate <p> tags on a website

How: I changed clap and atty to be feature dependent, added the cli feature and made it default. I then added a lib that provides the FSRXStyler struct that maintains contrast, fixation, saccade mode and regex snippet states. it provides publicly the style_line function which accepts a &str and returns a FSRX styled String

Checklist:

• [x] Allow edits from maintainers option checked
• [x] Branch name is prefixed with [your_username]/ (ex. thatvegandev/featureX)
• [ ] Documentation added
• [ ] Tests added
• [x] No failing actions
• [x] Merge ready

What:

Adds an installation part for Nix.

Why:

Improves user experience for users with nix installed.

How:

Checklist:

• [x] Allow edits from maintainers option checked
• [x] Branch name is prefixed with [your_username]/ (ex. thatvegandev/featureX)
• [x] Documentation added
• [ ] Tests added N/A
• [ ] No failing actions N/A
• [x] Merge ready

Closes #6.

Description

I've worked out how to use fsrx to speed up my reading of manpages. However, intermittently, I get an error when closing the pager.

$ echo "$MANPAGER"
col -bx | fsrx | ifne less -R
$ RUST_BACKTRACE="full" man man
thread 'main' panicked at 'failed printing to stdout: Broken pipe (os error 32)', library/std/src/io/stdio.rs:1016:9
stack backtrace:
   0:        0x10032b60c - <std::sys_common::backtrace::_print::DisplayBacktrace as core::fmt::Display>::fmt::ha610dc96df5533b5
   1:        0x10033dab8 - core::fmt::write::h85a0222d7173f527
   2:        0x100318834 - std::io::Write::write_fmt::h1e81e1aae1f60926
   3:        0x100320564 - std::panicking::default_hook::{{closure}}::hafcdd34daa6aee47
   4:        0x100320228 - std::panicking::default_hook::hbdef0c99978ce86d
   5:        0x100320a78 - std::panicking::rust_panic_with_hook::he857adbde651a96b
   6:        0x10032bbcc - std::panicking::begin_panic_handler::{{closure}}::h78d4b95de3b3c015
   7:        0x10032b720 - std::sys_common::backtrace::__rust_end_short_backtrace::h948efd9d51b5e877
   8:        0x100320678 - _rust_begin_unwind
   9:        0x10034a1d0 - core::panicking::panic_fmt::h4c391ad4ab25a9e0
  10:        0x100312004 - std::io::stdio::_print::hff0a1d2b7e1a5800
  11:        0x10026ab8c - fsrx::main::h55fca34d33cf796a
  12:        0x10026e77c - std::sys_common::backtrace::__rust_begin_short_backtrace::h389c28ebd38b79bf
  13:        0x10026e79c - std::rt::lang_start::{{closure}}::hcd3d64d5e1b5843b
  14:        0x100318288 - std::rt::lang_start_internal::h0a14a326db0de5c9
  15:        0x10026b72c - _main
$

Expected behavior

Everything works as desired except for the error at the end.

Environment

• OS: macOS-12.4
• Terminal Emulator: kitty
• Font: Iosevka Custom
• fsrx version: 1.0.2

Hey, first of all I wanted to thank you for this awesome application. Secondly, I just wanted to let you know that I recently packaged fsrx for nix. Perhaps you could add a small note to the README, so other nix users could know that it is packaged and ready to go.

What:

• Inputs with non-latin alphabets are now processed correctly.

Why:

• The original regex [\w\\']+ only matches latin alphabets, thus non-latin inputs were not processed at all.
• The &str.len() is not always the same as the length of the Unicode graphemes, and indices in style_substr were calculated wrongly for multibyte characters.

How:

• Changed the word-split algorithm from regex to unicode_word_indices
• Changed the character indexing from &str slice to UnicodeSegmentation::graphemes

Tests:

• English echo 'The Quick Brown Fox Jumps Over The Lazy Dog' | fsrx
• French echo "Le cœur déçu mais l'âme plutôt naïve, Louÿs rêva de crapaüter en canoë au-delà des îles, près du mälström où brûlent les novæ" | fsrx
• Korean echo '키스의 고유 조건은 입술끼리 만나야 하고 특별한 기술은 필요치 않다.' | fsrx

Checklist:

• [x] Allow edits from maintainers option checked
• [x] Branch name is prefixed with [your_username]/ (ex. coloradocolby/featureX)
• [x] Documentation added
• [x] Tests added
• [x] No failing actions
• [x] Merge ready

Caveat:

• I comfirmed that languages putting spaces between words are processed quite similarly to English. However, it seems that fsrx's algorithm (and Bionic Reading) cannot be applicable to some Asian languages that do not use spaces (such as Japanese and Chinese.)
• Some terminal emulators (e.g., Alacritty, if I remember correctly) may not properly support Unicode input / output. I tested my code with xfce4-terminal.
• For non-latin alphabets, I tested my code with D2Coding font, but other fonts such as Noto will work as well.