v0.21.8 (#716)

- Added vim-like scrolling as the default scrolling method. Set
`xplr.config.general.paginated_scrolling = false` to disable ~ by
@ElSamhaa & @sayanarijit.
- Added `xplr.config.general.scroll_padding` config option to set the
padding in vim-like scrolling ~ by @ElSamhaa & @sayanarijit.
- Fixed some color rendering issues ~ by @har7an.
- Added feature flag so that xplr can be build with system Lua ~ by
@nekopsykose.
- Fixed `ScrollUpHalf` behavior.
- `xplr.util.lscolor()` won't return nil anymore.
- Arguments passed to the custom dynamic layout Lua function will
include `scrolltop` field.
- Fixed node_type resolution for directories with `.` in their name ~ by
@abhinavnatarajan.
- Dependency updates.

.cargo/config

@@ -1,4 +1,14 @@
 # Why dynamic linking?
 # See https://github.com/sayanarijit/xplr/issues/309
+
 [target.x86_64-unknown-linux-gnu]
 rustflags = ["-C", "link-args=-rdynamic"]
+
+[target.aarch64-unknown-linux-gnu]
+rustflags = ["-C", "linker=aarch64-linux-gnu-gcc", "-C", "link-args=-rdynamic"]
+
+[target.aarch64-linux-android]
+rustflags = ["-C", "linker=aarch64-linux-android-clang", "-C", "link-args=-rdynamic", "-C", "default-linker-libraries"]
+
+[target.arm-unknown-linux-gnueabihf]
+rustflags = ["-C", "linker=arm-linux-gnueabihf-gcc", "-C", "link-args=-rdynamic"]

.codespellignore

@@ -0,0 +1,6 @@
+ratatui
+crate
+ser
+enque
+noice
+ans

.github/workflows/cd.yml

@@ -3,7 +3,7 @@ name: Continuous Deployment
 on:
   push:
     tags:
-      - 'v*.*.*'
+      - "v*.*.*"
   workflow_dispatch:
 
 jobs:
@@ -12,72 +12,84 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os:
-          - macos-latest
-          - ubuntu-latest
-          - ubuntu-20.04
+        build:
+          - macos
+          - macos-aarch64
+          - linux
+          - linux-musl
+          - linux-aarch64
+          - linux-arm
         rust: [stable]
         include:
-
           # See the list: https://github.com/cross-rs/cross
 
-          - os: macos-latest
-            artifact_prefix: macos
+          - build: macos
+            os: macos-latest
             target: x86_64-apple-darwin
-            binary_postfix: ''
 
-          - os: ubuntu-latest
-            artifact_prefix: linux
+          - build: macos-aarch64
+            os: macos-latest
+            target: aarch64-apple-darwin
+
+          - build: linux
+            os: ubuntu-latest
             target: x86_64-unknown-linux-gnu
-            binary_postfix: ''
 
-          - os: ubuntu-20.04
-            artifact_prefix: linux-musl
+          - build: linux-musl
+            os: ubuntu-latest
             target: x86_64-unknown-linux-musl
-            binary_postfix: ''
 
-          # Will see later
+          - build: linux-aarch64
+            os: ubuntu-latest
+            target: aarch64-unknown-linux-gnu
 
-          # - os: ubuntu-latest
-          #   artifact_prefix: x86_64-android
-          #   target: x86_64-linux-android
-          #   binary_postfix: ''
-          #
-          # - os: ubuntu-latest
-          #   artifact_prefix: aarch64-android
-          #   target: aarch64-linux-android
-          #   binary_postfix: ''
+          - build: linux-arm
+            os: ubuntu-latest
+            target: arm-unknown-linux-gnueabihf
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Installing Rust toolchain
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@stable
         with:
           toolchain: ${{ matrix.rust }}
           target: ${{ matrix.target }}
-          override: true
 
       - name: Installing needed macOS dependencies
         if: matrix.os == 'macos-latest'
         run: brew install openssl@1.1
 
       - name: Installing needed Ubuntu dependencies
-        if: matrix.os == 'ubuntu-latest' || matrix.os == 'ubuntu-20.04'
+        if: matrix.os == 'ubuntu-latest'
         run: |
-          sudo apt-get update
-          sudo apt-get install -y -qq pkg-config libssl-dev libxcb1-dev libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev
+          sudo apt-get update --fix-missing
+          sudo apt-get install -y --no-install-recommends liblua5.1-0-dev libluajit-5.1-dev gcc pkg-config curl git make ca-certificates
+          sudo apt-get install -y snapd
+          # sudo snap install snapcraft --classic
+          # sudo snap install multipass --classic --beta
 
-      - name: Checking out sources
-        uses: actions/checkout@v1
+      - if: matrix.build == 'linux-musl'
+        run: sudo apt-get install -y musl-tools
+
+      - if: matrix.build == 'linux-aarch64'
+        run: sudo apt-get install -y gcc-aarch64-linux-gnu
+
+      - if: matrix.build == 'linux-arm'
+        run: |
+          sudo apt-get install -y gcc-multilib
+          sudo apt-get install -y gcc-arm-linux-gnueabihf
+          sudo ln -s /usr/include/asm-generic/ /usr/include/asm
 
       - name: Running cargo build
-        uses: actions-rs/cargo@v1
-        with:
-          use-cross: true
-          command: build
-          toolchain: ${{ matrix.rust }}
-          args: --locked --release --target ${{ matrix.target }}
+        run: cargo build --locked --release --target ${{ matrix.target }}
+
+      # - name: Running snapcraft build
+      #   run: |
+      #     snapcraft
+      #     printf ' [ INFO ] generated <snapcraft> files include:\n'
+      #     command ls -Al | grep "\.snap" | awk '{ print $9 }'
+      #     mv ./*.snap ./xplr.snap
 
       - name: Install gpg secret key
         run: |
@@ -88,9 +100,8 @@ jobs:
         shell: bash
         run: |
           cd target/${{ matrix.target }}/release
-          BINARY_NAME=xplr${{ matrix.binary_postfix }}
-          strip $BINARY_NAME
-          RELEASE_NAME=xplr-${{ matrix.artifact_prefix }}
+          BINARY_NAME=xplr
+          RELEASE_NAME=$BINARY_NAME-${{ matrix.build }}
           tar czvf $RELEASE_NAME.tar.gz $BINARY_NAME
           shasum -a 256 $RELEASE_NAME.tar.gz > $RELEASE_NAME.sha256
           cat <(echo "${{ secrets.GPG_PASS }}") | gpg --pinentry-mode loopback --passphrase-fd 0 --detach-sign --armor $RELEASE_NAME.tar.gz
@@ -99,17 +110,23 @@ jobs:
         uses: softprops/action-gh-release@v1
         with:
           files: |
-            target/${{ matrix.target }}/release/xplr-${{ matrix.artifact_prefix }}.tar.gz
-            target/${{ matrix.target }}/release/xplr-${{ matrix.artifact_prefix }}.sha256
-            target/${{ matrix.target }}/release/xplr-${{ matrix.artifact_prefix }}.tar.gz.asc
+            target/${{ matrix.target }}/release/xplr-${{ matrix.build }}.tar.gz
+            target/${{ matrix.target }}/release/xplr-${{ matrix.build }}.sha256
+            target/${{ matrix.target }}/release/xplr-${{ matrix.build }}.tar.gz.asc
+            xplr.snap
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
+      # - name: Cleaning snapcraft
+      #   run: |
+      #     command rm --verbose ./*.snap
+      #     snapcraft clean
+
   publish-gpg-signature:
     name: Publishing GPG signature
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Install gpg secret key
         run: |
           cat <(echo -e "${{ secrets.GPG_SECRET }}") | gpg --batch --import
@@ -134,20 +151,16 @@ jobs:
     name: Publishing to Cargo
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
-      - uses: actions-rs/toolchain@v1
+      - uses: dtolnay/rust-toolchain@stable
         with:
           toolchain: stable
-          override: true
 
       - run: |
-          sudo apt-get update
+          sudo apt-get update --fix-missing
           sudo apt-get install -y -qq pkg-config libssl-dev libxcb1-dev libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev
 
-      - uses: actions-rs/cargo@v1
-        with:
-          command: publish
-          args: --allow-dirty
+      - run: cargo publish --allow-dirty
         env:
           CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_API_KEY }}

.github/workflows/ci.yml

@@ -11,120 +11,134 @@ jobs:
     name: Check
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions-rs/toolchain@v1
+      - uses: actions/checkout@v3
+      - uses: dtolnay/rust-toolchain@stable
         with:
           toolchain: stable
-          profile: minimal
-          override: true
-      - uses: actions-rs/cargo@v1
+      - run: cargo check
+
+  fmt:
+    name: Rustfmt
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          toolchain: stable
+          components: rustfmt
+      - run: cargo fmt --all -- --check
+
+  clippy:
+    name: Clippy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: dtolnay/rust-toolchain@stable
         with:
-          command: check
+          toolchain: stable
+          components: clippy
+      - run: cargo clippy -- -D warnings
+
+  spellcheck:
+    name: Spellcheck
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: codespell-project/actions-codespell@v1
+        with:
+          ignore_words_file: .codespellignore
 
   test:
     name: Test Suite
     runs-on: ${{ matrix.os }}
+    needs:
+      - check
+      - fmt
+      - clippy
+      - spellcheck
     strategy:
       matrix:
-        os:
-          - macos-latest
-          - ubuntu-latest
-          - ubuntu-20.04
+        build:
+          - macos
+          - macos-aarch64
+          - linux
+          - linux-musl
+          - linux-aarch64
+          - linux-arm
         rust: [stable]
         include:
-          - os: macos-latest
-            artifact_prefix: macos
+          # See the list: https://github.com/cross-rs/cross
+
+          - build: macos
+            os: macos-latest
             target: x86_64-apple-darwin
-            binary_postfix: ''
-          - os: ubuntu-latest
-            artifact_prefix: linux
+
+          - build: macos-aarch64
+            os: macos-latest
+            target: aarch64-apple-darwin
+
+          - build: linux
+            os: ubuntu-latest
             target: x86_64-unknown-linux-gnu
-            binary_postfix: ''
-          - os: ubuntu-20.04
-            artifact_prefix: linux-musl
+
+          - build: linux-musl
+            os: ubuntu-latest
             target: x86_64-unknown-linux-musl
-            binary_postfix: ''
+
+          - build: linux-aarch64
+            os: ubuntu-latest
+            target: aarch64-unknown-linux-gnu
+
+          - build: linux-arm
+            os: ubuntu-latest
+            target: arm-unknown-linux-gnueabihf
 
     env:
       RUST_BACKTRACE: full
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Installing Rust toolchain
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@stable
         with:
           toolchain: ${{ matrix.rust }}
           target: ${{ matrix.target }}
-          override: true
 
       - name: Installing needed macOS dependencies
         if: matrix.os == 'macos-latest'
         run: brew install openssl@1.1
 
       - name: Installing needed Ubuntu dependencies
-        if: matrix.os == 'ubuntu-latest' || matrix.os == 'ubuntu-20.04'
+        if: matrix.os == 'ubuntu-latest'
         run: |
-          sudo apt-get update
-          sudo apt-get install -y -qq pkg-config libssl-dev libxcb1-dev libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev
+          sudo apt-get update --fix-missing
+          sudo apt-get install -y --no-install-recommends liblua5.1-0-dev libluajit-5.1-dev gcc pkg-config curl git make ca-certificates
 
-      - name: Build
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
-          toolchain: ${{ matrix.rust }}
-          args: --target ${{ matrix.target }}
+      - if: matrix.build == 'linux-musl'
+        run: sudo apt-get install -y musl-tools
 
-      - name: Test
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
-          toolchain: ${{ matrix.rust }}
-          args: --target ${{ matrix.target }}
+      - if: matrix.build == 'linux-aarch64'
+        run: sudo apt-get install -y gcc-aarch64-linux-gnu
+
+      - if: matrix.build == 'linux-arm'
+        run: |
+          sudo apt-get install -y gcc-multilib
+          sudo apt-get install -y gcc-arm-linux-gnueabihf
+          sudo ln -s /usr/include/asm-generic/ /usr/include/asm
+
+      - run: cargo build --target ${{ matrix.target }}
+
+      - if: matrix.build == 'macos' || matrix.build == 'linux'
+        run: cargo test --target ${{ matrix.target }}
 
   # bench:
   #   name: Benchmarks
   #   runs-on: ubuntu-latest
   #   steps:
-  #     - uses: actions/checkout@v2
-  #     - uses: actions-rs/toolchain@v1
+  #     - uses: actions/checkout@v3
+  #     - uses: dtolnay/rust-toolchain@stable
   #       with:
   #         toolchain: stable
-  #         profile: minimal
-  #         override: true
   #     # These dependencies are required for `clipboard`
   #     - run: sudo apt-get install -y -qq libxcb1-dev libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev
-  #     - uses: actions-rs/cargo@v1
-  #       with:
-  #         command: bench
-
-  fmt:
-    name: Rustfmt
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions-rs/toolchain@v1
-        with:
-          toolchain: stable
-          profile: minimal
-          override: true
-          components: rustfmt
-      - uses: actions-rs/cargo@v1
-        with:
-          command: fmt
-          args: --all -- --check
-
-  clippy:
-    name: Clippy
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions-rs/toolchain@v1
-        with:
-          toolchain: stable
-          profile: minimal
-          override: true
-          components: clippy
-      - uses: actions-rs/cargo@v1
-        with:
-          command: clippy
-          args: -- -D warnings
+  #     - run: cargo bench

.gitignore

@@ -17,3 +17,6 @@ book/
 
 # direnv
 .direnv/
+
+# nix
+result

Cargo.toml

@@ -8,7 +8,7 @@ path = './benches/criterion.rs'
 
 [package]
 name = 'xplr'
-version = '0.20.1'
+version = '0.21.8'
 authors = ['Arijit Basu <hi@arijitbasu.in>']
 edition = '2021'
 description = 'A hackable, minimal, fast TUI file explorer'
@@ -22,20 +22,31 @@ categories = ['command-line-interface', 'command-line-utilities']
 include = ['src/**/*', 'docs/en/src/**/*', 'LICENSE', 'README.md']
 
 [dependencies]
-libc = "0.2.138"
-humansize = "2.1.2"
+libc = "0.2.153"
+humansize = "2.1.3"
 natord = "1.0.9"
-anyhow = "1.0.66"
-serde_yaml = "0.9.14"
-crossterm = "0.25.0"
-dirs = "4.0.0"
-ansi-to-tui = "2.0.0"
-regex = "1.7.0"
-gethostname = "0.4.1"
-fuzzy-matcher = "0.3.7"
-serde_json = "1.0.89"
-path-absolutize = "3.0.14"
-which = "4.3.0"
+anyhow = "1.0.81"
+serde_yaml = "0.9.33"
+crossterm = { version = "0.27.0", features = [], default-features = false }
+ansi-to-tui = "3.1.0"
+regex = "1.10.3"
+gethostname = "0.4.3"
+serde_json = "1.0.114"
+path-absolutize = "3.1.1"
+which = "6.0.0"
+nu-ansi-term = "0.50.0"
+textwrap = "0.16"
+snailquote = "0.3.1"
+skim = { version = "0.10.4", default-features = false }
+time = { version = "0.3.34", features = ["serde", "local-offset", "formatting", "macros"] }
+jf = "0.6.2"
+xdg = "2.5.2"
+home = "0.5.9"
+
+[dependencies.lscolors]
+version = "0.17.0"
+default-features = false
+features = ["nu-ansi-term"]
 
 [dependencies.lazy_static]
 version = "1.4.0"
@@ -43,40 +54,41 @@ default-features = false
 
 [dependencies.mime_guess]
 version = "2.0.4"
-features = ["rev-mappings"]
+default-features = false
 
 [dependencies.tui]
-version = "0.19.0"
+version = "=0.26.1"  # https://github.com/ratatui-org/ratatui/issues/1032
 default-features = false
 features = ['crossterm', 'serde']
+package = 'ratatui'
 
 [dependencies.serde]
-version = "1.0.148"
-features = ['derive']
-
-[dependencies.chrono]
-version = "0.4.23"
-features = ['serde']
+version = "1.0.197"
+features = []
+default-features = false
 
 [dependencies.indexmap]
-version = "1.9.2"
+version = "2.2.5"
 features = ['serde']
 
 [dependencies.mlua]
-version = "0.8.6"
-features = ['luajit', 'vendored', 'serialize', 'send']
+version = "0.9.6"
+features = ['luajit', 'serialize', 'send']
 
 [dependencies.tui-input]
-version = "0.6.1"
+version = "0.8.0"
 features = ['serde']
 
 [dev-dependencies]
-criterion = "0.4.0"
-assert_cmd = "2.0.7"
+criterion = "0.5.1"
+assert_cmd = "2.0.14"
 
 [profile.release]
 lto = true
 codegen-units = 1
 panic = 'abort'
+strip = true
 
 [features]
+default = ["vendored-lua"]
+vendored-lua = ["mlua/vendored"]

README.md

@@ -12,18 +12,6 @@ A hackable, minimal, fast TUI file explorer
 <img src="https://img.shields.io/crates/v/xplr.svg" />
 </a>
 
-<a href="https://github.com/sayanarijit/xplr/commits">
-<img src="https://img.shields.io/github/commit-activity/m/sayanarijit/xplr" />
-</a>
-
-<a href="https://matrix.to/#/#xplr-pub:matrix.org">
-<img alt="Matrix" src="https://img.shields.io/matrix/xplr-pub:matrix.org?color=0DB787&label=matrix&logo=Matrix">
-</a>
-  
-<a href="https://discord.gg/JmasSPCcz3">
-<img src="https://img.shields.io/discord/834369918312382485?color=5865F2&label=discord&logo=Discord" />
-</a>
-
 </p>
 
 <p align="center">
@@ -38,7 +26,6 @@ https://user-images.githubusercontent.com/11632726/166747867-8a4573f2-cb2f-43a6-
   [<a href="https://xplr.dev/en/awesome-hacks">Hacks</a>]
   [<a href="https://xplr.dev/en/awesome-plugins">Plugins</a>]
   [<a href="https://xplr.dev/en/awesome-integrations">Integrations</a>]
-  [<a href="https://xplr.dev/en/community">Community</a>]
 </h3>
 
 xplr is a terminal UI based file explorer that aims to increase our terminal
@@ -60,6 +47,8 @@ integration][15], enabling you to achieve insane terminal productivity.
 
 - [[Article] What is a TUI file explorer & why would you need one? ~ xplr.stck.me](https://xplr.stck.me/post/25252/What-is-a-TUI-file-explorer-why-would-you-need-one)
 
+- [[Article] FOSSPicks - Linux Magazine](<https://www.linux-magazine.com/Issues/2022/258/FOSSPicks/(offset)/6>)
+
 ## Packaging
 
 Package maintainers please refer to the [RELEASE.md](./RELEASE.md).

RELEASE.md

@@ -3,8 +3,8 @@
 See [install.md](./docs/en/src/install.md#build-from-source)
 
 Note: xplr ships with vendored luajit. If the platform can't compile this,
-you need to grep out the feature "vendored" from the "mlua" dependency
-specified in [Cargo.toml](./Cargo.toml), and static link luajit yourself.
+you need to compile using `--no-default-features` argument to avoid using
+vendored luajit, so that you can static link luajit yourself.
 
 # Release
 

benches/criterion.rs

@@ -18,8 +18,9 @@ fn navigation_benchmark(c: &mut Criterion) {
     });
 
     let lua = mlua::Lua::new();
-    let mut app = app::App::create(PWD.into(), &lua, None, [].into())
-        .expect("failed to create app");
+    let mut app =
+        app::App::create("xplr".into(), None, PWD.into(), &lua, None, [].into())
+            .expect("failed to create app");
 
     app = app
         .clone()
@@ -97,8 +98,10 @@ fn draw_benchmark(c: &mut Criterion) {
     });
 
     let lua = mlua::Lua::new();
-    let mut app = app::App::create(PWD.into(), &lua, None, [].into())
-        .expect("failed to create app");
+    let mut ui = ui::UI::new(&lua);
+    let mut app =
+        app::App::create("xplr".into(), None, PWD.into(), &lua, None, [].into())
+            .expect("failed to create app");
 
     app = app
         .clone()
@@ -119,7 +122,7 @@ fn draw_benchmark(c: &mut Criterion) {
 
     c.bench_function("draw on terminal", |b| {
         b.iter(|| {
-            terminal.draw(|f| ui::draw(f, &app, &lua)).unwrap();
+            terminal.draw(|f| ui.draw(f, &app)).unwrap();
         })
     });
 

docs/en/src/SUMMARY.md

@@ -10,6 +10,7 @@
   - [Layouts][9]
   - [Modes][7]
 - [Concept][32]
+  - [Sum Type][42]
   - [Key Bindings][27]
     - [Configure Key Bindings][28]
     - [Default Key Bindings][14]
@@ -22,6 +23,7 @@
     - [Input Operation][39]
   - [Borders][31]
   - [Style][11]
+  - [Searching][41]
   - [Sorting][12]
   - [Filtering][13]
   - [Column Renderer][26]
@@ -37,8 +39,6 @@
   - [Awesome Integrations][20]
 - [Alternatives][22]
 - [Upgrade Guide][23]
-- [Community][24]
-- [Contribute][25]
 
 [1]: introduction.md
 [2]: quickstart.md
@@ -62,8 +62,6 @@
 [20]: awesome-integrations.md
 [22]: alternatives.md
 [23]: upgrade-guide.md
-[24]: community.md
-[25]: contribute.md
 [26]: column-renderer.md
 [27]: key-bindings.md
 [28]: configure-key-bindings.md
@@ -79,3 +77,5 @@
 [38]: messages.md
 [39]: input-operation.md
 [40]: xplr.util.md
+[41]: searching.md
+[42]: sum-type.md

docs/en/src/alternatives.md

@@ -14,6 +14,8 @@ These are the alternative TUI/CLI file managers/explorers you might want to chec
 - [noice][10]
 - [clifm][11]
 - [clifm][12] (non curses)
+- [felix][14]
+- [yazi][15]
 
 [add more][13]
 
@@ -29,4 +31,6 @@ These are the alternative TUI/CLI file managers/explorers you might want to chec
 [10]: https://git.2f30.org/noice/
 [11]: https://github.com/pasqu4le/clifm
 [12]: https://github.com/leo-arch/clifm
-[13]: community.md
+[13]: https://github.com/sayanarijit/xplr/edit/dev/docs/en/src/alternatives.md
+[14]: https://github.com/kyoheiu/felix
+[15]: https://github.com/sxyazi/yazi

docs/en/src/awesome-hacks.md

@@ -6,9 +6,9 @@ too small or too niche for a full fledge [plugin][2].
 
 Do you have something cool to share?
 
-[Edit this file][3] or [share them here][4] or [let us know][5].
+[Edit this file][3] or [share them here][4].
 
-You can try these hacks by writing them to a file, say `hack.lua` and passsing
+You can try these hacks by writing them to a file, say `hack.lua` and passing
 it to xplr with `--extra-config` or `-C`.
 
 ```bash
@@ -135,7 +135,14 @@ bookmark can be added, deleted, or jumped to.
 - Tested on: MacOS
 
 ```lua
+-- With `export XPLR_BOOKMARK_FILE="$HOME/bookmarks"`
 -- Bookmark: mode binding
+xplr.config.modes.builtin.default.key_bindings.on_key["b"] = {
+  help = "bookmark mode",
+  messages = {
+    { SwitchModeCustom = "bookmark" },
+  },
+}
 xplr.config.modes.custom.bookmark = {
   name = "bookmark",
   key_bindings = {
@@ -143,12 +150,13 @@ xplr.config.modes.custom.bookmark = {
       m = {
         help = "bookmark dir",
         messages = {
-          { BashExecSilently0 = [[
+          {
+            BashExecSilently0 = [[
               PTH="${XPLR_FOCUS_PATH:?}"
               if [ -d "${PTH}" ]; then
                 PTH="${PTH}"
               elif [ -f "${PTH}" ]; then
-                PTH="$(dirname "${PTH}")"
+                PTH=$(dirname "${PTH}")
               fi
               PTH_ESC=$(printf %q "$PTH")
               if echo "${PTH:?}" >> "${XPLR_BOOKMARK_FILE:?}"; then
@@ -156,8 +164,9 @@ xplr.config.modes.custom.bookmark = {
               else
                 "$XPLR" -m 'LogError: %q' "Failed to bookmark $PTH_ESC"
               fi
-            ]]
+            ]],
           },
+          "PopMode",
         },
       },
       g = {
@@ -169,18 +178,21 @@ xplr.config.modes.custom.bookmark = {
               if [ "$PTH" ]; then
                 "$XPLR" -m 'FocusPath: %q' "$PTH"
               fi
-            ]===]
+            ]===],
           },
+          "PopMode",
         },
       },
       d = {
         help = "delete bookmark",
         messages = {
-          { BashExec0 = [[
+          {
+            BashExec0 = [[
               PTH=$(cat "${XPLR_BOOKMARK_FILE:?}" | fzf --no-sort)
               sd "$PTH\n" "" "${XPLR_BOOKMARK_FILE:?}"
-            ]]
+            ]],
           },
+          "PopMode",
         },
       },
       esc = {
@@ -192,6 +204,7 @@ xplr.config.modes.custom.bookmark = {
     },
   },
 }
+
 ```
 
 </details>
@@ -410,7 +423,7 @@ Preview text files in a native xplr pane (should be fast enough).
 
 ```lua
 local function stat(node)
-  return node.mime_essence
+  return xplr.util.to_yaml(xplr.util.node(node.absolute_path))
 end
 
 local function read(path, height)
@@ -439,8 +452,29 @@ local function read(path, height)
   return res
 end
 
+xplr.fn.custom.preview_pane = {}
+xplr.fn.custom.preview_pane.render = function(ctx)
+  local title = nil
+  local body = ""
+  local n = ctx.app.focused_node
+  if n and n.canonical then
+    n = n.canonical
+  end
 
-xplr.config.layouts.builtin.default = {
+  if n then
+    title = { format = n.absolute_path, style = xplr.util.lscolor(n.absolute_path) }
+    if n.is_file then
+      body = read(n.absolute_path, ctx.layout_size.height) or stat(n)
+    else
+      body = stat(n)
+    end
+  end
+
+  return { CustomParagraph = { ui = { title = title }, body = body } }
+end
+
+local preview_pane = { Dynamic = "custom.preview_pane.render" }
+local split_preview = {
   Horizontal = {
     config = {
       constraints = {
@@ -450,34 +484,13 @@ xplr.config.layouts.builtin.default = {
     },
     splits = {
       "Table",
-      {
-        CustomContent = {
-          title = "preview",
-          body = { DynamicParagraph = { render = "custom.preview_pane.render" } },
-        },
-      },
+      preview_pane,
     },
   },
 }
 
-xplr.fn.custom.preview_pane = {}
-xplr.fn.custom.preview_pane.render = function(ctx)
-  local n = ctx.app.focused_node
-
-  if n and n.canonical then
-    n = n.canonical
-  end
-
-  if n then
-    if n.is_file then
-      return read(n.absolute_path, ctx.layout_size.height)
-    else
-      return stat(n)
-    end
-  else
-    return ""
-  end
-end
+xplr.config.layouts.builtin.default =
+    xplr.util.layout_replace(xplr.config.layouts.builtin.default, "Table", split_preview)
 ```
 
 </details>
@@ -497,7 +510,7 @@ Navigate using the [tere][19] file explorer (defaults to type-to-nav system).
 xplr.config.modes.builtin.default.key_bindings.on_key.T = {
   help = "tere nav",
   messages = {
-    { BashExec0 = [[xplr -m 'ChangeDirectory: %q' "$(tere)"]] },
+    { BashExec0 = [["$XPLR" -m 'ChangeDirectory: %q' "$(tere)"]] },
   },
 }
 ```
@@ -513,7 +526,6 @@ xplr.config.modes.builtin.default.key_bindings.on_key.T = {
 [2]: plugin.md
 [3]: https://github.com/sayanarijit/xplr/edit/main/docs/en/src/awesome-hacks.md
 [4]: https://github.com/sayanarijit/xplr/discussions/categories/show-and-tell
-[5]: community.md
 [6]: https://gifyu.com/image/rGSR
 [7]: https://s4.gifyu.com/images/xplr-bookmark.gif
 [8]: https://github.com/sayanarijit

docs/en/src/awesome-plugins.md

@@ -11,14 +11,16 @@ of the following plugins work for you, it's very easy to
 - [**sayanarijit/dual-pane.xplr**][43] Implements support for dual-pane navigation into xplr.
 - [**sayanarijit/map.xplr**][38] Visually inspect and interactively execute batch commands using xplr.
 - [**sayanarijit/offline-docs.xplr**][51] Fetch the appropriate version of xplr docs and browse offline.
-- [**sayanarijit/regex-search.xplr**][55] Bring back the regex based seach in xplr.
+- [**sayanarijit/regex-search.xplr**][55] Bring back the regex based search in xplr.
 - [**sayanarijit/registers.xplr**][49] Use multiple registers to store the selected paths.
+- [**sayanarijit/tree-view.xplr**][61] Hackable tree view for xplr
 - [**sayanarijit/tri-pane.xplr**][56] xplr plugin that implements ranger-like three pane layout.
 - [**sayanarijit/type-to-nav.xplr**][28] Inspired by [nnn's type-to-nav mode][29] for xplr,
   with some tweaks.
-- [**igorepst/term.xplr**][39] Terminal integration for xplr
+- [**dtomvan/term.xplr**][39] Terminal integration for xplr.
 - [**sayanarijit/wl-clipboard.xplr**][52] Copy and paste with system clipboard using wl-clipboard
-- [**dtomvan/xpm.xplr**][47] The XPLR Plugin Manager
+- [**dtomvan/xpm.xplr**][47] The XPLR Plugin Manager.
+- [**emsquid/style.xplr**][57] Helper plugin that allows you to integrate xplr's [Style][58] anywhere.
 
 ### Integration
 
@@ -26,9 +28,9 @@ of the following plugins work for you, it's very easy to
 - [**sayanarijit/dragon.xplr**][4] Drag and drop files using [dragon][5].
 - [**sayanarijit/dua-cli.xplr**][6] Get the disk usage using [dua-cli][7] with selection
   support.
-- [**sayanarijit/fzf.xplr**][8] Fuzzy search using [fzf][9] to focus on a file or enter
+- [**sayanarijit/fzf.xplr**][8] Fuzzy search using [fzf][9] to focus on a file or enter.
 - [**sayanarijit/find.xplr**][44] An interactive finder plugin to complement [map.xplr][38].
-- [**Junker/nuke.xplr**][53] Open files in apps by file type or mime
+- [**Junker/nuke.xplr**][53] Open files in apps by file type or mime.
 - [**sayanarijit/nvim-ctrl.xplr**][35] Send files to running Neovim sessions using
   [nvim-ctrl][36].
 - [**dtomvan/ouch.xplr**][40] This plugin uses [ouch][41] to compress and decompress files.
@@ -39,8 +41,6 @@ of the following plugins work for you, it's very easy to
 - [**sayanarijit/qrcp.xplr**][26] Send and receive files via QR code using [qrcp][27].
 - [**sayanarijit/scp.xplr**][54] Integrate xplr with scp.
 - [**sayanarijit/trash-cli.xplr**][13] Trash files and directories using [trash-cli][14].
-- [**sayanarijit/xargs.xplr**][22] Batch execute commands on the focused or selected files
-  using `xargs`.
 - [**sayanarijit/xclip.xplr**][15] Copy and paste with system clipboard using [xclip][16].
 - [**sayanarijit/zoxide.xplr**][17] Change directory using the [zoxide][18] database.
 
@@ -49,9 +49,14 @@ of the following plugins work for you, it's very easy to
 - [**sayanarijit/material-landscape.xplr**][19] Material Landscape
 - [**sayanarijit/material-landscape2.xplr**][20] Material Landscape 2
 - [**sayanarijit/zentable.xplr**][31] A clean, distraction free xplr table UI
+- [**dy-sh/dysh-style.xplr**][63] Complements xplr theme with icons and highlighting.
 - [**prncss-xyz/icons.xplr**][30] An icon theme for xplr.
 - [**dtomvan/extra-icons.xplr**][50] Adds more icons to icons.xplr, compatible
   with zentable.xplr.
+- [**hartan/web-devicons.xplr**][59] Adds [nvim-web-devicons][60] to xplr with
+  optional coloring
+- [**duganchen/one-table-column.xplr**][62] Moves file stats to a status bar.
+- [**dy-sh/get-rid-of-index.xplr**][64] Removes the index column.
 
 ## Also See:
 
@@ -95,7 +100,7 @@ of the following plugins work for you, it's very easy to
 [36]: https://github.com/chmln/nvim-ctrl
 [37]: https://github.com/sayanarijit/command-mode.xplr
 [38]: https://github.com/sayanarijit/map.xplr
-[39]: https://github.com/igorepst/term.xplr
+[39]: https://github.com/dtomvan/term.xplr
 [40]: https://github.com/dtomvan/ouch.xplr
 [41]: https://github.com/ouch-org/ouch
 [42]: https://github.com/igorepst/context-switch.xplr
@@ -113,3 +118,11 @@ of the following plugins work for you, it's very easy to
 [54]: https://github.com/sayanarijit/scp.xplr
 [55]: https://github.com/sayanarijit/regex-search.xplr
 [56]: https://github.com/sayanarijit/tri-pane.xplr
+[57]: https://github.com/emsquid/style.xplr
+[58]: style.md
+[59]: https://gitlab.com/hartan/web-devicons.xplr
+[60]: https://github.com/nvim-tree/nvim-web-devicons
+[61]: https://github.com/sayanarijit/tree-view.xplr
+[62]: https://github.com/duganchen/one-table-column.xplr
+[63]: https://github.com/dy-sh/dysh-style.xplr
+[64]: https://github.com/dy-sh/get-rid-of-index.xplr

docs/en/src/borders.md

@@ -4,21 +4,25 @@ xplr allows customizing the shape and style of the borders.
 
 ### Border
 
-A border can be one of the following:
+A border is a [sum type][2] that can be one of the following:
 
-- Top
-- Right
-- Bottom
-- Left
+- "Top"
+- "Right"
+- "Bottom"
+- "Left"
 
 ### Border Type
 
-A border can be one of the following:
+A border type is a [sum type][2] that can be one of the following:
 
-- Plain
-- Rounded
-- Double
-- Thick
+- "Plain"
+- "Rounded"
+- "Double"
+- "Thick"
+
+### Border Style
+
+The [style][1] of the borders.
 
 ## Example
 
@@ -28,3 +32,6 @@ xplr.config.general.panel_ui.default.border_type = "Thick"
 xplr.config.general.panel_ui.default.border_style.fg = "Black"
 xplr.config.general.panel_ui.default.border_style.bg = "Gray"
 ```
+
+[1]: style.md#style
+[2]: sum-type.md

docs/en/src/column-renderer.md

@@ -73,6 +73,7 @@ The special argument contains the following fields
 - [is_selected][25]
 - [is_focused][26]
 - [total][27]
+- [style][38]
 - [meta][28]
 
 ### parent
@@ -254,6 +255,12 @@ Type: integer
 
 The total number of the nodes.
 
+### style
+
+Type: [Style][39]
+
+The applicable [style object][39] for the node.
+
 ### meta
 
 Type: mapping of string and string
@@ -333,3 +340,5 @@ It contains the following fields.
 [35]: #last_modified
 [36]: #uid
 [37]: #gid
+[38]: #style
+[39]: style.md#style

docs/en/src/community.md

@@ -1,12 +0,0 @@
-# Community
-
-Building an active community of awesome people and learning stuff together is
-one of my reasons to publish this tool and maintain it. Hence, please feel free
-to reach out via your preferred way.
-
-- Real-time chat lovers can join our [**matrix room**][3] or [**discord channel**][1].
-- Forum discussion veterans can [**start a new GitHub discussion**][2].
-
-[1]: https://discord.gg/JmasSPCcz3
-[2]: https://github.com/sayanarijit/xplr/discussions
-[3]: https://matrix.to/#/#xplr-pub:matrix.org

docs/en/src/configuration.md

@@ -115,5 +115,42 @@ return {
     { LogSuccess = "Changed focus" },
     { CallLuaSilently = "custom.some_plugin_with_hooks.on_focus_change" },
   }
+
+  -- Add messages to send when the mode is switched.
+  --
+  -- Type: list of [Message](https://xplr.dev/en/message#message)s
+  on_mode_switch = {
+    { LogSuccess = "Switched mode" },
+    { CallLuaSilently = "custom.some_plugin_with_hooks.on_mode_switch" },
+  }
+
+  -- Add messages to send when the layout is switched
+  --
+  -- Type: list of [Message](https://xplr.dev/en/message#message)s
+  on_layout_switch = {
+    { LogSuccess = "Switched layout" },
+    { CallLuaSilently = "custom.some_plugin_with_hooks.on_layout_switch" },
+  }
+
+  -- Add messages to send when the selection changes
+  --
+  -- Type: list of [Message](https://xplr.dev/en/message#message)s
+  on_selection_change = {
+    { LogSuccess = "Selection changed" },
+    { CallLuaSilently = "custom.some_plugin_with_hooks.on_selection_change" },
+  }
 }
 ```
+
+---
+
+> Note:
+>
+> It's not recommended to copy the entire configuration, unless you want to
+> freeze it and miss out on useful updates to the defaults.
+>
+> Instead, you can use this as a reference to overwrite only the parts you
+> want to update.
+>
+> If you still want to copy the entire configuration, make sure to put your
+> customization before the return statement.

docs/en/src/configure-key-bindings.md

@@ -86,7 +86,7 @@ Default action to perform in case if a keyboard input not mapped via any of the
 
 ## Key
 
-A key can be one of the following:
+A key is a [sum type][36] can be one of the following:
 
 - 0, 1, ... 9
 - a, b, ... z
@@ -230,3 +230,4 @@ Visit [Awesome Plugins][27] for more [integration][28] options.
 [33]: #on_character
 [34]: #on_navigation
 [35]: #on_function
+[36]: sum-type.md

docs/en/src/contribute.md

@@ -1,32 +0,0 @@
-If you like xplr, and want to contribute, that would be really awesome.
-
-You can contribute to this project in the following ways
-
-- Contribute your time and expertise (read [CONTRIBUTING.md][1] for instructions).
-
-  - **Developers:** You can help me improve my code, fix things, implement features etc.
-  - **Repository maintainers:** You can save the users from the pain of managing xplr in their system manually.
-  - **Code Reviewers:** Teach me your ways of code.
-  - **Designers:** You can make the logo even more awesome, donate stickers and blog post worthy pictures.
-  - **Bloggers, YouTubers & broadcasters:** You can help spread the word.
-
-- Contribute by donating or sponsoring me via any of the following ways.
-  - [GitHub Sponsors][5]
-  - [Open Collective][2]
-  - [ko-fi][3]
-  - [liberapay][6]
-  - [PayPal][7]
-
-For further queries or concern related to `xplr`, [just ask us][4].
-
-### Backers
-
-<a href="https://opencollective.com/xplr#backer"><img src="https://opencollective.com/xplr/tiers/backer.svg?width=890" /></a>
-
-[1]: https://github.com/sayanarijit/xplr/blob/main/CONTRIBUTING.md
-[2]: https://opencollective.com/xplr
-[3]: https://ko-fi.com/sayanarijit
-[4]: community.md
-[5]: https://github.com/sponsors/sayanarijit?o=esb
-[6]: https://liberapay.com/sayanarijit
-[7]: https://paypal.me/sayanarijit

docs/en/src/default-key-bindings.md

@@ -16,15 +16,20 @@ of [modes][4] and the key mappings for each mode.
 
 | key       | remaps | action              |
 | --------- | ------ | ------------------- |
+| (         |        | prev deep branch    |
+| )         |        | next deep branch    |
 | .         |        | show hidden         |
 | /         | ctrl-f | search              |
 | :         |        | action              |
-| ?         |        | global help menu    |
+| ?         | f1     | global help menu    |
 | G         |        | go to bottom        |
 | V         | ctrl-a | select/unselect all |
+| c         |        | copy to             |
 | ctrl-d    |        | duplicate as        |
 | ctrl-i    | tab    | next visited path   |
+| ctrl-n    |        | next selection      |
 | ctrl-o    |        | last visited path   |
+| ctrl-p    |        | prev selection      |
 | ctrl-r    |        | refresh screen      |
 | ctrl-u    |        | clear selection     |
 | ctrl-w    |        | switch layout       |
@@ -36,6 +41,7 @@ of [modes][4] and the key mappings for each mode.
 | h         | left   | back                |
 | k         | up     | up                  |
 | l         | right  | enter               |
+| m         |        | move to             |
 | page-down |        | scroll down         |
 | page-up   |        | scroll up           |
 | q         |        | quit                |
@@ -47,123 +53,205 @@ of [modes][4] and the key mappings for each mode.
 | ~         |        | go home             |
 | [0-9]     |        | input               |
 
-### filter
-
-| key       | remaps | action                             |
-| --------- | ------ | ---------------------------------- |
-| R         |        | relative path does not match regex |
-| backspace |        | remove last filter                 |
-| ctrl-r    |        | reset filters                      |
-| ctrl-u    |        | clear filters                      |
-| r         |        | relative path does match regex     |
-
-### vroot
+### go_to_path
 
-| key    | remaps | action       |
-| ------ | ------ | ------------ |
-| .      |        | vroot $PWD   |
-| /      |        | vroot /      |
-| ~      |        | vroot $HOME  |
-| v      |        | toggle vroot |
-| ctrl-r |        | reset vroot  |
-| ctrl-u |        | unset vroot  |
+| key   | remaps | action           |
+| ----- | ------ | ---------------- |
+| enter |        | submit           |
+| f1    |        | global help menu |
+| tab   |        | try complete     |
 
-### create_file
+### rename
 
-| key   | remaps | action       |
-| ----- | ------ | ------------ |
-| enter |        | submit       |
-| tab   |        | try complete |
+| key   | remaps | action           |
+| ----- | ------ | ---------------- |
+| enter |        | submit           |
+| f1    |        | global help menu |
+| tab   |        | try complete     |
 
-### selection_ops
+### recover
 
-| key | remaps | action          |
-| --- | ------ | --------------- |
-| c   |        | copy here       |
-| m   |        | move here       |
-| u   |        | clear selection |
+| key | remaps | action           |
+| --- | ------ | ---------------- |
+| f1  |        | global help menu |
 
-### create
+### go_to
 
 | key | remaps | action           |
 | --- | ------ | ---------------- |
-| d   |        | create directory |
-| f   |        | create file      |
+| f   |        | follow symlink   |
+| f1  |        | global help menu |
+| g   |        | top              |
+| i   |        | initial $PWD     |
+| p   |        | path             |
+| x   |        | open in gui      |
 
-### quit
+### relative_path_does_match_regex
 
-| key   | remaps | action                  |
-| ----- | ------ | ----------------------- |
-| enter |        | just quit               |
-| f     |        | quit printing focus     |
-| p     |        | quit printing pwd       |
-| r     |        | quit printing result    |
-| s     |        | quit printing selection |
+| key   | remaps | action           |
+| ----- | ------ | ---------------- |
+| enter |        | submit           |
+| f1    |        | global help menu |
 
-### switch_layout
+### action
 
-| key | remaps | action               |
-| --- | ------ | -------------------- |
-| 1   |        | default              |
-| 2   |        | no help menu         |
-| 3   |        | no selection panel   |
-| 4   |        | no help or selection |
+| key   | remaps | action               |
+| ----- | ------ | -------------------- |
+| !     |        | shell                |
+| c     |        | create               |
+| e     |        | open in editor       |
+| f1    |        | global help menu     |
+| l     |        | logs                 |
+| m     |        | toggle mouse         |
+| p     |        | edit permissions     |
+| q     |        | quit options         |
+| s     |        | selection operations |
+| v     |        | vroot                |
+| [0-9] |        | go to index          |
 
-### delete
+### default
+
+| key       | remaps | action              |
+| --------- | ------ | ------------------- |
+| (         |        | prev deep branch    |
+| )         |        | next deep branch    |
+| .         |        | show hidden         |
+| /         | ctrl-f | search              |
+| :         |        | action              |
+| ?         | f1     | global help menu    |
+| G         |        | go to bottom        |
+| V         | ctrl-a | select/unselect all |
+| c         |        | copy to             |
+| ctrl-d    |        | duplicate as        |
+| ctrl-i    | tab    | next visited path   |
+| ctrl-n    |        | next selection      |
+| ctrl-o    |        | last visited path   |
+| ctrl-p    |        | prev selection      |
+| ctrl-r    |        | refresh screen      |
+| ctrl-u    |        | clear selection     |
+| ctrl-w    |        | switch layout       |
+| d         |        | delete              |
+| down      | j      | down                |
+| enter     |        | quit with result    |
+| f         |        | filter              |
+| g         |        | go to               |
+| h         | left   | back                |
+| k         | up     | up                  |
+| l         | right  | enter               |
+| m         |        | move to             |
+| page-down |        | scroll down         |
+| page-up   |        | scroll up           |
+| q         |        | quit                |
+| r         |        | rename              |
+| s         |        | sort                |
+| space     | v      | toggle selection    |
+| {         |        | scroll up half      |
+| }         |        | scroll down half    |
+| ~         |        | go home             |
+| [0-9]     |        | input               |
 
-| key | remaps | action       |
-| --- | ------ | ------------ |
-| D   |        | force delete |
-| d   |        | delete       |
+### debug_error
+
+| key   | remaps | action              |
+| ----- | ------ | ------------------- |
+| enter |        | open logs in editor |
+| f1    |        | global help menu    |
+| q     |        | quit                |
+
+### create_directory
+
+| key   | remaps | action           |
+| ----- | ------ | ---------------- |
+| enter |        | submit           |
+| f1    |        | global help menu |
+| tab   |        | try complete     |
+
+### selection_ops
+
+| key | remaps | action           |
+| --- | ------ | ---------------- |
+| c   |        | copy here        |
+| e   |        | edit selection   |
+| f1  |        | global help menu |
+| h   |        | hardlink here    |
+| l   |        | list selection   |
+| m   |        | move here        |
+| s   |        | softlink here    |
+| u   |        | clear selection  |
 
 ### relative_path_does_not_match_regex
 
-| key   | remaps | action |
-| ----- | ------ | ------ |
-| enter |        | submit |
+| key   | remaps | action           |
+| ----- | ------ | ---------------- |
+| enter |        | submit           |
+| f1    |        | global help menu |
 
-### number
+### create_file
 
-| key   | remaps | action   |
-| ----- | ------ | -------- |
-| down  | j      | to down  |
-| enter |        | to index |
-| k     | up     | to up    |
-| [0-9] |        | input    |
+| key   | remaps | action           |
+| ----- | ------ | ---------------- |
+| enter |        | submit           |
+| f1    |        | global help menu |
+| tab   |        | try complete     |
 
-### relative_path_does_match_regex
+### quit
 
-| key   | remaps | action |
-| ----- | ------ | ------ |
-| enter |        | submit |
+| key   | remaps | action                  |
+| ----- | ------ | ----------------------- |
+| enter |        | just quit               |
+| f     |        | quit printing focus     |
+| f1    |        | global help menu        |
+| p     |        | quit printing pwd       |
+| r     |        | quit printing result    |
+| s     |        | quit printing selection |
 
-### create_directory
+### create
 
-| key   | remaps | action       |
-| ----- | ------ | ------------ |
-| enter |        | submit       |
-| tab   |        | try complete |
+| key | remaps | action           |
+| --- | ------ | ---------------- |
+| d   |        | create directory |
+| f   |        | create file      |
+| f1  |        | global help menu |
 
-### duplicate_as
+### vroot
 
-| key   | remaps | action       |
-| ----- | ------ | ------------ |
-| enter |        | submit       |
-| tab   |        | try complete |
+| key    | remaps | action           |
+| ------ | ------ | ---------------- |
+| .      |        | vroot $PWD       |
+| /      |        | vroot /          |
+| ctrl-r |        | reset vroot      |
+| ctrl-u |        | unset vroot      |
+| f1     |        | global help menu |
+| v      |        | toggle vroot     |
+| ~      |        | vroot $HOME      |
 
-### rename
+### search
 
-| key   | remaps | action       |
-| ----- | ------ | ------------ |
-| enter |        | submit       |
-| tab   |        | try complete |
+| key    | remaps | action                  |
+| ------ | ------ | ----------------------- |
+| ctrl-a |        | toggle search algorithm |
+| ctrl-f |        | fuzzy search            |
+| ctrl-n | down   | down                    |
+| ctrl-p | up     | up                      |
+| ctrl-r |        | regex search            |
+| ctrl-s |        | sort (no search order)  |
+| ctrl-z |        | toggle ordering         |
+| enter  |        | submit                  |
+| esc    |        | cancel                  |
+| f1     |        | global help menu        |
+| left   |        | back                    |
+| right  |        | enter                   |
+| tab    |        | toggle selection        |
 
-### go_to_path
+### switch_layout
 
-| key   | remaps | action       |
-| ----- | ------ | ------------ |
-| enter |        | submit       |
-| tab   |        | try complete |
+| key | remaps | action               |
+| --- | ------ | -------------------- |
+| 1   |        | default              |
+| 2   |        | no help menu         |
+| 3   |        | no selection panel   |
+| 4   |        | no help or selection |
+| f1  |        | global help menu     |
 
 ### sort
 
@@ -183,56 +271,78 @@ of [modes][4] and the key mappings for each mode.
 | ctrl-u    |        | clear sorters                     |
 | e         |        | by canonical extension            |
 | enter     |        | submit                            |
+| f1        |        | global help menu                  |
 | l         |        | by last modified                  |
 | m         |        | by canonical mime essence         |
 | n         |        | by node type                      |
 | r         |        | by relative path                  |
 | s         |        | by size                           |
 
-### search
+### number
+
+| key   | remaps | action           |
+| ----- | ------ | ---------------- |
+| down  | j      | to down          |
+| enter |        | to index         |
+| f1    |        | global help menu |
+| k     | up     | to up            |
+| [0-9] |        | input            |
+
+### copy_to
+
+| key   | remaps | action           |
+| ----- | ------ | ---------------- |
+| enter |        | submit           |
+| f1    |        | global help menu |
+| tab   |        | try complete     |
+
+### edit_permissions
 
 | key    | remaps | action           |
 | ------ | ------ | ---------------- |
-| ctrl-n | down   | down             |
-| ctrl-p | up     | up               |
+| G      |        | -group           |
+| M      |        | min              |
+| O      |        | -other           |
+| U      |        | -user            |
+| ctrl-r |        | reset            |
 | enter  |        | submit           |
-| esc    |        | cancel           |
-| left   |        | back             |
-| right  |        | enter            |
-| tab    |        | toggle selection |
+| f1     |        | global help menu |
+| g      |        | +group           |
+| m      |        | max              |
+| o      |        | +other           |
+| u      |        | +user            |
 
-### debug_error
+### delete
 
-| key   | remaps | action              |
-| ----- | ------ | ------------------- |
-| enter |        | open logs in editor |
-| q     |        | quit                |
+| key | remaps | action           |
+| --- | ------ | ---------------- |
+| D   |        | force delete     |
+| d   |        | delete           |
+| f1  |        | global help menu |
 
-### action
+### move_to
 
-| key   | remaps | action               |
-| ----- | ------ | -------------------- |
-| !     |        | shell                |
-| c     |        | create               |
-| e     |        | open in editor       |
-| l     |        | logs                 |
-| m     |        | toggle mouse         |
-| q     |        | quit options         |
-| s     |        | selection operations |
-| v     |        | vroot                |
-| [0-9] |        | go to index          |
+| key   | remaps | action           |
+| ----- | ------ | ---------------- |
+| enter |        | submit           |
+| f1    |        | global help menu |
+| tab   |        | try complete     |
 
-### recover
+### filter
 
-| key | remaps | action |
-| --- | ------ | ------ |
+| key       | remaps | action                             |
+| --------- | ------ | ---------------------------------- |
+| R         |        | relative path does not match regex |
+| backspace |        | remove last filter                 |
+| ctrl-r    |        | reset filters                      |
+| ctrl-u    |        | clear filters                      |
+| f1        |        | global help menu                   |
+| r         |        | relative path does match regex     |
 
-### go_to
+### duplicate_as
 
-| key | remaps | action         |
-| --- | ------ | -------------- |
-| f   |        | follow symlink |
-| g   |        | top            |
-| i   |        | initial $PWD   |
-| p   |        | path           |
-| x   |        | open in gui    |
+| key   | remaps | action           |
+| ----- | ------ | ---------------- |
+| enter |        | submit           |
+| f1    |        | global help menu |
+| tab   |        | try complete     |

docs/en/src/environment-variables-and-pipes.md

@@ -174,6 +174,8 @@ message using newline or null character (`\n` or `\0`).
 > directly to this file, as safely escaping YAML strings is a lot of work. Use
 > `xplr -m` / `xplr --pipe-msg-in` to pass messages to xplr in a safer way.
 >
+> It uses [jf][41] syntax to safely convert an YAML template into a valid message.
+>
 > Example: `"$XPLR" -m 'ChangeDirectory: %q' "${HOME:?}"`
 
 #### XPLR_PIPE_SELECTION_OUT
@@ -225,3 +227,4 @@ List of paths, filtered and sorted as displayed in the [files table][28].
 [38]: #xplr
 [39]: #xplr_vroot
 [40]: #xplr_initial_pwd
+[41]: https://github.com/sayanarijit/jf

docs/en/src/filtering.md

@@ -25,7 +25,7 @@ It contains the following information:
 
 ### filter
 
-A filter can be one of the following:
+A filter is a [sum type][5] that can be one of the following:
 
 - "RelativePathIs"
 - "RelativePathIsNot"
@@ -90,3 +90,4 @@ Here, `ToggleNodeFilter` is a [message][4] that adds or removes
 [2]: #filter
 [3]: #input
 [4]: message.md
+[5]: sum-type.md

docs/en/src/general-config.md

@@ -42,6 +42,19 @@ Set it to `true` if you want to hide all remaps in the help menu.
 
 Type: boolean
 
+#### xplr.config.general.paginated_scrolling
+
+Set it to `true` if you want paginated scrolling.
+
+Type: boolean
+
+#### xplr.config.general.scroll_padding
+
+Set the padding value to the scroll area.
+Only applicable when `xplr.config.general.paginated_scrolling = false`.
+
+Type: boolean
+
 #### xplr.config.general.enforce_bounded_index_navigation
 
 Set it to `true` if you want the cursor to stay in the same position when
@@ -72,7 +85,7 @@ Type: nullable string
 
 #### xplr.config.general.logs.info.style
 
-The style for the informations logs.
+The style for the information logs.
 
 Type: [Style](https://xplr.dev/en/style)
 
@@ -181,6 +194,30 @@ Constraint for the column widths.
 
 Type: nullable list of [Constraint](https://xplr.dev/en/layouts#constraint)
 
+#### xplr.config.general.selection.item.format
+
+Renderer for each item in the selection list.
+
+Type: nullable string
+
+#### xplr.config.general.selection.item.style
+
+Style for each item in the selection list.
+
+Type: [Style](https://xplr.dev/en/style)
+
+#### xplr.config.general.search.algorithm
+
+The default search algorithm
+
+Type: [Search Algorithm](https://xplr.dev/en/searching#algorithm)
+
+#### xplr.config.general.search.unordered
+
+The default search ordering
+
+Type: boolean
+
 #### xplr.config.general.default_ui.prefix
 
 The content that is placed before the item name for each row by default.
@@ -322,12 +359,24 @@ Type: nullable mapping of the following key-value pairs:
   - format: nullable string
   - style: [Style](https://xplr.dev/en/style)
 
-#### xplr.config.general.sort_and_filter_ui.search_identifier
+#### xplr.config.general.sort_and_filter_ui.search_identifiers
 
 The identifiers used to denote applied search input.
 
 Type: { format = nullable string, style = [Style](https://xplr.dev/en/style) }
 
+#### xplr.config.general.sort_and_filter_ui.search_direction_identifiers.ordered.format
+
+The shape of ordered indicator for search ordering identifiers in Sort & filter panel.
+
+Type: nullable string
+
+#### xplr.config.general.sort_and_filter_ui.search_direction_identifiers.unordered.format
+
+The shape of unordered indicator for search ordering identifiers in Sort & filter panel.
+
+Type: nullable string
+
 #### xplr.config.general.panel_ui.default.title.format
 
 The content for panel title by default.
@@ -551,12 +600,16 @@ Type: nullable list of [Node Sorter](https://xplr.dev/en/sorting#node-sorter-app
 #### xplr.config.general.initial_mode
 
 The name of one of the modes to use when xplr loads.
+This isn't the default mode. To modify the default mode, overwrite
+[xplr.config.modes.builtin.default](https://xplr.dev/en/modes#xplrconfigmodesbuiltindefault).
 
 Type: nullable string
 
 #### xplr.config.general.initial_layout
 
 The name of one of the layouts to use when xplr loads.
+This isn't the default layout. To modify the default layout, overwrite
+[xplr.config.layouts.builtin.default](https://xplr.dev/en/layouts#xplrconfiglayoutsbuiltindefault).
 
 Type: nullable string
 

docs/en/src/input-operation.md

@@ -1,6 +1,6 @@
 # Input Operation
 
-Cursor based input operation can be one of the following:
+Cursor based input operation is a [sum type][3] can be one of the following:
 
 - { SetCursor = int }
 - { InsertCharacter = str }
@@ -24,3 +24,4 @@ Cursor based input operation can be one of the following:
 
 [1]: message.md
 [2]: messages.md
+[3]: sum-type.md

docs/en/src/install.md

@@ -41,6 +41,48 @@ repositories:
 nix-env -f https://github.com/NixOS/nixpkgs/tarball/master -iA xplr
 ```
 
+Or
+
+```nix
+# configuration.nix or darwin-configuration.nix
+environment.systemPackages = with nixpkgs; [
+  xplr
+  # ...
+];
+```
+
+#### [Home Manager][30]
+
+```nix
+# home.nix
+home.packages = with nixpkgs; [
+  xplr
+  # ...
+];
+```
+
+Or
+
+```nix
+# home.nix
+programs.xplr = {
+  enable = true;
+
+  # Optional params:
+  plugins = {
+    tree-view = fetchFromGitHub {
+      owner = "sayanarijit";
+      repo = "tree-view.xplr";
+    };
+    local-plugin = "/home/user/.config/xplr/plugins/local-plugin";
+  };
+  extraConfig = ''
+    require("tree-view").setup()
+    require("local-plugin").setup()
+  '';
+};
+```
+
 ### Arch Linux
 
 (same for Manjaro Linux)
@@ -80,6 +122,8 @@ apk add xplr bash less
 
 ### macOS
 
+Make sure you have the latest version of [GNU core utilities][29] installed.
+
 #### [MacPorts][11]
 
 ```
@@ -194,57 +238,16 @@ cargo build --locked --release --bin xplr
 sudo cp target/release/xplr /usr/local/bin/
 ```
 
-## Android
-
-### [Termux][23]
-
-[![xplr-termuxfd3c398d3cf4bcbc.md.jpg][24]][25]
-
-> Please note that xplr isn't heavily tested on Termux, hence things might
-> need a little tweaking and fixing for a smooth usage experience.
-
-- Install build dependencies
-
-  ```bash
-  pkg install rustc cargo make
-  ```
-
-- Install `xplr`
-
-  ```bash
-  cargo install --locked --force xplr
-  ```
-
-- Setup storage
-
-  ```bash
-  termux-setup-storage
-  ```
-
-- Setup config and runtime dir
-
-  ```bash
-  export XDG_CONFIG_HOME="$PWD/storage/.config"
-  export XDG_RUNTIME_DIR="$PWD/storage/run"
-
-  mkdir -p "$XDG_CONFIG_HOME" "$XDG_RUNTIME_DIR"
-  ```
-
-- Run
-  ```bash
-  ~/.cargo/bin/xplr
-  ```
-
 [1]: #direct-download
-[2]: #from-a-hrefhttpscratesiocratesxplrcratesioa
+[2]: #from-cratesio
 [3]: #build-from-source
 [4]: https://github.com/sayanarijit/xplr/watchers
 [5]: https://repology.org/badge/vertical-allrepos/xplr.svg
 [6]: https://repology.org/project/xplr/versions
-[7]: https://archlinux.org/packages/community/x86_64/xplr
+[7]: https://archlinux.org/packages/extra/x86_64/xplr
 [8]: https://aur.archlinux.org/packages/?O=0&SeB=n&K=xplr&outdated=&SB=n&SO=a&PP=50&do_Search=Go
 [9]: https://github.com/shubham-cpp/void-pkg-templates
-[10]: https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/misc/xplr
+[10]: https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/xp/xplr/package.nix
 [11]: https://ports.macports.org/port/xplr
 [12]: https://formulae.brew.sh/formula/xplr
 [13]: https://cgit.freebsd.org/ports/plain/misc/xplr/
@@ -257,9 +260,10 @@ sudo cp target/release/xplr /usr/local/bin/
 [20]: https://gcc.gnu.org/
 [21]: https://www.gnu.org/software/make/
 [22]: https://git-scm.com/
-[23]: https://termux.com/
-[24]: https://s3.gifyu.com/images/xplr-termuxfd3c398d3cf4bcbc.md.jpg
+[23]: https://github.com/sayanarijit/xplr/assets/11632726/3b61e8c8-76f0-48e8-8734-50e9e7e495b7
 [25]: https://gifyu.com/image/tF2D
 [26]: https://github.com/sayanarijit/xplr/releases/latest/download/xplr-linux-musl.tar.gz
 [27]: https://pkgs.alpinelinux.org/packages?name=xplr
 [28]: https://gpo.zugaina.org/Overlays/guru/app-misc/xplr
+[29]: https://formulae.brew.sh/formula/coreutils
+[30]: https://github.com/nix-community/home-manager/blob/master/modules/programs/xplr.nix

docs/en/src/introduction.md

@@ -84,8 +84,6 @@ Some of the coolest features xplr provide beside the basic stuff:
     (`:` `q` `s`).
   - Quit with failure (`ctrl-c`).
 
-**Q.** What features should be added here? [let us know][20].
-
 [1]: layouts.md
 [2]: configure-key-bindings.md
 [3]: awesome-plugins.md
@@ -105,6 +103,5 @@ Some of the coolest features xplr provide beside the basic stuff:
 [17]: node_types.md
 [18]: https://github.com/sayanarijit/xplr/blob/main/src/init.lua
 [19]: messages.md#startfifo
-[20]: community.md
 [21]: messages.md#virtual-root
 [22]: configuration.md#hooks

docs/en/src/layout.md

@@ -2,15 +2,13 @@
 
 #### Example: Defining Custom Layout
 
-[![layout.png][23]][24]
-
 ```lua
 xplr.config.layouts.builtin.default = {
   Horizontal = {
     config = {
       margin = 1,
-      horizontal_margin = 2,
-      vertical_margin = 3,
+      horizontal_margin = 1,
+      vertical_margin = 1,
       constraints = {
         { Percentage = 50 },
         { Percentage = 50 },
@@ -24,7 +22,22 @@ xplr.config.layouts.builtin.default = {
 }
 ```
 
-A layout can be one of the following:
+Result:
+
+```
+ ╭ /home ─────────────╮╭ Help [default] ────╮
+ │   ╭─── path        ││.    show hidden    │
+ │   ├▸[ð Desktop/]   ││/    search         │
+ │   ├  ð Documents/  ││:    action         │
+ │   ├  ð Downloads/  ││?    global help    │
+ │   ├  ð GitHub/     ││G    go to bottom   │
+ │   ├  ð Music/      ││V    select/unselect│
+ │   ├  ð Pictures/   ││ctrl duplicate as   │
+ │   ├  ð Public/     ││ctrl next visit     │
+ ╰────────────────────╯╰────────────────────╯
+```
+
+A layout is a [sum type][56] can be one of the following:
 
 - [Nothing][8]
 - [Table][9]
@@ -32,56 +45,61 @@ A layout can be one of the following:
 - [Selection][11]
 - [HelpMenu][12]
 - [SortAndFilter][13]
-- [CustomContent][25]
+- [Static][25]
+- [Dynamic][26]
 - [Horizontal][14]
 - [Vertical][16]
+- CustomContent (deprecated, use `Static` or `Dynamic`)
 
 ### Nothing
 
 This layout contains a blank panel.
 
-Example: "Nothing"
+Type: "Nothing"
 
 ### Table
 
-This layout contains the table displaying the files and directories in the
-current directory.
+This layout contains the table displaying the files and directories in the current
+directory.
 
 ### InputAndLogs
 
 This layout contains the panel displaying the input prompt and logs.
 
-Example: "InputAndLogs"
+Type: "InputAndLogs"
 
 ### Selection
 
 This layout contains the panel displaying the selected paths.
 
-Example: "Selection"
+Type: "Selection"
 
 ### HelpMenu
 
 This layout contains the panel displaying the help menu for the current mode in
 real-time.
 
-Example: "HelpMenu"
+Type: "HelpMenu"
 
 ### SortAndFilter
 
-This layout contains the panel displaying the pipeline of sorters and filters
-applied of the list of paths being displayed.
+This layout contains the panel displaying the pipeline of sorters and filters applied on
+the list of paths being displayed.
 
-Example: "SortAndFilter"
+Type: "SortAndFilter"
 
-### Custom Content
+### Static
 
-Custom content is a special layout to render something custom.
-It contains the following information:
+This is a custom layout to render static content.
 
-- [title][33]
-- [body][34]
+Type: { Static = [Custom Panel][27] }
 
-Example: { CustomContent = { title = [title][33], body = [body][34] }
+### Dynamic
+
+This is a custom layout to render dynamic content using a function defined in
+[xplr.fn][28] that takes [Content Renderer Argument][36] and returns [Custom Panel][27].
+
+Type: { Dynamic = "[Content Renderer][35]" }
 
 ### Horizontal
 
@@ -92,7 +110,7 @@ It contains the following information:
 - [config][15]
 - [splits][17]
 
-Example: { Horizontal = { config = [config][15], splits = [splits][17] }
+Type: { Vertical = { config = [Layout Config][15], splits = { [Layout][17], ... } }
 
 ### Vertical
 
@@ -103,7 +121,7 @@ It contains the following information:
 - [config][15]
 - [splits][17]
 
-Example: { Vertical = { config = [config][15], splits = [splits][17] }
+Type: { Vertical = { config = [Layout Config][15], splits = { [Layout][17], ... } }
 
 ## Layout Config
 
@@ -140,7 +158,7 @@ The constraints applied on the layout.
 
 ## Constraint
 
-A constraint can be one of the following:
+A constraint is a [sum type][56] can be one of the following:
 
 - { Percentage = int }
 - { Ratio = { int, int } }
@@ -166,187 +184,305 @@ Type: list of [Layout][3]
 
 The list of child layouts to fit into the parent layout.
 
-## title
-
-Type: nullable string
-
-The title of the panel.
-
-## body
-
-Type: [Content Body][26]
+## Custom Panel
 
-The body of the panel.
+Custom panel is a [sum type][56] can be one of the following:
 
-## Content Body
+- [CustomParagraph][29]
+- [CustomList][30]
+- [CustomTable][31]
+- [CustomLayout][55]
 
-Content body can be one of the following:
-
-- [StaticParagraph][27]
-- [DynamicParagraph][28]
-- [StaticList][29]
-- [DynamicList][30]
-- [StaticTable][31]
-- [DynamicTable][32]
-
-## Static Paragraph
+### CustomParagraph
 
 A paragraph to render. It contains the following fields:
 
-- **render** (string): The string to render.
+- **ui** (nullable [Panel UI Config][32]): Optional UI config for the panel.
+- **body** (string): The string to render.
 
 #### Example: Render a custom static paragraph
 
 ```lua
 xplr.config.layouts.builtin.default = {
-  CustomContent = {
-    title = "custom title",
-    body = {
-      StaticParagraph = { render = "custom body" },
+  Static = {
+    CustomParagraph = {
+      ui = { title = { format = " custom title " } },
+      body = "custom body",
     },
   },
 }
 ```
 
-## Dynamic Paragraph
-
-A [Lua function][35] to render a custom paragraph.
-It contains the following fields:
+Result:
 
-- **render** (string): The [lua function][35] that returns the paragraph to
-  render.
+```
+╭ custom title ────────╮
+│custom body           │
+│                      │
+│                      │
+╰──────────────────────╯
+```
 
 #### Example: Render a custom dynamic paragraph
 
 ```lua
-xplr.config.layouts.builtin.default = {
-  CustomContent = {
-    title = "custom title",
-    body = { DynamicParagraph = { render = "custom.render_layout" } },
-  },
-}
+xplr.config.layouts.builtin.default = { Dynamic = "custom.render_layout" }
 
 xplr.fn.custom.render_layout = function(ctx)
-  return ctx.app.pwd
+  return {
+    CustomParagraph = {
+      ui = { title = { format = ctx.app.pwd } },
+      body = xplr.util.to_yaml(ctx.app.focused_node),
+    },
+  }
 end
 ```
 
-## Static List
+Result:
+
+```
+╭/home/sayanarijit───────────────────────────╮
+│mime_essence: inode/directory               │
+│relative_path: Desktop                      │
+│is_symlink: false                           │
+│is_readonly: false                          │
+│parent: /home/sayanarijit                   │
+│absolute_path: /home/sayanarijit/Desktop    │
+│is_broken: false                            │
+│created: 1668087850396758714                │
+│size: 4096                                  │
+│gid: 100                                    │
+╰────────────────────────────────────────────╯
+```
+
+### CustomList
 
 A list to render. It contains the following fields:
 
-- **render** (list of string): The list to render.
+- **ui** (nullable [Panel UI Config][32]): Optional UI config for the panel.
+- **body** (list of string): The list of strings to display.
 
 #### Example: Render a custom static list
 
 ```lua
 xplr.config.layouts.builtin.default = {
-  CustomContent = {
-    title = "custom title",
-    body = {
-      StaticList = { render = { "1", "2", "3" } },
+  Static = {
+    CustomList = {
+      ui = { title = { format = " custom title " } },
+      body = { "1", "2", "3" },
     },
   },
 }
 ```
 
-## Dynamic List
+Result:
 
-A [Lua function][35] to render a custom list.
-It contains the following fields:
-
-- **render** (string): The [lua function][35] that returns the list to render.
+```
+╭ custom title ─────────────╮
+│1                          │
+│2                          │
+│3                          │
+│                           │
+╰───────────────────────────╯
+```
 
 #### Example: Render a custom dynamic list
 
 ```lua
-xplr.config.layouts.builtin.default = {
-  CustomContent = {
-    title = "custom title",
-    body = { DynamicList = { render = "custom.render_layout" } },
-  },
-}
+xplr.config.layouts.builtin.default = { Dynamic = "custom.render_layout" }
 
 xplr.fn.custom.render_layout = function(ctx)
   return {
-    ctx.app.pwd,
-    ctx.app.version,
-    tostring(ctx.app.pid),
+    CustomList = {
+      ui = { title = { format = ctx.app.pwd } },
+      body = {
+        (ctx.app.focused_node or {}).relative_path or "",
+        ctx.app.version,
+        tostring(ctx.app.pid),
+      },
+    },
   }
 end
 ```
 
-## Static Table
+Result:
 
-A table to render. It contains the following fields:
+```
+╭/home/sayanarijit──────────╮
+│Desktop                    │
+│0.21.2                     │
+│17336                      │
+│                           │
+│                           │
+╰───────────────────────────╯
+```
+
+## CustomTable
+
+A custom table to render. It contains the following fields:
 
+- **ui** (nullable [Panel UI Config][32]): Optional UI config for the panel.
 - **widths** (list of [Constraint][22]): Width of the columns.
 - **col_spacing** (nullable int): Spacing between columns. Defaults to 1.
-- **render** (list of list of string): The rows and columns to render.
+- **body** (list of list of string): The rows and columns to render.
 
 #### Example: Render a custom static table
 
 ```lua
 xplr.config.layouts.builtin.default = {
-  CustomContent = {
-    title = "custom title",
-    body = {
-      StaticTable = {
-        widths = {
-          { Percentage = 50 },
-          { Percentage = 50 },
-        },
-        col_spacing = 1,
-        render = {
-          { "a", "b" },
-          { "c", "d" },
-        },
+  Static = {
+    CustomTable = {
+      ui = { title = { format = " custom title " } },
+      widths = {
+        { Percentage = 50 },
+        { Percentage = 50 },
+      },
+      body = {
+        { "a", "b" },
+        { "c", "d" },
       },
     },
   },
 }
 ```
 
-## Dynamic Table
+Result:
 
-A [Lua function][35] to render a custom table.
-It contains the following fields:
-
-- **widths** (list of [Constraint][22]): Width of the columns.
-- **col_spacing** (nullable int): Spacing between columns. Defaults to 1.
-- **render** (string): The [lua function][35] that returns the table to render.
+```
+╭ custom title ────────────────────╮
+│a                 b               │
+│c                 d               │
+│                                  │
+│                                  │
+│                                  │
+╰──────────────────────────────────╯
+```
 
 #### Example: Render a custom dynamic table
 
 ```lua
-xplr.config.layouts.builtin.default = {
-  CustomContent = {
-    title = "custom title",
-    body = {
-      DynamicTable = {
-        widths = {
-          { Percentage = 50 },
-          { Percentage = 50 },
-        },
-        col_spacing = 1,
-        render = "custom.render_layout",
+xplr.config.layouts.builtin.default = {Dynamic = "custom.render_layout" }
+
+xplr.fn.custom.render_layout = function(ctx)
+  return {
+    CustomTable = {
+      ui = { title = { format = ctx.app.pwd } },
+      widths = {
+        { Percentage = 50 },
+        { Percentage = 50 },
+      },
+      body = {
+        { "", "" },
+        { "Layout height", tostring(ctx.layout_size.height) },
+        { "Layout width", tostring(ctx.layout_size.width) },
+        { "", "" },
+        { "Screen height", tostring(ctx.screen_size.height) },
+        { "Screen width", tostring(ctx.screen_size.width) },
       },
     },
-  },
-}
+  }
+end
+```
+
+Result:
+
+```
+╭/home/sayanarijit───────────────────────────╮
+│                                            │
+│Layout height          12                   │
+│Layout width           46                   │
+│                                            │
+│Screen height          12                   │
+│Screen width           46                   │
+│                                            │
+│                                            │
+│                                            │
+│                                            │
+╰────────────────────────────────────────────╯
+```
+
+### CustomLayout
+
+A whole custom layout to render. It doesn't make sense to use it as a
+[Static][25] layout, but can be very useful to render as a [Dynamic][26] layout
+for use cases where the structure of the layout needs to change without having
+to switch modes.
+
+> WARNING: Rendering the same dynamic custom layout recursively will result in
+> a ugly crash.
+
+#### Example: Render a custom dynamic layout
+
+```lua
+xplr.config.layouts.builtin.default = { Dynamic = "custom.render_layout" }
 
 xplr.fn.custom.render_layout = function(ctx)
-  return {
-    { "", "" },
-    { "Layout height", tostring(ctx.layout_size.height) },
-    { "Layout width", tostring(ctx.layout_size.width) },
-    { "", "" },
-    { "Screen height", tostring(ctx.screen_size.height) },
-    { "Screen width", tostring(ctx.screen_size.width) },
+  local inner = {
+    config = {
+      constraints = {
+        { Percentage = 50 },
+        { Percentage = 50 },
+      },
+    },
+    splits = {
+      { Static = { CustomParagraph = { body = "Try your luck..." } } },
+      { Static = { CustomParagraph = { body = "Press ctrl-r" } } },
+    },
   }
+
+  local layout_type = "Vertical"
+  if math.random(1, 2) == 1 then
+    layout_type = "Horizontal"
+  end
+
+  return { CustomLayout = { [layout_type] = inner } }
 end
 ```
 
+Result:
+
+```
+╭─────────────────────╮╭─────────────────────╮
+│Try your luck...     ││Press ctrl-r         │
+│                     ││                     │
+│                     ││                     │
+│                     ││                     │
+│                     ││                     │
+│                     ││                     │
+│                     ││                     │
+│                     ││                     │
+│                     ││                     │
+│                     ││                     │
+╰─────────────────────╯╰─────────────────────╯
+```
+
+Or
+
+```
+╭────────────────────────────────────────────╮
+│Try your luck...                            │
+│                                            │
+│                                            │
+│                                            │
+╰────────────────────────────────────────────╯
+╭────────────────────────────────────────────╮
+│Press ctrl-r                                │
+│                                            │
+│                                            │
+│                                            │
+╰────────────────────────────────────────────╯
+```
+
+## Panel UI Config
+
+It contains the following optional fields:
+
+- **title** ({ format = "string", style = [Style][33] }): the title of the panel.
+- **style** ([Style][33]): The style of the panel body.
+- **borders** (nullable list of [Border][34]): The shape of the borders.
+- **border_type** ([Border Type][54]): The type of the borders.
+- **border_style** ([Style][33]): The style of the borders.
+
 ## Content Renderer
 
 It is a Lua function that receives [a special argument][36] as input and
@@ -359,6 +495,7 @@ It contains the following information:
 
 - [layout_size][37]
 - [screen_size][37]
+- [scrolltop][57]
 - [app][38]
 
 ### Size
@@ -372,13 +509,19 @@ It contains the following information:
 
 Every field is of integer type.
 
+### scrolltop
+
+Type: integer
+
+The start index of the visible nodes in the table.
+
 ### app
 
 This is a lightweight version of the [Lua Context][39]. In this context, the
 heavyweight fields like [directory_buffer][50] are omitted for performance
 reasons.
 
-Hence, only the following fields are avilable.
+Hence, only the following fields are available.
 
 - [version][40]
 - [pwd][41]
@@ -419,18 +562,16 @@ Hence, only the following fields are avilable.
 [20]: #vertical_margin
 [21]: #constraints
 [22]: #constraint
-[23]: https://s6.gifyu.com/images/layout.png
-[24]: https://gifyu.com/image/1X38
-[25]: #custom-content
-[26]: #content-body
-[27]: #static-paragraph
-[28]: #dynamic-paragraph
-[29]: #static-list
-[30]: #dynamic-list
-[31]: #static-table
-[32]: #dynamic-table
-[33]: #title
-[34]: #body
+[25]: #static
+[26]: #dynamic
+[27]: #custom-panel
+[28]: configuration.md#function
+[29]: #customparagraph
+[30]: #customlist
+[31]: #customtable
+[32]: #panel-ui-config
+[33]: style.md#style
+[34]: borders.md#border
 [35]: #content-renderer
 [36]: #content-renderer-argument
 [37]: #size
@@ -450,3 +591,7 @@ Hence, only the following fields are avilable.
 [51]: layouts.md
 [52]: lua-function-calls.md#vroot
 [53]: lua-function-calls.md#initial_pwd
+[54]: borders.md#border-type
+[55]: #customlayout
+[56]: sum-type.md
+[57]: #scrolltop

docs/en/src/layouts.md

@@ -12,15 +12,13 @@ You can add new panels in `xplr.config.layouts.custom`.
 
 ##### Example: Defining Custom Layout
 
-![demo](https://s6.gifyu.com/images/layout.png)
-
 ```lua
 xplr.config.layouts.builtin.default = {
   Horizontal = {
     config = {
       margin = 1,
-      horizontal_margin = 2,
-      vertical_margin = 3,
+      horizontal_margin = 1,
+      vertical_margin = 1,
       constraints = {
         { Percentage = 50 },
         { Percentage = 50 },
@@ -34,6 +32,21 @@ xplr.config.layouts.builtin.default = {
 }
 ```
 
+Result:
+
+```
+╭ /home ─────────────╮╭ Help [default] ────╮
+│   ╭─── path        ││.    show hidden    │
+│   ├▸[ð Desktop/]   ││/    search         │
+│   ├  ð Documents/  ││:    action         │
+│   ├  ð Downloads/  ││?    global help    │
+│   ├  ð GitHub/     ││G    go to bottom   │
+│   ├  ð Music/      ││V    select/unselect│
+│   ├  ð Pictures/   ││ctrl duplicate as   │
+│   ├  ð Public/     ││ctrl next visit     │
+╰────────────────────╯╰────────────────────╯
+```
+
 #### xplr.config.layouts.builtin.default
 
 The default layout

docs/en/src/lua-function-calls.md

@@ -368,28 +368,11 @@ Type: list of [Node Sorter Applicable][81]
 
 ### searcher
 
-Type: nullable [Node Searcher][82]
+The searcher to use (if any).
 
-## Node Searcher
+Type: nullable [Node Searcher Applicable][82]
 
-Node Searcher contains the following fields:
-
-- [pattern][83]
-- [recoverable_focus][84]
-
-### pattern
-
-The patters used to search.
-
-Type: string
-
-### recoverable_focus
-
-Where to focus when search is cancelled.
-
-Type: nullable string
-
-## Also Ssee:
+## Also See:
 
 - [xplr.util][85]
 
@@ -457,7 +440,5 @@ Type: nullable string
 [79]: #searcher
 [80]: filtering.md#node-filter-applicable
 [81]: sorting.md#node-sorter-applicable
-[82]: #node-searcher
-[83]: #pattern
-[84]: #recoverable_focus
+[82]: searching.md#node-searcher-applicable
 [85]: xplr.util.md

docs/en/src/message.md

@@ -1,7 +1,9 @@
 # Message
 
 You can think of xplr as a server. Just like web servers listen to HTTP
-requests, xplr listens to [messages][1].
+requests, xplr listens to messages.
+
+A message is a [sum type][9] that can have [these possible values][1].
 
 You can send these messages to an xplr session in the following ways:
 
@@ -13,22 +15,35 @@ You can send these messages to an xplr session in the following ways:
 
 ### Format
 
-To send messages using the [key bindings][2] or
-[Lua function calls][3], messages are represented in
-[Lua][5] syntax. For example:
+To send messages using the [key bindings][2] or [Lua function calls][3],
+messages are represented in [Lua][5] syntax.
+
+For example:
 
 - `"Quit"`
 - `{ FocusPath = "/path/to/file" }`
 - `{ Call = { command = "bash", args = { "-c", "read -p test" } } }`
 
 However, to send messages using the [input pipe][4], they need to be
-represented using
-[YAML][6] (or [JSON][7]) syntax. For example:
+represented using [YAML][6] (or [JSON][7]) syntax.
+
+For example:
 
 - `Quit`
 - `FocusPath: "/path/to/file"`
 - `Call: { command: bash, args: ["-c", "read -p test"] }`
 
+Use `"$XPLR" -m TEMPLATE [VALUE]...` command-line option to safely format
+`TEMPLATE` into a valid message. If uses [jf][8] to parse and render the
+template. And `$XPLR` (rather than `xplr`) makes sure that the correct version
+of the binary is being used.
+
+For example:
+
+- `"$XPLR" -m Quit`
+- `"$XPLR" -m 'FocusPath: %q' "/path/to/file"`
+- `"$XPLR" -m 'Call: { command: %q, args: [%*q] }' bash -c "read -p test"`
+
 ## Also See:
 
 - [Full List of Messages][1]
@@ -40,3 +55,5 @@ represented using
 [5]: https://www.lua.org/
 [6]: http://yaml.org/
 [7]: https://www.json.org
+[8]: https://github.com/sayanarijit/jf
+[9]: sum-type.md

docs/en/src/messages.md

@@ -97,6 +97,15 @@ Example:
 - Lua: `"FocusNext"`
 - YAML: `FocusNext`
 
+#### FocusNextSelection
+
+Focus on the next selected node.
+
+Example:
+
+- Lua: `"FocusNextSelection"`
+- YAML: `FocusNextSelection`
+
 #### FocusNextByRelativeIndex
 
 Focus on the `n`th node relative to the current focus where `n` is a
@@ -128,6 +137,15 @@ Example:
 - Lua: `"FocusPrevious"`
 - YAML: `FocusPrevious`
 
+#### FocusPreviousSelection
+
+Focus on the previous selection item.
+
+Example:
+
+- Lua: `"FocusPreviousSelection"`
+- YAML: `FocusPreviousSelection`
+
 #### FocusPreviousByRelativeIndex
 
 Focus on the `-n`th node relative to the current focus where `n` is a
@@ -302,6 +320,24 @@ Example:
 - Lua: `"NextVisitedPath"`
 - YAML: `NextVisitedPath`
 
+#### PreviousVisitedDeepBranch
+
+Go to the previous deep level branch.
+
+Example:
+
+- Lua: `"PreviousVisitedDeepBranch"`
+- YAML: `PreviousVisitedDeepBranch`
+
+#### NextVisitedDeepBranch
+
+Go to the next deep level branch.
+
+Example:
+
+- Lua: `"NextVisitedDeepBranch"`
+- YAML: `NextVisitedDeepBranch`
+
 #### FollowSymlink
 
 Follow the symlink under focus to its actual location.
@@ -371,7 +407,7 @@ Example:
 
 Update the input buffer using cursor based operations.
 
-Type: { UpdateInputBuffer = [Input Opertaion](https://xplr.dev/en/input-operation) }
+Type: { UpdateInputBuffer = [Input Operation](https://xplr.dev/en/input-operation) }
 
 Example:
 
@@ -400,7 +436,7 @@ Example:
 
 #### BufferInputFromKey
 
-Append/buffer the characted read from a keyboard input into the
+Append/buffer the character read from a keyboard input into the
 input buffer.
 
 Example:
@@ -825,7 +861,7 @@ Example:
 
 Add a [filter](https://xplr.dev/en/filtering#filter) to exclude nodes
 while exploring directories.
-You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
 Filters get automatically cleared when changing directories.
 
 Type: { AddNodeFilter = { filter = [Filter](https://xplr.dev/en/filtering#filter), input = "string" }
@@ -838,7 +874,7 @@ Example:
 #### RemoveNodeFilter
 
 Remove an existing [filter](https://xplr.dev/en/filtering#filter).
-You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
 
 Type: { RemoveNodeFilter = { filter = [Filter](https://xplr.dev/en/filtering), input = "string" }
 
@@ -851,7 +887,7 @@ Example:
 
 Remove a [filter](https://xplr.dev/en/filtering#filter) if it exists,
 else, add a it.
-You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
 
 Type: { ToggleNodeFilter = { filter = [Filter](https://xplr.dev/en/filtering), input = "string" }
 
@@ -864,7 +900,7 @@ Example:
 
 Add a node [filter](https://xplr.dev/en/filtering#filter) reading the
 input from the buffer.
-You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
 
 Type: { AddNodeFilterFromInput = [Filter](https://xplr.dev/en/filtering) }
 
@@ -877,7 +913,7 @@ Example:
 
 Remove a node [filter](https://xplr.dev/en/filtering#filter) reading
 the input from the buffer.
-You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
 
 Type: { RemoveNodeFilterFromInput = [Filter](https://xplr.dev/en/filtering) }
 
@@ -889,7 +925,7 @@ Example:
 #### RemoveLastNodeFilter
 
 Remove the last node [filter](https://xplr.dev/en/filtering).
-You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
 
 Example:
 
@@ -900,7 +936,7 @@ Example:
 
 Reset the node [filters](https://xplr.dev/en/filtering) back to the
 default configuration.
-You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
 
 Example:
 
@@ -910,7 +946,7 @@ Example:
 #### ClearNodeFilters
 
 Clear all the node [filters](https://xplr.dev/en/filtering).
-You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
 
 Example:
 
@@ -923,7 +959,7 @@ Example:
 
 Add a [sorter](https://xplr.dev/en/sorting#sorter) to sort nodes while
 exploring directories.
-You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
 
 Type: { AddNodeSorter = { sorter = [Sorter](https://xplr.dev/en/sorting#sorter), reverse = bool } }
 
@@ -935,7 +971,7 @@ Example:
 #### RemoveNodeSorter
 
 Remove an existing [sorter](https://xplr.dev/en/sorting#sorter).
-You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
 
 Type: { RemoveNodeSorter = [Sorter](https://xplr.dev/en/sorting#sorter) }
 
@@ -947,7 +983,7 @@ Example:
 #### ReverseNodeSorter
 
 Reverse a node [sorter](https://xplr.dev/en/sorting#sorter).
-You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
 
 Type: { ReverseNodeSorter = [Sorter](https://xplr.dev/en/sorting#sorter) }
 
@@ -960,7 +996,7 @@ Example:
 
 Remove a [sorter](https://xplr.dev/en/sorting#sorter) if it exists,
 else, add a it.
-You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
 
 Type: { ToggleNodeSorter = { sorter = [Sorter](https://xplr.dev/en/sorting#sorter), reverse = bool } }
 
@@ -972,7 +1008,7 @@ Example:
 #### ReverseNodeSorters
 
 Reverse the node [sorters](https://xplr.dev/en/sorting#sorter).
-You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
 
 Example:
 
@@ -982,7 +1018,7 @@ Example:
 #### RemoveLastNodeSorter
 
 Remove the last node [sorter](https://xplr.dev/en/sorting#sorter).
-You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
 
 Example:
 
@@ -993,7 +1029,7 @@ Example:
 
 Reset the node [sorters](https://xplr.dev/en/sorting#sorter) back to
 the default configuration.
-You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
 
 Example:
 
@@ -1003,7 +1039,7 @@ Example:
 #### ClearNodeSorters
 
 Clear all the node [sorters](https://xplr.dev/en/sorting#sorter).
-You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
 
 Example:
 
@@ -1012,11 +1048,33 @@ Example:
 
 ### Search Operations
 
+#### Search
+
+Search files using the current or default (fuzzy) search algorithm.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
+It gets reset automatically when changing directory.
+
+Type: { Search = "string" }
+
+Example:
+
+- Lua: `{ Search = "pattern" }`
+- YAML: `Search: pattern`
+
+#### SearchFromInput
+
+Calls `Search` with the input taken from the input buffer.
+
+Example:
+
+- Lua: `"SearchFromInput"`
+- YAML: `SearchFromInput`
+
 #### SearchFuzzy
 
 Search files using fuzzy match algorithm.
 It keeps the filters, but overrides the sorters.
-You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
 It gets reset automatically when changing directory.
 
 Type: { SearchFuzzy = "string" }
@@ -1029,13 +1087,127 @@ Example:
 #### SearchFuzzyFromInput
 
 Calls `SearchFuzzy` with the input taken from the input buffer.
-You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
+It gets reset automatically when changing directory.
 
 Example:
 
 - Lua: `"SearchFuzzyFromInput"`
 - YAML: `SearchFuzzyFromInput`
 
+#### SearchFuzzyUnordered
+
+Like `SearchFuzzy`, but doesn't not perform rank based sorting.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
+It gets reset automatically when changing directory.
+
+Type: { SearchFuzzyUnordered = "string" }
+
+Example:
+
+- Lua: `{ SearchFuzzyUnordered = "pattern" }`
+- YAML: `SearchFuzzyUnordered: pattern`
+
+#### SearchFuzzyUnorderedFromInput
+
+Calls `SearchFuzzyUnordered` with the input taken from the input buffer.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
+It gets reset automatically when changing directory.
+
+Example:
+
+- Lua: `"SearchFuzzyUnorderedFromInput"`
+- YAML: `SearchFuzzyUnorderedFromInput`
+
+#### SearchRegex
+
+Search files using regex match algorithm.
+It keeps the filters, but overrides the sorters.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
+It gets reset automatically when changing directory.
+
+Type: { SearchRegex = "string" }
+
+Example:
+
+- Lua: `{ SearchRegex = "pattern" }`
+- YAML: `SearchRegex: pattern`
+
+#### SearchRegexFromInput
+
+Calls `SearchRegex` with the input taken from the input buffer.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
+It gets reset automatically when changing directory.
+
+Example:
+
+- Lua: `"SearchRegexFromInput"`
+- YAML: `SearchRegexFromInput`
+
+#### SearchRegexUnordered
+
+Like `SearchRegex`, but doesn't not perform rank based sorting.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
+It gets reset automatically when changing directory.
+
+Type: { SearchRegexUnordered = "string" }
+
+Example:
+
+- Lua: `{ SearchRegexUnordered = "pattern" }`
+- YAML: `SearchRegexUnordered: pattern`
+
+#### SearchRegexUnorderedFromInput
+
+Calls `SearchRegexUnordered` with the input taken from the input buffer.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
+It gets reset automatically when changing directory.
+
+Example:
+
+- Lua: `"SearchRegexUnorderedFromInput"`
+- YAML: `SearchRegexUnorderedFromInput`
+
+#### ToggleSearchAlgorithm
+
+Toggles between different search algorithms, without changing the input
+buffer
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
+
+Example:
+
+- Lua: `"ToggleSearchAlgorithm"`
+- YAML: `ToggleSearchAlgorithm`
+
+#### EnableSearchOrder
+
+Enables ranked search without changing the input buffer.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
+
+Example:
+
+- Lua: `"EnableOrderedSearch"`
+- YAML: `EnableSearchOrder`
+
+#### DisableSearchOrder
+
+Disabled ranked search without changing the input buffer.
+You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
+
+Example:
+
+- Lua: `"DisableSearchOrder"`
+- YAML: `DisableSearchOrder`
+
+#### ToggleSearchOrder
+
+Toggles ranked search without changing the input buffer.
+
+Example:
+
+- Lua: `"ToggleSearchOrder"`
+- YAML: `ToggleSearchOrder`
+
 #### AcceptSearch
 
 Accepts the search by keeping the latest focus while in search mode.
@@ -1110,7 +1282,7 @@ Example:
 
 #### ToggleFifo
 
-Toggle betwen {Start|Stop}Fifo
+Toggle between {Start|Stop}Fifo
 
 Type: { ToggleFifo = "string" }
 

docs/en/src/modes.md

@@ -35,6 +35,18 @@ The builtin go to path mode.
 
 Type: [Mode](https://xplr.dev/en/mode)
 
+#### xplr.config.modes.builtin.move_to
+
+The builtin move_to mode.
+
+Type: [Mode](https://xplr.dev/en/mode)
+
+#### xplr.config.modes.builtin.copy_to
+
+The builtin copy_to mode.
+
+Type: [Mode](https://xplr.dev/en/mode)
+
 #### xplr.config.modes.builtin.selection_ops
 
 The builtin selection ops mode.
@@ -143,6 +155,12 @@ The builtin vroot mode.
 
 Type: [Mode](https://xplr.dev/en/mode)
 
+#### xplr.config.modes.builtin.edit_permissions
+
+The builtin edit permissions mode.
+
+Type: [Mode](https://xplr.dev/en/mode)
+
 #### xplr.config.modes.custom
 
 This is where you define custom modes.

docs/en/src/node_types.md

@@ -88,7 +88,7 @@ Example:
 xplr.config.node_types.mime_essence = {
   application = {
     -- application/*
-    ["*"] = { meta = { icon = "a" } }
+    ["*"] = { meta = { icon = "a" } },
 
     -- application/pdf
     pdf = { meta = { icon = "" }, style = { fg = "Blue" } },

docs/en/src/post-install.md

@@ -16,14 +16,6 @@ Then
 **[copy from here][2]**
 and remove / comment out what you don't want to customize.
 
-> **Note:** You don't generally need to create the config file. You can use the
-> default configuration for basic operations. However, creating the config file
-> is recommended because the project is in its early stage and the defaults
-> might change. Creating the config file will save you from unexpected behavior
-> when you [upgrade][3].
-> Also, the default configuration is meant to be overwritten to suit your
-> workflow.
-
 ## Run
 
 ```

docs/en/src/searching.md

@@ -0,0 +1,77 @@
+# Searching
+
+xplr supports searching paths using different algorithm. The search mechanism
+generally appears between filters and sorters in the `Sort & filter` panel.
+
+Example:
+
+```
+fzy:foo↓
+```
+
+This line means that the nodes visible on the table are being filtered using the
+[fuzzy matching][1] algorithm on the input `foo`. The arrow means that ranking based
+ordering is being applied, i.e. [sorters][2] are being ignored.
+
+## Node Searcher Applicable
+
+Node Searcher contains the following fields:
+
+- [pattern][3]
+- [recoverable_focus][4]
+- [algorithm][5]
+- [unordered][7]
+
+### pattern
+
+The patterns used to search.
+
+Type: string
+
+### recoverable_focus
+
+Where to focus when search is cancelled.
+
+Type: nullable string
+
+### algorithm
+
+Search algorithm to use. Defaults to the value set in
+[xplr.config.general.search.algorithm][8].
+
+It can be one of the following:
+
+- Fuzzy
+- Regex
+
+### unordered
+
+Whether to skip ordering the search result by algorithm based ranking. Defaults
+to the value set in [xplr.config.general.search.unordered][9].
+
+Type: boolean
+
+## Example:
+
+```lua
+local searcher = {
+  pattern = "pattern to search",
+  recoverable_focus = "/path/to/focus/on/cancel",
+  algorithm = "Fuzzy",
+  unordered = false,
+}
+
+xplr.util.explore({ searcher = searcher })
+```
+
+See [xplr.util.explore][6].
+
+[1]: https://en.wikipedia.org/wiki/Approximate_string_matching
+[2]: sorting.md
+[3]: #pattern
+[4]: #recoverable_focus
+[5]: #algorithm
+[6]: xplr.util.md#xplrutilexplore
+[7]: #unordered
+[8]: general-config.md#xplrconfiggeneralsearchalgorithm
+[9]: general-config.md#xplrconfiggeneralsearchunordered

docs/en/src/sorting.md

@@ -27,7 +27,7 @@ It contains the following information:
 
 ### sorter
 
-A sorter can be one of the following:
+A sorter is a [sum type][4] that can be one of the following:
 
 - "ByRelativePath"
 - "ByIRelativePath"
@@ -82,3 +82,4 @@ This snippet defines the initial sorting logic to be applied when xplr loads.
 [1]: #node-sorter-applicable
 [2]: #sorter
 [3]: #reverse
+[4]: sum-type.md

docs/en/src/style.md

@@ -33,7 +33,7 @@ Modifiers to remove.
 
 ## Color
 
-Color can be one of the following:
+Color is a [sum type][7] that can be one of the following:
 
 - "Reset"
 - "Black"
@@ -57,7 +57,7 @@ Color can be one of the following:
 
 ## Modifier
 
-Modifier can be one of the following:
+Modifier is a [sum type][7] that can be one of the following:
 
 - "Bold"
 - "Dim"
@@ -84,3 +84,4 @@ xplr.config.general.prompt.style.sub_modifiers = { "Hidden" }
 [4]: #sub_modifiers
 [5]: #color
 [6]: #modifier
+[7]: sum-type.md

docs/en/src/sum-type.md

@@ -0,0 +1,96 @@
+# Sum Type
+
+> This section isn't specific to xplr. However, since xplr configuration makes
+> heavy use of this particular data type, even though it isn't available in
+> most of the mainstream programming languages (yet), making it a wild or
+> unfamiliar concept for many, it's worth doing a quick introduction here.
+>
+> If you're already familiar with [Sum Type / Tagged Union][1] (e.g. Rust's
+> enum), you can skip ahead.
+
+While reading this doc, you'll come across some data types like [Layout][2],
+[Color][4], [Message][3] etc. that says something like "x is a sum type that
+can be any of the following", and then you'll see a list of strings and/or lua
+tables just below.
+
+Yes, they are actually sum types, i.e. they can be any of the given set of
+tagged variants listed there.
+
+Notice the word "be". Unlike classes or structs (aka product types), they can't
+"have" values, they can only "be" the value, or rather, be one of the possible
+set of values.
+
+Also notice the word "tagged". Unlike the single variant `null`, or the dual
+variant `boolean` types, the variants of sum types are tagged (i.e. named), and
+may further have, or be, value or values of any data type.
+
+A simple example of a sum type is an enum. Many programming languages have
+them, but only a few modern programming languages allow nesting other types
+into a sum type.
+
+```rust
+enum Color {
+    Red,
+    Green,
+}
+```
+
+Here, `Color` can be one of two possible set of values: `Red` and `Green`, just
+like `boolean`, but unlike `boolean`, being tagged allows `Color` to have more
+than two variants if required, by changing the definition.
+
+e.g.
+
+```rust
+enum Color {
+    Red,
+    Green,
+    Blue,
+}
+```
+
+We'd document it here as:
+
+> Result is a sum type that can be one of the following:
+>
+> - "Red"
+> - "Green"
+> - "Blue"
+
+But some languages (like Rust, Haskell, Elm etc.) go even further, allowing us
+to associate each branch of the enum with further nested types like:
+
+```rust
+enum Layout {
+    Table,
+    HelpMenu,
+    Horizontal {
+        config: LayoutConfig,  // A product type (similar to class/struct)
+        splits: Vec<Layout>  // A list of "Layout"s (i.e. list of sum types)
+    },
+}
+```
+
+Here, as we can see, unlike the first example, some of `Layout`'s possible
+variants can have further nested types associated with them. Note that
+`Horizontal` here can have a sum type (e.g. enum), or a product type (e.g.
+class/struct), or both (any number of them actually) nested in it. But the
+nested values will only exist when `Layout` is `Horizontal`.
+
+We'd document it here as:
+
+> Layout is a sum type that can be one of the following:
+>
+> - "Table"
+> - "HelpMenu"
+> - { Horizontal = { config = Layout Config, splits = { Layout, ... } }
+
+And then we'd go on documenting whatever `Layout Config` is.
+
+So, there you go. This is exactly what sum types are - glorified enums that can
+have nested types in each branch.
+
+[1]: https://en.wikipedia.org/wiki/Tagged_union
+[2]: layout.md
+[3]: message.md
+[4]: style.md#color

docs/en/src/upgrade-guide.md

@@ -45,7 +45,99 @@ compatibility.
 
 ### Instructions
 
-#### [v0.19.4][47] -> [v0.20.1][48]
+#### [v0.20.2][48] -> [v0.21.8][49]
+
+- Some plugins might stop rendering colors. Wait for them to update.
+- Rename `xplr.config.general.sort_and_filter_ui.search_identifier` to
+  `xplr.config.general.sort_and_filter_ui.search_identifiers`.
+- Resolved Node API will not contain the `permissions` field anymore.
+  Use the utility function `xplr.util.node` to get its permissions.
+- Layout `CustomContent` has been undocumented. It will stay for compatibility,
+  but you should prefer using the following new layouts, because they support
+  custom title:
+  - Static
+  - Dynamic
+- Use the new messages for improved search operations:
+  - Search
+  - SearchFromInput
+  - SearchFuzzyUnordered
+  - SearchFuzzyUnorderedFromInput
+  - SearchRegex
+  - SearchRegexFromInput
+  - SearchRegexUnordered
+  - SearchRegexUnorderedFromInput
+  - ToggleSearchAlgorithm
+  - EnableSearchOrder
+  - DisableSearchOrder
+  - ToggleSearchOrder
+- Use skim's [search syntax][50] to customize the search.
+- Set your preferred search algorithm and ordering:
+  `xplr.config.general.search.algorithm = "Fuzzy" -- or "Regex"`.
+  `xplr.config.general.search.unordered = false -- or true`
+- You need to clear the selection list manually after performing batch
+  operation like copy, softlink creation etc.
+- Use the following new key bindings:
+  - `:sl` to list selection in a $PAGER.
+  - `:ss` to create softlink of the selected items.
+  - `:sh` to create hardlink of the selected items.
+  - `:se` to edit selection list in your $EDITOR.
+  - Better conflict handling: prompt for action.
+- Navigate between the selected paths using the following messages:
+  - FocusPreviousSelection (`ctrl-p`)
+  - FocusNextSelection (`ctrl-n`)
+- Use `LS_COLORS` environment variable, along with the following utility
+- functions for applying better styling/theaming.
+  - xplr.util.lscolor
+  - xplr.util.paint
+  - xplr.util.textwrap
+  - xplr.util.style_mix
+- Use new the fields in Column Renderer Argument:
+  - style
+  - permissions
+- Use the following config to specify how the paths in selection list should be
+  rendered:
+  - xplr.config.general.selection.item.format
+  - xplr.config.general.selection.item.style
+- Use the following utility functions to work with the file permissions:
+  - xplr.util.permissions_rwx
+  - xplr.util.permissions_octal
+- Type `:p` to edit file permissions interactively.
+- Also check out the following utility functions:
+  - xplr.util.layout_replace
+  - xplr.util.relative_to
+  - xplr.util.shorthand
+  - xplr.util.clone
+  - xplr.util.exists
+  - xplr.util.is_dir
+  - xplr.util.is_file
+  - xplr.util.is_symlink
+  - xplr.util.is_absolute
+  - xplr.util.path_split
+  - xplr.util.node
+  - xplr.util.node_type
+  - xplr.util.shell_escape
+- Executables will me marked with the mime type: `application/x-executable`.
+- macOS legacy coreutils will be generally supported, but please update it.
+- Since v0.21.2 you can use the on_selection_change hook.
+- Since v0.21.4 you can use function keys upto F24 and the following new
+  messages:
+  - NextVisitedDeepBranch (bound to `)` key)
+  - PreviousVisitedDeepBranch (bound to `(` key)
+- Since v0.21.6:
+  - You can use `c` and `m` keys in default mode to quickly copy
+    and move focused or selected files, without having to change directory.
+  - Use `xplr.util.debug()` to debug lua values.
+- Since v0.21.8:
+  - Scroll behavior will default to vim-like continuous scrolling. You can set
+    `xplr.config.general.paginated_scrolling = true` to revert back to the
+    paginated scrolling.
+  - Set `xplr.config.general.scroll_padding` to customize the scroll padding.
+  - The calculated `scrolltop` value will be passed as part of the
+    `Content Rendeder Argument` in `Dynamic` layout renderer functions.
+
+Thanks to @noahmayr for contributing to a major part of this release.
+
+#### [v0.19.4][47] -> [v0.20.2][48]
 
 - BREAKING: xplr shell (`:!`) will default to null (`\0`) delimited pipes, as
   opposed to newline (`\n`) delimited ones (i.e. will use `Call0` instead of
@@ -65,6 +157,8 @@ compatibility.
   - on_load
   - on_focus_change
   - on_directory_change
+  - on_mode_switch (since v0.20.2)
+  - on_layout_switch (since v0.20.2)
 - Use `--vroot` to isolate navigation of an xplr session inside a specific
   directory. Interaction still requires passing full path, and shell,
   lua functions etc still can access paths outside vroot.
@@ -127,8 +221,6 @@ compatibility.
   - ScrollUpHalf ---- {
   - ScrollDownHalf -- }
 
-<sub>Like this project so far? **[Please consider contributing][5]**.</sub>
-
 #### [v0.17.6][45] -> [v0.18.0][46]
 
 - Key binding `f` `r` and `f` `R` will now filter using regex.
@@ -227,7 +319,7 @@ compatibility.
 - You can disable the recover mode using `config.general.disable_recover_mode = true`.
 - Try running `xplr --help`. Yes, CLI has been implemented.
 - Since version `v0.14.3`, `StartFifo` and `ToggleFifo` will write to the FIFO
-  path when called. So, there's no need to pipe the focus path explicitely.
+  path when called. So, there's no need to pipe the focus path explicitly.
 - Since version `v0.14.3`, general config `xplr.config.start_fifo` is available
   which can be set to a file path to start a fifo when xplr starts.
 - Since version `v0.14.4`, `$XPLR_SESSION_PATH` can be used to dump session
@@ -238,7 +330,7 @@ compatibility.
 #### [v0.12.1][6] -> [v0.13.7][2]
 
 - Lua functions called using [`CallLua`][7] and [`CallLuaSilently`][8] messages will receive [`CallLuaArg`][9] object as the function argument (instead of the [`App`][10] object).
-- Each `node_types` config will inherit defaults from matching less specifig `node_types` config and overwrite them.
+- Each `node_types` config will inherit defaults from matching less specific `node_types` config and overwrite them.
 - Since version `v0.13.2`, you don't need to use/send `Refresh` anymore. It will be auto-handled by xplr.
 
 #### [v0.11.1][11] -> [v0.12.1][6]
@@ -394,7 +486,6 @@ Else do the following:
 [2]: https://github.com/sayanarijit/xplr/releases/tag/v0.13.7
 [3]: https://github.com/sayanarijit/xplr/releases/tag/v0.14.7
 [4]: https://github.com/sayanarijit/xplr/pull/229#issue-662426960
-[5]: contribute.md
 [6]: https://github.com/sayanarijit/xplr/releases/tag/v0.12.1
 [7]: https://docs.rs/xplr/latest/xplr/app/enum.ExternalMsg.html#variant.CallLua
 [8]: https://docs.rs/xplr/latest/xplr/app/enum.ExternalMsg.html#variant.CallLuaSilently
@@ -437,4 +528,6 @@ Else do the following:
 [45]: https://github.com/sayanarijit/xplr/releases/tag/v0.17.6
 [46]: https://github.com/sayanarijit/xplr/releases/tag/v0.18.0
 [47]: https://github.com/sayanarijit/xplr/releases/tag/v0.19.4
-[48]: https://github.com/sayanarijit/xplr/releases/tag/v0.20.1
+[48]: https://github.com/sayanarijit/xplr/releases/tag/v0.20.2
+[49]: https://github.com/sayanarijit/xplr/releases/tag/v0.21.8
+[50]: https://github.com/lotabout/skim#search-syntax

docs/en/src/writing-plugins.md

@@ -70,8 +70,6 @@ Visit [Awesome Plugins][5] for xplr plugin examples.
 
 - [Tip: A list of hacks yet to make it as Lua plugins][15]
 - [Tip: Some UI and themeing tips][12]
-- [Tip: A list of handy utility functions][13]
-- [Tip: Share tips and tricks working with Lua][14]
 - [Tutorial: Adding a New Mode][6]
 - [Example: Using Environment Variables and Pipes][7]
 - [Example: Using Lua Function Calls][8]
@@ -92,7 +90,5 @@ Visit [Awesome Plugins][5] for xplr plugin examples.
 [10]: column-renderer.md#example-customizing-table-renderer
 [11]: layout.md#example-render-a-custom-dynamic-table
 [12]: https://github.com/sayanarijit/xplr/discussions/274
-[13]: https://github.com/sayanarijit/xplr/discussions/273
-[14]: https://github.com/sayanarijit/xplr/discussions/250
-[15]: https://github.com/sayanarijit/xplr/wiki/Hacks
+[15]: awesome-hacks.md
 [16]: https://github.com/sayanarijit/xplr/discussions/529#discussioncomment-4073734

docs/en/src/xplr.util.md

@@ -11,6 +11,158 @@ xplr.util.version()
 -- { major = 0, minor = 0, patch = 0 }
 ```
 
+### xplr.util.debug
+
+Print the given value to the console, and return it as a string.
+Useful for debugging.
+
+Type: function( value ) -> string
+
+Example:
+
+```lua
+xplr.util.debug({ foo = "bar", bar = function() end })
+-- {
+--   ["bar"] = function: 0x55e5cebdeae0,
+--   ["foo"] = "bar",
+-- }
+```
+
+### xplr.util.clone
+
+Clone/deepcopy a Lua value. Doesn't work with functions.
+
+Type: function( value ) -> value
+
+Example:
+
+```lua
+local val = { foo = "bar" }
+local val_clone = xplr.util.clone(val)
+val.foo = "baz"
+print(val_clone.foo)
+-- "bar"
+```
+
+### xplr.util.exists
+
+Check if the given path exists.
+
+Type: function( path:string ) -> boolean
+
+Example:
+
+```lua
+xplr.util.exists("/foo/bar")
+-- true
+```
+
+### xplr.util.is_dir
+
+Check if the given path is a directory.
+
+Type: function( path:string ) -> boolean
+
+Example:
+
+```lua
+xplr.util.is_dir("/foo/bar")
+-- true
+```
+
+### xplr.util.is_file
+
+Check if the given path is a file.
+
+Type: function( path:string ) -> boolean
+
+Example:
+
+```lua
+xplr.util.is_file("/foo/bar")
+-- true
+```
+
+### xplr.util.is_symlink
+
+Check if the given path is a symlink.
+
+Type: function( path:string ) -> boolean
+
+Example:
+
+```lua
+xplr.util.is_file("/foo/bar")
+-- true
+```
+
+### xplr.util.is_absolute
+
+Check if the given path is an absolute path.
+
+Type: function( path:string ) -> boolean
+
+Example:
+
+```lua
+xplr.util.is_absolute("/foo/bar")
+-- true
+```
+
+### xplr.util.path_split
+
+Split a path into its components.
+
+Type: function( path:string ) -> boolean
+
+Example:
+
+```lua
+xplr.util.path_split("/foo/bar")
+-- { "/", "foo", "bar" }
+
+xplr.util.path_split(".././foo")
+-- { "..", "foo" }
+```
+
+### xplr.util.node
+
+Get [Node][5] information of a given path.
+Doesn't check if the path exists.
+Returns nil if the path is "/".
+Errors out if absolute path can't be obtained.
+
+Type: function( path:string ) -> [Node][5]|nil
+
+Example:
+
+```lua
+xplr.util.node("./bar")
+-- { parent = "/pwd", relative_path = "bar", absolute_path = "/pwd/bar", ... }
+
+xplr.util.node("/")
+-- nil
+```
+
+### xplr.util.node_type
+
+Get the configured [Node Type][6] of a given [Node][5].
+
+Type: function( [Node][5], [xplr.config.node_types][7]|nil ) -> [Node Type][6]
+
+If the second argument is missing, global config `xplr.config.node_types`
+will be used.
+
+Example:
+
+```lua
+xplr.util.node_type(app.focused_node)
+-- { style = { fg = "Red", ... }, meta = { icon = "", ... } ... }
+
+xplr.util.node_type(xplr.util.node("/foo/bar"), xplr.config.node_types)
+-- { style = { fg = "Red", ... }, meta = { icon = "", ... } ... }
+```
+
 ### xplr.util.dirname
 
 Get the directory name of a given path.
@@ -51,36 +203,108 @@ xplr.util.absolute("foo/bar")
 -- "/tmp/foo/bar"
 ```
 
+### xplr.util.relative_to
+
+Get the relative path based on the given base path or current working dir.
+Will error if it fails to determine a relative path.
+
+Type: function( path:string, options:table|nil ) -> path:string
+
+Options type: { base:string|nil, with_prefix_dots:bookean|nil, without_suffix_dots:boolean|nil }
+
+- If `base` path is given, the path will be relative to it.
+- If `with_prefix_dots` is true, the path will always start with dots `..` / `.`
+- If `without_suffix_dots` is true, the name will be visible instead of dots `..` / `.`
+
+Example:
+
+```lua
+xplr.util.relative_to("/present/working/directory")
+-- "."
+
+xplr.util.relative_to("/present/working/directory/foo")
+-- "foo"
+
+xplr.util.relative_to("/present/working/directory/foo", { with_prefix_dots = true })
+-- "./foo"
+
+xplr.util.relative_to("/present/working/directory", { without_suffix_dots = true })
+-- "../directory"
+
+xplr.util.relative_to("/present/working")
+-- ".."
+
+xplr.util.relative_to("/present/working", { without_suffix_dots = true })
+-- "../../working"
+
+xplr.util.relative_to("/present/working/directory", { base = "/present/foo/bar" })
+-- "../../working/directory"
+```
+
+### xplr.util.shorten
+
+Shorten the given absolute path using the following rules:
+
+- either relative to your home dir if it makes sense
+- or relative to the current working directory
+- or absolute path if it makes the most sense
+
+Type: Similar to `xplr.util.relative_to`
+
+Example:
+
+```lua
+xplr.util.shorten("/home/username/.config")
+-- "~/.config"
+
+xplr.util.shorten("/present/working/directory")
+-- "."
+
+xplr.util.shorten("/present/working/directory/foo")
+-- "foo"
+
+xplr.util.shorten("/present/working/directory/foo", { with_prefix_dots = true })
+-- "./foo"
+
+xplr.util.shorten("/present/working/directory", { without_suffix_dots = true })
+-- "../directory"
+
+xplr.util.shorten("/present/working/directory", { base = "/present/foo/bar" })
+-- "../../working/directory"
+
+xplr.util.shorten("/tmp")
+-- "/tmp"
+```
+
 ### xplr.util.explore
 
 Explore directories with the given explorer config.
 
-Type: function( path:string, config:[Explorer Config][1]|nil )
--> { node:[Node][2]... }
+Type: function( path:string, [ExplorerConfig][1]|nil ) -> { [Node][2], ... }
 
 Example:
 
 ```lua
 
 xplr.util.explore("/tmp")
+-- { { absolute_path = "/tmp/a", ... }, ... }
+
 xplr.util.explore("/tmp", app.explorer_config)
 -- { { absolute_path = "/tmp/a", ... }, ... }
 ```
 
-[1]: https://xplr.dev/en/lua-function-calls#explorer-config
-[2]: https://xplr.dev/en/lua-function-calls#node
-
 ### xplr.util.shell_execute
 
 Execute shell commands safely.
 
-Type: function( program:string, args:{ arg:string... }|nil )
--> { stdout = string, stderr = string, returncode = number|nil }
+Type: function( program:string, args:{ string, ... }|nil ) -> { stdout = string, stderr = string, returncode = number|nil }
 
 Example:
 
 ```lua
-xplr.util.shell_execute("pwd"})
+xplr.util.shell_execute("pwd")
+-- { stdout = "/present/working/directory", stderr = "", returncode = 0 }
+
 xplr.util.shell_execute("bash", {"-c", "xplr --help"})
 -- { stdout = "xplr...", stderr = "", returncode = 0 }
 ```
@@ -98,11 +322,24 @@ xplr.util.shell_quote("a'b\"c")
 -- 'a'"'"'b"c'
 ```
 
+### xplr.util.shell_escape
+
+Escape commands and paths safely.
+
+Type: function( string ) -> string
+
+Example:
+
+```lua
+xplr.util.shell_escape("a'b\"c")
+-- "\"a'b\\\"c\""
+```
+
 ### xplr.util.from_json
 
 Load JSON string into Lua value.
 
-Type: function( string ) -> value
+Type: function( string ) -> any
 
 Example:
 
@@ -121,11 +358,11 @@ Example:
 
 ```lua
 xplr.util.to_json({ foo = "bar" })
--- [[{ "foos": "bar" }]]
+-- [[{ "foo": "bar" }]]
 
 xplr.util.to_json({ foo = "bar" }, { pretty = true })
 -- [[{
---   "foos": "bar"
+--   "foo": "bar"
 -- }]]
 ```
 
@@ -154,3 +391,138 @@ Example:
 xplr.util.to_yaml({ foo = "bar" })
 -- "foo: bar"
 ```
+
+### xplr.util.lscolor
+
+Get a [Style][3] object for the given path based on the LS_COLORS
+environment variable.
+
+Type: function( path:string ) -> [Style][3]
+
+Example:
+
+```lua
+xplr.util.lscolor("Desktop")
+-- { fg = "Red", bg = nil, add_modifiers = {}, sub_modifiers = {} }
+```
+
+### xplr.util.paint
+
+Apply style (escape sequence) to string using a given [Style][3] object.
+
+Type: function( string, [Style][3]|nil ) -> string
+
+Example:
+
+```lua
+xplr.util.paint("Desktop", { fg = "Red", bg = nil, add_modifiers = {}, sub_modifiers = {} })
+-- "\u001b[31mDesktop\u001b[0m"
+```
+
+### xplr.util.style_mix
+
+Mix multiple [Style][3] objects into one.
+
+Type: function( { [Style][3], [Style][3], ... } ) -> [Style][3]
+
+Example:
+
+```lua
+xplr.util.style_mix({{ fg = "Red" }, { bg = "Blue" }, { add_modifiers = {"Bold"} }})
+-- { fg = "Red", bg = "Blue", add_modifiers = { "Bold" }, sub_modifiers = {} }
+```
+
+### xplr.util.textwrap
+
+Wrap the given text to fit the specified width.
+It will try to not split words when possible.
+
+Type: function( string, options:number|table ) -> { string, ...}
+
+Options type: { width = number, initial_indent = string|nil, subsequent_indent = string|nil, break_words = boolean|nil }
+
+Example:
+
+```lua
+xplr.util.textwrap("this will be cut off", 11)
+-- { "this will', 'be cut off" }
+
+xplr.util.textwrap(
+  "this will be cut off",
+  { width = 12, initial_indent = "", subsequent_indent = "    ", break_words = false }
+)
+-- { "this will be", "    cut off" }
+```
+
+### xplr.util.layout_replace
+
+Find the target layout in the given layout and replace it with the replacement layout,
+returning a new layout.
+
+Type: function( layout:[Layout][4], target:[Layout][4], replacement:[Layout][4] ) -> layout:[Layout][4]
+
+Example:
+
+```lua
+local layout = {
+  Horizontal = {
+    splits = {
+      "Table",  -- Target
+      "HelpMenu",
+    },
+    config = ...,
+  }
+}
+
+xplr.util.layout_replace(layout, "Table", "Selection")
+-- {
+--   Horizontal = {
+--     splits = {
+--       "Selection",  -- Replacement
+--       "HelpMenu",
+--     },
+--     config = ...
+--   }
+-- }
+```
+
+### xplr.util.permissions_rwx
+
+Convert [Permission][8] to rwxrwxrwx representation with special bits.
+
+Type: function( [Permission][8] ) -> string
+
+Example:
+
+```lua
+xplr.util.permissions_rwx({ user_read = true })
+-- "r--------"
+
+xplr.util.permissions_rwx(app.focused_node.permission)
+-- "rwxrwsrwT"
+```
+
+### xplr.util.permissions_octal
+
+Convert [Permission][8] to octal representation.
+
+Type: function( [Permission][8] ) -> { number, number, number, number }
+
+Example:
+
+```lua
+xplr.util.permissions_octal({ user_read = true })
+-- { 0, 4, 0, 0 }
+
+xplr.util.permissions_octal(app.focused_node.permission)
+-- { 0, 7, 5, 4 }
+```
+
+[1]: https://xplr.dev/en/lua-function-calls#explorer-config
+[2]: https://xplr.dev/en/lua-function-calls#node
+[3]: https://xplr.dev/en/style
+[4]: https://xplr.dev/en/layout
+[5]: https://xplr.dev/en/lua-function-calls#node
+[6]: https://xplr.dev/en/node-type
+[7]: https://xplr.dev/en/node_types
+[8]: https://xplr.dev/en/column-renderer#permission

docs/landing/index.html

@@ -151,7 +151,7 @@
               <li class="nav-item">
                 <a
                   class="nav-link page-scroll"
-                  href="https://xplr.stck.me"
+                  href="https://blog.xplr.dev"
                   target="_blank"
                   rel="noreferrer noopener"
                 >

docs/script/deploy-cf.sh

@@ -0,0 +1,11 @@
+v="0.4.37"
+
+curl -L https://github.com/rust-lang/mdBook/releases/download/v$v/mdbook-v$v-x86_64-unknown-linux-gnu.tar.gz -o mdbook.tgz \
+  && tar xzvf mdbook.tgz \
+  && ./mdbook build docs/en \
+  && mkdir dist \
+  && mv -v docs/en/book/html dist/en \
+  && mv -v assets dist \
+  && mv -v docs/landing/index.html docs/landing/css docs/landing/js dist \
+  && rm -v mdbook \
+  && rm -v mdbook.tgz

docs/script/generate.py

@@ -260,6 +260,9 @@ def gen_xplr_util():
             print("\n".join(function.doc))
             print("\n".join(function.doc), file=f)
 
+        if reading:
+            print("\n".join(reading.doc), file=f)
+
 
 def format_docs():
     os.system("prettier --write docs/en/src")

flake.lock

@@ -1,97 +1,12 @@
 {
   "nodes": {
-    "flake-compat": {
-      "flake": false,
-      "locked": {
-        "lastModified": 1650374568,
-        "narHash": "sha256-Z+s0J8/r907g149rllvwhb4pKi8Wam5ij0st8PwAh+E=",
-        "owner": "edolstra",
-        "repo": "flake-compat",
-        "rev": "b4a34015c698c7793d592d66adbab377907a2be8",
-        "type": "github"
-      },
-      "original": {
-        "owner": "edolstra",
-        "repo": "flake-compat",
-        "type": "github"
-      }
-    },
-    "lowdown-src": {
-      "flake": false,
-      "locked": {
-        "lastModified": 1633514407,
-        "narHash": "sha256-Dw32tiMjdK9t3ETl5fzGrutQTzh2rufgZV4A/BbxuD4=",
-        "owner": "kristapsdz",
-        "repo": "lowdown",
-        "rev": "d2c2b44ff6c27b936ec27358a2653caaef8f73b8",
-        "type": "github"
-      },
-      "original": {
-        "owner": "kristapsdz",
-        "repo": "lowdown",
-        "type": "github"
-      }
-    },
-    "nix": {
-      "inputs": {
-        "lowdown-src": "lowdown-src",
-        "nixpkgs": "nixpkgs",
-        "nixpkgs-regression": "nixpkgs-regression"
-      },
-      "locked": {
-        "lastModified": 1667849540,
-        "narHash": "sha256-kqo8PTE3i21Z0pnxJwcwCQRZKKC15Y8xFTEN6qko3M8=",
-        "owner": "domenkozar",
-        "repo": "nix",
-        "rev": "3dcbdd412592413f34552a50403daf58656d43e6",
-        "type": "github"
-      },
-      "original": {
-        "owner": "domenkozar",
-        "ref": "relaxed-flakes",
-        "repo": "nix",
-        "type": "github"
-      }
-    },
     "nixpkgs": {
       "locked": {
-        "lastModified": 1657693803,
-        "narHash": "sha256-G++2CJ9u0E7NNTAi9n5G8TdDmGJXcIjkJ3NF8cetQB8=",
-        "owner": "NixOS",
-        "repo": "nixpkgs",
-        "rev": "365e1b3a859281cf11b94f87231adeabbdd878a2",
-        "type": "github"
-      },
-      "original": {
-        "owner": "NixOS",
-        "ref": "nixos-22.05-small",
-        "repo": "nixpkgs",
-        "type": "github"
-      }
-    },
-    "nixpkgs-regression": {
-      "locked": {
-        "lastModified": 1643052045,
-        "narHash": "sha256-uGJ0VXIhWKGXxkeNnq4TvV3CIOkUJ3PAoLZ3HMzNVMw=",
-        "owner": "NixOS",
-        "repo": "nixpkgs",
-        "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2",
-        "type": "github"
-      },
-      "original": {
-        "owner": "NixOS",
-        "repo": "nixpkgs",
-        "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2",
-        "type": "github"
-      }
-    },
-    "nixpkgs_2": {
-      "locked": {
-        "lastModified": 1668199800,
-        "narHash": "sha256-qnEeVo88H8an0Wds9kBSxWlGCa0vY5EgEswnQUZnXmc=",
+        "lastModified": 1704262187,
+        "narHash": "sha256-N4j9qghlp/Eb3Z11WF7Cb9U91AXwpascUbLH7YKMcLc=",
         "owner": "nixos",
         "repo": "nixpkgs",
-        "rev": "98bb201bbfba99003e6cd5f85c13c46050fb8ee8",
+        "rev": "65f0d241783c94a08e4c9a3870736fc8854dd520",
         "type": "github"
       },
       "original": {
@@ -102,9 +17,7 @@
     },
     "root": {
       "inputs": {
-        "flake-compat": "flake-compat",
-        "nix": "nix",
-        "nixpkgs": "nixpkgs_2"
+        "nixpkgs": "nixpkgs"
       }
     }
   },

flake.nix

@@ -3,30 +3,26 @@
 
   inputs = {
     nixpkgs.url = "github:nixos/nixpkgs";
-    nix.url = "github:domenkozar/nix/relaxed-flakes";
-    flake-compat = {
-      url = "github:edolstra/flake-compat";
-      flake = false;
-    };
   };
 
-  outputs = { self, nixpkgs, nix, ... }:
+  outputs = inputs@{ self, nixpkgs, ... }:
     let
-      systems = [
-        "x86_64-linux"
-        "i686-linux"
-        "x86_64-darwin"
-        "aarch64-linux"
-        "aarch64-darwin"
-      ];
-      forAllSystems = f: builtins.listToAttrs (map (name: { inherit name; value = f name; }) systems);
+      lib = nixpkgs.lib;
+
+      darwin = [ "x86_64-darwin" "aarch64-darwin" ];
+      linux = [ "x86_64-linux" "x86_64-linux-musl" "aarch64-linux" "aarch64-linux-android" "i86_64-linux" ];
+      allSystems = darwin ++ linux;
+
+      forEachSystem = systems: f: lib.genAttrs systems (system: f system);
+      forAllSystems = forEachSystem allSystems;
     in
     {
       packages = forAllSystems (system:
         let
           pkgs = import nixpkgs { inherit system; };
         in
-        {
+        rec {
+          # e.g. nix build .#xplr
           xplr = pkgs.rustPlatform.buildRustPackage rec {
             name = "xplr";
             src = ./.;
@@ -34,6 +30,14 @@
               lockFile = ./Cargo.lock;
             };
           };
+
+          # e.g. nix build .#cross.x86_64-linux-musl.xplr --impure
+          cross = forEachSystem (lib.filter (sys: sys != system) allSystems) (targetSystem:
+            let
+              crossPkgs = import nixpkgs { localSystem = system; crossSystem = targetSystem; };
+            in
+            { inherit (crossPkgs) xplr; }
+          );
         }
       );
       defaultPackage = forAllSystems (system: self.packages.${system}.xplr);
@@ -54,6 +58,9 @@
           default = pkgs.mkShell {
             RUST_BACKTRACE = 1;
 
+            # For cross compilation
+            NIXPKGS_ALLOW_UNSUPPORTED_SYSTEM = 1;
+
             buildInputs = devRequirements;
             packages = devRequirements;
           };

snap/snapcraft.yaml

@@ -0,0 +1,26 @@
+name: xplr
+version: git
+summary: A hackable, minimal, fast TUI file explorer
+description: |
+  xplr is a terminal UI based file explorer
+  that aims to increase our terminal productivity by being a flexible,
+  interactive orchestrator for the ever growing awesome command-line
+  utilities that work with the file-system.
+source-code: https://github.com/sayanarijit/xplr
+issues: https://github.com/sayanarijit/xplr/issues
+website: https://xplr.dev/
+
+base: core20
+grade: devel # must be 'stable' to release into candidate/stable channels
+confinement: devmode # use 'strict' once you have the right plugs and slots
+
+
+parts:
+  xplr:
+    plugin: rust
+    source: .
+
+apps:
+  xplr:
+    command: bin/xplr
+

src/bin/xplr.rs

@@ -6,7 +6,7 @@ use xplr::runner;
 
 fn main() {
     let cli = Cli::parse(env::args()).unwrap_or_else(|e| {
-        eprintln!("error: {}", e);
+        eprintln!("error: {e}");
         std::process::exit(1);
     });
 
@@ -15,32 +15,32 @@ fn main() {
     xplr [FLAG]... [OPTION]... [PATH] [SELECTION]..."###;
 
         let flags = r###"
-    -                            Reads new-line (\n) separated paths from stdin
-    --                           Denotes the end of command-line flags and options
-        --force-focus            Focuses on the given <PATH>, even if it is a directory
-    -h, --help                   Prints help information
-    -m, --pipe-msg-in            Helps safely passing messages to the active xplr
-                                   session, use %%, %s and %q as the placeholders
-    -M, --print-msg-in           Like --pipe-msg-in, but prints the message instead of
-                                   passing to the active xplr session
-        --print-pwd-as-result    Prints the present working directory when quitting
-                                   with `PrintResultAndQuit`
-        --read-only              Enables read-only mode (config.general.read_only)
-        --read0                  Reads paths separated using the null character (\0)
-        --write0                 Prints paths separated using the null character (\0)
-    -0  --null                   Combines --read0 and --write0
-    -V, --version                Prints version information"###;
+  -                            Reads new-line (\n) separated paths from stdin
+  --                           Denotes the end of command-line flags and options
+      --force-focus            Focuses on the given <PATH>, even if it is a directory
+  -h, --help                   Prints help information
+  -m, --pipe-msg-in            Helps safely passing messages to the active xplr
+                                 session, use %%, %s and %q as the placeholders
+  -M, --print-msg-in           Like --pipe-msg-in, but prints the message instead of
+                                 passing to the active xplr session
+      --print-pwd-as-result    Prints the present working directory when quitting
+                                 with `PrintResultAndQuit`
+      --read-only              Enables read-only mode (config.general.read_only)
+      --read0                  Reads paths separated using the null character (\0)
+      --write0                 Prints paths separated using the null character (\0)
+  -0  --null                   Combines --read0 and --write0
+  -V, --version                Prints version information"###;
 
         let options = r###"
-    -c, --config <PATH>             Specifies a custom config file (default is
-                                      "$HOME/.config/xplr/init.lua")
-    -C, --extra-config <PATH>...    Specifies extra config files to load
-        --on-load <MESSAGE>...      Sends messages when xplr loads
-        --vroot <PATH>              Treats the specified path as the virtual root"###;
+  -c, --config <PATH>             Specifies a custom config file (default is
+                                    "$HOME/.config/xplr/init.lua")
+  -C, --extra-config <PATH>...    Specifies extra config files to load
+      --on-load <MESSAGE>...      Sends messages when xplr loads
+      --vroot <PATH>              Treats the specified path as the virtual root"###;
 
         let args = r###"
-    <PATH>            Path to focus on, or enter if directory, (default is `.`)
-    <SELECTION>...    Paths to select, requires <PATH> to be set explicitly"###;
+  <PATH>            Path to focus on, or enter if directory, (default is `.`)
+  <SELECTION>...    Paths to select, requires <PATH> to be set explicitly"###;
 
         let help = format!(
             "xplr {}\n{}\n{}\n\nUSAGE:{}\n\nFLAGS:{}\n\nOPTIONS:{}\n\nARGS:{}",
@@ -54,28 +54,28 @@ fn main() {
         );
         let help = help.trim();
 
-        println!("{}", help);
+        println!("{help}");
     } else if cli.version {
         println!("xplr {}", xplr::app::VERSION);
     } else if !cli.pipe_msg_in.is_empty() {
         if let Err(err) = cli::pipe_msg_in(cli.pipe_msg_in) {
-            eprintln!("error: {}", err);
+            eprintln!("error: {err}");
             std::process::exit(1);
         }
     } else if !cli.print_msg_in.is_empty() {
         if let Err(err) = cli::print_msg_in(cli.print_msg_in) {
-            eprintln!("error: {}", err);
+            eprintln!("error: {err}");
             std::process::exit(1);
         }
     } else {
         match runner::from_cli(cli).and_then(|a| a.run()) {
             Ok(Some(out)) => {
-                print!("{}", out);
+                print!("{out}");
             }
             Ok(None) => {}
             Err(err) => {
                 if !err.to_string().is_empty() {
-                    eprintln!("error: {}", err);
+                    eprintln!("error: {err}");
                 };
 
                 std::process::exit(1);

src/cli.rs

@@ -106,17 +106,17 @@ impl Cli {
                     // Options
                     "-c" | "--config" => {
                         cli.config = Some(
-                            args.next().map(|a| Cli::read_path(&a)).with_context(
-                                || format!("usage: xplr {} PATH", arg),
-                            )??,
+                            args.next()
+                                .map(|a| Cli::read_path(&a))
+                                .with_context(|| format!("usage: xplr {arg} PATH"))??,
                         );
                     }
 
                     "--vroot" => {
                         cli.vroot = Some(
-                            args.next().map(|a| Cli::read_path(&a)).with_context(
-                                || format!("usage: xplr {} PATH", arg),
-                            )??,
+                            args.next()
+                                .map(|a| Cli::read_path(&a))
+                                .with_context(|| format!("usage: xplr {arg} PATH"))??,
                         );
                     }
 
@@ -185,13 +185,13 @@ pub fn pipe_msg_in(args: Vec<String>) -> Result<()> {
             .cloned()
             .context("failed to detect delimmiter")?;
 
-        msg.push(delimiter.try_into()?);
+        msg.push(delimiter.into());
         File::options()
             .append(true)
             .open(&path)?
             .write_all(msg.as_bytes())?;
     } else {
-        println!("{}", msg);
+        println!("{msg}");
     };
 
     Ok(())
@@ -199,70 +199,21 @@ pub fn pipe_msg_in(args: Vec<String>) -> Result<()> {
 
 pub fn print_msg_in(args: Vec<String>) -> Result<()> {
     let msg = fmt_msg_in(args)?;
-    print!("{}", msg);
+    print!("{msg}");
     Ok(())
 }
 
 fn fmt_msg_in(args: Vec<String>) -> Result<String> {
-    let mut args = args.into_iter();
-    let format = args.next().context("FORMAT is missing")?;
-    let mut msg = "".to_string();
-    let mut last_char = None;
-
-    for (col, ch) in format.chars().enumerate() {
-        match (ch, last_char) {
-            ('%', Some('%')) => {
-                msg.push(ch);
-                last_char = None;
-            }
-            ('%', _) => {
-                last_char = Some(ch);
-            }
-            ('q', Some('%')) => {
-                let arg = args.next().context(format!(
-                    "argument missing for the placeholder at column {}",
-                    col
-                ))?;
-                msg.push_str(&json::to_string(&arg)?);
-                last_char = None;
-            }
-            ('s', Some('%')) => {
-                let arg = args.next().context(format!(
-                    "argument missing for the placeholder at column {}",
-                    col
-                ))?;
-                msg.push_str(&arg);
-                last_char = None;
-            }
-            (ch, Some('%')) => {
-                bail!(format!(
-                    "invalid placeholder '%{}' at column {}, use one of '%s' or '%q', or escape it using '%%'",
-                    ch, col
-                ));
-            }
-            (ch, _) => {
-                msg.push(ch);
-                last_char = Some(ch);
-            }
-        }
-    }
-
-    if last_char == Some('%') {
-        bail!("message ended with incomplete placeholder");
-    }
-
-    if args.count() != 0 {
-        bail!("too many arguments, not enough placeholders")
-    }
-
-    // Since we'll mostly by passing json using `-m`, and json is faster than yaml
-    // let's try to validate using json first.
-    let msg = if let Ok(val) = json::from_str::<ExternalMsg>(&msg) {
-        json::to_string(&val)?
-    } else {
-        let val: ExternalMsg = yaml::from_str(&msg)?;
-        json::to_string(&val)?
+    let msg = match jf::format(args.into_iter().map(Into::into)) {
+        Ok(msg) => msg,
+        Err(jf::Error::Jf(e)) => bail!("xplr -m: {e}"),
+        Err(jf::Error::Json(e)) => bail!("xplr -m: json: {e}"),
+        Err(jf::Error::Yaml(e)) => bail!("xplr -m: yaml: {e}"),
+        Err(jf::Error::Io(e)) => bail!("xplr -m: io: {e}"),
     };
 
+    // validate
+    let _: ExternalMsg = json::from_str(&msg)?;
+
     Ok(msg)
 }

src/compat.rs

@@ -0,0 +1,224 @@
+// Things of the past, mostly bad decisions, which cannot erased, stays in this
+// haunted module.
+
+use crate::app;
+use crate::lua;
+use crate::ui::block;
+use crate::ui::string_to_text;
+use crate::ui::Constraint;
+use crate::ui::ContentRendererArg;
+use crate::ui::UI;
+use serde::{Deserialize, Serialize};
+use tui::layout::Constraint as TuiConstraint;
+use tui::layout::Rect as TuiRect;
+use tui::widgets::Cell;
+use tui::widgets::List;
+use tui::widgets::ListItem;
+use tui::widgets::Paragraph;
+use tui::widgets::Row;
+use tui::widgets::Table;
+use tui::Frame;
+
+/// A cursed enum from crate::ui.
+#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
+#[serde(deny_unknown_fields)]
+pub enum ContentBody {
+    /// A paragraph to render
+    StaticParagraph { render: String },
+
+    /// A Lua function that returns a paragraph to render
+    DynamicParagraph { render: String },
+
+    /// List to render
+    StaticList { render: Vec<String> },
+
+    /// A Lua function that returns lines to render
+    DynamicList { render: String },
+
+    /// A table to render
+    StaticTable {
+        widths: Vec<Constraint>,
+        col_spacing: Option<u16>,
+        render: Vec<Vec<String>>,
+    },
+
+    /// A Lua function that returns a table to render
+    DynamicTable {
+        widths: Vec<Constraint>,
+        col_spacing: Option<u16>,
+        render: String,
+    },
+}
+
+/// A cursed struct from crate::ui.
+#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
+#[serde(deny_unknown_fields)]
+pub struct CustomContent {
+    pub title: Option<String>,
+    pub body: ContentBody,
+}
+
+/// A cursed function from crate::ui.
+pub fn draw_custom_content(
+    ui: &mut UI,
+    f: &mut Frame,
+    layout_size: TuiRect,
+    app: &app::App,
+    content: CustomContent,
+) {
+    let config = app.config.general.panel_ui.default.clone();
+    let title = content.title;
+    let body = content.body;
+
+    match body {
+        ContentBody::StaticParagraph { render } => {
+            let render = string_to_text(render);
+            let content = Paragraph::new(render).block(block(
+                config,
+                title.map(|t| format!(" {t} ")).unwrap_or_default(),
+            ));
+            f.render_widget(content, layout_size);
+        }
+
+        ContentBody::DynamicParagraph { render } => {
+            let ctx = ContentRendererArg {
+                app: app.to_lua_ctx_light(),
+                layout_size: layout_size.into(),
+                screen_size: ui.screen_size.into(),
+                scrolltop: ui.scrolltop as u16,
+            };
+
+            let render = lua::serialize(ui.lua, &ctx)
+                .map(|arg| {
+                    lua::call(ui.lua, &render, arg).unwrap_or_else(|e| format!("{e:?}"))
+                })
+                .unwrap_or_else(|e| e.to_string());
+
+            let render = string_to_text(render);
+
+            let content = Paragraph::new(render).block(block(
+                config,
+                title.map(|t| format!(" {t} ")).unwrap_or_default(),
+            ));
+            f.render_widget(content, layout_size);
+        }
+
+        ContentBody::StaticList { render } => {
+            let items = render
+                .into_iter()
+                .map(string_to_text)
+                .map(ListItem::new)
+                .collect::<Vec<ListItem>>();
+
+            let content = List::new(items).block(block(
+                config,
+                title.map(|t| format!(" {t} ")).unwrap_or_default(),
+            ));
+            f.render_widget(content, layout_size);
+        }
+
+        ContentBody::DynamicList { render } => {
+            let ctx = ContentRendererArg {
+                app: app.to_lua_ctx_light(),
+                layout_size: layout_size.into(),
+                screen_size: ui.screen_size.into(),
+                scrolltop: ui.scrolltop as u16,
+            };
+
+            let items = lua::serialize(ui.lua, &ctx)
+                .map(|arg| {
+                    lua::call(ui.lua, &render, arg)
+                        .unwrap_or_else(|e| vec![format!("{e:?}")])
+                })
+                .unwrap_or_else(|e| vec![e.to_string()])
+                .into_iter()
+                .map(string_to_text)
+                .map(ListItem::new)
+                .collect::<Vec<ListItem>>();
+
+            let content = List::new(items).block(block(
+                config,
+                title.map(|t| format!(" {t} ")).unwrap_or_default(),
+            ));
+            f.render_widget(content, layout_size);
+        }
+
+        ContentBody::StaticTable {
+            widths,
+            col_spacing,
+            render,
+        } => {
+            let rows = render
+                .into_iter()
+                .map(|cols| {
+                    Row::new(
+                        cols.into_iter()
+                            .map(string_to_text)
+                            .map(Cell::from)
+                            .collect::<Vec<Cell>>(),
+                    )
+                })
+                .collect::<Vec<Row>>();
+
+            let widths = widths
+                .into_iter()
+                .map(|w| w.to_tui(ui.screen_size, layout_size))
+                .collect::<Vec<TuiConstraint>>();
+
+            let content = Table::new(rows, widths)
+                .column_spacing(col_spacing.unwrap_or(1))
+                .block(block(
+                    config,
+                    title.map(|t| format!(" {t} ")).unwrap_or_default(),
+                ));
+
+            f.render_widget(content, layout_size);
+        }
+
+        ContentBody::DynamicTable {
+            widths,
+            col_spacing,
+            render,
+        } => {
+            let ctx = ContentRendererArg {
+                app: app.to_lua_ctx_light(),
+                layout_size: layout_size.into(),
+                screen_size: ui.screen_size.into(),
+                scrolltop: ui.scrolltop as u16,
+            };
+
+            let rows = lua::serialize(ui.lua, &ctx)
+                .map(|arg| {
+                    lua::call(ui.lua, &render, arg)
+                        .unwrap_or_else(|e| vec![vec![format!("{e:?}")]])
+                })
+                .unwrap_or_else(|e| vec![vec![e.to_string()]])
+                .into_iter()
+                .map(|cols| {
+                    Row::new(
+                        cols.into_iter()
+                            .map(string_to_text)
+                            .map(Cell::from)
+                            .collect::<Vec<Cell>>(),
+                    )
+                })
+                .collect::<Vec<Row>>();
+
+            let widths = widths
+                .into_iter()
+                .map(|w| w.to_tui(ui.screen_size, layout_size))
+                .collect::<Vec<TuiConstraint>>();
+
+            let mut content = Table::new(rows, &widths).block(block(
+                config,
+                title.map(|t| format!(" {t} ")).unwrap_or_default(),
+            ));
+
+            if let Some(col_spacing) = col_spacing {
+                content = content.column_spacing(col_spacing);
+            };
+
+            f.render_widget(content, layout_size);
+        }
+    }
+}

src/config.rs

@@ -3,6 +3,8 @@ use crate::app::HelpMenuLine;
 use crate::app::NodeFilter;
 use crate::app::NodeSorter;
 use crate::app::NodeSorterApplicable;
+use crate::node::Node;
+use crate::search::SearchAlgorithm;
 use crate::ui::Border;
 use crate::ui::BorderType;
 use crate::ui::Constraint;
@@ -53,7 +55,7 @@ pub struct NodeTypeConfig {
 impl NodeTypeConfig {
     pub fn extend(mut self, other: &Self) -> Self {
         self.style = self.style.extend(&other.style);
-        self.meta.extend(other.meta.to_owned());
+        self.meta.extend(other.meta.clone());
         self
     }
 }
@@ -80,6 +82,40 @@ pub struct NodeTypesConfig {
     pub special: HashMap<String, NodeTypeConfig>,
 }
 
+impl NodeTypesConfig {
+    pub fn get(&self, node: &Node) -> NodeTypeConfig {
+        let mut node_type = if node.is_symlink {
+            self.symlink.clone()
+        } else if node.is_dir {
+            self.directory.clone()
+        } else {
+            self.file.clone()
+        };
+
+        let mut me = node.mime_essence.splitn(2, '/');
+        let mimetype: String = me.next().map(|s| s.into()).unwrap_or_default();
+        let mimesub: String = me.next().map(|s| s.into()).unwrap_or_default();
+
+        if let Some(conf) = self
+            .mime_essence
+            .get(&mimetype)
+            .and_then(|t| t.get(&mimesub).or_else(|| t.get("*")))
+        {
+            node_type = node_type.extend(conf);
+        }
+
+        if let (Some(conf), false) = (self.extension.get(&node.extension), node.is_dir) {
+            node_type = node_type.extend(conf);
+        }
+
+        if let Some(conf) = self.special.get(&node.relative_path) {
+            node_type = node_type.extend(conf);
+        }
+
+        node_type
+    }
+}
+
 #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
 #[serde(deny_unknown_fields)]
 pub struct UiConfig {
@@ -105,7 +141,7 @@ pub struct UiElement {
 
 impl UiElement {
     pub fn extend(mut self, other: &Self) -> Self {
-        self.format = other.format.to_owned().or(self.format);
+        self.format = other.format.clone().or(self.format);
         self.style = self.style.extend(&other.style);
         self
     }
@@ -146,6 +182,23 @@ pub struct TableConfig {
     pub col_widths: Option<Vec<Constraint>>,
 }
 
+#[derive(Debug, Clone, Default, Serialize, Deserialize)]
+#[serde(deny_unknown_fields)]
+pub struct SelectionConfig {
+    #[serde(default)]
+    pub item: UiElement,
+}
+
+#[derive(Debug, Clone, Default, Serialize, Deserialize)]
+#[serde(deny_unknown_fields)]
+pub struct SearchConfig {
+    #[serde(default)]
+    pub algorithm: SearchAlgorithm,
+
+    #[serde(default)]
+    pub unordered: bool,
+}
+
 #[derive(Debug, Clone, Default, Serialize, Deserialize)]
 #[serde(deny_unknown_fields)]
 pub struct LogsConfig {
@@ -172,6 +225,16 @@ pub struct SortDirectionIdentifiersUi {
     pub reverse: UiElement,
 }
 
+#[derive(Debug, Clone, Default, Serialize, Deserialize)]
+#[serde(deny_unknown_fields)]
+pub struct SearchDirectionIdentifiersUi {
+    #[serde(default)]
+    pub ordered: UiElement,
+
+    #[serde(default)]
+    pub unordered: UiElement,
+}
+
 #[derive(Debug, Clone, Default, Serialize, Deserialize)]
 #[serde(deny_unknown_fields)]
 pub struct SortAndFilterUi {
@@ -191,7 +254,10 @@ pub struct SortAndFilterUi {
     pub filter_identifiers: HashMap<NodeFilter, UiElement>,
 
     #[serde(default)]
-    pub search_identifier: Option<UiElement>,
+    pub search_direction_identifiers: SearchDirectionIdentifiersUi,
+
+    #[serde(default)]
+    pub search_identifiers: HashMap<SearchAlgorithm, UiElement>,
 }
 
 #[derive(Debug, Clone, Default, Serialize, Deserialize)]
@@ -249,6 +315,12 @@ pub struct GeneralConfig {
     #[serde(default)]
     pub table: TableConfig,
 
+    #[serde(default)]
+    pub selection: SelectionConfig,
+
+    #[serde(default)]
+    pub search: SearchConfig,
+
     #[serde(default)]
     pub default_ui: UiConfig,
 
@@ -281,6 +353,12 @@ pub struct GeneralConfig {
 
     #[serde(default)]
     pub global_key_bindings: KeyBindings,
+
+    #[serde(default)]
+    pub paginated_scrolling: bool,
+
+    #[serde(default)]
+    pub scroll_padding: usize,
 }
 
 #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
@@ -566,8 +644,8 @@ impl PanelUiConfig {
     pub fn extend(mut self, other: &Self) -> Self {
         self.title = self.title.extend(&other.title);
         self.style = self.style.extend(&other.style);
-        self.borders = other.borders.to_owned().or(self.borders);
-        self.border_type = other.border_type.to_owned().or(self.border_type);
+        self.borders = other.borders.clone().or(self.borders);
+        self.border_type = other.border_type.or(self.border_type);
         self.border_style = self.border_style.extend(&other.border_style);
         self
     }
@@ -624,6 +702,15 @@ pub struct Hooks {
 
     #[serde(default)]
     pub on_focus_change: Vec<ExternalMsg>,
+
+    #[serde(default)]
+    pub on_mode_switch: Vec<ExternalMsg>,
+
+    #[serde(default)]
+    pub on_layout_switch: Vec<ExternalMsg>,
+
+    #[serde(default)]
+    pub on_selection_change: Vec<ExternalMsg>,
     // TODO After cleanup or Runner::run
     // #[serde(default)]
     // pub before_quit: Vec<ExternalMsg>,
@@ -634,6 +721,9 @@ impl Hooks {
         self.on_load.extend(other.on_load);
         self.on_directory_change.extend(other.on_directory_change);
         self.on_focus_change.extend(other.on_focus_change);
+        self.on_mode_switch.extend(other.on_mode_switch);
+        self.on_layout_switch.extend(other.on_layout_switch);
+        self.on_selection_change.extend(other.on_selection_change);
         self
     }
 }

src/directory_buffer.rs

@@ -1,6 +1,6 @@
 use crate::node::Node;
-use chrono::{DateTime, Utc};
 use serde::{Deserialize, Serialize};
+use time::OffsetDateTime;
 
 #[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
 pub struct DirectoryBuffer {
@@ -9,8 +9,8 @@ pub struct DirectoryBuffer {
     pub total: usize,
     pub focus: usize,
 
-    #[serde(skip)]
-    pub explored_at: DateTime<Utc>,
+    #[serde(skip, default = "now")]
+    pub explored_at: OffsetDateTime,
 }
 
 impl DirectoryBuffer {
@@ -21,7 +21,7 @@ impl DirectoryBuffer {
             nodes,
             total,
             focus,
-            explored_at: Utc::now(),
+            explored_at: now(),
         }
     }
 
@@ -29,3 +29,9 @@ impl DirectoryBuffer {
         self.nodes.get(self.focus)
     }
 }
+
+fn now() -> OffsetDateTime {
+    OffsetDateTime::now_local()
+        .ok()
+        .unwrap_or_else(OffsetDateTime::now_utc)
+}

src/dirs.rs

@@ -0,0 +1,26 @@
+use std::{env, path::PathBuf};
+
+use lazy_static::lazy_static;
+use xdg::BaseDirectories;
+
+lazy_static! {
+    pub static ref BASE_DIRS: Option<BaseDirectories> = BaseDirectories::new().ok();
+}
+
+pub fn home_dir() -> Option<PathBuf> {
+    home::home_dir()
+}
+
+pub fn config_dir() -> Option<PathBuf> {
+    BASE_DIRS.as_ref().map(|base| base.get_config_home())
+}
+
+pub fn runtime_dir() -> PathBuf {
+    let Some(dir) = BASE_DIRS
+        .as_ref()
+        .and_then(|base| base.get_runtime_directory().ok())
+    else {
+        return env::temp_dir();
+    };
+    dir.clone()
+}

src/explorer.rs

@@ -2,21 +2,14 @@ use crate::app::{
     DirectoryBuffer, ExplorerConfig, ExternalMsg, InternalMsg, MsgIn, Node, Task,
 };
 use anyhow::{Error, Result};
-use fuzzy_matcher::skim::SkimMatcherV2;
-use fuzzy_matcher::FuzzyMatcher;
-use lazy_static::lazy_static;
 use std::fs;
 use std::path::PathBuf;
 use std::sync::mpsc::Sender;
 use std::thread;
 
-lazy_static! {
-    static ref FUZZY_MATCHER: SkimMatcherV2 = SkimMatcherV2::default();
-}
-
 pub fn explore(parent: &PathBuf, config: &ExplorerConfig) -> Result<Vec<Node>> {
     let dirs = fs::read_dir(parent)?;
-    let mut nodes = dirs
+    let nodes = dirs
         .filter_map(|d| {
             d.ok().map(|e| {
                 e.path()
@@ -26,26 +19,24 @@ pub fn explore(parent: &PathBuf, config: &ExplorerConfig) -> Result<Vec<Node>> {
             })
         })
         .map(|name| Node::new(parent.to_string_lossy().to_string(), name))
-        .filter(|n| config.filter(n))
-        .collect::<Vec<Node>>();
-
-    nodes = if let Some(pattern) = config.searcher.as_ref().map(|s| &s.pattern) {
-        let mut nodes = nodes
-            .into_iter()
-            .filter_map(|n| {
-                FUZZY_MATCHER
-                    .fuzzy_match(&n.relative_path, pattern)
-                    .map(|score| (n, score))
-            })
-            .collect::<Vec<(_, _)>>();
+        .filter(|n| config.filter(n));
 
-        nodes.sort_by(|(_, s1), (_, s2)| s2.cmp(s1));
-        nodes.into_iter().map(|(n, _)| n).collect::<Vec<_>>()
+    let mut nodes = if let Some(searcher) = config.searcher.as_ref() {
+        searcher.search(nodes)
     } else {
-        nodes.sort_by(|a, b| config.sort(a, b));
-        nodes
+        nodes.collect()
     };
 
+    let is_ordered_search = config
+        .searcher
+        .as_ref()
+        .map(|s| !s.unordered)
+        .unwrap_or(false);
+
+    if !is_ordered_search {
+        nodes.sort_by(|a, b| config.sort(a, b));
+    }
+
     Ok(nodes)
 }
 
@@ -65,7 +56,7 @@ pub(crate) fn explore_sync(
             .enumerate()
             .find(|(_, n)| n.relative_path == focus_str)
             .map(|(i, _)| i)
-            .unwrap_or_else(|| fallback_focus.min(nodes.len().max(1) - 1))
+            .unwrap_or_else(|| fallback_focus.min(nodes.len().saturating_sub(1)))
     } else {
         0
     };

src/input.rs

@@ -18,6 +18,18 @@ pub enum Key {
     F10,
     F11,
     F12,
+    F13,
+    F14,
+    F15,
+    F16,
+    F17,
+    F18,
+    F19,
+    F20,
+    F21,
+    F22,
+    F23,
+    F24,
 
     Num0,
     Num1,
@@ -203,7 +215,7 @@ impl std::fmt::Display for Key {
                     .unwrap_or_default()
             });
 
-        write!(f, "{}", key_str)
+        write!(f, "{key_str}")
     }
 }
 
@@ -339,7 +351,19 @@ impl Key {
                 KeyCode::F(9) => Key::F9,
                 KeyCode::F(10) => Key::F10,
                 KeyCode::F(11) => Key::F11,
-                KeyCode::F(12) => Key::F12,
+                KeyCode::F(13) => Key::F13,
+                KeyCode::F(12) => Key::F13,
+                KeyCode::F(14) => Key::F14,
+                KeyCode::F(15) => Key::F15,
+                KeyCode::F(16) => Key::F16,
+                KeyCode::F(17) => Key::F17,
+                KeyCode::F(18) => Key::F18,
+                KeyCode::F(19) => Key::F19,
+                KeyCode::F(20) => Key::F20,
+                KeyCode::F(21) => Key::F21,
+                KeyCode::F(22) => Key::F22,
+                KeyCode::F(23) => Key::F23,
+                KeyCode::F(24) => Key::F24,
 
                 KeyCode::Backspace => Key::Backspace,
                 KeyCode::Left => Key::Left,
@@ -623,7 +647,7 @@ impl Key {
             Self::ShiftZ => Some('Z'),
 
             Self::Space => Some(' '),
-            Self::Special(c) => Some(c.to_owned()),
+            Self::Special(c) => Some(*c),
 
             _ => None,
         }

src/lib.rs

@@ -4,18 +4,22 @@
 
 pub mod app;
 pub mod cli;
+pub mod compat;
 pub mod config;
 pub mod directory_buffer;
+pub mod dirs;
 pub mod event_reader;
 pub mod explorer;
 pub mod input;
 pub mod lua;
 pub mod msg;
 pub mod node;
+pub mod path;
 pub mod permissions;
 pub mod pipe;
 pub mod pwd_watcher;
 pub mod runner;
+pub mod search;
 pub mod ui;
 pub mod yaml;
 

src/lua/mod.rs

@@ -7,7 +7,7 @@ use anyhow::Result;
 use mlua::Lua;
 use mlua::LuaSerdeExt;
 use mlua::SerializeOptions;
-use serde::Deserialize;
+use serde::de::DeserializeOwned;
 use serde::Serialize;
 use std::fs;
 
@@ -81,7 +81,7 @@ pub fn init(lua: &Lua) -> Result<(Config, Option<Hooks>)> {
 
     let hooks: Option<Hooks> = lua
         .load(DEFAULT_LUA_SCRIPT)
-        .set_name("xplr init")?
+        .set_name("xplr init")
         .call(())
         .and_then(|v| lua.from_value(v))?;
 
@@ -98,7 +98,7 @@ pub fn extend(lua: &Lua, path: &str) -> Result<(Config, Option<Hooks>)> {
 
     let hooks: Option<Hooks> = lua
         .load(&script)
-        .set_name(path)?
+        .set_name(path)
         .call(())
         .and_then(|v| lua.from_value(v))?;
 
@@ -138,12 +138,12 @@ pub fn resolve_fn<'lua>(
     resolve_fn_recursive(globals, path.split('.'))
 }
 
-pub fn call<'lua, R: Deserialize<'lua>>(
+pub fn call<'lua, R: DeserializeOwned>(
     lua: &'lua Lua,
     func: &str,
     arg: mlua::Value<'lua>,
 ) -> Result<R> {
-    let func = format!("xplr.fn.{}", func);
+    let func = format!("xplr.fn.{func}");
     let func = resolve_fn(&lua.globals(), &func)?;
     let res: mlua::Value = func.call(arg)?;
     let res: R = lua.from_value(res)?;
@@ -160,24 +160,24 @@ mod tests {
         assert!(check_version(VERSION, "foo path").is_ok());
 
         // Current release if OK
-        assert!(check_version("0.20.1", "foo path").is_ok());
+        assert!(check_version("0.21.8", "foo path").is_ok());
 
         // Prev major release is ERR
         // - Not yet
 
         // Prev minor release is ERR (Change when we get to v1)
-        assert!(check_version("0.19.1", "foo path").is_err());
+        assert!(check_version("0.20.8", "foo path").is_err());
 
         // Prev bugfix release is OK
-        assert!(check_version("0.20.0", "foo path").is_ok());
+        assert!(check_version("0.21.7", "foo path").is_ok());
 
         // Next major release is ERR
-        assert!(check_version("1.20.1", "foo path").is_err());
+        assert!(check_version("1.20.8", "foo path").is_err());
 
         // Next minor release is ERR
-        assert!(check_version("0.21.1", "foo path").is_err());
+        assert!(check_version("0.22.8", "foo path").is_err());
 
         // Next bugfix release is ERR (Change when we get to v1)
-        assert!(check_version("0.20.2", "foo path").is_err());
+        assert!(check_version("0.21.9", "foo path").is_err());
     }
 }

src/lua/util.rs

@@ -1,8 +1,20 @@
 use crate::app::VERSION;
+use crate::config::NodeTypesConfig;
 use crate::explorer;
 use crate::lua;
 use crate::msg::in_::external::ExplorerConfig;
+use crate::node::Node;
+use crate::path;
+use crate::path::RelativityConfig;
+use crate::permissions::Octal;
+use crate::permissions::Permissions;
+use crate::ui;
+use crate::ui::Layout;
+use crate::ui::Style;
+use crate::ui::WrapOptions;
 use anyhow::Result;
+use lazy_static::lazy_static;
+use lscolors::LsColors;
 use mlua::Error as LuaError;
 use mlua::Lua;
 use mlua::LuaSerdeExt;
@@ -13,25 +25,12 @@ use serde::de::Error;
 use serde::{Deserialize, Serialize};
 use serde_json as json;
 use serde_yaml as yaml;
+use std::borrow::Cow;
 use std::path::PathBuf;
 use std::process::Command;
 
-pub(crate) fn create_table(lua: &Lua) -> Result<Table> {
-    let mut util = lua.create_table()?;
-
-    util = version(util, lua)?;
-    util = dirname(util, lua)?;
-    util = basename(util, lua)?;
-    util = absolute(util, lua)?;
-    util = explore(util, lua)?;
-    util = shell_execute(util, lua)?;
-    util = shell_quote(util, lua)?;
-    util = from_json(util, lua)?;
-    util = to_json(util, lua)?;
-    util = from_yaml(util, lua)?;
-    util = to_yaml(util, lua)?;
-
-    Ok(util)
+lazy_static! {
+    static ref LS_COLORS: LsColors = LsColors::from_env().unwrap_or_default();
 }
 
 /// Get the xplr version details.
@@ -70,6 +69,233 @@ pub fn version<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
     Ok(util)
 }
 
+/// Print the given value to the console, and return it as a string.
+/// Useful for debugging.
+///
+/// Type: function( value ) -> string
+///
+/// Example:
+///
+/// ```lua
+/// xplr.util.debug({ foo = "bar", bar = function() end })
+/// -- {
+/// --   ["bar"] = function: 0x55e5cebdeae0,
+/// --   ["foo"] = "bar",
+/// -- }
+/// ```
+pub fn debug<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
+    let func = lua.create_function(|_, value: Value| {
+        let log = format!("{:#?}", value);
+        println!("{}", log);
+        Ok(log)
+    })?;
+    util.set("debug", func)?;
+    Ok(util)
+}
+
+/// Clone/deepcopy a Lua value. Doesn't work with functions.
+///
+/// Type: function( value ) -> value
+///
+/// Example:
+///
+/// ```lua
+/// local val = { foo = "bar" }
+/// local val_clone = xplr.util.clone(val)
+/// val.foo = "baz"
+/// print(val_clone.foo)
+/// -- "bar"
+/// ```
+pub fn clone<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
+    let func = lua.create_function(move |lua, value: Value| {
+        lua::serialize(lua, &value).map_err(LuaError::custom)
+    })?;
+    util.set("clone", func)?;
+    Ok(util)
+}
+
+/// Check if the given path exists.
+///
+/// Type: function( path:string ) -> boolean
+///
+/// Example:
+///
+/// ```lua
+/// xplr.util.exists("/foo/bar")
+/// -- true
+/// ```
+pub fn exists<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
+    let func =
+        lua.create_function(move |_, path: String| Ok(PathBuf::from(path).exists()))?;
+    util.set("exists", func)?;
+    Ok(util)
+}
+
+/// Check if the given path is a directory.
+///
+/// Type: function( path:string ) -> boolean
+///
+/// Example:
+///
+/// ```lua
+/// xplr.util.is_dir("/foo/bar")
+/// -- true
+/// ```
+pub fn is_dir<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
+    let func =
+        lua.create_function(move |_, path: String| Ok(PathBuf::from(path).is_dir()))?;
+    util.set("is_dir", func)?;
+    Ok(util)
+}
+
+/// Check if the given path is a file.
+///
+/// Type: function( path:string ) -> boolean
+///
+/// Example:
+///
+/// ```lua
+/// xplr.util.is_file("/foo/bar")
+/// -- true
+/// ```
+pub fn is_file<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
+    let func =
+        lua.create_function(move |_, path: String| Ok(PathBuf::from(path).is_file()))?;
+    util.set("is_file", func)?;
+    Ok(util)
+}
+
+/// Check if the given path is a symlink.
+///
+/// Type: function( path:string ) -> boolean
+///
+/// Example:
+///
+/// ```lua
+/// xplr.util.is_file("/foo/bar")
+/// -- true
+/// ```
+pub fn is_symlink<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
+    let func = lua
+        .create_function(move |_, path: String| Ok(PathBuf::from(path).is_symlink()))?;
+    util.set("is_symlink", func)?;
+    Ok(util)
+}
+
+/// Check if the given path is an absolute path.
+///
+/// Type: function( path:string ) -> boolean
+///
+/// Example:
+///
+/// ```lua
+/// xplr.util.is_absolute("/foo/bar")
+/// -- true
+/// ```
+pub fn is_absolute<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
+    let func = lua
+        .create_function(move |_, path: String| Ok(PathBuf::from(path).is_absolute()))?;
+    util.set("is_absolute", func)?;
+    Ok(util)
+}
+
+/// Split a path into its components.
+///
+/// Type: function( path:string ) -> boolean
+///
+/// Example:
+///
+/// ```lua
+/// xplr.util.path_split("/foo/bar")
+/// -- { "/", "foo", "bar" }
+///
+/// xplr.util.path_split(".././foo")
+/// -- { "..", "foo" }
+/// ```
+pub fn path_split<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
+    let func = lua.create_function(move |_, path: String| {
+        let components: Vec<String> = PathBuf::from(path)
+            .components()
+            .map(|c| c.as_os_str().to_string_lossy().to_string())
+            .collect();
+        Ok(components)
+    })?;
+    util.set("path_split", func)?;
+    Ok(util)
+}
+
+/// Get [Node][5] information of a given path.
+/// Doesn't check if the path exists.
+/// Returns nil if the path is "/".
+/// Errors out if absolute path can't be obtained.
+///
+/// Type: function( path:string ) -> [Node][5]|nil
+///
+/// Example:
+///
+/// ```lua
+/// xplr.util.node("./bar")
+/// -- { parent = "/pwd", relative_path = "bar", absolute_path = "/pwd/bar", ... }
+///
+/// xplr.util.node("/")
+/// -- nil
+/// ```
+pub fn node<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
+    let func = lua.create_function(move |lua, path: String| {
+        let path = PathBuf::from(path);
+        let abs = path.absolutize()?;
+        match (abs.parent(), abs.file_name()) {
+            (Some(parent), Some(name)) => {
+                let node = Node::new(
+                    parent.to_string_lossy().to_string(),
+                    name.to_string_lossy().to_string(),
+                );
+                Ok(lua::serialize(lua, &node).map_err(LuaError::custom)?)
+            }
+            (_, _) => Ok(Value::Nil),
+        }
+    })?;
+    util.set("node", func)?;
+    Ok(util)
+}
+
+/// Get the configured [Node Type][6] of a given [Node][5].
+///
+/// Type: function( [Node][5], [xplr.config.node_types][7]|nil ) -> [Node Type][6]
+///
+/// If the second argument is missing, global config `xplr.config.node_types`
+/// will be used.
+///
+/// Example:
+///
+/// ```lua
+/// xplr.util.node_type(app.focused_node)
+/// -- { style = { fg = "Red", ... }, meta = { icon = "", ... } ... }
+///
+/// xplr.util.node_type(xplr.util.node("/foo/bar"), xplr.config.node_types)
+/// -- { style = { fg = "Red", ... }, meta = { icon = "", ... } ... }
+/// ```
+pub fn node_type<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
+    let func =
+        lua.create_function(move |lua, (node, config): (Table, Option<Table>)| {
+            let node: Node = lua.from_value(Value::Table(node))?;
+            let config: Table = if let Some(config) = config {
+                config
+            } else {
+                lua.globals()
+                    .get::<_, Table>("xplr")?
+                    .get::<_, Table>("config")?
+                    .get::<_, Table>("node_types")?
+            };
+            let config: NodeTypesConfig = lua.from_value(Value::Table(config))?;
+            let node_type = config.get(&node);
+            let node_type = lua::serialize(lua, &node_type).map_err(LuaError::custom)?;
+            Ok(node_type)
+        })?;
+    util.set("node_type", func)?;
+    Ok(util)
+}
+
 /// Get the directory name of a given path.
 ///
 /// Type: function( path:string ) -> path:string|nil
@@ -125,32 +351,119 @@ pub fn basename<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
 /// ```
 pub fn absolute<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
     let func = lua.create_function(|_, path: String| {
-        let parent = PathBuf::from(path)
+        let abs = PathBuf::from(path)
             .absolutize()?
             .to_string_lossy()
             .to_string();
-        Ok(parent)
+        Ok(abs)
     })?;
     util.set("absolute", func)?;
     Ok(util)
 }
 
+/// Get the relative path based on the given base path or current working dir.
+/// Will error if it fails to determine a relative path.
+///
+/// Type: function( path:string, options:table|nil ) -> path:string
+///
+/// Options type: { base:string|nil, with_prefix_dots:bookean|nil, without_suffix_dots:boolean|nil }
+///
+/// - If `base` path is given, the path will be relative to it.
+/// - If `with_prefix_dots` is true, the path will always start with dots `..` / `.`
+/// - If `without_suffix_dots` is true, the name will be visible instead of dots `..` / `.`
+///
+/// Example:
+///
+/// ```lua
+/// xplr.util.relative_to("/present/working/directory")
+/// -- "."
+///
+/// xplr.util.relative_to("/present/working/directory/foo")
+/// -- "foo"
+///
+/// xplr.util.relative_to("/present/working/directory/foo", { with_prefix_dots = true })
+/// -- "./foo"
+///
+/// xplr.util.relative_to("/present/working/directory", { without_suffix_dots = true })
+/// -- "../directory"
+///
+/// xplr.util.relative_to("/present/working")
+/// -- ".."
+///
+/// xplr.util.relative_to("/present/working", { without_suffix_dots = true })
+/// -- "../../working"
+///
+/// xplr.util.relative_to("/present/working/directory", { base = "/present/foo/bar" })
+/// -- "../../working/directory"
+/// ```
+pub fn relative_to<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
+    let func = lua.create_function(|lua, (path, config): (String, Option<Table>)| {
+        let config: Option<RelativityConfig<String>> =
+            lua.from_value(config.map(Value::Table).unwrap_or(Value::Nil))?;
+        path::relative_to(path, config.as_ref())
+            .map(|p| p.to_string_lossy().to_string())
+            .map_err(LuaError::custom)
+    })?;
+    util.set("relative_to", func)?;
+    Ok(util)
+}
+
+/// Shorten the given absolute path using the following rules:
+/// - either relative to your home dir if it makes sense
+/// - or relative to the current working directory
+/// - or absolute path if it makes the most sense
+///
+/// Type: Similar to `xplr.util.relative_to`
+///
+/// Example:
+///
+/// ```lua
+/// xplr.util.shorten("/home/username/.config")
+/// -- "~/.config"
+///
+/// xplr.util.shorten("/present/working/directory")
+/// -- "."
+///
+/// xplr.util.shorten("/present/working/directory/foo")
+/// -- "foo"
+///
+/// xplr.util.shorten("/present/working/directory/foo", { with_prefix_dots = true })
+/// -- "./foo"
+///
+/// xplr.util.shorten("/present/working/directory", { without_suffix_dots = true })
+/// -- "../directory"
+///
+/// xplr.util.shorten("/present/working/directory", { base = "/present/foo/bar" })
+/// -- "../../working/directory"
+///
+/// xplr.util.shorten("/tmp")
+/// -- "/tmp"
+/// ```
+pub fn shorten<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
+    let func =
+        lua.create_function(move |lua, (path, config): (String, Option<Table>)| {
+            let config: Option<RelativityConfig<String>> =
+                lua.from_value(config.map(Value::Table).unwrap_or(Value::Nil))?;
+            path::shorten(path, config.as_ref()).map_err(LuaError::custom)
+        })?;
+    util.set("shorten", func)?;
+    Ok(util)
+}
+
 /// Explore directories with the given explorer config.
 ///
-/// Type: function( path:string, config:[Explorer Config][1]|nil )
-///         -> { node:[Node][2]... }
+/// Type: function( path:string, [ExplorerConfig][1]|nil ) -> { [Node][2], ... }
 ///
 /// Example:
 ///
 /// ```lua
 ///
 /// xplr.util.explore("/tmp")
+/// -- { { absolute_path = "/tmp/a", ... }, ... }
+///
 /// xplr.util.explore("/tmp", app.explorer_config)
 /// -- { { absolute_path = "/tmp/a", ... }, ... }
 /// ```
-///
-/// [1]: https://xplr.dev/en/lua-function-calls#explorer-config
-/// [2]: https://xplr.dev/en/lua-function-calls#node
 pub fn explore<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
     let func = lua.create_function(|lua, (path, config): (String, Option<Table>)| {
         let config: ExplorerConfig = if let Some(cfg) = config {
@@ -170,13 +483,14 @@ pub fn explore<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
 
 /// Execute shell commands safely.
 ///
-/// Type: function( program:string, args:{ arg:string... }|nil )
-///         -> { stdout = string, stderr = string, returncode = number|nil }
+/// Type: function( program:string, args:{ string, ... }|nil ) -> { stdout = string, stderr = string, returncode = number|nil }
 ///
 /// Example:
 ///
 /// ```lua
-/// xplr.util.shell_execute("pwd"})
+/// xplr.util.shell_execute("pwd")
+/// -- { stdout = "/present/working/directory", stderr = "", returncode = 0 }
+///
 /// xplr.util.shell_execute("bash", {"-c", "xplr --help"})
 /// -- { stdout = "xplr...", stderr = "", returncode = 0 }
 /// ```
@@ -218,9 +532,28 @@ pub fn shell_quote<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
     Ok(util)
 }
 
+/// Escape commands and paths safely.
+///
+/// Type: function( string ) -> string
+///
+/// Example:
+///
+/// ```lua
+/// xplr.util.shell_escape("a'b\"c")
+/// -- "\"a'b\\\"c\""
+/// ```
+pub fn shell_escape<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
+    let func = lua.create_function(move |_, string: String| {
+        let val = path::escape(&string).to_string();
+        Ok(val)
+    })?;
+    util.set("shell_escape", func)?;
+    Ok(util)
+}
+
 /// Load JSON string into Lua value.
 ///
-/// Type: function( string ) -> value
+/// Type: function( string ) -> any
 ///
 /// Example:
 ///
@@ -245,11 +578,11 @@ pub fn from_json<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
 ///
 /// ```lua
 /// xplr.util.to_json({ foo = "bar" })
-/// -- [[{ "foos": "bar" }]]
+/// -- [[{ "foo": "bar" }]]
 ///
 /// xplr.util.to_json({ foo = "bar" }, { pretty = true })
 /// -- [[{
-/// --   "foos": "bar"
+/// --   "foo": "bar"
 /// -- }]]
 /// ```
 pub fn to_json<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
@@ -317,3 +650,255 @@ pub fn to_yaml<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
     util.set("to_yaml", func)?;
     Ok(util)
 }
+
+/// Get a [Style][3] object for the given path based on the LS_COLORS
+/// environment variable.
+///
+/// Type: function( path:string ) -> [Style][3]
+///
+/// Example:
+///
+/// ```lua
+/// xplr.util.lscolor("Desktop")
+/// -- { fg = "Red", bg = nil, add_modifiers = {}, sub_modifiers = {} }
+/// ```
+pub fn lscolor<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
+    let func = lua.create_function(move |lua, path: String| {
+        let style = LS_COLORS
+            .style_for_path(path)
+            .map(Style::from)
+            .unwrap_or_default();
+        lua::serialize(lua, &style).map_err(LuaError::custom)
+    })?;
+    util.set("lscolor", func)?;
+    Ok(util)
+}
+
+/// Apply style (escape sequence) to string using a given [Style][3] object.
+///
+/// Type: function( string, [Style][3]|nil ) -> string
+///
+/// Example:
+///
+/// ```lua
+/// xplr.util.paint("Desktop", { fg = "Red", bg = nil, add_modifiers = {}, sub_modifiers = {} })
+/// -- "\u001b[31mDesktop\u001b[0m"
+/// ```
+pub fn paint<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
+    let func =
+        lua.create_function(|lua, (string, style): (String, Option<Table>)| {
+            if *ui::NO_COLOR {
+                return Ok(string);
+            }
+
+            if let Some(style) = style {
+                let style: Style = lua.from_value(Value::Table(style))?;
+                let ansi_style: nu_ansi_term::Style = style.into();
+                Ok::<String, LuaError>(ansi_style.paint(string).to_string())
+            } else {
+                Ok(string)
+            }
+        })?;
+    util.set("paint", func)?;
+    Ok(util)
+}
+
+/// Mix multiple [Style][3] objects into one.
+///
+/// Type: function( { [Style][3], [Style][3], ... } ) -> [Style][3]
+///
+/// Example:
+///
+/// ```lua
+/// xplr.util.style_mix({{ fg = "Red" }, { bg = "Blue" }, { add_modifiers = {"Bold"} }})
+/// -- { fg = "Red", bg = "Blue", add_modifiers = { "Bold" }, sub_modifiers = {} }
+/// ```
+pub fn style_mix<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
+    let func = lua.create_function(|lua, styles: Vec<Table>| {
+        let mut style = Style::default();
+        for other in styles {
+            let other: Style = lua.from_value(Value::Table(other))?;
+            style = style.extend(&other);
+        }
+
+        lua::serialize(lua, &style).map_err(LuaError::custom)
+    })?;
+    util.set("style_mix", func)?;
+    Ok(util)
+}
+
+/// Wrap the given text to fit the specified width.
+/// It will try to not split words when possible.
+///
+/// Type: function( string, options:number|table ) -> { string, ...}
+///
+/// Options type: { width = number, initial_indent = string|nil, subsequent_indent = string|nil, break_words = boolean|nil }
+///
+/// Example:
+///
+/// ```lua
+/// xplr.util.textwrap("this will be cut off", 11)
+/// -- { "this will', 'be cut off" }
+///
+/// xplr.util.textwrap(
+///   "this will be cut off",
+///   { width = 12, initial_indent = "", subsequent_indent = "    ", break_words = false }
+/// )
+/// -- { "this will be", "    cut off" }
+/// ```
+pub fn textwrap<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
+    let func = lua.create_function(|lua, (text, options): (String, Value)| {
+        let lines = match lua.from_value::<usize>(options.clone()) {
+            Ok(width) => textwrap::wrap(&text, width),
+            Err(_) => {
+                let options = lua.from_value::<WrapOptions>(options)?;
+                textwrap::wrap(&text, options.get_options())
+            }
+        };
+
+        Ok(lines.iter().map(Cow::to_string).collect::<Vec<String>>())
+    })?;
+    util.set("textwrap", func)?;
+    Ok(util)
+}
+
+/// Find the target layout in the given layout and replace it with the replacement layout,
+/// returning a new layout.
+///
+/// Type: function( layout:[Layout][4], target:[Layout][4], replacement:[Layout][4] ) -> layout:[Layout][4]
+///
+/// Example:
+///
+/// ```lua
+/// local layout = {
+///   Horizontal = {
+///     splits = {
+///       "Table",  -- Target
+///       "HelpMenu",
+///     },
+///     config = ...,
+///   }
+/// }
+///
+/// xplr.util.layout_replace(layout, "Table", "Selection")
+/// -- {
+/// --   Horizontal = {
+/// --     splits = {
+/// --       "Selection",  -- Replacement
+/// --       "HelpMenu",
+/// --     },
+/// --     config = ...
+/// --   }
+/// -- }
+/// ```
+pub fn layout_replace<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
+    let func = lua.create_function(
+        move |lua, (layout, target, replacement): (Value, Value, Value)| {
+            let layout: Layout = lua.from_value(layout)?;
+            let target: Layout = lua.from_value(target)?;
+            let replacement: Layout = lua.from_value(replacement)?;
+
+            let res = layout.replace(&target, &replacement);
+            let res = lua::serialize(lua, &res).map_err(LuaError::custom)?;
+
+            Ok(res)
+        },
+    )?;
+    util.set("layout_replace", func)?;
+    Ok(util)
+}
+
+/// Convert [Permission][8] to rwxrwxrwx representation with special bits.
+///
+/// Type: function( [Permission][8] ) -> string
+///
+/// Example:
+///
+/// ```lua
+/// xplr.util.permissions_rwx({ user_read = true })
+/// -- "r--------"
+///
+/// xplr.util.permissions_rwx(app.focused_node.permission)
+/// -- "rwxrwsrwT"
+/// ```
+pub fn permissions_rwx<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
+    let func = lua.create_function(|lua, permission: Table| {
+        let permissions: Permissions = lua.from_value(Value::Table(permission))?;
+        let permissions = permissions.to_string();
+        Ok(permissions)
+    })?;
+    util.set("permissions_rwx", func)?;
+    Ok(util)
+}
+
+/// Convert [Permission][8] to octal representation.
+///
+/// Type: function( [Permission][8] ) -> { number, number, number, number }
+///
+/// Example:
+///
+/// ```lua
+/// xplr.util.permissions_octal({ user_read = true })
+/// -- { 0, 4, 0, 0 }
+///
+/// xplr.util.permissions_octal(app.focused_node.permission)
+/// -- { 0, 7, 5, 4 }
+/// ```
+pub fn permissions_octal<'a>(util: Table<'a>, lua: &Lua) -> Result<Table<'a>> {
+    let func = lua.create_function(|lua, permission: Table| {
+        let permissions: Permissions = lua.from_value(Value::Table(permission))?;
+        let permissions: Octal = permissions.into();
+        let permissions = lua::serialize(lua, &permissions).map_err(LuaError::custom)?;
+        Ok(permissions)
+    })?;
+    util.set("permissions_octal", func)?;
+    Ok(util)
+}
+
+///
+/// [1]: https://xplr.dev/en/lua-function-calls#explorer-config
+/// [2]: https://xplr.dev/en/lua-function-calls#node
+/// [3]: https://xplr.dev/en/style
+/// [4]: https://xplr.dev/en/layout
+/// [5]: https://xplr.dev/en/lua-function-calls#node
+/// [6]: https://xplr.dev/en/node-type
+/// [7]: https://xplr.dev/en/node_types
+/// [8]: https://xplr.dev/en/column-renderer#permission
+
+pub(crate) fn create_table(lua: &Lua) -> Result<Table> {
+    let mut util = lua.create_table()?;
+
+    util = version(util, lua)?;
+    util = debug(util, lua)?;
+    util = clone(util, lua)?;
+    util = exists(util, lua)?;
+    util = is_dir(util, lua)?;
+    util = is_file(util, lua)?;
+    util = is_symlink(util, lua)?;
+    util = is_absolute(util, lua)?;
+    util = path_split(util, lua)?;
+    util = node(util, lua)?;
+    util = node_type(util, lua)?;
+    util = dirname(util, lua)?;
+    util = basename(util, lua)?;
+    util = absolute(util, lua)?;
+    util = relative_to(util, lua)?;
+    util = shorten(util, lua)?;
+    util = explore(util, lua)?;
+    util = shell_execute(util, lua)?;
+    util = shell_quote(util, lua)?;
+    util = shell_escape(util, lua)?;
+    util = from_json(util, lua)?;
+    util = to_json(util, lua)?;
+    util = from_yaml(util, lua)?;
+    util = to_yaml(util, lua)?;
+    util = lscolor(util, lua)?;
+    util = paint(util, lua)?;
+    util = style_mix(util, lua)?;
+    util = textwrap(util, lua)?;
+    util = layout_replace(util, lua)?;
+    util = permissions_rwx(util, lua)?;
+    util = permissions_octal(util, lua)?;
+
+    Ok(util)
+}

src/msg/in_/external.rs

@@ -1,8 +1,11 @@
-use crate::{app::Node, input::InputOperation};
+use crate::app::Node;
+use crate::input::InputOperation;
+use crate::search::PathItem;
+use crate::search::SearchAlgorithm;
 use indexmap::IndexSet;
 use regex::Regex;
 use serde::{Deserialize, Serialize};
-use std::cmp::Ordering;
+use std::{cmp::Ordering, sync::Arc};
 
 #[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
 pub enum ExternalMsg {
@@ -74,6 +77,14 @@ pub enum ExternalMsg {
     /// - YAML: `FocusNext`
     FocusNext,
 
+    /// Focus on the next selected node.
+    ///
+    /// Example:
+    ///
+    /// - Lua: `"FocusNextSelection"`
+    /// - YAML: `FocusNextSelection`
+    FocusNextSelection,
+
     /// Focus on the `n`th node relative to the current focus where `n` is a
     /// given value.
     ///
@@ -102,6 +113,14 @@ pub enum ExternalMsg {
     /// - YAML: `FocusPrevious`
     FocusPrevious,
 
+    /// Focus on the previous selection item.
+    ///
+    /// Example:
+    ///
+    /// - Lua: `"FocusPreviousSelection"`
+    /// - YAML: `FocusPreviousSelection`
+    FocusPreviousSelection,
+
     /// Focus on the `-n`th node relative to the current focus where `n` is a
     /// given value.
     ///
@@ -258,6 +277,22 @@ pub enum ExternalMsg {
     /// - YAML: `NextVisitedPath`
     NextVisitedPath,
 
+    /// Go to the previous deep level branch.
+    ///
+    /// Example:
+    ///
+    /// - Lua: `"PreviousVisitedDeepBranch"`
+    /// - YAML: `PreviousVisitedDeepBranch`
+    PreviousVisitedDeepBranch,
+
+    /// Go to the next deep level branch.
+    ///
+    /// Example:
+    ///
+    /// - Lua: `"NextVisitedDeepBranch"`
+    /// - YAML: `NextVisitedDeepBranch`
+    NextVisitedDeepBranch,
+
     /// Follow the symlink under focus to its actual location.
     ///
     /// Example:
@@ -319,7 +354,7 @@ pub enum ExternalMsg {
 
     /// Update the input buffer using cursor based operations.
     ///
-    /// Type: { UpdateInputBuffer = [Input Opertaion](https://xplr.dev/en/input-operation) }
+    /// Type: { UpdateInputBuffer = [Input Operation](https://xplr.dev/en/input-operation) }
     ///
     /// Example:
     ///
@@ -345,7 +380,7 @@ pub enum ExternalMsg {
     /// - YAML: `BufferInput: foo`
     BufferInput(String),
 
-    /// Append/buffer the characted read from a keyboard input into the
+    /// Append/buffer the character read from a keyboard input into the
     /// input buffer.
     ///
     /// Example:
@@ -732,7 +767,7 @@ pub enum ExternalMsg {
 
     /// Add a [filter](https://xplr.dev/en/filtering#filter) to exclude nodes
     /// while exploring directories.
-    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
     /// Filters get automatically cleared when changing directories.
     ///
     /// Type: { AddNodeFilter = { filter = [Filter](https://xplr.dev/en/filtering#filter), input = "string" }
@@ -744,7 +779,7 @@ pub enum ExternalMsg {
     AddNodeFilter(NodeFilterApplicable),
 
     /// Remove an existing [filter](https://xplr.dev/en/filtering#filter).
-    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
     ///
     /// Type: { RemoveNodeFilter = { filter = [Filter](https://xplr.dev/en/filtering), input = "string" }
     ///
@@ -756,7 +791,7 @@ pub enum ExternalMsg {
 
     /// Remove a [filter](https://xplr.dev/en/filtering#filter) if it exists,
     /// else, add a it.
-    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
     ///
     /// Type: { ToggleNodeFilter = { filter = [Filter](https://xplr.dev/en/filtering), input = "string" }
     ///
@@ -768,7 +803,7 @@ pub enum ExternalMsg {
 
     /// Add a node [filter](https://xplr.dev/en/filtering#filter) reading the
     /// input from the buffer.
-    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
     ///
     /// Type: { AddNodeFilterFromInput = [Filter](https://xplr.dev/en/filtering) }
     ///
@@ -780,7 +815,7 @@ pub enum ExternalMsg {
 
     /// Remove a node [filter](https://xplr.dev/en/filtering#filter) reading
     /// the input from the buffer.
-    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
     ///
     /// Type: { RemoveNodeFilterFromInput = [Filter](https://xplr.dev/en/filtering) }
     ///
@@ -791,7 +826,7 @@ pub enum ExternalMsg {
     RemoveNodeFilterFromInput(NodeFilter),
 
     /// Remove the last node [filter](https://xplr.dev/en/filtering).
-    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
     ///
     /// Example:
     ///
@@ -801,7 +836,7 @@ pub enum ExternalMsg {
 
     /// Reset the node [filters](https://xplr.dev/en/filtering) back to the
     /// default configuration.
-    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
     ///
     /// Example:
     ///
@@ -810,7 +845,7 @@ pub enum ExternalMsg {
     ResetNodeFilters,
 
     /// Clear all the node [filters](https://xplr.dev/en/filtering).
-    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
     ///
     /// Example:
     ///
@@ -822,7 +857,7 @@ pub enum ExternalMsg {
 
     /// Add a [sorter](https://xplr.dev/en/sorting#sorter) to sort nodes while
     /// exploring directories.
-    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
     ///
     /// Type: { AddNodeSorter = { sorter = [Sorter](https://xplr.dev/en/sorting#sorter), reverse = bool } }
     ///
@@ -833,7 +868,7 @@ pub enum ExternalMsg {
     AddNodeSorter(NodeSorterApplicable),
 
     /// Remove an existing [sorter](https://xplr.dev/en/sorting#sorter).
-    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
     ///
     /// Type: { RemoveNodeSorter = [Sorter](https://xplr.dev/en/sorting#sorter) }
     ///
@@ -844,7 +879,7 @@ pub enum ExternalMsg {
     RemoveNodeSorter(NodeSorter),
 
     /// Reverse a node [sorter](https://xplr.dev/en/sorting#sorter).
-    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
     ///
     /// Type: { ReverseNodeSorter = [Sorter](https://xplr.dev/en/sorting#sorter) }
     ///
@@ -856,7 +891,7 @@ pub enum ExternalMsg {
 
     /// Remove a [sorter](https://xplr.dev/en/sorting#sorter) if it exists,
     /// else, add a it.
-    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
     ///
     /// Type: { ToggleNodeSorter = { sorter = [Sorter](https://xplr.dev/en/sorting#sorter), reverse = bool } }
     ///
@@ -867,7 +902,7 @@ pub enum ExternalMsg {
     ToggleNodeSorter(NodeSorterApplicable),
 
     /// Reverse the node [sorters](https://xplr.dev/en/sorting#sorter).
-    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
     ///
     /// Example:
     ///
@@ -876,7 +911,7 @@ pub enum ExternalMsg {
     ReverseNodeSorters,
 
     /// Remove the last node [sorter](https://xplr.dev/en/sorting#sorter).
-    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
     ///
     /// Example:
     ///
@@ -886,7 +921,7 @@ pub enum ExternalMsg {
 
     /// Reset the node [sorters](https://xplr.dev/en/sorting#sorter) back to
     /// the default configuration.
-    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
     ///
     /// Example:
     ///
@@ -895,7 +930,7 @@ pub enum ExternalMsg {
     ResetNodeSorters,
 
     /// Clear all the node [sorters](https://xplr.dev/en/sorting#sorter).
-    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
     ///
     /// Example:
     ///
@@ -905,9 +940,29 @@ pub enum ExternalMsg {
 
     /// ### Search Operations --------------------------------------------------
 
+    /// Search files using the current or default (fuzzy) search algorithm.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
+    /// It gets reset automatically when changing directory.
+    ///
+    /// Type: { Search = "string" }
+    ///
+    /// Example:
+    ///
+    /// - Lua: `{ Search = "pattern" }`
+    /// - YAML: `Search: pattern`
+    Search(String),
+
+    /// Calls `Search` with the input taken from the input buffer.
+    ///
+    /// Example:
+    ///
+    /// - Lua: `"SearchFromInput"`
+    /// - YAML: `SearchFromInput`
+    SearchFromInput,
+
     /// Search files using fuzzy match algorithm.
     /// It keeps the filters, but overrides the sorters.
-    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
     /// It gets reset automatically when changing directory.
     ///
     /// Type: { SearchFuzzy = "string" }
@@ -919,7 +974,8 @@ pub enum ExternalMsg {
     SearchFuzzy(String),
 
     /// Calls `SearchFuzzy` with the input taken from the input buffer.
-    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitely.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
+    /// It gets reset automatically when changing directory.
     ///
     /// Example:
     ///
@@ -927,6 +983,109 @@ pub enum ExternalMsg {
     /// - YAML: `SearchFuzzyFromInput`
     SearchFuzzyFromInput,
 
+    /// Like `SearchFuzzy`, but doesn't not perform rank based sorting.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
+    /// It gets reset automatically when changing directory.
+    ///
+    /// Type: { SearchFuzzyUnordered = "string" }
+    ///
+    /// Example:
+    ///
+    /// - Lua: `{ SearchFuzzyUnordered = "pattern" }`
+    /// - YAML: `SearchFuzzyUnordered: pattern`
+    SearchFuzzyUnordered(String),
+
+    /// Calls `SearchFuzzyUnordered` with the input taken from the input buffer.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
+    /// It gets reset automatically when changing directory.
+    ///
+    /// Example:
+    ///
+    /// - Lua: `"SearchFuzzyUnorderedFromInput"`
+    /// - YAML: `SearchFuzzyUnorderedFromInput`
+    SearchFuzzyUnorderedFromInput,
+
+    /// Search files using regex match algorithm.
+    /// It keeps the filters, but overrides the sorters.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
+    /// It gets reset automatically when changing directory.
+    ///
+    /// Type: { SearchRegex = "string" }
+    ///
+    /// Example:
+    ///
+    /// - Lua: `{ SearchRegex = "pattern" }`
+    /// - YAML: `SearchRegex: pattern`
+    SearchRegex(String),
+
+    /// Calls `SearchRegex` with the input taken from the input buffer.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
+    /// It gets reset automatically when changing directory.
+    ///
+    /// Example:
+    ///
+    /// - Lua: `"SearchRegexFromInput"`
+    /// - YAML: `SearchRegexFromInput`
+    SearchRegexFromInput,
+
+    /// Like `SearchRegex`, but doesn't not perform rank based sorting.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
+    /// It gets reset automatically when changing directory.
+    ///
+    /// Type: { SearchRegexUnordered = "string" }
+    ///
+    /// Example:
+    ///
+    /// - Lua: `{ SearchRegexUnordered = "pattern" }`
+    /// - YAML: `SearchRegexUnordered: pattern`
+    SearchRegexUnordered(String),
+
+    /// Calls `SearchRegexUnordered` with the input taken from the input buffer.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
+    /// It gets reset automatically when changing directory.
+    ///
+    /// Example:
+    ///
+    /// - Lua: `"SearchRegexUnorderedFromInput"`
+    /// - YAML: `SearchRegexUnorderedFromInput`
+    SearchRegexUnorderedFromInput,
+
+    /// Toggles between different search algorithms, without changing the input
+    /// buffer
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
+    ///
+    /// Example:
+    ///
+    /// - Lua: `"ToggleSearchAlgorithm"`
+    /// - YAML: `ToggleSearchAlgorithm`
+    ToggleSearchAlgorithm,
+
+    /// Enables ranked search without changing the input buffer.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
+    ///
+    /// Example:
+    ///
+    /// - Lua: `"EnableOrderedSearch"`
+    /// - YAML: `EnableSearchOrder`
+    EnableSearchOrder,
+
+    /// Disabled ranked search without changing the input buffer.
+    /// You need to call `ExplorePwd` or `ExplorePwdAsync` explicitly.
+    ///
+    /// Example:
+    ///
+    /// - Lua: `"DisableSearchOrder"`
+    /// - YAML: `DisableSearchOrder`
+    DisableSearchOrder,
+
+    /// Toggles ranked search without changing the input buffer.
+    ///
+    /// Example:
+    ///
+    /// - Lua: `"ToggleSearchOrder"`
+    /// - YAML: `ToggleSearchOrder`
+    ToggleSearchOrder,
+
     /// Accepts the search by keeping the latest focus while in search mode.
     /// Automatically calls `ExplorePwd`.
     ///
@@ -992,7 +1151,7 @@ pub enum ExternalMsg {
     /// - YAML: `StopFifo`
     StopFifo,
 
-    /// Toggle betwen {Start|Stop}Fifo
+    /// Toggle between {Start|Stop}Fifo
     ///
     /// Type: { ToggleFifo = "string" }
     ///
@@ -1635,18 +1794,78 @@ impl NodeFilterApplicable {
 }
 
 #[derive(Debug, Clone, Eq, Hash, PartialEq, Serialize, Deserialize)]
-pub struct NodeSearcher {
+pub struct NodeSearcherApplicable {
     pub pattern: String,
 
     #[serde(default)]
     pub recoverable_focus: Option<String>,
+
+    #[serde(default)]
+    pub algorithm: SearchAlgorithm,
+
+    #[serde(default)]
+    pub unordered: bool,
 }
 
-impl NodeSearcher {
-    pub fn new(pattern: String, recoverable_focus: Option<String>) -> Self {
+impl NodeSearcherApplicable {
+    pub fn new(
+        pattern: String,
+        recoverable_focus: Option<String>,
+        algorithm: SearchAlgorithm,
+        unordered: bool,
+    ) -> Self {
         Self {
             pattern,
             recoverable_focus,
+            algorithm,
+            unordered,
+        }
+    }
+
+    pub fn search<I>(&self, nodes: I) -> Vec<Node>
+    where
+        I: IntoIterator<Item = Node>,
+    {
+        let engine = self.algorithm.engine(&self.pattern);
+        let ranked_nodes = nodes.into_iter().filter_map(|n| {
+            let item = Arc::new(PathItem::from(n.relative_path.clone()));
+            engine.match_item(item).map(|res| (n, res.rank))
+        });
+
+        if self.unordered {
+            ranked_nodes.map(|(n, _)| n).collect()
+        } else {
+            let mut ranked_nodes = ranked_nodes.collect::<Vec<_>>();
+            ranked_nodes.sort_by(|(_, s1), (_, s2)| s1.cmp(s2));
+            ranked_nodes.into_iter().map(|(n, _)| n).collect()
+        }
+    }
+
+    pub fn enable_search_order(self) -> Self {
+        Self {
+            unordered: false,
+            ..self
+        }
+    }
+
+    pub fn disable_search_order(self) -> Self {
+        Self {
+            unordered: true,
+            ..self
+        }
+    }
+
+    pub fn toggle_search_order(self) -> Self {
+        Self {
+            unordered: !self.unordered,
+            ..self
+        }
+    }
+
+    pub fn toggle_algorithm(self) -> Self {
+        Self {
+            algorithm: self.algorithm.toggle(),
+            ..self
         }
     }
 }
@@ -1660,7 +1879,7 @@ pub struct ExplorerConfig {
     pub sorters: IndexSet<NodeSorterApplicable>,
 
     #[serde(default)]
-    pub searcher: Option<NodeSearcher>,
+    pub searcher: Option<NodeSearcherApplicable>,
 }
 
 impl ExplorerConfig {

src/msg/in_/internal.rs

@@ -7,4 +7,5 @@ pub enum InternalMsg {
     AddLastFocus(String, Option<String>),
     SetDirectory(DirectoryBuffer),
     HandleKey(Key),
+    RefreshSelection,
 }

src/msg/out/mod.rs

@@ -17,7 +17,6 @@ pub enum MsgOut {
     CallLuaSilently(String),
     LuaEval(String),
     LuaEvalSilently(String),
-    Enque(Task),
     EnableMouse,
     DisableMouse,
     ToggleMouse,
@@ -34,4 +33,5 @@ pub enum MsgOut {
     PrintSelectionAndQuit,
     PrintResultAndQuit,
     PrintAppStateAndQuit,
+    Enqueue(Task),
 }

src/node.rs

@@ -10,9 +10,16 @@ fn to_human_size(size: u64) -> String {
     format_size(size, DECIMAL)
 }
 
-fn mime_essence(path: &Path, is_dir: bool) -> String {
+fn mime_essence(
+    path: &Path,
+    is_dir: bool,
+    extension: &str,
+    is_executable: bool,
+) -> String {
     if is_dir {
         String::from("inode/directory")
+    } else if extension.is_empty() && is_executable {
+        String::from("application/x-executable")
     } else {
         mime_guess::from_path(path)
             .first()
@@ -44,29 +51,43 @@ impl ResolvedNode {
             .map(|e| e.to_string_lossy().to_string())
             .unwrap_or_default();
 
-        let (is_dir, is_file, is_readonly, size, created, last_modified, uid, gid) =
-            path.metadata()
-                .map(|m| {
-                    (
-                        m.is_dir(),
-                        m.is_file(),
-                        m.permissions().readonly(),
-                        m.len(),
-                        m.created()
-                            .ok()
-                            .and_then(|t| t.duration_since(UNIX_EPOCH).ok())
-                            .map(|d| d.as_nanos()),
-                        m.modified()
-                            .ok()
-                            .and_then(|t| t.duration_since(UNIX_EPOCH).ok())
-                            .map(|d| d.as_nanos()),
-                        m.uid(),
-                        m.gid(),
-                    )
-                })
-                .unwrap_or((false, false, false, 0, None, None, 0, 0));
-
-        let mime_essence = mime_essence(&path, is_dir);
+        let (
+            is_dir,
+            is_file,
+            is_readonly,
+            size,
+            permissions,
+            created,
+            last_modified,
+            uid,
+            gid,
+        ) = path
+            .metadata()
+            .map(|m| {
+                (
+                    m.is_dir(),
+                    m.is_file(),
+                    m.permissions().readonly(),
+                    m.len(),
+                    Permissions::from(&m),
+                    m.created()
+                        .ok()
+                        .and_then(|t| t.duration_since(UNIX_EPOCH).ok())
+                        .map(|d| d.as_nanos()),
+                    m.modified()
+                        .ok()
+                        .and_then(|t| t.duration_since(UNIX_EPOCH).ok())
+                        .map(|d| d.as_nanos()),
+                    m.uid(),
+                    m.gid(),
+                )
+            })
+            .unwrap_or((false, false, false, 0, Default::default(), None, None, 0, 0));
+
+        let is_executable = permissions.user_execute
+            || permissions.group_execute
+            || permissions.other_execute;
+        let mime_essence = mime_essence(&path, is_dir, &extension, is_executable);
         let human_size = to_human_size(size);
 
         Self {
@@ -177,7 +198,11 @@ impl Node {
                 )
             });
 
-        let mime_essence = mime_essence(&path, is_dir);
+        let is_executable = permissions.user_execute
+            || permissions.group_execute
+            || permissions.other_execute;
+
+        let mime_essence = mime_essence(&path, is_dir, &extension, is_executable);
         let human_size = to_human_size(size);
 
         Self {

src/path.rs

@@ -0,0 +1,499 @@
+use crate::dirs;
+use anyhow::{bail, Result};
+use lazy_static::lazy_static;
+use serde::{Deserialize, Serialize};
+pub use snailquote::escape;
+use std::path::{Component, Path, PathBuf};
+
+lazy_static! {
+    pub static ref HOME: Option<PathBuf> = dirs::home_dir();
+}
+
+// Stolen from https://github.com/Manishearth/pathdiff/blob/master/src/lib.rs
+pub fn diff<P, B>(path: P, base: B) -> Result<PathBuf>
+where
+    P: AsRef<Path>,
+    B: AsRef<Path>,
+{
+    let path = path.as_ref();
+    let base = base.as_ref();
+
+    if path.is_absolute() != base.is_absolute() {
+        if path.is_absolute() {
+            Ok(PathBuf::from(path))
+        } else {
+            let path = path.to_string_lossy();
+            bail!("{path}: is not absolute")
+        }
+    } else {
+        let mut ita = path.components();
+        let mut itb = base.components();
+        let mut comps: Vec<Component> = vec![];
+        loop {
+            match (ita.next(), itb.next()) {
+                (None, None) => break,
+                (Some(a), None) => {
+                    comps.push(a);
+                    comps.extend(ita.by_ref());
+                    break;
+                }
+                (None, _) => comps.push(Component::ParentDir),
+                (Some(a), Some(b)) if comps.is_empty() && a == b => (),
+                (Some(a), Some(Component::CurDir)) => comps.push(a),
+                (Some(_), Some(Component::ParentDir)) => {
+                    let path = path.to_string_lossy();
+                    let base = base.to_string_lossy();
+                    bail!("{base} is not a parent of {path}")
+                }
+                (Some(a), Some(_)) => {
+                    comps.push(Component::ParentDir);
+                    for _ in itb {
+                        comps.push(Component::ParentDir);
+                    }
+                    comps.push(a);
+                    comps.extend(ita.by_ref());
+                    break;
+                }
+            }
+        }
+        Ok(comps.iter().map(|c| c.as_os_str()).collect())
+    }
+}
+
+#[derive(Debug, Default, Clone, Serialize, Deserialize)]
+pub struct RelativityConfig<B: AsRef<Path>> {
+    base: Option<B>,
+    with_prefix_dots: Option<bool>,
+    without_suffix_dots: Option<bool>,
+}
+
+impl<B: AsRef<Path>> RelativityConfig<B> {
+    pub fn with_base(mut self, base: B) -> Self {
+        self.base = Some(base);
+        self
+    }
+
+    pub fn with_prefix_dots(mut self) -> Self {
+        self.with_prefix_dots = Some(true);
+        self
+    }
+
+    pub fn without_suffix_dots(mut self) -> Self {
+        self.without_suffix_dots = Some(true);
+        self
+    }
+}
+
+pub fn relative_to<P, B>(
+    path: P,
+    config: Option<&RelativityConfig<B>>,
+) -> Result<PathBuf>
+where
+    P: AsRef<Path>,
+    B: AsRef<Path>,
+{
+    let path = path.as_ref();
+    let base = match config.and_then(|c| c.base.as_ref()) {
+        Some(base) => PathBuf::from(base.as_ref()),
+        None => std::env::current_dir()?,
+    };
+
+    let diff = diff(path, base)?;
+
+    let relative = if diff.to_str() == Some("") {
+        ".".into()
+    } else {
+        diff
+    };
+
+    let relative = if config.and_then(|c| c.with_prefix_dots).unwrap_or(false)
+        && !relative.starts_with(".")
+        && !relative.starts_with("..")
+    {
+        PathBuf::from(".").join(relative)
+    } else {
+        relative
+    };
+
+    let relative = if !config.and_then(|c| c.without_suffix_dots).unwrap_or(false) {
+        relative
+    } else if relative.ends_with(".") {
+        match (path.parent(), path.file_name()) {
+            (Some(_), Some(name)) => PathBuf::from("..").join(name),
+            (_, _) => relative,
+        }
+    } else if relative.ends_with("..") {
+        match (path.parent(), path.file_name()) {
+            (Some(parent), Some(name)) => {
+                if parent.parent().is_some() {
+                    relative.join("..").join(name)
+                } else {
+                    // always prefer absolute path if it's a child of the root directory
+                    // to guarantee that the basename is included
+                    path.into()
+                }
+            }
+            (_, _) => relative,
+        }
+    } else {
+        relative
+    };
+
+    Ok(relative)
+}
+
+pub fn shorten<P, B>(path: P, config: Option<&RelativityConfig<B>>) -> Result<String>
+where
+    P: AsRef<Path>,
+    B: AsRef<Path>,
+{
+    let path = path.as_ref();
+    let pathstring = path.to_string_lossy().to_string();
+    let relative = relative_to(path, config)?;
+
+    let relative = relative.to_string_lossy().to_string();
+
+    let fromhome = HOME
+        .as_ref()
+        .and_then(|h| {
+            path.strip_prefix(h).ok().map(|p| {
+                if p.to_str() == Some("") {
+                    "~".into()
+                } else {
+                    PathBuf::from("~").join(p).to_string_lossy().to_string()
+                }
+            })
+        })
+        .unwrap_or(pathstring);
+
+    if relative.len() < fromhome.len() {
+        Ok(relative)
+    } else {
+        Ok(fromhome)
+    }
+}
+
+#[cfg(test)]
+mod tests {
+
+    use super::*;
+
+    type Config<'a> = Option<&'a RelativityConfig<String>>;
+
+    const NONE: Config = Config::None;
+
+    fn default<'a>() -> RelativityConfig<&'a str> {
+        Default::default()
+    }
+
+    #[test]
+    fn test_relative_to_pwd() {
+        let path = std::env::current_dir().unwrap();
+
+        let relative = relative_to(&path, NONE).unwrap();
+        assert_eq!(relative, PathBuf::from("."));
+
+        let relative = relative_to(&path, Some(&default().with_prefix_dots())).unwrap();
+        assert_eq!(relative, PathBuf::from("."));
+
+        let relative =
+            relative_to(&path, Some(&default().without_suffix_dots())).unwrap();
+        assert_eq!(
+            relative,
+            PathBuf::from("..").join(path.file_name().unwrap())
+        );
+
+        let relative = relative_to(
+            &path,
+            Some(&default().with_prefix_dots().without_suffix_dots()),
+        )
+        .unwrap();
+        assert_eq!(
+            relative,
+            PathBuf::from("..").join(path.file_name().unwrap())
+        );
+    }
+
+    #[test]
+    fn test_relative_to_parent() {
+        let path = std::env::current_dir().unwrap().join("docs");
+        let parent = path.parent().unwrap();
+
+        let base = default().with_base(path.to_str().unwrap());
+
+        let relative = relative_to(parent, Some(&base)).unwrap();
+        assert_eq!(relative, PathBuf::from(".."));
+
+        let relative =
+            relative_to(parent, Some(&base.clone().with_prefix_dots())).unwrap();
+        assert_eq!(relative, PathBuf::from(".."));
+
+        let relative =
+            relative_to(parent, Some(&base.clone().without_suffix_dots())).unwrap();
+        assert_eq!(
+            relative,
+            PathBuf::from("../..").join(parent.file_name().unwrap())
+        );
+
+        let relative = relative_to(
+            parent,
+            Some(&base.clone().with_prefix_dots().without_suffix_dots()),
+        )
+        .unwrap();
+        assert_eq!(
+            relative,
+            PathBuf::from("../..").join(parent.file_name().unwrap())
+        );
+    }
+
+    #[test]
+    fn test_relative_to_file() {
+        let path = std::env::current_dir().unwrap().join("foo").join("bar");
+
+        let relative = relative_to(&path, NONE).unwrap();
+        assert_eq!(relative, PathBuf::from("foo/bar"));
+
+        let relative = relative_to(&path, Some(&default().with_prefix_dots())).unwrap();
+        assert_eq!(relative, PathBuf::from("./foo/bar"));
+
+        let relative = relative_to(
+            &path,
+            Some(&default().with_prefix_dots().without_suffix_dots()),
+        )
+        .unwrap();
+        assert_eq!(relative, PathBuf::from("./foo/bar"));
+    }
+
+    #[test]
+    fn test_relative_to_root() {
+        let relative = relative_to("/foo", Some(&default().with_base("/"))).unwrap();
+        assert_eq!(relative, PathBuf::from("foo"));
+
+        let relative = relative_to(
+            "/foo",
+            Some(
+                &default()
+                    .with_base("/")
+                    .with_prefix_dots()
+                    .without_suffix_dots(),
+            ),
+        )
+        .unwrap();
+        assert_eq!(relative, PathBuf::from("./foo"));
+
+        let relative = relative_to("/", Some(&default().with_base("/"))).unwrap();
+        assert_eq!(relative, PathBuf::from("."));
+
+        let relative = relative_to(
+            "/",
+            Some(
+                &default()
+                    .with_base("/")
+                    .with_prefix_dots()
+                    .without_suffix_dots(),
+            ),
+        )
+        .unwrap();
+        assert_eq!(relative, PathBuf::from("."));
+
+        let relative = relative_to("/", Some(&default().with_base("/foo"))).unwrap();
+        assert_eq!(relative, PathBuf::from(".."));
+
+        let relative = relative_to(
+            "/",
+            Some(
+                &default()
+                    .with_base("/foo")
+                    .with_prefix_dots()
+                    .without_suffix_dots(),
+            ),
+        )
+        .unwrap();
+        assert_eq!(relative, PathBuf::from(".."));
+    }
+
+    #[test]
+    fn test_relative_to_base() {
+        let path = "/some/directory";
+        let base = "/another/foo/bar";
+
+        let relative = relative_to(path, Some(&default().with_base(base))).unwrap();
+        assert_eq!(relative, PathBuf::from("../../../some/directory"));
+
+        let relative = relative_to(
+            path,
+            Some(
+                &default()
+                    .with_base(base)
+                    .with_prefix_dots()
+                    .without_suffix_dots(),
+            ),
+        )
+        .unwrap();
+        assert_eq!(relative, PathBuf::from("../../../some/directory"));
+    }
+
+    #[test]
+    fn test_shorten_home() {
+        let path = HOME.as_ref().unwrap();
+
+        let res = shorten(path, NONE).unwrap();
+        assert_eq!(res, "~");
+
+        let res = shorten(
+            path,
+            Some(&default().with_prefix_dots().without_suffix_dots()),
+        )
+        .unwrap();
+        assert_eq!(res, "~");
+
+        let res = shorten(
+            path,
+            Some(&default().with_prefix_dots().without_suffix_dots()),
+        )
+        .unwrap();
+        assert_eq!(res, "~");
+
+        let res = shorten(path.join("foo"), NONE).unwrap();
+        assert_eq!(res, "~/foo");
+
+        let res = shorten(
+            path.join("foo"),
+            Some(&default().with_prefix_dots().without_suffix_dots()),
+        )
+        .unwrap();
+        assert_eq!(res, "~/foo");
+
+        let res = shorten(format!("{}foo", path.to_string_lossy()), NONE).unwrap();
+        assert_ne!(res, "~/foo");
+        assert_eq!(res, format!("{}foo", path.to_string_lossy()));
+    }
+
+    #[test]
+    fn test_shorten_base() {
+        let path = "/present/working/directory";
+        let base = "/present/foo/bar";
+
+        let res = shorten(path, Some(&default().with_base(base))).unwrap();
+        assert_eq!(res, "../../working/directory");
+
+        let res = shorten(
+            path,
+            Some(
+                &default()
+                    .with_base(base)
+                    .with_prefix_dots()
+                    .without_suffix_dots(),
+            ),
+        )
+        .unwrap();
+        assert_eq!(res, "../../working/directory");
+    }
+
+    #[test]
+    fn test_shorten_pwd() {
+        let path = "/present/working/directory";
+
+        let res = shorten(path, Some(&default().with_base(path))).unwrap();
+        assert_eq!(res, ".");
+
+        let res = shorten(
+            path,
+            Some(
+                &default()
+                    .with_base(path)
+                    .with_prefix_dots()
+                    .without_suffix_dots(),
+            ),
+        )
+        .unwrap();
+        assert_eq!(res, "../directory");
+    }
+
+    #[test]
+    fn test_shorten_parent() {
+        let path = "/present/working";
+        let base = "/present/working/directory";
+
+        let res = shorten(path, Some(&default().with_base(base))).unwrap();
+        assert_eq!(res, "..");
+
+        let res = shorten(
+            path,
+            Some(
+                &default()
+                    .with_base(base)
+                    .with_prefix_dots()
+                    .without_suffix_dots(),
+            ),
+        )
+        .unwrap();
+        assert_eq!(res, "../../working");
+    }
+
+    #[test]
+    fn test_shorten_root() {
+        let res = shorten("/", Some(&default().with_base("/"))).unwrap();
+        assert_eq!(res, "/");
+
+        let res = shorten(
+            "/",
+            Some(
+                &default()
+                    .with_base("/")
+                    .with_prefix_dots()
+                    .without_suffix_dots(),
+            ),
+        )
+        .unwrap();
+        assert_eq!(res, "/");
+
+        let res = shorten("/foo", Some(&default().with_base("/"))).unwrap();
+        assert_eq!(res, "foo");
+
+        let res = shorten(
+            "/foo",
+            Some(
+                &default()
+                    .with_base("/")
+                    .with_prefix_dots()
+                    .without_suffix_dots(),
+            ),
+        )
+        .unwrap();
+        assert_eq!(res, "/foo");
+
+        let res = shorten(
+            "/",
+            Some(
+                &default()
+                    .with_base("/foo")
+                    .with_prefix_dots()
+                    .without_suffix_dots(),
+            ),
+        )
+        .unwrap();
+        assert_eq!(res, "/");
+    }
+
+    #[test]
+    fn test_path_escape() {
+        let text = "foo".to_string();
+        assert_eq!(escape(&text), "foo");
+
+        let text = "foo bar".to_string();
+        assert_eq!(escape(&text), "'foo bar'");
+
+        let text = "foo\nbar".to_string();
+        assert_eq!(escape(&text), "\"foo\\nbar\"");
+
+        let text = "foo$bar".to_string();
+        assert_eq!(escape(&text), "'foo$bar'");
+
+        let text = "foo'$\n'bar".to_string();
+        assert_eq!(escape(&text), "\"foo'\\$\\n'bar\"");
+
+        let text = "a'b\"c".to_string();
+        assert_eq!(escape(&text), "\"a'b\\\"c\"");
+    }
+}

src/permissions.rs

@@ -1,27 +1,52 @@
 // Stolen from https://github.com/Peltoche/lsd/blob/master/src/meta/permissions.rs
 
 use serde::{Deserialize, Serialize};
-use std::fs::Metadata;
+use std::{fmt::Display, fs::Metadata};
 
-#[derive(Debug, PartialEq, Eq, Copy, Clone, Serialize, Deserialize, Hash, Default)]
+pub type RWX = (char, char, char, char, char, char, char, char, char);
+pub type Octal = (u8, u8, u8, u8);
+
+#[derive(Debug, Default, PartialEq, Eq, Copy, Clone, Serialize, Deserialize, Hash)]
 pub struct Permissions {
+    #[serde(default)]
     pub user_read: bool,
+
+    #[serde(default)]
     pub user_write: bool,
+
+    #[serde(default)]
     pub user_execute: bool,
 
+    #[serde(default)]
     pub group_read: bool,
+
+    #[serde(default)]
     pub group_write: bool,
+
+    #[serde(default)]
     pub group_execute: bool,
 
+    #[serde(default)]
     pub other_read: bool,
+
+    #[serde(default)]
     pub other_write: bool,
+
+    #[serde(default)]
     pub other_execute: bool,
 
+    #[serde(default)]
     pub sticky: bool,
+
+    #[serde(default)]
     pub setgid: bool,
+
+    #[serde(default)]
     pub setuid: bool,
 }
 
+impl Permissions {}
+
 impl<'a> From<&'a Metadata> for Permissions {
     #[cfg(unix)]
     fn from(meta: &Metadata) -> Self {
@@ -55,6 +80,68 @@ impl<'a> From<&'a Metadata> for Permissions {
     }
 }
 
+impl Display for Permissions {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        let (ur, uw, ux, gr, gw, gx, or, ow, ox) = (*self).into();
+        write!(f, "{ur}{uw}{ux}{gr}{gw}{gx}{or}{ow}{ox}")
+    }
+}
+
+impl Into<RWX> for Permissions {
+    fn into(self) -> RWX {
+        let bit = |bit: bool, chr: char| {
+            if bit {
+                chr
+            } else {
+                '-'
+            }
+        };
+
+        let ur = bit(self.user_read, 'r');
+        let uw = bit(self.user_write, 'w');
+        let ux = match (self.user_execute, self.setuid) {
+            (true, true) => 's',
+            (true, false) => 'x',
+            (false, true) => 'S',
+            (false, false) => '-',
+        };
+
+        let gr = bit(self.group_read, 'r');
+        let gw = bit(self.group_write, 'w');
+        let gx = match (self.group_execute, self.setgid) {
+            (true, true) => 's',
+            (true, false) => 'x',
+            (false, true) => 'S',
+            (false, false) => '-',
+        };
+
+        let or = bit(self.other_read, 'r');
+        let ow = bit(self.other_write, 'w');
+        let ox = match (self.other_execute, self.sticky) {
+            (true, true) => 't',
+            (true, false) => 'x',
+            (false, true) => 'T',
+            (false, false) => '-',
+        };
+
+        (ur, uw, ux, gr, gw, gx, or, ow, ox)
+    }
+}
+
+impl Into<Octal> for Permissions {
+    fn into(self) -> Octal {
+        let bits_to_octal =
+            |r: bool, w: bool, x: bool| (r as u8) * 4 + (w as u8) * 2 + (x as u8);
+
+        (
+            bits_to_octal(self.setuid, self.setgid, self.sticky),
+            bits_to_octal(self.user_read, self.user_write, self.user_execute),
+            bits_to_octal(self.group_read, self.group_write, self.group_execute),
+            bits_to_octal(self.other_read, self.other_write, self.other_execute),
+        )
+    }
+}
+
 // More readable aliases for the permission bits exposed by libc.
 #[allow(trivial_numeric_casts)]
 #[cfg(unix)]

src/runner.rs

@@ -8,7 +8,8 @@ use crate::explorer;
 use crate::lua;
 use crate::pipe;
 use crate::pwd_watcher;
-use crate::ui;
+use crate::ui::NO_COLOR;
+use crate::ui::UI;
 use crate::yaml;
 use anyhow::{bail, Error, Result};
 use crossterm::event;
@@ -31,7 +32,7 @@ pub fn get_tty() -> Result<fs::File> {
     match fs::OpenOptions::new().read(true).write(true).open(tty) {
         Ok(f) => Ok(f),
         Err(e) => {
-            bail!(format!("Failed to open {}. {}", tty, e))
+            bail!(format!("could not open {tty}. {e}"))
         }
     }
 }
@@ -40,15 +41,14 @@ pub fn get_tty() -> Result<fs::File> {
 // returns physical path. As a workaround, this function tries to use `PWD`
 // environment variable that is configured by shell.
 fn get_current_dir() -> Result<PathBuf, std::io::Error> {
-    let cur = std::env::current_dir();
     if let Ok(pwd) = std::env::var("PWD") {
         if pwd.is_empty() {
-            cur
+            std::env::current_dir()
         } else {
             Ok(PathBuf::from(pwd))
         }
     } else {
-        cur
+        std::env::current_dir()
     }
 }
 
@@ -140,7 +140,7 @@ fn call(
             if s.success() {
                 Ok(())
             } else {
-                Err(format!("process exited with code {}", &s))
+                Err(format!("process exited with code {s}"))
             }
         })
         .unwrap_or_else(|e| Err(e.to_string()));
@@ -184,7 +184,7 @@ fn call(
 fn start_fifo(path: &str, focus_path: &str) -> Result<fs::File> {
     match fs::OpenOptions::new().write(true).open(path) {
         Ok(mut file) => {
-            writeln!(file, "{}", focus_path)?;
+            writeln!(file, "{focus_path}")?;
             Ok(file)
         }
         Err(e) => Err(e.into()),
@@ -286,7 +286,7 @@ impl Runner {
         tx_pwd_watcher.send(app.pwd.clone())?;
 
         let mut result = Ok(None);
-        let session_path = app.session_path.to_owned();
+        let session_path = app.session_path.clone();
 
         term::enable_raw_mode()?;
 
@@ -297,12 +297,13 @@ impl Runner {
         execute!(stdout, term::EnterAlternateScreen)?;
 
         let mut fifo: Option<fs::File> =
-            if let Some(path) = app.config.general.start_fifo.as_ref() {
+            if let Some(path) = app.config.general.start_fifo.clone() {
                 // TODO remove duplicate segment
-                match start_fifo(path, &app.focused_node_str()) {
+                match start_fifo(&path, &app.focused_node_str()) {
                     Ok(file) => Some(file),
                     Err(e) => {
-                        app = app.log_error(e.to_string())?;
+                        app = app
+                            .log_error(format!("could not start fifo {path:?}: {e}"))?;
                         None
                     }
                 }
@@ -316,7 +317,7 @@ impl Runner {
         let mut mouse_enabled = app.config.general.enable_mouse;
         if mouse_enabled {
             if let Err(e) = execute!(stdout, event::EnableMouseCapture) {
-                app = app.log_error(e.to_string())?;
+                app = app.log_error(format!("could not enable mouse: {e}"))?;
             }
         }
 
@@ -341,6 +342,9 @@ impl Runner {
             None,
         ))?;
 
+        // UI
+        let mut ui = UI::new(&lua);
+
         'outer: for task in rx_msg_in {
             match app.handle_task(task) {
                 Ok(a) => {
@@ -348,9 +352,7 @@ impl Runner {
                     while let Some(msg) = app.msg_out.pop_front() {
                         use app::MsgOut::*;
                         match msg {
-                            // NOTE: Do not schedule critical tasks via tx_msg_in in this loop.
-                            // Try handling them immediately.
-                            Enque(task) => {
+                            Enqueue(task) => {
                                 tx_msg_in.send(task)?;
                             }
 
@@ -393,7 +395,7 @@ impl Runner {
                             }
 
                             Debug(path) => {
-                                fs::write(&path, yaml::to_string(&app)?)?;
+                                fs::write(path, yaml::to_string(&app)?)?;
                             }
 
                             ClearScreen => {
@@ -413,7 +415,7 @@ impl Runner {
                             }
 
                             ScrollUpHalf => {
-                                app = app.focus_next_by_relative_index(
+                                app = app.focus_previous_by_relative_index(
                                     terminal.size()?.height as usize / 2,
                                 )?;
                             }
@@ -472,13 +474,13 @@ impl Runner {
                                 }
 
                                 if app.pwd != last_pwd {
-                                    last_pwd = app.pwd.clone();
+                                    last_pwd.clone_from(&app.pwd);
 
                                     // $PWD watcher
                                     tx_pwd_watcher.send(app.pwd.clone())?;
 
                                     // OSC 7: Change CWD
-                                    if !(*ui::NO_COLOR) {
+                                    if !(*NO_COLOR) {
                                         write!(
                                             terminal.backend_mut(),
                                             "\x1b]7;file://{}{}\x1b\\",
@@ -495,7 +497,7 @@ impl Runner {
                                 }
 
                                 // UI
-                                terminal.draw(|f| ui::draw(f, &app, &lua))?;
+                                terminal.draw(|f| ui.draw(f, &app))?;
                             }
 
                             EnableMouse => {
@@ -508,7 +510,9 @@ impl Runner {
                                             mouse_enabled = true;
                                         }
                                         Err(e) => {
-                                            app = app.log_error(e.to_string())?;
+                                            app = app.log_error(format!(
+                                                "could not enable mouse: {e}"
+                                            ))?;
                                         }
                                     }
                                 }
@@ -536,7 +540,9 @@ impl Runner {
                                             mouse_enabled = false;
                                         }
                                         Err(e) => {
-                                            app = app.log_error(e.to_string())?;
+                                            app = app.log_error(format!(
+                                                "could not disable mouse: {e}"
+                                            ))?;
                                         }
                                     }
                                 }
@@ -546,7 +552,9 @@ impl Runner {
                                 fifo = match start_fifo(&path, &app.focused_node_str()) {
                                     Ok(file) => Some(file),
                                     Err(e) => {
-                                        app = app.log_error(e.to_string())?;
+                                        app = app.log_error(format!(
+                                            "could not start fifo {path:?}: {e}"
+                                        ))?;
                                         None
                                     }
                                 }
@@ -569,7 +577,9 @@ impl Runner {
                                         {
                                             Ok(file) => Some(file),
                                             Err(e) => {
-                                                app = app.log_error(e.to_string())?;
+                                                app = app.log_error(format!(
+                                                    "could not toggle fifo {path:?}: {e}"
+                                                ))?;
                                                 None
                                             }
                                         }

src/search.rs

@@ -0,0 +1,50 @@
+use lazy_static::lazy_static;
+use serde::{Deserialize, Serialize};
+use skim::prelude::{ExactOrFuzzyEngineFactory, RegexEngineFactory};
+use skim::{MatchEngine, MatchEngineFactory, SkimItem};
+
+lazy_static! {
+    static ref FUZZY_FACTORY: ExactOrFuzzyEngineFactory =
+        ExactOrFuzzyEngineFactory::builder().build();
+    static ref REGEX_FACTORY: RegexEngineFactory = RegexEngineFactory::builder().build();
+}
+
+pub struct PathItem {
+    path: String,
+}
+
+impl From<String> for PathItem {
+    fn from(value: String) -> Self {
+        Self { path: value }
+    }
+}
+
+impl SkimItem for PathItem {
+    fn text(&self) -> std::borrow::Cow<str> {
+        std::borrow::Cow::from(&self.path)
+    }
+}
+
+#[derive(Debug, Copy, Clone, Default, Eq, PartialEq, Hash, Serialize, Deserialize)]
+#[serde(deny_unknown_fields)]
+pub enum SearchAlgorithm {
+    #[default]
+    Fuzzy,
+    Regex,
+}
+
+impl SearchAlgorithm {
+    pub fn toggle(self) -> Self {
+        match self {
+            Self::Fuzzy => Self::Regex,
+            Self::Regex => Self::Fuzzy,
+        }
+    }
+
+    pub fn engine(&self, pattern: &str) -> Box<dyn MatchEngine> {
+        match self {
+            Self::Fuzzy => FUZZY_FACTORY.create_engine(pattern),
+            Self::Regex => REGEX_FACTORY.create_engine(pattern),
+        }
+    }
+}