version: increment version

* better handling for color in terminal

* cleanup

* cleanup

* cargo fmt

* clippy + tests

* clean

.github/workflows/CICD.yml

@@ -22,50 +22,56 @@ jobs:
           - { os: macos-latest }
           - { os: windows-latest }
     steps:
-    - uses: actions/checkout@v1
-    - name: Initialize workflow variables
-      id: vars
-      shell: bash
-      run: |
-        # 'windows-latest' `cargo fmt` is bugged for this project (see reasons @ GH:rust-lang/rustfmt #3324, #3590, #3688 ; waiting for repair)
-        JOB_DO_FORMAT_TESTING="true"
-        case ${{ matrix.job.os }} in windows-latest) unset JOB_DO_FORMAT_TESTING ;; esac;
-        echo set-output name=JOB_DO_FORMAT_TESTING::${JOB_DO_FORMAT_TESTING:-<empty>/false}
-        echo ::set-output name=JOB_DO_FORMAT_TESTING::${JOB_DO_FORMAT_TESTING}
-    - name: Install `rust` toolchain
-      uses: actions-rs/toolchain@v1
-      with:
-        toolchain: stable
-        override: true
-        profile: minimal # minimal component installation (ie, no documentation)
-        components: rustfmt, clippy
-    - name: "`fmt` testing"
-      if: steps.vars.outputs.JOB_DO_FORMAT_TESTING
-      uses: actions-rs/cargo@v1
-      with:
-        command: fmt
-        args: --all -- --check
-    - name: "`clippy` testing"
-      if: success() || failure() # run regardless of prior step ("`fmt` testing") success/failure
-      uses: actions-rs/cargo@v1
-      with:
-        command: clippy
-        args: ${{ matrix.job.cargo-options }} --features "${{ matrix.job.features }}" -- -D warnings
+      - uses: actions/checkout@v1
+      - name: Initialize workflow variables
+        id: vars
+        shell: bash
+        run: |
+          # 'windows-latest' `cargo fmt` is bugged for this project (see reasons @ GH:rust-lang/rustfmt #3324, #3590, #3688 ; waiting for repair)
+          JOB_DO_FORMAT_TESTING="true"
+          case ${{ matrix.job.os }} in windows-latest) unset JOB_DO_FORMAT_TESTING ;; esac;
+          echo set-output name=JOB_DO_FORMAT_TESTING::${JOB_DO_FORMAT_TESTING:-<empty>/false}
+          echo ::set-output name=JOB_DO_FORMAT_TESTING::${JOB_DO_FORMAT_TESTING}
+          # target-specific options
+          # * CARGO_FEATURES_OPTION
+          CARGO_FEATURES_OPTION='' ;
+          if [ -n "${{ matrix.job.features }}" ]; then CARGO_FEATURES_OPTION='--features "${{ matrix.job.features }}"' ; fi
+          echo set-output name=CARGO_FEATURES_OPTION::${CARGO_FEATURES_OPTION}
+          echo ::set-output name=CARGO_FEATURES_OPTION::${CARGO_FEATURES_OPTION}
+      - name: Install `rust` toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+          profile: minimal # minimal component installation (ie, no documentation)
+          components: rustfmt, clippy
+      - name: "`fmt` testing"
+        if: steps.vars.outputs.JOB_DO_FORMAT_TESTING
+        uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          args: --all -- --check
+      - name: "`clippy` testing"
+        if: success() || failure() # run regardless of prior step ("`fmt` testing") success/failure
+        uses: actions-rs/cargo@v1
+        with:
+          command: clippy
+          args: ${{ matrix.job.cargo-options }} ${{ steps.vars.outputs.CARGO_FEATURES_OPTION }} -- -D warnings
 
   min_version:
     name: MinSRV # Minimum supported rust version
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
-    - name: Install `rust` toolchain (v${{ env.RUST_MIN_SRV }})
-      uses: actions-rs/toolchain@v1
-      with:
-        toolchain: ${{ env.RUST_MIN_SRV }}
-        profile: minimal # minimal component installation (ie, no documentation)
-    - name: Test
-      uses: actions-rs/cargo@v1
-      with:
-        command: test
+      - uses: actions/checkout@v1
+      - name: Install `rust` toolchain (v${{ env.RUST_MIN_SRV }})
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: ${{ env.RUST_MIN_SRV }}
+          profile: minimal # minimal component installation (ie, no documentation)
+      - name: Test
+        uses: actions-rs/cargo@v1
+        with:
+          command: test
 
   build:
     name: Build
@@ -75,161 +81,223 @@ jobs:
       matrix:
         job:
           # { os, target, cargo-options, features, use-cross, toolchain }
-          - { os: ubuntu-latest  , target: arm-unknown-linux-gnueabihf , use-cross: use-cross }
-          - { os: ubuntu-18.04   , target: i686-unknown-linux-gnu      , use-cross: use-cross }
-          - { os: ubuntu-18.04   , target: i686-unknown-linux-musl     , use-cross: use-cross }
-          - { os: ubuntu-18.04   , target: x86_64-unknown-linux-gnu    , use-cross: use-cross }
-          - { os: ubuntu-18.04   , target: x86_64-unknown-linux-musl   , use-cross: use-cross }
-          - { os: ubuntu-16.04   , target: x86_64-unknown-linux-gnu    , use-cross: use-cross }
-          - { os: macos-latest   , target: x86_64-apple-darwin         }
-          - { os: windows-latest , target: i686-pc-windows-gnu         }
-          - { os: windows-latest , target: i686-pc-windows-msvc        }
-          - { os: windows-latest , target: x86_64-pc-windows-gnu       } ## !maint: [rivy; 2020-01-21] may break due to rust bug; follow possible solution from GH:rust-lang/rust#47048 (refs: GH:rust-lang/rust#47048 , GH:rust-lang/rust#53454 , GH:bike-barn/hermit#172 )
-          - { os: windows-latest , target: x86_64-pc-windows-msvc      }
+          - {
+              os: ubuntu-latest,
+              target: aarch64-unknown-linux-gnu,
+              use-cross: use-cross,
+            }
+          - {
+              os: ubuntu-latest,
+              target: aarch64-unknown-linux-musl,
+              use-cross: use-cross,
+            }
+          - {
+              os: ubuntu-latest,
+              target: arm-unknown-linux-gnueabihf,
+              use-cross: use-cross,
+            }
+          - {
+              os: ubuntu-latest,
+              target: arm-unknown-linux-musleabi,
+              use-cross: use-cross,
+            }
+          - {
+              os: ubuntu-latest,
+              target: i686-unknown-linux-gnu,
+              use-cross: use-cross,
+            }
+          - {
+              os: ubuntu-latest,
+              target: i686-unknown-linux-musl,
+              use-cross: use-cross,
+            }
+          - {
+              os: ubuntu-latest,
+              target: x86_64-unknown-linux-gnu,
+              use-cross: use-cross,
+            }
+          - {
+              os: ubuntu-latest,
+              target: x86_64-unknown-linux-musl,
+              use-cross: use-cross,
+            }
+          - { os: macos-latest, target: x86_64-apple-darwin }
+          - { os: windows-latest, target: i686-pc-windows-gnu }
+          - { os: windows-latest, target: i686-pc-windows-msvc }
+          - { os: windows-latest, target: x86_64-pc-windows-gnu } ## !maint: [rivy; 2020-01-21] may break due to rust bug; follow possible solution from GH:rust-lang/rust#47048 (refs: GH:rust-lang/rust#47048 , GH:rust-lang/rust#53454 , GH:bike-barn/hermit#172 )
+          - { os: windows-latest, target: x86_64-pc-windows-msvc }
     steps:
-    - uses: actions/checkout@v1
-    - name: Install any prerequisites
-      shell: bash
-      run: |
-        case ${{ matrix.job.target }} in
-          arm-unknown-linux-gnueabihf) sudo apt-get -y update ; sudo apt-get -y install gcc-arm-linux-gnueabihf ;;
-        esac
-    - name: Initialize workflow variables
-      id: vars
-      shell: bash
-      run: |
-        # toolchain
-        TOOLCHAIN="stable" ## default to "stable" toolchain
-        # * specify alternate TOOLCHAIN for *-pc-windows-gnu targets; gnu targets on Windows are broken for the standard *-pc-windows-msvc toolchain (refs: <https://github.com/rust-lang/rust/issues/47048>, <https://github.com/rust-lang/rust/issues/53454>, <https://github.com/rust-lang/cargo/issues/6754>)
-        case ${{ matrix.job.target }} in *-pc-windows-gnu) TOOLCHAIN="stable-${{ matrix.job.target }}" ;; esac;
-        # * use requested TOOLCHAIN if specified
-        if [ -n "${{ matrix.job.toolchain }}" ]; then TOOLCHAIN="${{ matrix.job.toolchain }}" ; fi
-        echo set-output name=TOOLCHAIN::${TOOLCHAIN}
-        echo ::set-output name=TOOLCHAIN::${TOOLCHAIN}
-        # staging directory
-        STAGING='_staging'
-        echo set-output name=STAGING::${STAGING}
-        echo ::set-output name=STAGING::${STAGING}
-        # determine EXE suffix
-        EXE_suffix="" ; case ${{ matrix.job.target }} in *-pc-windows-*) EXE_suffix=".exe" ;; esac;
-        echo set-output name=EXE_suffix::${EXE_suffix}
-        echo ::set-output name=EXE_suffix::${EXE_suffix}
-        # parse commit reference info
-        REF_NAME=${GITHUB_REF#refs/*/}
-        unset REF_BRANCH ; case ${GITHUB_REF} in refs/heads/*) REF_BRANCH=${GITHUB_REF#refs/heads/} ;; esac;
-        unset REF_TAG ; case ${GITHUB_REF} in refs/tags/*) REF_TAG=${GITHUB_REF#refs/tags/} ;; esac;
-        REF_SHAS=${GITHUB_SHA:0:8}
-        echo set-output name=REF_NAME::${REF_NAME}
-        echo set-output name=REF_BRANCH::${REF_BRANCH}
-        echo set-output name=REF_TAG::${REF_TAG}
-        echo set-output name=REF_SHAS::${REF_SHAS}
-        echo ::set-output name=REF_NAME::${REF_NAME}
-        echo ::set-output name=REF_BRANCH::${REF_BRANCH}
-        echo ::set-output name=REF_TAG::${REF_TAG}
-        echo ::set-output name=REF_SHAS::${REF_SHAS}
-        # parse target
-        unset TARGET_ARCH ; case ${{ matrix.job.target }} in arm-unknown-linux-gnueabihf) TARGET_ARCH=arm ;; i686-*) TARGET_ARCH=i686 ;; x86_64-*) TARGET_ARCH=x86_64 ;; esac;
-        echo set-output name=TARGET_ARCH::${TARGET_ARCH}
-        echo ::set-output name=TARGET_ARCH::${TARGET_ARCH}
-        unset TARGET_OS ; case ${{ matrix.job.target }} in *-linux-*) TARGET_OS=linux ;; *-apple-*) TARGET_OS=macos ;; *-windows-*) TARGET_OS=windows ;; esac;
-        echo set-output name=TARGET_OS::${TARGET_OS}
-        echo ::set-output name=TARGET_OS::${TARGET_OS}
-        # package name
-        PKG_suffix=".tar.gz" ; case ${{ matrix.job.target }} in *-pc-windows-*) PKG_suffix=".zip" ;; esac;
-        PKG_BASENAME=${PROJECT_NAME}-${REF_TAG:-$REF_SHAS}-${{ matrix.job.target }}
-        PKG_NAME=${PKG_BASENAME}${PKG_suffix}
-        echo set-output name=PKG_suffix::${PKG_suffix}
-        echo set-output name=PKG_BASENAME::${PKG_BASENAME}
-        echo set-output name=PKG_NAME::${PKG_NAME}
-        echo ::set-output name=PKG_suffix::${PKG_suffix}
-        echo ::set-output name=PKG_BASENAME::${PKG_BASENAME}
-        echo ::set-output name=PKG_NAME::${PKG_NAME}
-        # deployable tag? (ie, leading "vM" or "M"; M == version number)
-        unset DEPLOY ; if [[ $REF_TAG =~ ^[vV]?[0-9].* ]]; then DEPLOY='true' ; fi
-        echo set-output name=DEPLOY::${DEPLOY:-<empty>/false}
-        echo ::set-output name=DEPLOY::${DEPLOY}
-        # target-specific options
-        # * CARGO_USE_CROSS (truthy)
-        CARGO_USE_CROSS='true' ; case '${{ matrix.job.use-cross }}' in ''|0|f|false|n|no) unset CARGO_USE_CROSS ;; esac;
-        echo set-output name=CARGO_USE_CROSS::${CARGO_USE_CROSS:-<empty>/false}
-        echo ::set-output name=CARGO_USE_CROSS::${CARGO_USE_CROSS}
-        # # * `arm` cannot be tested on ubuntu-* hosts (b/c testing is currently primarily done via comparison of target outputs with built-in outputs and the `arm` target is not executable on the host)
-        JOB_DO_TESTING="true"
-        case ${{ matrix.job.target }} in arm-*) unset JOB_DO_TESTING ;; esac;
-        echo set-output name=JOB_DO_TESTING::${JOB_DO_TESTING:-<empty>/false}
-        echo ::set-output name=JOB_DO_TESTING::${JOB_DO_TESTING}
-        # # * test only binary for arm-type targets
-        unset CARGO_TEST_OPTIONS
-        unset CARGO_TEST_OPTIONS ; case ${{ matrix.job.target }} in arm-*) CARGO_TEST_OPTIONS="--bin ${PROJECT_NAME}" ;; esac;
-        echo set-output name=CARGO_TEST_OPTIONS::${CARGO_TEST_OPTIONS}
-        echo ::set-output name=CARGO_TEST_OPTIONS::${CARGO_TEST_OPTIONS}
-        # * strip executable?
-        STRIP="strip" ; case ${{ matrix.job.target }} in arm-unknown-linux-gnueabihf) STRIP="arm-linux-gnueabihf-strip" ;; *-pc-windows-msvc) STRIP="" ;; esac;
-        echo set-output name=STRIP::${STRIP}
-        echo ::set-output name=STRIP::${STRIP}
-    - name: Create all needed build/work directories
-      shell: bash
-      run: |
-        mkdir -p '${{ steps.vars.outputs.STAGING }}'
-        mkdir -p '${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_BASENAME }}'
-    - name: rust toolchain ~ install
-      uses: actions-rs/toolchain@v1
-      with:
-        toolchain: ${{ steps.vars.outputs.TOOLCHAIN }}
-        target: ${{ matrix.job.target }}
-        override: true
-        profile: minimal # minimal component installation (ie, no documentation)
-    - name: Info
-      shell: bash
-      run: |
-        gcc --version || true
-        rustup -V
-        rustup toolchain list
-        rustup default
-        cargo -V
-        rustc -V
-    - name: Build
-      uses: actions-rs/cargo@v1
-      with:
-        use-cross: ${{ steps.vars.outputs.CARGO_USE_CROSS }}
-        command: build
-        args: --release --target=${{ matrix.job.target }} ${{ matrix.job.cargo-options }} --features "${{ matrix.job.features }}"
-    - name: Test
-      uses: actions-rs/cargo@v1
-      with:
-        use-cross: ${{ steps.vars.outputs.CARGO_USE_CROSS }}
-        command: test
-        args: --target=${{ matrix.job.target }} ${{ steps.vars.outputs.CARGO_TEST_OPTIONS}} ${{ matrix.job.cargo-options }} --features "${{ matrix.job.features }}"
-    - name: Archive executable artifacts
-      uses: actions/upload-artifact@master
-      with:
-        name: ${{ env.PROJECT_NAME }}-${{ matrix.job.target }}
-        path: target/${{ matrix.job.target }}/release/${{ env.PROJECT_NAME }}${{ steps.vars.outputs.EXE_suffix }}
-    - name: Package
-      shell: bash
-      run: |
-        # binary
-        cp 'target/${{ matrix.job.target }}/release/${{ env.PROJECT_NAME }}${{ steps.vars.outputs.EXE_suffix }}' '${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_BASENAME }}/'
-        # `strip` binary (if needed)
-        if [ -n "${{ steps.vars.outputs.STRIP }}" ]; then "${{ steps.vars.outputs.STRIP }}" '${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_BASENAME }}/${{ env.PROJECT_NAME }}${{ steps.vars.outputs.EXE_suffix }}' ; fi
-        # README and LICENSE
-        cp README.md '${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_BASENAME }}/'
-        cp LICENSE '${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_BASENAME }}/'
-        # base compressed package
-        pushd '${{ steps.vars.outputs.STAGING }}/' >/dev/null
-        case ${{ matrix.job.target }} in
-          *-pc-windows-*) 7z -y a '${{ steps.vars.outputs.PKG_NAME }}' '${{ steps.vars.outputs.PKG_BASENAME }}'/* | tail -2 ;;
-          *) tar czf '${{ steps.vars.outputs.PKG_NAME }}' '${{ steps.vars.outputs.PKG_BASENAME }}'/* ;;
-        esac;
-        popd >/dev/null
-    - name: Publish
-      uses: softprops/action-gh-release@v1
-      if: steps.vars.outputs.DEPLOY
-      with:
-        files: |
-          ${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_NAME }}
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - uses: actions/checkout@v1
+      - name: Install any prerequisites
+        shell: bash
+        run: |
+          case ${{ matrix.job.target }} in
+            arm-unknown-linux-gnueabihf) sudo apt-get -y update ; sudo apt-get -y install gcc-arm-linux-gnueabihf ;;
+            aarch64-unknown-linux-gnu) sudo apt-get -y update ; sudo apt-get -y install binutils-aarch64-linux-gnu ;;
+          esac
+      - name: Initialize workflow variables
+        id: vars
+        shell: bash
+        run: |
+          # toolchain
+          TOOLCHAIN="stable" ## default to "stable" toolchain
+          # * specify alternate TOOLCHAIN for *-pc-windows-gnu targets; gnu targets on Windows are broken for the standard *-pc-windows-msvc toolchain (refs: <https://github.com/rust-lang/rust/issues/47048>, <https://github.com/rust-lang/rust/issues/53454>, <https://github.com/rust-lang/cargo/issues/6754>)
+          case ${{ matrix.job.target }} in *-pc-windows-gnu) TOOLCHAIN="stable-${{ matrix.job.target }}" ;; esac;
+          # * use requested TOOLCHAIN if specified
+          if [ -n "${{ matrix.job.toolchain }}" ]; then TOOLCHAIN="${{ matrix.job.toolchain }}" ; fi
+          echo set-output name=TOOLCHAIN::${TOOLCHAIN}
+          echo ::set-output name=TOOLCHAIN::${TOOLCHAIN}
+          # staging directory
+          STAGING='_staging'
+          echo set-output name=STAGING::${STAGING}
+          echo ::set-output name=STAGING::${STAGING}
+          # determine EXE suffix
+          EXE_suffix="" ; case ${{ matrix.job.target }} in *-pc-windows-*) EXE_suffix=".exe" ;; esac;
+          echo set-output name=EXE_suffix::${EXE_suffix}
+          echo ::set-output name=EXE_suffix::${EXE_suffix}
+          # parse commit reference info
+          REF_NAME=${GITHUB_REF#refs/*/}
+          unset REF_BRANCH ; case ${GITHUB_REF} in refs/heads/*) REF_BRANCH=${GITHUB_REF#refs/heads/} ;; esac;
+          unset REF_TAG ; case ${GITHUB_REF} in refs/tags/*) REF_TAG=${GITHUB_REF#refs/tags/} ;; esac;
+          REF_SHAS=${GITHUB_SHA:0:8}
+          echo set-output name=REF_NAME::${REF_NAME}
+          echo set-output name=REF_BRANCH::${REF_BRANCH}
+          echo set-output name=REF_TAG::${REF_TAG}
+          echo set-output name=REF_SHAS::${REF_SHAS}
+          echo ::set-output name=REF_NAME::${REF_NAME}
+          echo ::set-output name=REF_BRANCH::${REF_BRANCH}
+          echo ::set-output name=REF_TAG::${REF_TAG}
+          echo ::set-output name=REF_SHAS::${REF_SHAS}
+          # parse target
+          unset TARGET_ARCH ; case ${{ matrix.job.target }} in arm-unknown-linux-gnueabihf) TARGET_ARCH=arm ;; aarch-*) TARGET_ARCH=aarch64 ;; i686-*) TARGET_ARCH=i686 ;; x86_64-*) TARGET_ARCH=x86_64 ;; esac;
+          echo set-output name=TARGET_ARCH::${TARGET_ARCH}
+          echo ::set-output name=TARGET_ARCH::${TARGET_ARCH}
+          unset TARGET_OS ; case ${{ matrix.job.target }} in *-linux-*) TARGET_OS=linux ;; *-apple-*) TARGET_OS=macos ;; *-windows-*) TARGET_OS=windows ;; esac;
+          echo set-output name=TARGET_OS::${TARGET_OS}
+          echo ::set-output name=TARGET_OS::${TARGET_OS}
+          # package name
+          PKG_suffix=".tar.gz" ; case ${{ matrix.job.target }} in *-pc-windows-*) PKG_suffix=".zip" ;; esac;
+          PKG_BASENAME=${PROJECT_NAME}-${REF_TAG:-$REF_SHAS}-${{ matrix.job.target }}
+          PKG_NAME=${PKG_BASENAME}${PKG_suffix}
+          echo set-output name=PKG_suffix::${PKG_suffix}
+          echo set-output name=PKG_BASENAME::${PKG_BASENAME}
+          echo set-output name=PKG_NAME::${PKG_NAME}
+          echo ::set-output name=PKG_suffix::${PKG_suffix}
+          echo ::set-output name=PKG_BASENAME::${PKG_BASENAME}
+          echo ::set-output name=PKG_NAME::${PKG_NAME}
+          # deployable tag? (ie, leading "vM" or "M"; M == version number)
+          unset DEPLOY ; if [[ $REF_TAG =~ ^[vV]?[0-9].* ]]; then DEPLOY='true' ; fi
+          echo set-output name=DEPLOY::${DEPLOY:-<empty>/false}
+          echo ::set-output name=DEPLOY::${DEPLOY}
+          # target-specific options
+          # * CARGO_FEATURES_OPTION
+          CARGO_FEATURES_OPTION='' ;
+          if [ -n "${{ matrix.job.features }}" ]; then CARGO_FEATURES_OPTION='--features "${{ matrix.job.features }}"' ; fi
+          echo set-output name=CARGO_FEATURES_OPTION::${CARGO_FEATURES_OPTION}
+          echo ::set-output name=CARGO_FEATURES_OPTION::${CARGO_FEATURES_OPTION}
+          # * CARGO_USE_CROSS (truthy)
+          CARGO_USE_CROSS='true' ; case '${{ matrix.job.use-cross }}' in ''|0|f|false|n|no) unset CARGO_USE_CROSS ;; esac;
+          echo set-output name=CARGO_USE_CROSS::${CARGO_USE_CROSS:-<empty>/false}
+          echo ::set-output name=CARGO_USE_CROSS::${CARGO_USE_CROSS}
+          # # * `arm` cannot be tested on ubuntu-* hosts (b/c testing is currently primarily done via comparison of target outputs with built-in outputs and the `arm` target is not executable on the host)
+          JOB_DO_TESTING="true"
+          case ${{ matrix.job.target }} in arm-*|aarch64-*) unset JOB_DO_TESTING ;; esac;
+          echo set-output name=JOB_DO_TESTING::${JOB_DO_TESTING:-<empty>/false}
+          echo ::set-output name=JOB_DO_TESTING::${JOB_DO_TESTING}
+          # # * test only binary for arm-type targets
+          unset CARGO_TEST_OPTIONS
+          unset CARGO_TEST_OPTIONS ; case ${{ matrix.job.target }} in arm-*|aarch64-*) CARGO_TEST_OPTIONS="--bin ${PROJECT_NAME}" ;; esac;
+          echo set-output name=CARGO_TEST_OPTIONS::${CARGO_TEST_OPTIONS}
+          echo ::set-output name=CARGO_TEST_OPTIONS::${CARGO_TEST_OPTIONS}
+          # * strip executable?
+          STRIP="strip" ; case ${{ matrix.job.target }} in arm-unknown-linux-gnueabihf) STRIP="arm-linux-gnueabihf-strip" ;; *-pc-windows-msvc) STRIP="" ;; aarch64-unknown-linux-gnu) STRIP="aarch64-linux-gnu-strip" ;; aarch64-unknown-linux-musl) STRIP="" ;; armv7-unknown-linux-musleabi) STRIP="" ;; arm-unknown-linux-musleabi) STRIP="" ;; esac;
+
+
+          echo set-output name=STRIP::${STRIP}
+          echo ::set-output name=STRIP::${STRIP}
+      - name: Create all needed build/work directories
+        shell: bash
+        run: |
+          mkdir -p '${{ steps.vars.outputs.STAGING }}'
+          mkdir -p '${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_BASENAME }}'
+      - name: rust toolchain ~ install
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: ${{ steps.vars.outputs.TOOLCHAIN }}
+          target: ${{ matrix.job.target }}
+          override: true
+          profile: minimal # minimal component installation (ie, no documentation)
+      - name: Info
+        shell: bash
+        run: |
+          gcc --version || true
+          rustup -V
+          rustup toolchain list
+          rustup default
+          cargo -V
+          rustc -V
+      - name: Build
+        uses: actions-rs/cargo@v1
+        with:
+          use-cross: ${{ steps.vars.outputs.CARGO_USE_CROSS }}
+          command: build
+          args: --release --target=${{ matrix.job.target }} ${{ matrix.job.cargo-options }} ${{ steps.vars.outputs.CARGO_FEATURES_OPTION }}
+      - name: Install cargo-deb
+        uses: actions-rs/cargo@v1
+        with:
+          command: install
+          args: cargo-deb
+        if: matrix.job.target == 'i686-unknown-linux-musl' || matrix.job.target == 'x86_64-unknown-linux-musl'
+      - name: Build deb
+        uses: actions-rs/cargo@v1
+        with:
+          command: deb
+          args: --no-build --target=${{ matrix.job.target }}
+        if: matrix.job.target == 'i686-unknown-linux-musl' || matrix.job.target == 'x86_64-unknown-linux-musl'
+      - name: Test
+        uses: actions-rs/cargo@v1
+        with:
+          use-cross: ${{ steps.vars.outputs.CARGO_USE_CROSS }}
+          command: test
+          args: --target=${{ matrix.job.target }} ${{ steps.vars.outputs.CARGO_TEST_OPTIONS}} ${{ matrix.job.cargo-options }} ${{ steps.vars.outputs.CARGO_FEATURES_OPTION }}
+      - name: Archive executable artifacts
+        uses: actions/upload-artifact@master
+        with:
+          name: ${{ env.PROJECT_NAME }}-${{ matrix.job.target }}
+          path: target/${{ matrix.job.target }}/release/${{ env.PROJECT_NAME }}${{ steps.vars.outputs.EXE_suffix }}
+      - name: Archive deb artifacts
+        uses: actions/upload-artifact@master
+        with:
+          name: ${{ env.PROJECT_NAME }}-${{ matrix.job.target }}.deb
+          path: target/${{ matrix.job.target }}/debian
+        if: matrix.job.target == 'i686-unknown-linux-musl' || matrix.job.target == 'x86_64-unknown-linux-musl'
+      - name: Package
+        shell: bash
+        run: |
+          # binary
+          cp 'target/${{ matrix.job.target }}/release/${{ env.PROJECT_NAME }}${{ steps.vars.outputs.EXE_suffix }}' '${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_BASENAME }}/'
+          # `strip` binary (if needed)
+          if [ -n "${{ steps.vars.outputs.STRIP }}" ]; then "${{ steps.vars.outputs.STRIP }}" '${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_BASENAME }}/${{ env.PROJECT_NAME }}${{ steps.vars.outputs.EXE_suffix }}' ; fi
+          # README and LICENSE
+          cp README.md '${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_BASENAME }}/'
+          cp LICENSE '${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_BASENAME }}/'
+          # base compressed package
+          pushd '${{ steps.vars.outputs.STAGING }}/' >/dev/null
+          case ${{ matrix.job.target }} in
+            *-pc-windows-*) 7z -y a '${{ steps.vars.outputs.PKG_NAME }}' '${{ steps.vars.outputs.PKG_BASENAME }}'/* | tail -2 ;;
+            *) tar czf '${{ steps.vars.outputs.PKG_NAME }}' '${{ steps.vars.outputs.PKG_BASENAME }}'/* ;;
+          esac;
+          popd >/dev/null
+      - name: Publish
+        uses: softprops/action-gh-release@v1
+        if: steps.vars.outputs.DEPLOY
+        with:
+          files: |
+            ${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_NAME }}
+            target/${{ matrix.job.target }}/debian/*.deb
+
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
   ## fix! [rivy; 2020-22-01] `cargo tarpaulin` is unable to test this repo at the moment; alternate recipe or another testing framework?
   # coverage:

.gitignore

@@ -6,4 +6,7 @@
 **/*.rs.bk
 *.swp
 .vscode/*
-*.idea/*
+*.idea/*
+
+#ignore macos files
+.DS_Store

.travis.yml

@@ -1,83 +0,0 @@
-# Based on the "trust" template v0.1.2
-# https://github.com/japaric/trust/tree/v0.1.2
-
-# ----------- To do a release ---------
-# tag a commit and push:
-#   git tag v0.4.0.1
-#   git push origin v0.4.0.1
-# Remember to do a cargo publish to put it in crates.io
-
-dist: trusty
-language: rust
-services: docker
-sudo: required
-
-# TODO Rust builds on stable by default, this can be
-# overridden on a case by case basis down below.
-
-env:
-  global:
-    # TODO Update this to match the name of your project.
-    - CRATE_NAME=dust
-
-matrix:
-  # TODO These are all the build jobs. Adjust as necessary. Comment out what you
-  # don't need
-  include:
-    # Linux
-    - env: TARGET=x86_64-unknown-linux-gnu
-
-    # OSX
-    - env: TARGET=x86_64-apple-darwin
-      os: osx
-
-before_install:
-  - set -e
-  - rustup self update
-
-install:
-  - sh ci/install.sh
-  - source ~/.cargo/env || true
-
-script:
-  - bash ci/script.sh
-
-after_script: set +e
-
-before_deploy:
-  - sh ci/before_deploy.sh
-
-deploy:
-  # TODO update `api_key.secure`
-  # - Create a `public_repo` GitHub token. Go to: https://github.com/settings/tokens/new
-  # - Encrypt it: `travis encrypt 0123456789012345678901234567890123456789
-  # - Paste the output down here
-#  api_key:
-#    secure: UlU73Td7Bkb2N88ws4YGLWR+4U0IMgiou9QQtMnmpouJFjeUNxtLSPMPODVXP7zq4sKt5HR5B3fX9MW4mKm351fvnQEoihETn06pKiXGnY//SlTPTt67MX9ZOYmd9ohJReMDOZDgqhnGLxfymycGtsLAmdjDZnAl+IMqgg0FMyVFj9Cl9aKxnn12lxQyX4zabHKk8TUKD3By8ZoEUnJMHt3gEtOmbDgS4brcTPeHCzqnYFw73LEnkqvz+JP0XwauJY7Cf8lminKm/klmjCkQji8T9SHI52v1g0Fxpx0ucp2o3vulQrLHXaHvZ6Fr7J0cSXXzaFF3rrGLt4t4jU/+9TZm1+n5k5XuPW4x4NTCC9NmIj/z0/z41t82E9qZhzhtm2Jdsg6H2tNk+C774TYqcmR6GCvfRadfjRp3cA5dh0UwDVjH2MJFxlHDVkl6la0mVVRsCGF3oBKZVk0BDl1womfnmI46o/uU+gLknHN6Ed6PHHPPYDViWd3VKdmHKT7XrkMMUF6HjZUtla689DWIOWZSiV++1dVPcl/1TV+6tTmN4bBtPcLuX7SHRuLp2PI2kATvRMECsa7gZRypW4jKpVn7b2yetX9TVI3i1zR5zkQJ3dPg8sATvYPL53aKH/WsqUg4rzoAlbk9so+++R4bQY69LhV3B511B7EAynoZFdM
-  api_key: $API_KEY
-  file_glob: true
-  file: $CRATE_NAME-$TRAVIS_TAG-$TARGET.*
-  on:
-    # TODO Here you can pick which targets will generate binary releases
-    # In this example, there are some targets that are tested using the stable
-    # and nightly channels. This condition makes sure there is only one release
-    # for such targets and that's generated using the stable channel
-    condition: $TRAVIS_RUST_VERSION = stable
-    tags: true
-  provider: releases
-  skip_cleanup: true
-
-cache: cargo
-before_cache:
-  # Travis can't cache files that are not readable by "others"
-  - chmod -R a+r $HOME/.cargo
-
-branches:
-  only:
-    # release tags
-    - /^v\d+\.\d+\.\d+.*$/
-    - master
-
-notifications:
-  email:
-    on_success: never

Cargo.toml

@@ -1,9 +1,10 @@
 [package]
 name = "du-dust"
 description = "A more intuitive version of du"
-version = "0.4.4"
+version = "1.0.0"
 authors = ["bootandy <bootandy@gmail.com>", "nebkor <code@ardent.nebcorp.com>"]
-edition = "2018"
+edition = "2021"
+readme = "README.md"
 
 documentation = "https://github.com/bootandy/dust"
 homepage = "https://github.com/bootandy/dust"
@@ -14,21 +15,75 @@ categories = ["command-line-utilities"]
 license = "Apache-2.0"
 
 [badges]
-travis-ci = {repository = "https://travis-ci.org/bootandy/dust"}
+travis-ci = { repository = "https://travis-ci.org/bootandy/dust" }
 
 [[bin]]
 name = "dust"
 path = "src/main.rs"
 
+[profile.release]
+codegen-units = 1
+lto = true
+strip = true
+
 [dependencies]
-ansi_term = "=0.12"
-clap = "=2.33"
-jwalk = "0.4.0"
-num_cpus = "1.12"
+ansi_term = "0.12"
+clap = "4.4"
+lscolors = "0.13"
+terminal_size = "0.2"
+unicode-width = "0.1"
+rayon = "1"
+thousands = "0.2"
+stfu8 = "0.2"
+regex = "1"
+config-file = "0.2"
+serde = { version = "1.0", features = ["derive"] }
+directories = "4"
+sysinfo = "0.27"
+ctrlc = "3.4"
 
 [target.'cfg(windows)'.dependencies]
 winapi-util = "0.1"
+filesize = "0.2.0"
 
 [dev-dependencies]
-assert_cli = "=0.6"
+assert_cmd = "2"
 tempfile = "=3"
+
+[build-dependencies]
+clap = "4.4"
+clap_complete = "4.4"
+clap_mangen = "0.2"
+
+[[test]]
+name = "integration"
+path = "tests/tests.rs"
+
+[package.metadata.binstall]
+pkg-url = "{ repo }/releases/download/v{ version }/dust-v{ version }-{ target }{ archive-suffix }"
+bin-dir = "dust-v{ version }-{ target }/{ bin }{ binary-ext }"
+
+[package.metadata.deb]
+section = "utils"
+assets = [
+  [
+    "target/release/dust",
+    "usr/bin/",
+    "755",
+  ],
+  [
+    "LICENSE",
+    "usr/share/doc/du-dust/",
+    "644",
+  ],
+  [
+    "README.md",
+    "usr/share/doc/du-dust/README",
+    "644",
+  ],
+]
+extended-description = """\
+Dust is meant to give you an instant overview of which directories are using
+disk space without requiring sort or head. Dust will print a maximum of one
+'Did not have permissions message'.
+"""

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright [2023] [andrew boot]
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -1,33 +1,63 @@
+[![Build Status](https://github.com/bootandy/dust/actions/workflows/CICD.yml/badge.svg)](https://github.com/bootandy/dust/actions)
 
-[![Build Status](https://travis-ci.org/bootandy/dust.svg?branch=master)](https://travis-ci.org/bootandy/dust)
 
 # Dust
 
-du + rust = dust. Like du but more intuitive
+du + rust = dust. Like du but more intuitive.
+
+# Why
+
+Because I want an easy way to see where my disk is being used.
+
+# Demo
+
+![Example](media/snap.png)
 
 ## Install
 
-#### Cargo Install
+#### Cargo <a href="https://repology.org/project/du-dust/versions"><img src="https://repology.org/badge/vertical-allrepos/du-dust.svg" alt="Packaging status" align="right"></a>
 
-* cargo install du-dust
+- `cargo install du-dust`
 
-#### Download Install
+#### 🍺 Homebrew (Mac OS)
 
-* Download linux / mac binary from [Releases](https://github.com/bootandy/dust/releases)
-* unzip file: tar -xvf _downloaded_file.tar.gz_
-* move file to executable path: sudo mv dust /usr/local/bin/
+- `brew install dust`
+
+#### 🍺 Homebrew (Linux)
+
+- `brew install dust`
+
+#### [Pacstall](https://github.com/pacstall/pacstall) (Debian/Ubuntu)
+
+- `pacstall -I dust-bin`
+
+### Anaconda (conda-forge)
+
+- `conda install -c conda-forge dust`
+
+#### [deb-get](https://github.com/wimpysworld/deb-get) (Debian/Ubuntu)
+
+- `deb-get install du-dust`
+
+#### Windows:
+
+- `scoop install dust`
+- Windows GNU version - works
+- Windows MSVC - requires: [VCRUNTIME140.dll](https://docs.microsoft.com/en-gb/cpp/windows/latest-supported-vc-redist?view=msvc-170)
+
+#### Download
+
+- Download Linux/Mac binary from [Releases](https://github.com/bootandy/dust/releases)
+- unzip file: `tar -xvf _downloaded_file.tar.gz`
+- move file to executable path: `sudo mv dust /usr/local/bin/`
 
 ## Overview
 
-Dust is meant to give you an instant overview of which directories are using disk space without requiring sort or head. Dust will print a maximum of 1 'Did not have permissions message'.
+Dust is meant to give you an instant overview of which directories are using disk space without requiring sort or head. Dust will print a maximum of one 'Did not have permissions message'.
 
-Dust will list the 20 biggest sub directories or files and will smartly recurse down the tree to find the larger ones. There is no need for a '-d' flag or a '-h' flag. The largest sub directory will have its size shown in *red*
+Dust will list a slightly-less-than-the-terminal-height number of the biggest subdirectories or files and will smartly recurse down the tree to find the larger ones. There is no need for a '-d' flag or a '-h' flag. The largest subdirectories will be colored.
 
-## Why?
-
-du has a number of ways of showing you what it finds, in terms of disk consumption, but really, there are only one or two ways you invoke it: with -h for “human readable” units, like 100G or 89k, or with -b for “bytes”. The former is generally used for a quick survey of a directory with a small number of things in it, and the latter for when you have a bunch and need to sort the output numerically, and you’re obligated to either further pass it into something like awk to turn bytes into the appropriate human-friendly unit like mega or gigabytes, or pipe thru sort and head while remembering the '-h' flag. Then once you have the top offenders, you recurse down into the largest one and repeat the process until you’ve found your cruft or gems and can move on.
-
-Dust assumes that’s what you wanted to do in the first place, and takes care of tracking the largest offenders in terms of actual size, and showing them to you with human-friendly units and in-context within the filetree.
+The different colors on the bars: These represent the combined tree hierarchy & disk usage. The shades of grey are used to indicate which parent folder a subfolder belongs to. For instance, look at the above screenshot. `.steam` is a folder taking 44% of the space. From the `.steam` bar is a light grey line that goes up. All these folders are inside `.steam` so if you delete `.steam` all that stuff will be gone too.
 
 ## Usage
 
@@ -35,40 +65,50 @@ Dust assumes that’s what you wanted to do in the first place, and takes care o
 Usage: dust
 Usage: dust <dir>
 Usage: dust <dir>  <another_dir> <and_more>
-Usage: dust -p <dir>  (full-path - does not shorten the path of the subdirectories)
-Usage: dust -s <dir>  (apparent-size - shows the length of the file as opposed to the amount of disk space it uses)
-Usage: dust -n 30  <dir>  (Shows 30 directories not 20)
-Usage: dust -d 3  <dir>  (Shows 3 levels of subdirectories)
-Usage: dust -r  <dir>  (Reverse order of output, with root at the lowest)
-Usage: dust -x  <dir>  (Only show directories on same filesystem)
-Usage: dust -X ignore  <dir>  (Ignore all files and directories containing the string 'ignore')
+Usage: dust -p (full-path - Show fullpath of the subdirectories)
+Usage: dust -s (apparent-size - shows the length of the file as opposed to the amount of disk space it uses)
+Usage: dust -n 30  (Shows 30 directories instead of the default [default is terminal height])
+Usage: dust -d 3  (Shows 3 levels of subdirectories)
+Usage: dust -D (Show only directories (eg dust -D))
+Usage: dust -F (Show only files - finds your largest files)
+Usage: dust -r (reverse order of output)
+Usage: dust -o si/b/kb/kib/mb/mib/gb/gib (si - prints sizes in powers of 1000. Others print size in that format).
+Usage: dust -X ignore  (ignore all files and directories with the name 'ignore')
+Usage: dust -x (Only show directories on the same filesystem)
+Usage: dust -b (Do not show percentages or draw ASCII bars)
+Usage: dust -B (--bars-on-right - Percent bars moved to right side of screen)
+Usage: dust -i (Do not show hidden files)
+Usage: dust -c (No colors [monochrome])
+Usage: dust -C (Force colors)
+Usage: dust -f (Count files instead of diskspace)
+Usage: dust -t (Group by filetype)
+Usage: dust -z 10M (min-size, Only include files larger than 10M)
+Usage: dust -e regex (Only include files matching this regex (eg dust -e "\.png$" would match png files))
+Usage: dust -v regex (Exclude files matching this regex (eg dust -v "\.png$" would ignore png files))
+Usage: dust -L (dereference-links - Treat sym links as directories and go into them)
+Usage: dust -P (Disable the progress indicator)
+Usage: dust -R (For screen readers. Removes bars/symbols. Adds new column: depth level. (May want to use -p for full path too))
+Usage: dust -S (Custom Stack size - Use if you see: 'fatal runtime error: stack overflow' (default allocation: low memory=1048576, high memory=1073741824)"),
+Usage: dust --skip-total (No total row will be displayed)
+Usage: dust -z 40000/30MB/20kib (Exclude output files/directories below size 40000 bytes / 30MB / 20KiB)
 ```
 
-```
-djin:git/dust> dust
- 1.2G  target
- 622M ├─┬ debug
- 445M │ ├── deps
-  70M │ ├── incremental
-  56M │ └── build
- 262M ├─┬ rls
- 262M │ └─┬ debug
- 203M │   ├── deps
-  56M │   └── build
- 165M ├─┬ package
- 165M │ └─┬ du-dust-0.2.4
- 165M │   └─┬ target
- 165M │     └─┬ debug
- 131M │       └── deps
- 165M └─┬ release
- 124M   └── deps
-```
+## Config file
 
+Dust has a config file where the above options can be set.
+Either: `~/.config/dust/config.toml` or `~/.dust.toml`
+```
+$ cat ~/.config/dust/config.toml
+reverse=true
+```
 
 ## Alternatives
 
-* [NCDU](https://dev.yorhel.nl/ncdu)
-* [dutree](https://github.com/nachoparker/dutree)
-* du -d 1 -h | sort -h
+- [NCDU](https://dev.yorhel.nl/ncdu)
+- [dutree](https://github.com/nachoparker/dutree)
+- [dua](https://github.com/Byron/dua-cli/)
+- [pdu](https://github.com/KSXGitHub/parallel-disk-usage)
+- [dirstat-rs](https://github.com/scullionw/dirstat-rs)
+- du -d 1 -h | sort -h
 
 Note: Apparent-size is calculated slightly differently in dust to gdu. In dust each hard link is counted as using file_length space. In gdu only the first entry is counted.

build.rs

@@ -0,0 +1,27 @@
+use clap_complete::{generate_to, shells::*};
+use clap_mangen::Man;
+use std::fs::File;
+use std::io::Error;
+use std::path::Path;
+
+include!("src/cli.rs");
+
+fn main() -> Result<(), Error> {
+    let outdir = "completions";
+    let app_name = "dust";
+    let mut cmd = build_cli();
+
+    generate_to(Bash, &mut cmd, app_name, outdir)?;
+    generate_to(Zsh, &mut cmd, app_name, outdir)?;
+    generate_to(Fish, &mut cmd, app_name, outdir)?;
+    generate_to(PowerShell, &mut cmd, app_name, outdir)?;
+    generate_to(Elvish, &mut cmd, app_name, outdir)?;
+
+    let file = Path::new("man-page").join("dust.1");
+    std::fs::create_dir_all("man-page")?;
+    let mut file = File::create(file)?;
+
+    Man::new(cmd).render(&mut file)?;
+
+    Ok(())
+}

ci/how2publish.txt

@@ -0,0 +1,14 @@
+# ----------- To do a release ---------
+# Compare times of runs to check no drastic slow down:
+#  time target/release/dust   ~/dev
+#  time dust ~dev
+
+# edit version in cargo.toml
+# tag a commit and push (increment version in Cargo.toml first):
+#   git tag v0.4.5
+#   git push origin v0.4.5
+
+# cargo publish to put it in crates.io
+
+# To install locally [Do before pushing it]
+#cargo install --path .

completions/_dust

@@ -0,0 +1,89 @@
+#compdef dust
+
+autoload -U is-at-least
+
+_dust() {
+    typeset -A opt_args
+    typeset -a _arguments_options
+    local ret=1
+
+    if is-at-least 5.2; then
+        _arguments_options=(-s -S -C)
+    else
+        _arguments_options=(-s -C)
+    fi
+
+    local context curcontext="$curcontext" state line
+    _arguments "${_arguments_options[@]}" \
+'-d+[Depth to show]: : ' \
+'--depth=[Depth to show]: : ' \
+'-n+[Number of lines of output to show. (Default is terminal_height - 10)]: : ' \
+'--number-of-lines=[Number of lines of output to show. (Default is terminal_height - 10)]: : ' \
+'*-X+[Exclude any file or directory with this name]: : ' \
+'*--ignore-directory=[Exclude any file or directory with this name]: : ' \
+'-I+[Exclude any file or directory with a regex matching that listed in this file, the file entries will be added to the ignore regexs provided by --invert_filter]: : ' \
+'--ignore-all-in-file=[Exclude any file or directory with a regex matching that listed in this file, the file entries will be added to the ignore regexs provided by --invert_filter]: : ' \
+'-z+[Minimum size file to include in output]: : ' \
+'--min-size=[Minimum size file to include in output]: : ' \
+'(-e --filter -t --file_types)*-v+[Exclude filepaths matching this regex. To ignore png files type\: -v "\\.png\$" ]: : ' \
+'(-e --filter -t --file_types)*--invert-filter=[Exclude filepaths matching this regex. To ignore png files type\: -v "\\.png\$" ]: : ' \
+'(-t --file_types)*-e+[Only include filepaths matching this regex. For png files type\: -e "\\.png\$" ]: : ' \
+'(-t --file_types)*--filter=[Only include filepaths matching this regex. For png files type\: -e "\\.png\$" ]: : ' \
+'-w+[Specify width of output overriding the auto detection of terminal width]: : ' \
+'--terminal_width=[Specify width of output overriding the auto detection of terminal width]: : ' \
+'-o+[Changes output display size. si will print sizes in powers of 1000. b/bytes kb kib mb mib gb gib will print the whole tree in that size]: : ' \
+'--output-format=[Changes output display size. si will print sizes in powers of 1000. b/bytes kb kib mb mib gb gib will print the whole tree in that size]: : ' \
+'-S+[Specify memory to use as stack size - use if you see\: '\''fatal runtime error\: stack overflow'\'' (default low memory=1048576, high memory=1073741824)]: : ' \
+'--stack-size=[Specify memory to use as stack size - use if you see\: '\''fatal runtime error\: stack overflow'\'' (default low memory=1048576, high memory=1073741824)]: : ' \
+'-p[Subdirectories will not have their path shortened]' \
+'--full-paths[Subdirectories will not have their path shortened]' \
+'-L[dereference sym links - Treat sym links as directories and go into them]' \
+'--dereference-links[dereference sym links - Treat sym links as directories and go into them]' \
+'-x[Only count the files and directories on the same filesystem as the supplied directory]' \
+'--limit-filesystem[Only count the files and directories on the same filesystem as the supplied directory]' \
+'-s[Use file length instead of blocks]' \
+'--apparent-size[Use file length instead of blocks]' \
+'-r[Print tree upside down (biggest highest)]' \
+'--reverse[Print tree upside down (biggest highest)]' \
+'-c[No colors will be printed (Useful for commands like\: watch)]' \
+'--no-colors[No colors will be printed (Useful for commands like\: watch)]' \
+'-C[Force colors print]' \
+'--force-colors[Force colors print]' \
+'-b[No percent bars or percentages will be displayed]' \
+'--no-percent-bars[No percent bars or percentages will be displayed]' \
+'-B[percent bars moved to right side of screen]' \
+'--bars-on-right[percent bars moved to right side of screen]' \
+'-R[For screen readers. Removes bars. Adds new column\: depth level (May want to use -p too for full path)]' \
+'--screen-reader[For screen readers. Removes bars. Adds new column\: depth level (May want to use -p too for full path)]' \
+'--skip-total[No total row will be displayed]' \
+'-f[Directory '\''size'\'' is number of child files instead of disk size]' \
+'--filecount[Directory '\''size'\'' is number of child files instead of disk size]' \
+'-i[Do not display hidden files]' \
+'--ignore_hidden[Do not display hidden files]' \
+'(-d --depth -D --only-dir)-t[show only these file types]' \
+'(-d --depth -D --only-dir)--file_types[show only these file types]' \
+'-P[Disable the progress indication.]' \
+'--no-progress[Disable the progress indication.]' \
+'(-F --only-file -t --file_types)-D[Only directories will be displayed.]' \
+'(-F --only-file -t --file_types)--only-dir[Only directories will be displayed.]' \
+'(-D --only-dir)-F[Only files will be displayed. (Finds your largest files)]' \
+'(-D --only-dir)--only-file[Only files will be displayed. (Finds your largest files)]' \
+'-h[Print help]' \
+'--help[Print help]' \
+'-V[Print version]' \
+'--version[Print version]' \
+'*::params:' \
+&& ret=0
+}
+
+(( $+functions[_dust_commands] )) ||
+_dust_commands() {
+    local commands; commands=()
+    _describe -t commands 'dust commands' commands "$@"
+}
+
+if [ "$funcstack[1]" = "_dust" ]; then
+    _dust "$@"
+else
+    compdef _dust dust
+fi

completions/_dust.ps1

@@ -0,0 +1,87 @@
+
+using namespace System.Management.Automation
+using namespace System.Management.Automation.Language
+
+Register-ArgumentCompleter -Native -CommandName 'dust' -ScriptBlock {
+    param($wordToComplete, $commandAst, $cursorPosition)
+
+    $commandElements = $commandAst.CommandElements
+    $command = @(
+        'dust'
+        for ($i = 1; $i -lt $commandElements.Count; $i++) {
+            $element = $commandElements[$i]
+            if ($element -isnot [StringConstantExpressionAst] -or
+                $element.StringConstantType -ne [StringConstantType]::BareWord -or
+                $element.Value.StartsWith('-') -or
+                $element.Value -eq $wordToComplete) {
+                break
+        }
+        $element.Value
+    }) -join ';'
+
+    $completions = @(switch ($command) {
+        'dust' {
+            [CompletionResult]::new('-d', 'd', [CompletionResultType]::ParameterName, 'Depth to show')
+            [CompletionResult]::new('--depth', 'depth', [CompletionResultType]::ParameterName, 'Depth to show')
+            [CompletionResult]::new('-n', 'n', [CompletionResultType]::ParameterName, 'Number of lines of output to show. (Default is terminal_height - 10)')
+            [CompletionResult]::new('--number-of-lines', 'number-of-lines', [CompletionResultType]::ParameterName, 'Number of lines of output to show. (Default is terminal_height - 10)')
+            [CompletionResult]::new('-X', 'X ', [CompletionResultType]::ParameterName, 'Exclude any file or directory with this name')
+            [CompletionResult]::new('--ignore-directory', 'ignore-directory', [CompletionResultType]::ParameterName, 'Exclude any file or directory with this name')
+            [CompletionResult]::new('-I', 'I ', [CompletionResultType]::ParameterName, 'Exclude any file or directory with a regex matching that listed in this file, the file entries will be added to the ignore regexs provided by --invert_filter')
+            [CompletionResult]::new('--ignore-all-in-file', 'ignore-all-in-file', [CompletionResultType]::ParameterName, 'Exclude any file or directory with a regex matching that listed in this file, the file entries will be added to the ignore regexs provided by --invert_filter')
+            [CompletionResult]::new('-z', 'z', [CompletionResultType]::ParameterName, 'Minimum size file to include in output')
+            [CompletionResult]::new('--min-size', 'min-size', [CompletionResultType]::ParameterName, 'Minimum size file to include in output')
+            [CompletionResult]::new('-v', 'v', [CompletionResultType]::ParameterName, 'Exclude filepaths matching this regex. To ignore png files type: -v "\.png$" ')
+            [CompletionResult]::new('--invert-filter', 'invert-filter', [CompletionResultType]::ParameterName, 'Exclude filepaths matching this regex. To ignore png files type: -v "\.png$" ')
+            [CompletionResult]::new('-e', 'e', [CompletionResultType]::ParameterName, 'Only include filepaths matching this regex. For png files type: -e "\.png$" ')
+            [CompletionResult]::new('--filter', 'filter', [CompletionResultType]::ParameterName, 'Only include filepaths matching this regex. For png files type: -e "\.png$" ')
+            [CompletionResult]::new('-w', 'w', [CompletionResultType]::ParameterName, 'Specify width of output overriding the auto detection of terminal width')
+            [CompletionResult]::new('--terminal_width', 'terminal_width', [CompletionResultType]::ParameterName, 'Specify width of output overriding the auto detection of terminal width')
+            [CompletionResult]::new('-o', 'o', [CompletionResultType]::ParameterName, 'Changes output display size. si will print sizes in powers of 1000. b/bytes kb kib mb mib gb gib will print the whole tree in that size')
+            [CompletionResult]::new('--output-format', 'output-format', [CompletionResultType]::ParameterName, 'Changes output display size. si will print sizes in powers of 1000. b/bytes kb kib mb mib gb gib will print the whole tree in that size')
+            [CompletionResult]::new('-S', 'S ', [CompletionResultType]::ParameterName, 'Specify memory to use as stack size - use if you see: ''fatal runtime error: stack overflow'' (default low memory=1048576, high memory=1073741824)')
+            [CompletionResult]::new('--stack-size', 'stack-size', [CompletionResultType]::ParameterName, 'Specify memory to use as stack size - use if you see: ''fatal runtime error: stack overflow'' (default low memory=1048576, high memory=1073741824)')
+            [CompletionResult]::new('-p', 'p', [CompletionResultType]::ParameterName, 'Subdirectories will not have their path shortened')
+            [CompletionResult]::new('--full-paths', 'full-paths', [CompletionResultType]::ParameterName, 'Subdirectories will not have their path shortened')
+            [CompletionResult]::new('-L', 'L ', [CompletionResultType]::ParameterName, 'dereference sym links - Treat sym links as directories and go into them')
+            [CompletionResult]::new('--dereference-links', 'dereference-links', [CompletionResultType]::ParameterName, 'dereference sym links - Treat sym links as directories and go into them')
+            [CompletionResult]::new('-x', 'x', [CompletionResultType]::ParameterName, 'Only count the files and directories on the same filesystem as the supplied directory')
+            [CompletionResult]::new('--limit-filesystem', 'limit-filesystem', [CompletionResultType]::ParameterName, 'Only count the files and directories on the same filesystem as the supplied directory')
+            [CompletionResult]::new('-s', 's', [CompletionResultType]::ParameterName, 'Use file length instead of blocks')
+            [CompletionResult]::new('--apparent-size', 'apparent-size', [CompletionResultType]::ParameterName, 'Use file length instead of blocks')
+            [CompletionResult]::new('-r', 'r', [CompletionResultType]::ParameterName, 'Print tree upside down (biggest highest)')
+            [CompletionResult]::new('--reverse', 'reverse', [CompletionResultType]::ParameterName, 'Print tree upside down (biggest highest)')
+            [CompletionResult]::new('-c', 'c', [CompletionResultType]::ParameterName, 'No colors will be printed (Useful for commands like: watch)')
+            [CompletionResult]::new('--no-colors', 'no-colors', [CompletionResultType]::ParameterName, 'No colors will be printed (Useful for commands like: watch)')
+            [CompletionResult]::new('-C', 'C ', [CompletionResultType]::ParameterName, 'Force colors print')
+            [CompletionResult]::new('--force-colors', 'force-colors', [CompletionResultType]::ParameterName, 'Force colors print')
+            [CompletionResult]::new('-b', 'b', [CompletionResultType]::ParameterName, 'No percent bars or percentages will be displayed')
+            [CompletionResult]::new('--no-percent-bars', 'no-percent-bars', [CompletionResultType]::ParameterName, 'No percent bars or percentages will be displayed')
+            [CompletionResult]::new('-B', 'B ', [CompletionResultType]::ParameterName, 'percent bars moved to right side of screen')
+            [CompletionResult]::new('--bars-on-right', 'bars-on-right', [CompletionResultType]::ParameterName, 'percent bars moved to right side of screen')
+            [CompletionResult]::new('-R', 'R ', [CompletionResultType]::ParameterName, 'For screen readers. Removes bars. Adds new column: depth level (May want to use -p too for full path)')
+            [CompletionResult]::new('--screen-reader', 'screen-reader', [CompletionResultType]::ParameterName, 'For screen readers. Removes bars. Adds new column: depth level (May want to use -p too for full path)')
+            [CompletionResult]::new('--skip-total', 'skip-total', [CompletionResultType]::ParameterName, 'No total row will be displayed')
+            [CompletionResult]::new('-f', 'f', [CompletionResultType]::ParameterName, 'Directory ''size'' is number of child files instead of disk size')
+            [CompletionResult]::new('--filecount', 'filecount', [CompletionResultType]::ParameterName, 'Directory ''size'' is number of child files instead of disk size')
+            [CompletionResult]::new('-i', 'i', [CompletionResultType]::ParameterName, 'Do not display hidden files')
+            [CompletionResult]::new('--ignore_hidden', 'ignore_hidden', [CompletionResultType]::ParameterName, 'Do not display hidden files')
+            [CompletionResult]::new('-t', 't', [CompletionResultType]::ParameterName, 'show only these file types')
+            [CompletionResult]::new('--file_types', 'file_types', [CompletionResultType]::ParameterName, 'show only these file types')
+            [CompletionResult]::new('-P', 'P ', [CompletionResultType]::ParameterName, 'Disable the progress indication.')
+            [CompletionResult]::new('--no-progress', 'no-progress', [CompletionResultType]::ParameterName, 'Disable the progress indication.')
+            [CompletionResult]::new('-D', 'D ', [CompletionResultType]::ParameterName, 'Only directories will be displayed.')
+            [CompletionResult]::new('--only-dir', 'only-dir', [CompletionResultType]::ParameterName, 'Only directories will be displayed.')
+            [CompletionResult]::new('-F', 'F ', [CompletionResultType]::ParameterName, 'Only files will be displayed. (Finds your largest files)')
+            [CompletionResult]::new('--only-file', 'only-file', [CompletionResultType]::ParameterName, 'Only files will be displayed. (Finds your largest files)')
+            [CompletionResult]::new('-h', 'h', [CompletionResultType]::ParameterName, 'Print help')
+            [CompletionResult]::new('--help', 'help', [CompletionResultType]::ParameterName, 'Print help')
+            [CompletionResult]::new('-V', 'V ', [CompletionResultType]::ParameterName, 'Print version')
+            [CompletionResult]::new('--version', 'version', [CompletionResultType]::ParameterName, 'Print version')
+            break
+        }
+    })
+
+    $completions.Where{ $_.CompletionText -like "$wordToComplete*" } |
+        Sort-Object -Property ListItemText
+}

completions/dust.bash

@@ -0,0 +1,122 @@
+_dust() {
+    local i cur prev opts cmd
+    COMPREPLY=()
+    cur="${COMP_WORDS[COMP_CWORD]}"
+    prev="${COMP_WORDS[COMP_CWORD-1]}"
+    cmd=""
+    opts=""
+
+    for i in ${COMP_WORDS[@]}
+    do
+        case "${cmd},${i}" in
+            ",$1")
+                cmd="dust"
+                ;;
+            *)
+                ;;
+        esac
+    done
+
+    case "${cmd}" in
+        dust)
+            opts="-d -n -p -X -I -L -x -s -r -c -C -b -B -z -R -f -i -v -e -t -w -P -D -F -o -S -h -V --depth --number-of-lines --full-paths --ignore-directory --ignore-all-in-file --dereference-links --limit-filesystem --apparent-size --reverse --no-colors --force-colors --no-percent-bars --bars-on-right --min-size --screen-reader --skip-total --filecount --ignore_hidden --invert-filter --filter --file_types --terminal_width --no-progress --only-dir --only-file --output-format --stack-size --help --version [params]..."
+            if [[ ${cur} == -* || ${COMP_CWORD} -eq 1 ]] ; then
+                COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
+                return 0
+            fi
+            case "${prev}" in
+                --depth)
+                    COMPREPLY=($(compgen -f "${cur}"))
+                    return 0
+                    ;;
+                -d)
+                    COMPREPLY=($(compgen -f "${cur}"))
+                    return 0
+                    ;;
+                --number-of-lines)
+                    COMPREPLY=($(compgen -f "${cur}"))
+                    return 0
+                    ;;
+                -n)
+                    COMPREPLY=($(compgen -f "${cur}"))
+                    return 0
+                    ;;
+                --ignore-directory)
+                    COMPREPLY=($(compgen -f "${cur}"))
+                    return 0
+                    ;;
+                -X)
+                    COMPREPLY=($(compgen -f "${cur}"))
+                    return 0
+                    ;;
+                --ignore-all-in-file)
+                    COMPREPLY=($(compgen -f "${cur}"))
+                    return 0
+                    ;;
+                -I)
+                    COMPREPLY=($(compgen -f "${cur}"))
+                    return 0
+                    ;;
+                --min-size)
+                    COMPREPLY=($(compgen -f "${cur}"))
+                    return 0
+                    ;;
+                -z)
+                    COMPREPLY=($(compgen -f "${cur}"))
+                    return 0
+                    ;;
+                --invert-filter)
+                    COMPREPLY=($(compgen -f "${cur}"))
+                    return 0
+                    ;;
+                -v)
+                    COMPREPLY=($(compgen -f "${cur}"))
+                    return 0
+                    ;;
+                --filter)
+                    COMPREPLY=($(compgen -f "${cur}"))
+                    return 0
+                    ;;
+                -e)
+                    COMPREPLY=($(compgen -f "${cur}"))
+                    return 0
+                    ;;
+                --terminal_width)
+                    COMPREPLY=($(compgen -f "${cur}"))
+                    return 0
+                    ;;
+                -w)
+                    COMPREPLY=($(compgen -f "${cur}"))
+                    return 0
+                    ;;
+                --output-format)
+                    COMPREPLY=($(compgen -f "${cur}"))
+                    return 0
+                    ;;
+                -o)
+                    COMPREPLY=($(compgen -f "${cur}"))
+                    return 0
+                    ;;
+                --stack-size)
+                    COMPREPLY=($(compgen -f "${cur}"))
+                    return 0
+                    ;;
+                -S)
+                    COMPREPLY=($(compgen -f "${cur}"))
+                    return 0
+                    ;;
+                *)
+                    COMPREPLY=()
+                    ;;
+            esac
+            COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
+            return 0
+            ;;
+    esac
+}
+
+if [[ "${BASH_VERSINFO[0]}" -eq 4 && "${BASH_VERSINFO[1]}" -ge 4 || "${BASH_VERSINFO[0]}" -gt 4 ]]; then
+    complete -F _dust -o nosort -o bashdefault -o default dust
+else
+    complete -F _dust -o bashdefault -o default dust
+fi

completions/dust.elv

@@ -0,0 +1,81 @@
+
+use builtin;
+use str;
+
+set edit:completion:arg-completer[dust] = {|@words|
+    fn spaces {|n|
+        builtin:repeat $n ' ' | str:join ''
+    }
+    fn cand {|text desc|
+        edit:complex-candidate $text &display=$text' '(spaces (- 14 (wcswidth $text)))$desc
+    }
+    var command = 'dust'
+    for word $words[1..-1] {
+        if (str:has-prefix $word '-') {
+            break
+        }
+        set command = $command';'$word
+    }
+    var completions = [
+        &'dust'= {
+            cand -d 'Depth to show'
+            cand --depth 'Depth to show'
+            cand -n 'Number of lines of output to show. (Default is terminal_height - 10)'
+            cand --number-of-lines 'Number of lines of output to show. (Default is terminal_height - 10)'
+            cand -X 'Exclude any file or directory with this name'
+            cand --ignore-directory 'Exclude any file or directory with this name'
+            cand -I 'Exclude any file or directory with a regex matching that listed in this file, the file entries will be added to the ignore regexs provided by --invert_filter'
+            cand --ignore-all-in-file 'Exclude any file or directory with a regex matching that listed in this file, the file entries will be added to the ignore regexs provided by --invert_filter'
+            cand -z 'Minimum size file to include in output'
+            cand --min-size 'Minimum size file to include in output'
+            cand -v 'Exclude filepaths matching this regex. To ignore png files type: -v "\.png$" '
+            cand --invert-filter 'Exclude filepaths matching this regex. To ignore png files type: -v "\.png$" '
+            cand -e 'Only include filepaths matching this regex. For png files type: -e "\.png$" '
+            cand --filter 'Only include filepaths matching this regex. For png files type: -e "\.png$" '
+            cand -w 'Specify width of output overriding the auto detection of terminal width'
+            cand --terminal_width 'Specify width of output overriding the auto detection of terminal width'
+            cand -o 'Changes output display size. si will print sizes in powers of 1000. b/bytes kb kib mb mib gb gib will print the whole tree in that size'
+            cand --output-format 'Changes output display size. si will print sizes in powers of 1000. b/bytes kb kib mb mib gb gib will print the whole tree in that size'
+            cand -S 'Specify memory to use as stack size - use if you see: ''fatal runtime error: stack overflow'' (default low memory=1048576, high memory=1073741824)'
+            cand --stack-size 'Specify memory to use as stack size - use if you see: ''fatal runtime error: stack overflow'' (default low memory=1048576, high memory=1073741824)'
+            cand -p 'Subdirectories will not have their path shortened'
+            cand --full-paths 'Subdirectories will not have their path shortened'
+            cand -L 'dereference sym links - Treat sym links as directories and go into them'
+            cand --dereference-links 'dereference sym links - Treat sym links as directories and go into them'
+            cand -x 'Only count the files and directories on the same filesystem as the supplied directory'
+            cand --limit-filesystem 'Only count the files and directories on the same filesystem as the supplied directory'
+            cand -s 'Use file length instead of blocks'
+            cand --apparent-size 'Use file length instead of blocks'
+            cand -r 'Print tree upside down (biggest highest)'
+            cand --reverse 'Print tree upside down (biggest highest)'
+            cand -c 'No colors will be printed (Useful for commands like: watch)'
+            cand --no-colors 'No colors will be printed (Useful for commands like: watch)'
+            cand -C 'Force colors print'
+            cand --force-colors 'Force colors print'
+            cand -b 'No percent bars or percentages will be displayed'
+            cand --no-percent-bars 'No percent bars or percentages will be displayed'
+            cand -B 'percent bars moved to right side of screen'
+            cand --bars-on-right 'percent bars moved to right side of screen'
+            cand -R 'For screen readers. Removes bars. Adds new column: depth level (May want to use -p too for full path)'
+            cand --screen-reader 'For screen readers. Removes bars. Adds new column: depth level (May want to use -p too for full path)'
+            cand --skip-total 'No total row will be displayed'
+            cand -f 'Directory ''size'' is number of child files instead of disk size'
+            cand --filecount 'Directory ''size'' is number of child files instead of disk size'
+            cand -i 'Do not display hidden files'
+            cand --ignore_hidden 'Do not display hidden files'
+            cand -t 'show only these file types'
+            cand --file_types 'show only these file types'
+            cand -P 'Disable the progress indication.'
+            cand --no-progress 'Disable the progress indication.'
+            cand -D 'Only directories will be displayed.'
+            cand --only-dir 'Only directories will be displayed.'
+            cand -F 'Only files will be displayed. (Finds your largest files)'
+            cand --only-file 'Only files will be displayed. (Finds your largest files)'
+            cand -h 'Print help'
+            cand --help 'Print help'
+            cand -V 'Print version'
+            cand --version 'Print version'
+        }
+    ]
+    $completions[$command]
+}

completions/dust.fish

@@ -0,0 +1,29 @@
+complete -c dust -s d -l depth -d 'Depth to show' -r
+complete -c dust -s n -l number-of-lines -d 'Number of lines of output to show. (Default is terminal_height - 10)' -r
+complete -c dust -s X -l ignore-directory -d 'Exclude any file or directory with this name' -r
+complete -c dust -s I -l ignore-all-in-file -d 'Exclude any file or directory with a regex matching that listed in this file, the file entries will be added to the ignore regexs provided by --invert_filter' -r
+complete -c dust -s z -l min-size -d 'Minimum size file to include in output' -r
+complete -c dust -s v -l invert-filter -d 'Exclude filepaths matching this regex. To ignore png files type: -v "\\.png$" ' -r
+complete -c dust -s e -l filter -d 'Only include filepaths matching this regex. For png files type: -e "\\.png$" ' -r
+complete -c dust -s w -l terminal_width -d 'Specify width of output overriding the auto detection of terminal width' -r
+complete -c dust -s o -l output-format -d 'Changes output display size. si will print sizes in powers of 1000. b/bytes kb kib mb mib gb gib will print the whole tree in that size' -r
+complete -c dust -s S -l stack-size -d 'Specify memory to use as stack size - use if you see: \'fatal runtime error: stack overflow\' (default low memory=1048576, high memory=1073741824)' -r
+complete -c dust -s p -l full-paths -d 'Subdirectories will not have their path shortened'
+complete -c dust -s L -l dereference-links -d 'dereference sym links - Treat sym links as directories and go into them'
+complete -c dust -s x -l limit-filesystem -d 'Only count the files and directories on the same filesystem as the supplied directory'
+complete -c dust -s s -l apparent-size -d 'Use file length instead of blocks'
+complete -c dust -s r -l reverse -d 'Print tree upside down (biggest highest)'
+complete -c dust -s c -l no-colors -d 'No colors will be printed (Useful for commands like: watch)'
+complete -c dust -s C -l force-colors -d 'Force colors print'
+complete -c dust -s b -l no-percent-bars -d 'No percent bars or percentages will be displayed'
+complete -c dust -s B -l bars-on-right -d 'percent bars moved to right side of screen'
+complete -c dust -s R -l screen-reader -d 'For screen readers. Removes bars. Adds new column: depth level (May want to use -p too for full path)'
+complete -c dust -l skip-total -d 'No total row will be displayed'
+complete -c dust -s f -l filecount -d 'Directory \'size\' is number of child files instead of disk size'
+complete -c dust -s i -l ignore_hidden -d 'Do not display hidden files'
+complete -c dust -s t -l file_types -d 'show only these file types'
+complete -c dust -s P -l no-progress -d 'Disable the progress indication.'
+complete -c dust -s D -l only-dir -d 'Only directories will be displayed.'
+complete -c dust -s F -l only-file -d 'Only files will be displayed. (Finds your largest files)'
+complete -c dust -s h -l help -d 'Print help'
+complete -c dust -s V -l version -d 'Print version'

config/config.toml

@@ -0,0 +1,28 @@
+# Sample Config file, works with toml and yaml
+# Place in either:
+#   ~/.config/dust/config.toml
+#   ~/.dust.toml
+
+# Print tree upside down (biggest highest)
+reverse=true
+
+# Subdirectories will not have their path shortened
+display-full-paths=true
+
+# Use file length instead of blocks
+display-apparent-size=true
+
+# No colors will be printed
+no-colors=true
+
+# No percent bars or percentages will be displayed
+no-bars=true
+
+# No total row will be displayed
+skip-total=true
+
+# Do not display hidden files
+ignore-hidden=true
+
+# print sizes in powers of 1000 (e.g., 1.1G)
+iso=true

man-page/dust.1

@@ -0,0 +1,102 @@
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.TH Dust 1  "Dust 1.0.0" 
+.SH NAME
+Dust \- Like du but more intuitive
+.SH SYNOPSIS
+\fBdust\fR [\fB\-d\fR|\fB\-\-depth\fR] [\fB\-n\fR|\fB\-\-number\-of\-lines\fR] [\fB\-p\fR|\fB\-\-full\-paths\fR] [\fB\-X\fR|\fB\-\-ignore\-directory\fR] [\fB\-I\fR|\fB\-\-ignore\-all\-in\-file\fR] [\fB\-L\fR|\fB\-\-dereference\-links\fR] [\fB\-x\fR|\fB\-\-limit\-filesystem\fR] [\fB\-s\fR|\fB\-\-apparent\-size\fR] [\fB\-r\fR|\fB\-\-reverse\fR] [\fB\-c\fR|\fB\-\-no\-colors\fR] [\fB\-C\fR|\fB\-\-force\-colors\fR] [\fB\-b\fR|\fB\-\-no\-percent\-bars\fR] [\fB\-B\fR|\fB\-\-bars\-on\-right\fR] [\fB\-z\fR|\fB\-\-min\-size\fR] [\fB\-R\fR|\fB\-\-screen\-reader\fR] [\fB\-\-skip\-total\fR] [\fB\-f\fR|\fB\-\-filecount\fR] [\fB\-i\fR|\fB\-\-ignore_hidden\fR] [\fB\-v\fR|\fB\-\-invert\-filter\fR] [\fB\-e\fR|\fB\-\-filter\fR] [\fB\-t\fR|\fB\-\-file_types\fR] [\fB\-w\fR|\fB\-\-terminal_width\fR] [\fB\-P\fR|\fB\-\-no\-progress\fR] [\fB\-D\fR|\fB\-\-only\-dir\fR] [\fB\-F\fR|\fB\-\-only\-file\fR] [\fB\-o\fR|\fB\-\-output\-format\fR] [\fB\-S\fR|\fB\-\-stack\-size\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] [\fIparams\fR] 
+.SH DESCRIPTION
+Like du but more intuitive
+.SH OPTIONS
+.TP
+\fB\-d\fR, \fB\-\-depth\fR
+Depth to show
+.TP
+\fB\-n\fR, \fB\-\-number\-of\-lines\fR
+Number of lines of output to show. (Default is terminal_height \- 10)
+.TP
+\fB\-p\fR, \fB\-\-full\-paths\fR
+Subdirectories will not have their path shortened
+.TP
+\fB\-X\fR, \fB\-\-ignore\-directory\fR
+Exclude any file or directory with this name
+.TP
+\fB\-I\fR, \fB\-\-ignore\-all\-in\-file\fR
+Exclude any file or directory with a regex matching that listed in this file, the file entries will be added to the ignore regexs provided by \-\-invert_filter
+.TP
+\fB\-L\fR, \fB\-\-dereference\-links\fR
+dereference sym links \- Treat sym links as directories and go into them
+.TP
+\fB\-x\fR, \fB\-\-limit\-filesystem\fR
+Only count the files and directories on the same filesystem as the supplied directory
+.TP
+\fB\-s\fR, \fB\-\-apparent\-size\fR
+Use file length instead of blocks
+.TP
+\fB\-r\fR, \fB\-\-reverse\fR
+Print tree upside down (biggest highest)
+.TP
+\fB\-c\fR, \fB\-\-no\-colors\fR
+No colors will be printed (Useful for commands like: watch)
+.TP
+\fB\-C\fR, \fB\-\-force\-colors\fR
+Force colors print
+.TP
+\fB\-b\fR, \fB\-\-no\-percent\-bars\fR
+No percent bars or percentages will be displayed
+.TP
+\fB\-B\fR, \fB\-\-bars\-on\-right\fR
+percent bars moved to right side of screen
+.TP
+\fB\-z\fR, \fB\-\-min\-size\fR
+Minimum size file to include in output
+.TP
+\fB\-R\fR, \fB\-\-screen\-reader\fR
+For screen readers. Removes bars. Adds new column: depth level (May want to use \-p too for full path)
+.TP
+\fB\-\-skip\-total\fR
+No total row will be displayed
+.TP
+\fB\-f\fR, \fB\-\-filecount\fR
+Directory \*(Aqsize\*(Aq is number of child files instead of disk size
+.TP
+\fB\-i\fR, \fB\-\-ignore_hidden\fR
+Do not display hidden files
+.TP
+\fB\-v\fR, \fB\-\-invert\-filter\fR
+Exclude filepaths matching this regex. To ignore png files type: \-v "\\.png$" 
+.TP
+\fB\-e\fR, \fB\-\-filter\fR
+Only include filepaths matching this regex. For png files type: \-e "\\.png$" 
+.TP
+\fB\-t\fR, \fB\-\-file_types\fR
+show only these file types
+.TP
+\fB\-w\fR, \fB\-\-terminal_width\fR
+Specify width of output overriding the auto detection of terminal width
+.TP
+\fB\-P\fR, \fB\-\-no\-progress\fR
+Disable the progress indication.
+.TP
+\fB\-D\fR, \fB\-\-only\-dir\fR
+Only directories will be displayed.
+.TP
+\fB\-F\fR, \fB\-\-only\-file\fR
+Only files will be displayed. (Finds your largest files)
+.TP
+\fB\-o\fR, \fB\-\-output\-format\fR
+Changes output display size. si will print sizes in powers of 1000. b/bytes kb kib mb mib gb gib will print the whole tree in that size
+.TP
+\fB\-S\fR, \fB\-\-stack\-size\fR
+Specify memory to use as stack size \- use if you see: \*(Aqfatal runtime error: stack overflow\*(Aq (default low memory=1048576, high memory=1073741824)
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+Print version
+.TP
+[\fIparams\fR]
+
+.SH VERSION
+v1.0.0

src/cli.rs

@@ -0,0 +1,213 @@
+use clap::{value_parser, Arg, Command};
+
+// For single thread mode set this variable on your command line:
+// export RAYON_NUM_THREADS=1
+
+pub fn build_cli() -> Command {
+    Command::new("Dust")
+        .about("Like du but more intuitive")
+        .version(env!("CARGO_PKG_VERSION"))
+        .trailing_var_arg(true)
+        .arg(
+            Arg::new("depth")
+                .short('d')
+                .long("depth")
+                .value_parser(value_parser!(usize))
+                .help("Depth to show")
+                .num_args(1)
+        )
+        .arg(
+            Arg::new("number_of_lines")
+                .short('n')
+                .long("number-of-lines")
+                .value_parser(value_parser!(usize))
+                .help("Number of lines of output to show. (Default is terminal_height - 10)")
+                .num_args(1)
+        )
+        .arg(
+            Arg::new("display_full_paths")
+                .short('p')
+                .long("full-paths")
+                .action(clap::ArgAction::SetTrue)
+                .help("Subdirectories will not have their path shortened"),
+        )
+        .arg(
+            Arg::new("ignore_directory")
+                .short('X')
+                .long("ignore-directory")
+                .action(clap::ArgAction::Append)
+                .help("Exclude any file or directory with this name"),
+        )
+        .arg(
+            Arg::new("ignore_all_in_file")
+                .short('I')
+                .long("ignore-all-in-file")
+                .value_parser(value_parser!(String))
+                .help("Exclude any file or directory with a regex matching that listed in this file, the file entries will be added to the ignore regexs provided by --invert_filter"),
+        )
+         .arg(
+            Arg::new("dereference_links")
+                .short('L')
+                .long("dereference-links")
+                .action(clap::ArgAction::SetTrue)
+                .help("dereference sym links - Treat sym links as directories and go into them"),
+        )
+        .arg(
+            Arg::new("limit_filesystem")
+                .short('x')
+                .long("limit-filesystem")
+                .action(clap::ArgAction::SetTrue)
+                .help("Only count the files and directories on the same filesystem as the supplied directory"),
+        )
+        .arg(
+            Arg::new("display_apparent_size")
+                .short('s')
+                .long("apparent-size")
+                .action(clap::ArgAction::SetTrue)
+                .help("Use file length instead of blocks"),
+        )
+        .arg(
+            Arg::new("reverse")
+                .short('r')
+                .long("reverse")
+                .action(clap::ArgAction::SetTrue)
+                .help("Print tree upside down (biggest highest)"),
+        )
+        .arg(
+            Arg::new("no_colors")
+                .short('c')
+                .long("no-colors")
+                .action(clap::ArgAction::SetTrue)
+                .help("No colors will be printed (Useful for commands like: watch)"),
+        )
+        .arg(
+            Arg::new("force_colors")
+                .short('C')
+                .long("force-colors")
+                .action(clap::ArgAction::SetTrue)
+                .help("Force colors print"),
+        )
+        .arg(
+            Arg::new("no_bars")
+                .short('b')
+                .long("no-percent-bars")
+                .action(clap::ArgAction::SetTrue)
+                .help("No percent bars or percentages will be displayed"),
+        )
+        .arg(
+            Arg::new("bars_on_right")
+                .short('B')
+                .long("bars-on-right")
+                .action(clap::ArgAction::SetTrue)
+                .help("percent bars moved to right side of screen"),
+        )
+        .arg(
+            Arg::new("min_size")
+                .short('z')
+                .long("min-size")
+                .num_args(1)
+                .help("Minimum size file to include in output"),
+        )
+        .arg(
+            Arg::new("screen_reader")
+                .short('R')
+                .long("screen-reader")
+                .action(clap::ArgAction::SetTrue)
+                .help("For screen readers. Removes bars. Adds new column: depth level (May want to use -p too for full path)"),
+        )
+        .arg(
+            Arg::new("skip_total")
+                .long("skip-total")
+                .action(clap::ArgAction::SetTrue)
+                .help("No total row will be displayed"),
+        )
+        .arg(
+            Arg::new("by_filecount")
+                .short('f')
+                .long("filecount")
+                .action(clap::ArgAction::SetTrue)
+                .help("Directory 'size' is number of child files instead of disk size"),
+        )
+        .arg(
+            Arg::new("ignore_hidden")
+                .short('i') // Do not use 'h' this is used by 'help'
+                .long("ignore_hidden")
+                .action(clap::ArgAction::SetTrue)
+                .help("Do not display hidden files"),
+        )
+        .arg(
+            Arg::new("invert_filter")
+                .short('v')
+                .long("invert-filter")
+                .action(clap::ArgAction::Append)
+                .conflicts_with("filter")
+                .conflicts_with("types")
+                .help("Exclude filepaths matching this regex. To ignore png files type: -v \"\\.png$\" "),
+        )
+        .arg(
+            Arg::new("filter")
+                .short('e')
+                .long("filter")
+                .action(clap::ArgAction::Append)
+                .conflicts_with("types")
+                .help("Only include filepaths matching this regex. For png files type: -e \"\\.png$\" "),
+        )
+        .arg(
+            Arg::new("types")
+                .short('t')
+                .long("file_types")
+                .conflicts_with("depth")
+                .conflicts_with("only_dir")
+                .action(clap::ArgAction::SetTrue)
+                .help("show only these file types"),
+        )
+        .arg(
+            Arg::new("width")
+                .short('w')
+                .long("terminal_width")
+                .num_args(1)
+                .value_parser(value_parser!(usize))
+                .help("Specify width of output overriding the auto detection of terminal width"),
+        )
+        .arg(
+            Arg::new("disable_progress")
+                .short('P')
+                .long("no-progress")
+                .action(clap::ArgAction::SetTrue)
+                .help("Disable the progress indication."),
+        )
+        .arg(
+            Arg::new("only_dir")
+                .short('D')
+                .long("only-dir")
+                .conflicts_with("only_file")
+                .conflicts_with("types")
+                .action(clap::ArgAction::SetTrue)
+                .help("Only directories will be displayed."),
+        )
+        .arg(
+            Arg::new("only_file")
+                .short('F')
+                .long("only-file")
+                .conflicts_with("only_dir")
+                .action(clap::ArgAction::SetTrue)
+                .help("Only files will be displayed. (Finds your largest files)"),
+        )
+        .arg(
+            Arg::new("output_format")
+                .short('o')
+                .long("output-format")
+                .value_parser(value_parser!(String))
+                .help("Changes output display size. si will print sizes in powers of 1000. b/bytes kb kib mb mib gb gib will print the whole tree in that size")
+        )
+        .arg(
+            Arg::new("stack_size")
+                .short('S')
+                .long("stack-size")
+                .num_args(1)
+                .value_parser(value_parser!(usize))
+                .help("Specify memory to use as stack size - use if you see: 'fatal runtime error: stack overflow' (default low memory=1048576, high memory=1073741824)"),
+        )
+        .arg(Arg::new("params").num_args(1..)
+            .value_parser(value_parser!(String)))
+}

src/config.rs

@@ -0,0 +1,244 @@
+use clap::ArgMatches;
+use config_file::FromConfigFile;
+use regex::Regex;
+use serde::Deserialize;
+use std::io::IsTerminal;
+use std::path::Path;
+use std::path::PathBuf;
+
+use crate::display::get_number_format;
+
+#[derive(Deserialize, Default)]
+#[serde(rename_all = "kebab-case")]
+#[serde(deny_unknown_fields)]
+pub struct Config {
+    pub display_full_paths: Option<bool>,
+    pub display_apparent_size: Option<bool>,
+    pub reverse: Option<bool>,
+    pub no_colors: Option<bool>,
+    pub force_colors: Option<bool>,
+    pub no_bars: Option<bool>,
+    pub skip_total: Option<bool>,
+    pub screen_reader: Option<bool>,
+    pub ignore_hidden: Option<bool>,
+    pub output_format: Option<String>,
+    pub min_size: Option<String>,
+    pub only_dir: Option<bool>,
+    pub only_file: Option<bool>,
+    pub disable_progress: Option<bool>,
+    pub depth: Option<usize>,
+    pub bars_on_right: Option<bool>,
+    pub stack_size: Option<usize>,
+}
+
+impl Config {
+    pub fn get_no_colors(&self, options: &ArgMatches) -> bool {
+        Some(true) == self.no_colors || options.get_flag("no_colors")
+    }
+    pub fn get_force_colors(&self, options: &ArgMatches) -> bool {
+        Some(true) == self.force_colors || options.get_flag("force_colors")
+    }
+    pub fn get_disable_progress(&self, options: &ArgMatches) -> bool {
+        Some(true) == self.disable_progress
+            || options.get_flag("disable_progress")
+            || !std::io::stdout().is_terminal()
+    }
+    pub fn get_apparent_size(&self, options: &ArgMatches) -> bool {
+        Some(true) == self.display_apparent_size || options.get_flag("display_apparent_size")
+    }
+    pub fn get_ignore_hidden(&self, options: &ArgMatches) -> bool {
+        Some(true) == self.ignore_hidden || options.get_flag("ignore_hidden")
+    }
+    pub fn get_full_paths(&self, options: &ArgMatches) -> bool {
+        // If we are only showing files, always show full paths
+        Some(true) == self.display_full_paths
+            || options.get_flag("display_full_paths")
+            || self.get_only_file(options)
+    }
+    pub fn get_reverse(&self, options: &ArgMatches) -> bool {
+        Some(true) == self.reverse || options.get_flag("reverse")
+    }
+    pub fn get_no_bars(&self, options: &ArgMatches) -> bool {
+        Some(true) == self.no_bars || options.get_flag("no_bars")
+    }
+    pub fn get_output_format(&self, options: &ArgMatches) -> String {
+        let out_fmt = options.get_one::<String>("output_format");
+        (match out_fmt {
+            None => match &self.output_format {
+                None => "".to_string(),
+                Some(x) => x.to_string(),
+            },
+            Some(x) => x.into(),
+        })
+        .to_lowercase()
+    }
+    pub fn get_skip_total(&self, options: &ArgMatches) -> bool {
+        Some(true) == self.skip_total || options.get_flag("skip_total")
+    }
+    pub fn get_screen_reader(&self, options: &ArgMatches) -> bool {
+        Some(true) == self.screen_reader || options.get_flag("screen_reader")
+    }
+    pub fn get_depth(&self, options: &ArgMatches) -> usize {
+        if let Some(v) = options.get_one::<usize>("depth") {
+            return *v;
+        }
+
+        self.depth.unwrap_or(usize::MAX)
+    }
+    pub fn get_min_size(&self, options: &ArgMatches) -> Option<usize> {
+        let size_from_param = options.get_one::<String>("min_size");
+        self._get_min_size(size_from_param)
+    }
+    fn _get_min_size(&self, min_size: Option<&String>) -> Option<usize> {
+        let size_from_param = min_size.and_then(|a| convert_min_size(a));
+
+        if size_from_param.is_none() {
+            self.min_size
+                .as_ref()
+                .and_then(|a| convert_min_size(a.as_ref()))
+        } else {
+            size_from_param
+        }
+    }
+    pub fn get_only_dir(&self, options: &ArgMatches) -> bool {
+        Some(true) == self.only_dir || options.get_flag("only_dir")
+    }
+    pub fn get_only_file(&self, options: &ArgMatches) -> bool {
+        Some(true) == self.only_file || options.get_flag("only_file")
+    }
+    pub fn get_bars_on_right(&self, options: &ArgMatches) -> bool {
+        Some(true) == self.bars_on_right || options.get_flag("bars_on_right")
+    }
+    pub fn get_custom_stack_size(&self, options: &ArgMatches) -> Option<usize> {
+        let from_cmd_line = options.get_one::<usize>("stack_size");
+        if from_cmd_line.is_none() {
+            self.stack_size
+        } else {
+            from_cmd_line.copied()
+        }
+    }
+}
+
+fn convert_min_size(input: &str) -> Option<usize> {
+    let re = Regex::new(r"([0-9]+)(\w*)").unwrap();
+
+    if let Some(cap) = re.captures(input) {
+        let (_, [digits, letters]) = cap.extract();
+
+        // Failure to parse should be impossible due to regex match
+        let digits_as_usize: Option<usize> = digits.parse().ok();
+
+        match digits_as_usize {
+            Some(parsed_digits) => {
+                let number_format = get_number_format(&letters.to_lowercase());
+                match number_format {
+                    Some((multiple, _)) => Some(parsed_digits * (multiple as usize)),
+                    None => {
+                        if letters.eq("") {
+                            Some(parsed_digits)
+                        } else {
+                            eprintln!("Ignoring invalid min-size: {input}");
+                            None
+                        }
+                    }
+                }
+            }
+            None => None,
+        }
+    } else {
+        None
+    }
+}
+
+fn get_config_locations(base: &Path) -> Vec<PathBuf> {
+    vec![
+        base.join(".dust.toml"),
+        base.join(".config").join("dust").join("config.toml"),
+    ]
+}
+
+pub fn get_config() -> Config {
+    if let Some(home) = directories::BaseDirs::new() {
+        for path in get_config_locations(home.home_dir()) {
+            if path.exists() {
+                if let Ok(config) = Config::from_config_file(path) {
+                    return config;
+                }
+            }
+        }
+    }
+    Config {
+        ..Default::default()
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    #[allow(unused_imports)]
+    use super::*;
+    use clap::{value_parser, Arg, ArgMatches, Command};
+
+    #[test]
+    fn test_conversion() {
+        assert_eq!(convert_min_size("55"), Some(55));
+        assert_eq!(convert_min_size("12344321"), Some(12344321));
+        assert_eq!(convert_min_size("95RUBBISH"), None);
+        assert_eq!(convert_min_size("10K"), Some(10 * 1024));
+        assert_eq!(convert_min_size("10M"), Some(10 * 1024usize.pow(2)));
+        assert_eq!(convert_min_size("10MiB"), Some(10 * 1000usize.pow(2)));
+        assert_eq!(convert_min_size("2G"), Some(2 * 1024usize.pow(3)));
+    }
+
+    #[test]
+    fn test_min_size_from_config_applied_or_overridden() {
+        let c = Config {
+            min_size: Some("1K".to_owned()),
+            ..Default::default()
+        };
+        assert_eq!(c._get_min_size(None), Some(1024));
+        assert_eq!(c._get_min_size(Some(&"2K".into())), Some(2048));
+
+        assert_eq!(c._get_min_size(Some(&"1kib".into())), Some(1000));
+        assert_eq!(c._get_min_size(Some(&"2KiB".into())), Some(2000));
+    }
+
+    #[test]
+    fn test_get_depth() {
+        // No config and no flag.
+        let c = Config::default();
+        let args = get_args(vec![]);
+        assert_eq!(c.get_depth(&args), usize::MAX);
+
+        // Config is not defined and flag is defined.
+        let c = Config::default();
+        let args = get_args(vec!["dust", "--depth", "5"]);
+        assert_eq!(c.get_depth(&args), 5);
+
+        // Config is defined and flag is not defined.
+        let c = Config {
+            depth: Some(3),
+            ..Default::default()
+        };
+        let args = get_args(vec![]);
+        assert_eq!(c.get_depth(&args), 3);
+
+        // Both config and flag are defined.
+        let c = Config {
+            depth: Some(3),
+            ..Default::default()
+        };
+        let args = get_args(vec!["dust", "--depth", "5"]);
+        assert_eq!(c.get_depth(&args), 5);
+    }
+
+    fn get_args(args: Vec<&str>) -> ArgMatches {
+        Command::new("Dust")
+            .arg(
+                Arg::new("depth")
+                    .long("depth")
+                    .num_args(1)
+                    .value_parser(value_parser!(usize)),
+            )
+            .get_matches_from(args)
+    }
+}

src/dir_walker.rs

@@ -0,0 +1,263 @@
+use std::fs;
+use std::sync::Arc;
+use std::sync::Mutex;
+
+use crate::node::Node;
+use crate::progress::Operation;
+use crate::progress::PAtomicInfo;
+use crate::progress::RuntimeErrors;
+use crate::progress::ORDERING;
+use crate::utils::is_filtered_out_due_to_invert_regex;
+use crate::utils::is_filtered_out_due_to_regex;
+use rayon::iter::ParallelBridge;
+use rayon::prelude::ParallelIterator;
+use regex::Regex;
+use std::path::PathBuf;
+
+use std::collections::HashSet;
+
+use crate::node::build_node;
+use std::fs::DirEntry;
+
+use crate::platform::get_metadata;
+pub struct WalkData<'a> {
+    pub ignore_directories: HashSet<PathBuf>,
+    pub filter_regex: &'a [Regex],
+    pub invert_filter_regex: &'a [Regex],
+    pub allowed_filesystems: HashSet<u64>,
+    pub use_apparent_size: bool,
+    pub by_filecount: bool,
+    pub ignore_hidden: bool,
+    pub follow_links: bool,
+    pub progress_data: Arc<PAtomicInfo>,
+    pub errors: Arc<Mutex<RuntimeErrors>>,
+}
+
+pub fn walk_it(dirs: HashSet<PathBuf>, walk_data: &WalkData) -> Vec<Node> {
+    let mut inodes = HashSet::new();
+    let top_level_nodes: Vec<_> = dirs
+        .into_iter()
+        .filter_map(|d| {
+            let prog_data = &walk_data.progress_data;
+            prog_data.clear_state(&d);
+            let node = walk(d, walk_data, 0)?;
+
+            prog_data.state.store(Operation::PREPARING, ORDERING);
+
+            clean_inodes(node, &mut inodes, walk_data.use_apparent_size)
+        })
+        .collect();
+    top_level_nodes
+}
+
+// Remove files which have the same inode, we don't want to double count them.
+fn clean_inodes(
+    x: Node,
+    inodes: &mut HashSet<(u64, u64)>,
+    use_apparent_size: bool,
+) -> Option<Node> {
+    if !use_apparent_size {
+        if let Some(id) = x.inode_device {
+            if !inodes.insert(id) {
+                return None;
+            }
+        }
+    }
+
+    // Sort Nodes so iteration order is predictable
+    let mut tmp: Vec<_> = x.children;
+    tmp.sort_by(sort_by_inode);
+    let new_children: Vec<_> = tmp
+        .into_iter()
+        .filter_map(|c| clean_inodes(c, inodes, use_apparent_size))
+        .collect();
+
+    Some(Node {
+        name: x.name,
+        size: x.size + new_children.iter().map(|c| c.size).sum::<u64>(),
+        children: new_children,
+        inode_device: x.inode_device,
+        depth: x.depth,
+    })
+}
+
+fn sort_by_inode(a: &Node, b: &Node) -> std::cmp::Ordering {
+    // Sorting by inode is quicker than by sorting by name/size
+    if let Some(x) = a.inode_device {
+        if let Some(y) = b.inode_device {
+            if x.0 != y.0 {
+                return x.0.cmp(&y.0);
+            } else if x.1 != y.1 {
+                return x.1.cmp(&y.1);
+            }
+        }
+    }
+    a.name.cmp(&b.name)
+}
+
+fn ignore_file(entry: &DirEntry, walk_data: &WalkData) -> bool {
+    let is_dot_file = entry.file_name().to_str().unwrap_or("").starts_with('.');
+    let is_ignored_path = walk_data.ignore_directories.contains(&entry.path());
+
+    if !walk_data.allowed_filesystems.is_empty() {
+        let size_inode_device = get_metadata(&entry.path(), false);
+
+        if let Some((_size, Some((_id, dev)))) = size_inode_device {
+            if !walk_data.allowed_filesystems.contains(&dev) {
+                return true;
+            }
+        }
+    }
+
+    // Keeping `walk_data.filter_regex.is_empty()` is important for performance reasons, it stops unnecessary work
+    if !walk_data.filter_regex.is_empty()
+        && entry.path().is_file()
+        && is_filtered_out_due_to_regex(walk_data.filter_regex, &entry.path())
+    {
+        return true;
+    }
+
+    if !walk_data.invert_filter_regex.is_empty()
+        && entry.path().is_file()
+        && is_filtered_out_due_to_invert_regex(walk_data.invert_filter_regex, &entry.path())
+    {
+        return true;
+    }
+
+    (is_dot_file && walk_data.ignore_hidden) || is_ignored_path
+}
+
+fn walk(dir: PathBuf, walk_data: &WalkData, depth: usize) -> Option<Node> {
+    let prog_data = &walk_data.progress_data;
+    let errors = &walk_data.errors;
+    if errors.lock().unwrap().abort {
+        return None;
+    }
+
+    let children = if dir.is_dir() {
+        let read_dir = fs::read_dir(&dir);
+        match read_dir {
+            Ok(entries) => {
+                entries
+                    .into_iter()
+                    .par_bridge()
+                    .filter_map(|entry| {
+                        if let Ok(ref entry) = entry {
+                            // uncommenting the below line gives simpler code but
+                            // rayon doesn't parallelize as well giving a 3X performance drop
+                            // hence we unravel the recursion a bit
+
+                            // return walk(entry.path(), walk_data, depth)
+
+                            if !ignore_file(entry, walk_data) {
+                                if let Ok(data) = entry.file_type() {
+                                    if data.is_dir()
+                                        || (walk_data.follow_links && data.is_symlink())
+                                    {
+                                        return walk(entry.path(), walk_data, depth + 1);
+                                    }
+
+                                    let node = build_node(
+                                        entry.path(),
+                                        vec![],
+                                        walk_data.filter_regex,
+                                        walk_data.invert_filter_regex,
+                                        walk_data.use_apparent_size,
+                                        data.is_symlink(),
+                                        data.is_file(),
+                                        walk_data.by_filecount,
+                                        depth,
+                                    );
+
+                                    prog_data.num_files.fetch_add(1, ORDERING);
+                                    if let Some(ref file) = node {
+                                        prog_data.total_file_size.fetch_add(file.size, ORDERING);
+                                    }
+
+                                    return node;
+                                }
+                            }
+                        } else {
+                            let mut editable_error = errors.lock().unwrap();
+                            editable_error.no_permissions = true
+                        }
+                        None
+                    })
+                    .collect()
+            }
+            Err(failed) => {
+                let mut editable_error = errors.lock().unwrap();
+                match failed.kind() {
+                    std::io::ErrorKind::PermissionDenied => {
+                        editable_error.no_permissions = true;
+                    }
+                    std::io::ErrorKind::NotFound => {
+                        editable_error.file_not_found.insert(failed.to_string());
+                    }
+                    _ => {
+                        editable_error.unknown_error.insert(failed.to_string());
+                    }
+                }
+                vec![]
+            }
+        }
+    } else {
+        if !dir.is_file() {
+            let mut editable_error = errors.lock().unwrap();
+            let bad_file = dir.as_os_str().to_string_lossy().into();
+            editable_error.file_not_found.insert(bad_file);
+        }
+        vec![]
+    };
+    build_node(
+        dir,
+        children,
+        walk_data.filter_regex,
+        walk_data.invert_filter_regex,
+        walk_data.use_apparent_size,
+        false,
+        false,
+        walk_data.by_filecount,
+        depth,
+    )
+}
+
+mod tests {
+    #[allow(unused_imports)]
+    use super::*;
+
+    #[cfg(test)]
+    fn create_node() -> Node {
+        Node {
+            name: PathBuf::new(),
+            size: 10,
+            children: vec![],
+            inode_device: Some((5, 6)),
+            depth: 0,
+        }
+    }
+
+    #[test]
+    #[allow(clippy::redundant_clone)]
+    fn test_should_ignore_file() {
+        let mut inodes = HashSet::new();
+        let n = create_node();
+
+        // First time we insert the node
+        assert_eq!(clean_inodes(n.clone(), &mut inodes, false), Some(n.clone()));
+
+        // Second time is a duplicate - we ignore it
+        assert_eq!(clean_inodes(n.clone(), &mut inodes, false), None);
+    }
+
+    #[test]
+    #[allow(clippy::redundant_clone)]
+    fn test_should_not_ignore_files_if_using_apparent_size() {
+        let mut inodes = HashSet::new();
+        let n = create_node();
+
+        // If using apparent size we include Nodes, even if duplicate inodes
+        assert_eq!(clean_inodes(n.clone(), &mut inodes, true), Some(n.clone()));
+        assert_eq!(clean_inodes(n.clone(), &mut inodes, true), Some(n.clone()));
+    }
+}

src/display.rs

@@ -1,121 +1,260 @@
-extern crate ansi_term;
+use crate::display_node::DisplayNode;
 
-use self::ansi_term::Colour::Fixed;
-use self::ansi_term::Style;
-use crate::utils::Node;
+use ansi_term::Colour::Red;
+use lscolors::{LsColors, Style};
 
-static UNITS: [char; 4] = ['T', 'G', 'M', 'K'];
+use unicode_width::UnicodeWidthStr;
 
-pub struct DisplayData {
+use stfu8::encode_u8;
+
+use std::cmp::max;
+use std::cmp::min;
+use std::fs;
+use std::iter::repeat;
+use std::path::Path;
+use thousands::Separable;
+
+pub static UNITS: [char; 4] = ['T', 'G', 'M', 'K'];
+static BLOCKS: [char; 5] = ['█', '▓', '▒', '░', ' '];
+
+pub struct InitialDisplayData {
     pub short_paths: bool,
     pub is_reversed: bool,
     pub colors_on: bool,
+    pub by_filecount: bool,
+    pub is_screen_reader: bool,
+    pub output_format: String,
+    pub bars_on_right: bool,
+}
+
+pub struct DisplayData {
+    pub initial: InitialDisplayData,
+    pub num_chars_needed_on_left_most: usize,
+    pub base_size: u64,
+    pub longest_string_length: usize,
+    pub ls_colors: LsColors,
 }
 
 impl DisplayData {
-    fn get_first_chars(&self) -> &str {
-        if self.is_reversed {
-            "─┴"
-        } else {
-            "─┬"
+    fn get_tree_chars(&self, was_i_last: bool, has_children: bool) -> &'static str {
+        match (self.initial.is_reversed, was_i_last, has_children) {
+            (true, true, true) => "┌─┴",
+            (true, true, false) => "┌──",
+            (true, false, true) => "├─┴",
+            (true, false, false) => "├──",
+            (false, true, true) => "└─┬",
+            (false, true, false) => "└──",
+            (false, false, true) => "├─┬",
+            (false, false, false) => "├──",
         }
     }
 
-    #[allow(clippy::collapsible_if)]
-    fn get_tree_chars(
-        &self,
-        num_siblings: u64,
-        max_siblings: u64,
-        has_children: bool,
-    ) -> &'static str {
-        if self.is_reversed {
-            if num_siblings == max_siblings - 1 {
-                if has_children {
-                    "┌─┴"
-                } else {
-                    "┌──"
-                }
-            } else if has_children {
-                "├─┴"
-            } else {
-                "├──"
-            }
+    fn is_biggest(&self, num_siblings: usize, max_siblings: u64) -> bool {
+        if self.initial.is_reversed {
+            num_siblings == (max_siblings - 1) as usize
         } else {
-            if num_siblings == 0 {
-                if has_children {
-                    "└─┬"
-                } else {
-                    "└──"
-                }
-            } else if has_children {
-                "├─┬"
-            } else {
-                "├──"
-            }
+            num_siblings == 0
         }
     }
 
-    fn is_biggest(&self, num_siblings: u64, max_siblings: u64) -> bool {
-        if self.is_reversed {
+    fn is_last(&self, num_siblings: usize, max_siblings: u64) -> bool {
+        if self.initial.is_reversed {
             num_siblings == 0
         } else {
-            num_siblings == max_siblings - 1
+            num_siblings == (max_siblings - 1) as usize
         }
     }
 
-    fn get_children_from_node(&self, node: Node) -> impl Iterator<Item = Node> {
-        if self.is_reversed {
-            let n: Vec<Node> = node.children.into_iter().rev().map(|a| a).collect();
-            n.into_iter()
+    fn percent_size(&self, node: &DisplayNode) -> f32 {
+        let result = node.size as f32 / self.base_size as f32;
+        if result.is_normal() {
+            result
         } else {
-            node.children.into_iter()
+            0.0
+        }
+    }
+}
+
+struct DrawData<'a> {
+    indent: String,
+    percent_bar: String,
+    display_data: &'a DisplayData,
+}
+
+impl DrawData<'_> {
+    fn get_new_indent(&self, has_children: bool, was_i_last: bool) -> String {
+        let chars = self.display_data.get_tree_chars(was_i_last, has_children);
+        self.indent.to_string() + chars
+    }
+
+    // TODO: can we test this?
+    fn generate_bar(&self, node: &DisplayNode, level: usize) -> String {
+        if self.display_data.initial.is_screen_reader {
+            return level.to_string();
+        }
+        let chars_in_bar = self.percent_bar.chars().count();
+        let num_bars = chars_in_bar as f32 * self.display_data.percent_size(node);
+        let mut num_not_my_bar = (chars_in_bar as i32) - num_bars as i32;
+
+        let mut new_bar = "".to_string();
+        let idx = 5 - level.clamp(1, 4);
+
+        let itr: Box<dyn Iterator<Item = char>> = if self.display_data.initial.bars_on_right {
+            Box::new(self.percent_bar.chars())
+        } else {
+            Box::new(self.percent_bar.chars().rev())
+        };
+
+        for c in itr {
+            num_not_my_bar -= 1;
+            if num_not_my_bar <= 0 {
+                new_bar.push(BLOCKS[0]);
+            } else if c == BLOCKS[0] {
+                new_bar.push(BLOCKS[idx]);
+            } else {
+                new_bar.push(c);
+            }
+        }
+        if self.display_data.initial.bars_on_right {
+            new_bar
+        } else {
+            new_bar.chars().rev().collect()
         }
     }
 }
 
 pub fn draw_it(
-    permissions: bool,
-    use_full_path: bool,
-    is_reversed: bool,
-    no_colors: bool,
-    root_node: Node,
+    idd: InitialDisplayData,
+    no_percent_bars: bool,
+    terminal_width: usize,
+    root_node: &DisplayNode,
+    skip_total: bool,
 ) {
-    if !permissions {
-        eprintln!("Did not have permissions for all directories");
-    }
-    let display_data = DisplayData {
-        short_paths: !use_full_path,
-        is_reversed,
-        colors_on: !no_colors,
+    let biggest = match skip_total {
+        false => root_node,
+        true => root_node
+            .get_children_from_node(false)
+            .next()
+            .unwrap_or(root_node),
     };
 
-    for c in display_data.get_children_from_node(root_node) {
-        let first_tree_chars = display_data.get_first_chars();
-        display_node(c, true, first_tree_chars, &display_data)
+    let num_chars_needed_on_left_most = if idd.by_filecount {
+        let max_size = biggest.size;
+        max_size.separate_with_commas().chars().count()
+    } else {
+        find_biggest_size_str(root_node, &idd.output_format)
+    };
+
+    assert!(
+        terminal_width > num_chars_needed_on_left_most + 2,
+        "Not enough terminal width"
+    );
+
+    let allowed_width = terminal_width - num_chars_needed_on_left_most - 2;
+    let num_indent_chars = 3;
+    let longest_string_length =
+        find_longest_dir_name(root_node, num_indent_chars, allowed_width, &idd);
+
+    let max_bar_length = if no_percent_bars || longest_string_length + 7 >= allowed_width {
+        0
+    } else {
+        allowed_width - longest_string_length - 7
+    };
+
+    let first_size_bar = repeat(BLOCKS[0]).take(max_bar_length).collect();
+
+    let display_data = DisplayData {
+        initial: idd,
+        num_chars_needed_on_left_most,
+        base_size: biggest.size,
+        longest_string_length,
+        ls_colors: LsColors::from_env().unwrap_or_default(),
+    };
+    let draw_data = DrawData {
+        indent: "".to_string(),
+        percent_bar: first_size_bar,
+        display_data: &display_data,
+    };
+
+    if !skip_total {
+        display_node(root_node, &draw_data, true, true);
+    } else {
+        for (count, c) in root_node
+            .get_children_from_node(draw_data.display_data.initial.is_reversed)
+            .enumerate()
+        {
+            let is_biggest = display_data.is_biggest(count, root_node.num_siblings());
+            let was_i_last = display_data.is_last(count, root_node.num_siblings());
+            display_node(c, &draw_data, is_biggest, was_i_last);
+        }
     }
 }
 
-fn display_node(node: Node, is_biggest: bool, indent: &str, display_data: &DisplayData) {
-    let mut num_siblings = node.children.len() as u64;
-    let max_sibling = num_siblings;
-    let new_indent = clean_indentation_string(indent);
-    let name = node.name.clone();
-    let size = node.size;
+fn find_biggest_size_str(node: &DisplayNode, output_format: &str) -> usize {
+    let mut mx = human_readable_number(node.size, output_format)
+        .chars()
+        .count();
+    for n in node.children.iter() {
+        mx = max(mx, find_biggest_size_str(n, output_format));
+    }
+    mx
+}
 
-    if !display_data.is_reversed {
-        print_this_node(&*name, size, is_biggest, display_data, indent);
+fn find_longest_dir_name(
+    node: &DisplayNode,
+    indent: usize,
+    terminal: usize,
+    idd: &InitialDisplayData,
+) -> usize {
+    let printable_name = get_printable_name(&node.name, idd.short_paths);
+
+    let longest = if idd.is_screen_reader {
+        UnicodeWidthStr::width(&*printable_name) + 1
+    } else {
+        min(
+            UnicodeWidthStr::width(&*printable_name) + 1 + indent,
+            terminal,
+        )
+    };
+
+    // each none root tree drawing is 2 more chars, hence we increment indent by 2
+    node.children
+        .iter()
+        .map(|c| find_longest_dir_name(c, indent + 2, terminal, idd))
+        .fold(longest, max)
+}
+
+fn display_node(node: &DisplayNode, draw_data: &DrawData, is_biggest: bool, is_last: bool) {
+    // hacky way of working out how deep we are in the tree
+    let indent = draw_data.get_new_indent(!node.children.is_empty(), is_last);
+    let level = ((indent.chars().count() - 1) / 2) - 1;
+    let bar_text = draw_data.generate_bar(node, level);
+
+    let to_print = format_string(node, &indent, &bar_text, is_biggest, draw_data.display_data);
+
+    if !draw_data.display_data.initial.is_reversed {
+        println!("{to_print}")
     }
 
-    for c in display_data.get_children_from_node(node) {
-        num_siblings -= 1;
-        let chars = display_data.get_tree_chars(num_siblings, max_sibling, !c.children.is_empty());
-        let is_biggest = display_data.is_biggest(num_siblings, max_sibling);
-        let full_indent = new_indent.clone() + chars;
-        display_node(c, is_biggest, &*full_indent, display_data)
+    let dd = DrawData {
+        indent: clean_indentation_string(&indent),
+        percent_bar: bar_text,
+        display_data: draw_data.display_data,
+    };
+
+    let num_siblings = node.num_siblings();
+
+    for (count, c) in node
+        .get_children_from_node(draw_data.display_data.initial.is_reversed)
+        .enumerate()
+    {
+        let is_biggest = dd.display_data.is_biggest(count, num_siblings);
+        let was_i_last = dd.display_data.is_last(count, num_siblings);
+        display_node(c, &dd, is_biggest, was_i_last);
     }
 
-    if display_data.is_reversed {
-        print_this_node(&*name, size, is_biggest, display_data, indent);
+    if draw_data.display_data.initial.is_reversed {
+        println!("{to_print}")
     }
 }
 
@@ -136,78 +275,349 @@ fn clean_indentation_string(s: &str) -> String {
     is
 }
 
-fn print_this_node(
-    name: &str,
-    size: u64,
-    is_biggest: bool,
-    display_data: &DisplayData,
-    indentation: &str,
-) {
-    let pretty_size = format!("{:>5}", human_readable_number(size),);
-    println!(
-        "{}",
-        format_string(name, is_biggest, display_data, &*pretty_size, indentation)
-    )
-}
-
-pub fn format_string(
-    dir_name: &str,
-    is_biggest: bool,
-    display_data: &DisplayData,
-    size: &str,
-    indentation: &str,
-) -> String {
+fn get_printable_name<P: AsRef<Path>>(dir_name: &P, short_paths: bool) -> String {
+    let dir_name = dir_name.as_ref();
     let printable_name = {
-        if display_data.short_paths {
-            dir_name
-                .split(std::path::is_separator)
-                .last()
-                .unwrap_or(dir_name)
+        if short_paths {
+            match dir_name.parent() {
+                Some(prefix) => match dir_name.strip_prefix(prefix) {
+                    Ok(base) => base,
+                    Err(_) => dir_name,
+                },
+                None => dir_name,
+            }
         } else {
             dir_name
         }
     };
-    format!(
-        "{} {} {}",
-        if is_biggest && display_data.colors_on {
-            Fixed(196).paint(size)
-        } else {
-            Style::new().paint(size)
-        },
-        indentation,
-        printable_name,
-    )
+    encode_u8(printable_name.display().to_string().as_bytes())
 }
 
-fn human_readable_number(size: u64) -> String {
+fn pad_or_trim_filename(node: &DisplayNode, indent: &str, display_data: &DisplayData) -> String {
+    let name = get_printable_name(&node.name, display_data.initial.short_paths);
+    let indent_and_name = format!("{indent} {name}");
+    let width = UnicodeWidthStr::width(&*indent_and_name);
+
+    assert!(
+        display_data.longest_string_length >= width,
+        "Terminal width not wide enough to draw directory tree"
+    );
+
+    // Add spaces after the filename so we can draw the % used bar chart.
+    let name_and_padding = name
+        + " "
+            .repeat(display_data.longest_string_length - width)
+            .as_str();
+
+    name_and_padding
+}
+
+fn maybe_trim_filename(name_in: String, indent: &str, display_data: &DisplayData) -> String {
+    let indent_length = UnicodeWidthStr::width(indent);
+    assert!(
+        display_data.longest_string_length >= indent_length + 2,
+        "Terminal width not wide enough to draw directory tree"
+    );
+
+    let max_size = display_data.longest_string_length - indent_length;
+    if UnicodeWidthStr::width(&*name_in) > max_size {
+        let name = name_in.chars().take(max_size - 2).collect::<String>();
+        name + ".."
+    } else {
+        name_in
+    }
+}
+
+pub fn format_string(
+    node: &DisplayNode,
+    indent: &str,
+    bars: &str,
+    is_biggest: bool,
+    display_data: &DisplayData,
+) -> String {
+    let (percent, name_and_padding) = get_name_percent(node, indent, bars, display_data);
+    let pretty_size = get_pretty_size(node, is_biggest, display_data);
+    let pretty_name = get_pretty_name(node, name_and_padding, display_data);
+    // we can clean this and the method below somehow, not sure yet
+    if display_data.initial.is_screen_reader {
+        // if screen_reader then bars is 'depth'
+        format!("{pretty_name} {bars} {pretty_size}{percent}")
+    } else {
+        format!("{pretty_size} {indent} {pretty_name}{percent}")
+    }
+}
+
+fn get_name_percent(
+    node: &DisplayNode,
+    indent: &str,
+    bar_chart: &str,
+    display_data: &DisplayData,
+) -> (String, String) {
+    if display_data.initial.is_screen_reader {
+        let percent = display_data.percent_size(node) * 100.0;
+        let percent_size_str = format!("{percent:.0}%");
+        let percents = format!(" {percent_size_str:>4}",);
+        let name = pad_or_trim_filename(node, "", display_data);
+        (percents, name)
+    // Bar chart being empty may come from either config or the screen not being wide enough
+    } else if !bar_chart.is_empty() {
+        let percent = display_data.percent_size(node) * 100.0;
+        let percent_size_str = format!("{percent:.0}%");
+        let percents = format!("│{bar_chart} │ {percent_size_str:>4}");
+        let name_and_padding = pad_or_trim_filename(node, indent, display_data);
+        (percents, name_and_padding)
+    } else {
+        let n = get_printable_name(&node.name, display_data.initial.short_paths);
+        let name = maybe_trim_filename(n, indent, display_data);
+        ("".into(), name)
+    }
+}
+
+fn get_pretty_size(node: &DisplayNode, is_biggest: bool, display_data: &DisplayData) -> String {
+    let output = if display_data.initial.by_filecount {
+        node.size.separate_with_commas()
+    } else {
+        human_readable_number(node.size, &display_data.initial.output_format)
+    };
+    let spaces_to_add = display_data.num_chars_needed_on_left_most - output.chars().count();
+    let output = " ".repeat(spaces_to_add) + output.as_str();
+
+    if is_biggest && display_data.initial.colors_on {
+        format!("{}", Red.paint(output))
+    } else {
+        output
+    }
+}
+
+fn get_pretty_name(
+    node: &DisplayNode,
+    name_and_padding: String,
+    display_data: &DisplayData,
+) -> String {
+    if display_data.initial.colors_on {
+        let meta_result = fs::metadata(&node.name);
+        let directory_color = display_data
+            .ls_colors
+            .style_for_path_with_metadata(&node.name, meta_result.as_ref().ok());
+        let ansi_style = directory_color
+            .map(Style::to_ansi_term_style)
+            .unwrap_or_default();
+        let out = ansi_style.paint(name_and_padding);
+        format!("{out}")
+    } else {
+        name_and_padding
+    }
+}
+
+// If we are working with SI units or not
+pub fn get_type_of_thousand(output_str: &str) -> u64 {
+    let is_si = output_str.contains('i'); // si, KiB, MiB, etc
+    if is_si {
+        1000
+    } else {
+        1024
+    }
+}
+
+pub fn get_number_format(output_str: &str) -> Option<(u64, char)> {
+    if output_str.starts_with('b') {
+        return Some((1, 'B'));
+    }
     for (i, u) in UNITS.iter().enumerate() {
-        let marker = 1024u64.pow((UNITS.len() - i) as u32);
-        if size >= marker {
-            if size / marker < 10 {
-                return format!("{:.1}{}", (size as f32 / marker as f32), u);
-            } else {
-                return format!("{}{}", (size / marker), u);
-            }
+        if output_str.starts_with((*u).to_ascii_lowercase()) {
+            let marker = get_type_of_thousand(output_str).pow((UNITS.len() - i) as u32);
+            return Some((marker, *u));
+        }
+    }
+    None
+}
+
+pub fn human_readable_number(size: u64, output_str: &str) -> String {
+    match get_number_format(output_str) {
+        Some((x, u)) => {
+            format!("{}{}", (size / x), u)
+        }
+        None => {
+            for (i, u) in UNITS.iter().enumerate() {
+                let marker = get_type_of_thousand(output_str).pow((UNITS.len() - i) as u32);
+                if size >= marker {
+                    if size / marker < 10 {
+                        return format!("{:.1}{}", (size as f32 / marker as f32), u);
+                    } else {
+                        return format!("{}{}", (size / marker), u);
+                    }
+                }
+            }
+            format!("{size}B")
         }
     }
-    return format!("{}B", size);
 }
 
 mod tests {
     #[allow(unused_imports)]
     use super::*;
+    #[allow(unused_imports)]
+    use std::path::PathBuf;
+
+    #[cfg(test)]
+    fn get_fake_display_data(longest_string_length: usize) -> DisplayData {
+        let initial = InitialDisplayData {
+            short_paths: true,
+            is_reversed: false,
+            colors_on: false,
+            by_filecount: false,
+            is_screen_reader: false,
+            output_format: "".into(),
+            bars_on_right: false,
+        };
+        DisplayData {
+            initial,
+            num_chars_needed_on_left_most: 5,
+            base_size: 2_u64.pow(12), // 4.0K
+            longest_string_length,
+            ls_colors: LsColors::from_env().unwrap_or_default(),
+        }
+    }
+
+    #[test]
+    fn test_format_str() {
+        let n = DisplayNode {
+            name: PathBuf::from("/short"),
+            size: 2_u64.pow(12), // This is 4.0K
+            children: vec![],
+        };
+        let indent = "┌─┴";
+        let percent_bar = "";
+        let is_biggest = false;
+        let data = get_fake_display_data(20);
+
+        let s = format_string(&n, indent, percent_bar, is_biggest, &data);
+        assert_eq!(s, " 4.0K ┌─┴ short");
+    }
+
+    #[test]
+    fn test_format_str_long_name() {
+        let name = "very_long_name_longer_than_the_eighty_character_limit_very_long_name_this_bit_will_truncate";
+        let n = DisplayNode {
+            name: PathBuf::from(name),
+            size: 2_u64.pow(12), // This is 4.0K
+            children: vec![],
+        };
+        let indent = "┌─┴";
+        let percent_bar = "";
+        let is_biggest = false;
+
+        let data = get_fake_display_data(64);
+        let s = format_string(&n, indent, percent_bar, is_biggest, &data);
+        assert_eq!(
+            s,
+            " 4.0K ┌─┴ very_long_name_longer_than_the_eighty_character_limit_very_.."
+        );
+    }
+
+    #[test]
+    fn test_format_str_screen_reader() {
+        let n = DisplayNode {
+            name: PathBuf::from("/short"),
+            size: 2_u64.pow(12), // This is 4.0K
+            children: vec![],
+        };
+        let indent = "";
+        let percent_bar = "3";
+        let is_biggest = false;
+        let mut data = get_fake_display_data(20);
+        data.initial.is_screen_reader = true;
+
+        let s = format_string(&n, indent, percent_bar, is_biggest, &data);
+        assert_eq!(s, "short               3  4.0K 100%");
+    }
 
     #[test]
     fn test_human_readable_number() {
-        assert_eq!(human_readable_number(1), "1B");
-        assert_eq!(human_readable_number(956), "956B");
-        assert_eq!(human_readable_number(1004), "1004B");
-        assert_eq!(human_readable_number(1024), "1.0K");
-        assert_eq!(human_readable_number(1536), "1.5K");
-        assert_eq!(human_readable_number(1024 * 512), "512K");
-        assert_eq!(human_readable_number(1024 * 1024), "1.0M");
-        assert_eq!(human_readable_number(1024 * 1024 * 1024 - 1), "1023M");
-        assert_eq!(human_readable_number(1024 * 1024 * 1024 * 20), "20G");
-        assert_eq!(human_readable_number(1024 * 1024 * 1024 * 1024), "1.0T");
+        assert_eq!(human_readable_number(1, ""), "1B");
+        assert_eq!(human_readable_number(956, ""), "956B");
+        assert_eq!(human_readable_number(1004, ""), "1004B");
+        assert_eq!(human_readable_number(1024, ""), "1.0K");
+        assert_eq!(human_readable_number(1536, ""), "1.5K");
+        assert_eq!(human_readable_number(1024 * 512, ""), "512K");
+        assert_eq!(human_readable_number(1024 * 1024, ""), "1.0M");
+        assert_eq!(human_readable_number(1024 * 1024 * 1024 - 1, ""), "1023M");
+        assert_eq!(human_readable_number(1024 * 1024 * 1024 * 20, ""), "20G");
+        assert_eq!(human_readable_number(1024 * 1024 * 1024 * 1024, ""), "1.0T");
+    }
+
+    #[test]
+    fn test_human_readable_number_si() {
+        assert_eq!(human_readable_number(1024 * 100, ""), "100K");
+        assert_eq!(human_readable_number(1024 * 100, "si"), "102K");
+    }
+
+    #[test]
+    fn test_human_readable_number_kb() {
+        let hrn = human_readable_number;
+        assert_eq!(hrn(1023, "b"), "1023B");
+        assert_eq!(hrn(1000 * 1000, "bytes"), "1000000B");
+        assert_eq!(hrn(1023, "kb"), "0K");
+        assert_eq!(hrn(1023, "kib"), "1K");
+        assert_eq!(hrn(1024, "kb"), "1K");
+        assert_eq!(hrn(1024 * 512, "kb"), "512K");
+        assert_eq!(hrn(1024 * 1024, "kb"), "1024K");
+        assert_eq!(hrn(1024 * 1000 * 1000 * 20, "kb"), "20000000K");
+        assert_eq!(hrn(1024 * 1024 * 1000 * 20, "mb"), "20000M");
+        assert_eq!(hrn(1024 * 1024 * 1024 * 20, "gb"), "20G");
+    }
+
+    #[cfg(test)]
+    fn build_draw_data<'a>(disp: &'a DisplayData, size: u32) -> (DrawData<'a>, DisplayNode) {
+        let n = DisplayNode {
+            name: PathBuf::from("/short"),
+            size: 2_u64.pow(size),
+            children: vec![],
+        };
+        let first_size_bar = repeat(BLOCKS[0]).take(13).collect();
+        let dd = DrawData {
+            indent: "".into(),
+            percent_bar: first_size_bar,
+            display_data: disp,
+        };
+        (dd, n)
+    }
+
+    #[test]
+    fn test_draw_data() {
+        let disp = &get_fake_display_data(20);
+        let (dd, n) = build_draw_data(disp, 12);
+        let bar = dd.generate_bar(&n, 1);
+        assert_eq!(bar, "█████████████");
+    }
+
+    #[test]
+    fn test_draw_data2() {
+        let disp = &get_fake_display_data(20);
+        let (dd, n) = build_draw_data(disp, 11);
+        let bar = dd.generate_bar(&n, 2);
+        assert_eq!(bar, "███████░░░░░░");
+    }
+    #[test]
+    fn test_draw_data3() {
+        let mut disp = get_fake_display_data(20);
+        let (dd, n) = build_draw_data(&disp, 11);
+        let bar = dd.generate_bar(&n, 3);
+        assert_eq!(bar, "███████▒▒▒▒▒▒");
+
+        disp.initial.bars_on_right = true;
+        let (dd, n) = build_draw_data(&disp, 11);
+        let bar = dd.generate_bar(&n, 3);
+        assert_eq!(bar, "▒▒▒▒▒▒███████")
+    }
+    #[test]
+    fn test_draw_data4() {
+        let disp = &get_fake_display_data(20);
+        let (dd, n) = build_draw_data(disp, 10);
+        // After 4 we have no more levels of shading so 4+ is the same
+        let bar = dd.generate_bar(&n, 4);
+        assert_eq!(bar, "████▓▓▓▓▓▓▓▓▓");
+        let bar = dd.generate_bar(&n, 5);
+        assert_eq!(bar, "████▓▓▓▓▓▓▓▓▓");
     }
 }

src/display_node.rs

@@ -0,0 +1,25 @@
+use std::path::PathBuf;
+
+#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone)]
+pub struct DisplayNode {
+    // Note: the order of fields in important here, for PartialEq and PartialOrd
+    pub size: u64,
+    pub name: PathBuf,
+    pub children: Vec<DisplayNode>,
+}
+
+impl DisplayNode {
+    pub fn num_siblings(&self) -> u64 {
+        self.children.len() as u64
+    }
+
+    pub fn get_children_from_node(&self, is_reversed: bool) -> impl Iterator<Item = &DisplayNode> {
+        // we box to avoid the clippy lint warning
+        let out: Box<dyn Iterator<Item = &DisplayNode>> = if is_reversed {
+            Box::new(self.children.iter().rev())
+        } else {
+            Box::new(self.children.iter())
+        };
+        out
+    }
+}

src/filter.rs

@@ -0,0 +1,140 @@
+use crate::display_node::DisplayNode;
+use crate::node::Node;
+use std::collections::BinaryHeap;
+use std::collections::HashMap;
+use std::path::Path;
+use std::path::PathBuf;
+
+pub struct AggregateData {
+    pub min_size: Option<usize>,
+    pub only_dir: bool,
+    pub only_file: bool,
+    pub number_of_lines: usize,
+    pub depth: usize,
+    pub using_a_filter: bool,
+}
+
+pub fn get_biggest(top_level_nodes: Vec<Node>, display_data: AggregateData) -> Option<DisplayNode> {
+    if top_level_nodes.is_empty() {
+        // perhaps change this, bring back Error object?
+        return None;
+    }
+    let mut heap = BinaryHeap::new();
+    let number_top_level_nodes = top_level_nodes.len();
+    let root;
+
+    if number_top_level_nodes > 1 {
+        let size = top_level_nodes.iter().map(|node| node.size).sum();
+        root = Node {
+            name: PathBuf::from("(total)"),
+            size,
+            children: top_level_nodes,
+            inode_device: None,
+            depth: 0,
+        };
+        // Always include the base nodes if we add a 'parent' (total) node
+        heap = always_add_children(&display_data, &root, heap);
+    } else {
+        root = top_level_nodes.into_iter().next().unwrap();
+        heap = add_children(&display_data, &root, heap);
+    }
+
+    Some(fill_remaining_lines(heap, &root, display_data))
+}
+
+pub fn fill_remaining_lines<'a>(
+    mut heap: BinaryHeap<&'a Node>,
+    root: &'a Node,
+    display_data: AggregateData,
+) -> DisplayNode {
+    let mut allowed_nodes = HashMap::new();
+
+    while allowed_nodes.len() < display_data.number_of_lines {
+        let line = heap.pop();
+        match line {
+            Some(line) => {
+                if !display_data.only_file || line.children.is_empty() {
+                    allowed_nodes.insert(line.name.as_path(), line);
+                }
+                heap = add_children(&display_data, line, heap);
+            }
+            None => break,
+        }
+    }
+
+    if display_data.only_file {
+        flat_rebuilder(allowed_nodes, root)
+    } else {
+        recursive_rebuilder(&allowed_nodes, root)
+    }
+}
+
+fn add_children<'a>(
+    display_data: &AggregateData,
+    file_or_folder: &'a Node,
+    heap: BinaryHeap<&'a Node>,
+) -> BinaryHeap<&'a Node> {
+    if display_data.depth > file_or_folder.depth {
+        always_add_children(display_data, file_or_folder, heap)
+    } else {
+        heap
+    }
+}
+
+fn always_add_children<'a>(
+    display_data: &AggregateData,
+    file_or_folder: &'a Node,
+    mut heap: BinaryHeap<&'a Node>,
+) -> BinaryHeap<&'a Node> {
+    heap.extend(
+        file_or_folder
+            .children
+            .iter()
+            .filter(|c| match display_data.min_size {
+                Some(ms) => c.size > ms as u64,
+                None => !display_data.using_a_filter || c.name.is_file() || c.size > 0,
+            })
+            .filter(|c| {
+                if display_data.only_dir {
+                    c.name.is_dir()
+                } else {
+                    true
+                }
+            }),
+    );
+    heap
+}
+
+// Finds children of current, if in allowed_nodes adds them as children to new DisplayNode
+fn recursive_rebuilder(allowed_nodes: &HashMap<&Path, &Node>, current: &Node) -> DisplayNode {
+    let new_children: Vec<_> = current
+        .children
+        .iter()
+        .filter(|c| allowed_nodes.contains_key(c.name.as_path()))
+        .map(|c| recursive_rebuilder(allowed_nodes, c))
+        .collect();
+
+    build_node(new_children, current)
+}
+
+// Applies all allowed nodes as children to current node
+fn flat_rebuilder(allowed_nodes: HashMap<&Path, &Node>, current: &Node) -> DisplayNode {
+    let new_children: Vec<DisplayNode> = allowed_nodes
+        .into_values()
+        .map(|v| DisplayNode {
+            name: v.name.clone(),
+            size: v.size,
+            children: vec![],
+        })
+        .collect::<Vec<DisplayNode>>();
+    build_node(new_children, current)
+}
+
+fn build_node(mut new_children: Vec<DisplayNode>, current: &Node) -> DisplayNode {
+    new_children.sort_by(|lhs, rhs| lhs.cmp(rhs).reverse());
+    DisplayNode {
+        name: current.name.clone(),
+        size: current.size,
+        children: new_children,
+    }
+}

src/filter_type.rs

@@ -0,0 +1,75 @@
+use crate::display_node::DisplayNode;
+use crate::node::Node;
+use std::collections::HashMap;
+use std::ffi::OsStr;
+use std::path::PathBuf;
+
+#[derive(PartialEq, Eq, PartialOrd, Ord)]
+struct ExtensionNode<'a> {
+    size: u64,
+    extension: Option<&'a OsStr>,
+}
+
+pub fn get_all_file_types(top_level_nodes: &[Node], n: usize) -> Option<DisplayNode> {
+    let ext_nodes = {
+        let mut extension_cumulative_sizes = HashMap::new();
+        build_by_all_file_types(top_level_nodes, &mut extension_cumulative_sizes);
+
+        let mut extension_cumulative_sizes: Vec<ExtensionNode<'_>> = extension_cumulative_sizes
+            .iter()
+            .map(|(&extension, &size)| ExtensionNode { extension, size })
+            .collect();
+
+        extension_cumulative_sizes.sort_by(|lhs, rhs| lhs.cmp(rhs).reverse());
+
+        extension_cumulative_sizes
+    };
+
+    let mut ext_nodes_iter = ext_nodes.iter();
+
+    // First, collect the first N - 1 nodes...
+    let mut displayed: Vec<DisplayNode> = ext_nodes_iter
+        .by_ref()
+        .take(if n > 1 { n - 1 } else { 1 })
+        .map(|node| DisplayNode {
+            name: PathBuf::from(
+                node.extension
+                    .map(|ext| format!(".{}", ext.to_string_lossy()))
+                    .unwrap_or_else(|| "(no extension)".to_owned()),
+            ),
+            size: node.size,
+            children: vec![],
+        })
+        .collect();
+
+    // ...then, aggregate the remaining nodes (if any) into a single  "(others)" node
+    if ext_nodes_iter.len() > 0 {
+        displayed.push(DisplayNode {
+            name: PathBuf::from("(others)"),
+            size: ext_nodes_iter.map(|node| node.size).sum(),
+            children: vec![],
+        });
+    }
+
+    let result = DisplayNode {
+        name: PathBuf::from("(total)"),
+        size: displayed.iter().map(|node| node.size).sum(),
+        children: displayed,
+    };
+
+    Some(result)
+}
+
+fn build_by_all_file_types<'a>(
+    top_level_nodes: &'a [Node],
+    counter: &mut HashMap<Option<&'a OsStr>, u64>,
+) {
+    for node in top_level_nodes {
+        if node.name.is_file() {
+            let ext = node.name.extension();
+            let cumulative_size = counter.entry(ext).or_default();
+            *cumulative_size += node.size;
+        }
+        build_by_all_file_types(&node.children, counter)
+    }
+}

src/main.rs

@@ -1,201 +1,327 @@
-#[macro_use]
-extern crate clap;
-
-use self::display::draw_it;
-use crate::utils::is_a_parent_of;
-use clap::{App, AppSettings, Arg};
-use utils::{find_big_ones, get_dir_tree, simplify_dir_names, sort, trim_deep_ones, Node};
-
+mod cli;
+mod config;
+mod dir_walker;
 mod display;
+mod display_node;
+mod filter;
+mod filter_type;
+mod node;
+mod platform;
+mod progress;
 mod utils;
 
-static DEFAULT_NUMBER_OF_LINES: usize = 20;
+use crate::cli::build_cli;
+use crate::progress::RuntimeErrors;
+use clap::parser::ValuesRef;
+use dir_walker::WalkData;
+use display::InitialDisplayData;
+use filter::AggregateData;
+use progress::PIndicator;
+use regex::Error;
+use std::collections::HashSet;
+use std::env;
+use std::fs::read_to_string;
+use std::panic;
+use std::process;
+use std::sync::Arc;
+use std::sync::Mutex;
+use sysinfo::{System, SystemExt};
 
-#[cfg(windows)]
-fn init_color() {
-    ansi_term::enable_ansi_support().expect("Couldn't enable color support");
+use self::display::draw_it;
+use config::get_config;
+use dir_walker::walk_it;
+use filter::get_biggest;
+use filter_type::get_all_file_types;
+use regex::Regex;
+use std::cmp::max;
+use std::path::PathBuf;
+use terminal_size::{terminal_size, Height, Width};
+use utils::get_filesystem_devices;
+use utils::simplify_dir_names;
+
+static DEFAULT_NUMBER_OF_LINES: usize = 30;
+static DEFAULT_TERMINAL_WIDTH: usize = 80;
+
+fn should_init_color(no_color: bool, force_color: bool) -> bool {
+    if force_color {
+        return true;
+    }
+    if no_color {
+        return false;
+    }
+    // check if NO_COLOR is set
+    // https://no-color.org/
+    if env::var_os("NO_COLOR").is_some() {
+        return false;
+    }
+    if terminal_size().is_none() {
+        // we are not in a terminal, color may not be needed
+        return false;
+    }
+    // we are in a terminal
+    #[cfg(windows)]
+    {
+        // Required for windows 10
+        // Fails to resolve for windows 8 so disable color
+        match ansi_term::enable_ansi_support() {
+            Ok(_) => true,
+            Err(_) => {
+                eprintln!("This version of Windows does not support ANSI colors");
+                false
+            }
+        }
+    }
+    #[cfg(not(windows))]
+    {
+        true
+    }
 }
 
-#[cfg(not(windows))]
-fn init_color() {}
+fn get_height_of_terminal() -> usize {
+    // Simplify once https://github.com/eminence/terminal-size/pull/41 is
+    // merged
+    terminal_size()
+        // Windows CI runners detect a terminal height of 0
+        .map(|(_, Height(h))| max(h as usize, DEFAULT_NUMBER_OF_LINES))
+        .unwrap_or(DEFAULT_NUMBER_OF_LINES)
+        - 10
+}
+
+fn get_width_of_terminal() -> usize {
+    // Simplify once https://github.com/eminence/terminal-size/pull/41 is
+    // merged
+    terminal_size()
+        .map(|(Width(w), _)| match cfg!(windows) {
+            // Windows CI runners detect a very low terminal width
+            true => max(w as usize, DEFAULT_TERMINAL_WIDTH),
+            false => w as usize,
+        })
+        .unwrap_or(DEFAULT_TERMINAL_WIDTH)
+}
+
+fn get_regex_value(maybe_value: Option<ValuesRef<String>>) -> Vec<Regex> {
+    maybe_value
+        .unwrap_or_default()
+        .map(|reg| {
+            Regex::new(reg).unwrap_or_else(|err| {
+                eprintln!("Ignoring bad value for regex {err:?}");
+                process::exit(1)
+            })
+        })
+        .collect()
+}
 
 fn main() {
-    init_color();
-    let def_num_str = DEFAULT_NUMBER_OF_LINES.to_string();
-    let options = App::new("Dust")
-        .about("Like du but more intuitive")
-        .version(crate_version!())
-        .setting(AppSettings::TrailingVarArg)
-        .arg(
-            Arg::with_name("depth")
-                .short("d")
-                .long("depth")
-                .help("Depth to show")
-                .takes_value(true),
-        )
-        .arg(
-            Arg::with_name("threads")
-                .short("t")
-                .long("threads")
-                .help("Number of threads to spawn simultaneously")
-                .takes_value(true),
-        )
-        .arg(
-            Arg::with_name("number_of_lines")
-                .short("n")
-                .long("number-of-lines")
-                .help("Number of lines of output to show")
-                .takes_value(true)
-                .default_value(def_num_str.as_ref()),
-        )
-        .arg(
-            Arg::with_name("display_full_paths")
-                .short("p")
-                .long("full-paths")
-                .help("If set sub directories will not have their path shortened"),
-        )
-        .arg(
-            Arg::with_name("ignore_directory")
-                .short("X")
-                .long("ignore-directory")
-                .takes_value(true)
-                .number_of_values(1)
-                .multiple(true)
-                .help("Exclude any file or directory with contains this substring."),
-        )
-        .arg(
-            Arg::with_name("limit_filesystem")
-                .short("x")
-                .long("limit-filesystem")
-                .help("Only count the files and directories in the same filesystem as the supplied directory"),
-        )
-        .arg(
-            Arg::with_name("display_apparent_size")
-                .short("s")
-                .long("apparent-size")
-                .help("If set will use file length. Otherwise we use blocks"),
-        )
-        .arg(
-            Arg::with_name("reverse")
-                .short("r")
-                .long("reverse")
-                .help("If applied tree will be printed upside down (biggest lowest)"),
-        )
-        .arg(
-            Arg::with_name("no_colors")
-                .short("c")
-                .long("no_colors")
-                .help("If applied no colors will be printed (normally largest directories are marked in red"),
-        )
-        .arg(Arg::with_name("inputs").multiple(true))
-        .get_matches();
+    let options = build_cli().get_matches();
+    let config = get_config();
 
-    let target_dirs = {
-        match options.values_of("inputs") {
-            None => vec!["."],
-            Some(r) => r.collect(),
+    let errors = RuntimeErrors::default();
+    let error_listen_for_ctrlc = Arc::new(Mutex::new(errors));
+    let errors_for_rayon = error_listen_for_ctrlc.clone();
+    let errors_final = error_listen_for_ctrlc.clone();
+
+    ctrlc::set_handler(move || {
+        error_listen_for_ctrlc.lock().unwrap().abort = true;
+        println!("\nAborting");
+    })
+    .expect("Error setting Ctrl-C handler");
+
+    let target_dirs = match options.get_many::<String>("params") {
+        Some(values) => values.map(|v| v.as_str()).collect::<Vec<&str>>(),
+        None => vec!["."],
+    };
+
+    let summarize_file_types = options.get_flag("types");
+
+    let filter_regexs = get_regex_value(options.get_many("filter"));
+    let invert_filter_regexs = get_regex_value(options.get_many("invert_filter"));
+
+    let terminal_width: usize = match options.get_one::<usize>("width") {
+        Some(&val) => val,
+        None => get_width_of_terminal(),
+    };
+
+    let depth = config.get_depth(&options);
+
+    // If depth is set, then we set the default number_of_lines to be max
+    // instead of screen height
+
+    let number_of_lines = match options.get_one::<usize>("number_of_lines") {
+        Some(&val) => val,
+        None => {
+            if depth != usize::MAX {
+                usize::MAX
+            } else {
+                get_height_of_terminal()
+            }
         }
     };
 
-    let number_of_lines = match value_t!(options.value_of("number_of_lines"), usize) {
-        Ok(v) => v,
-        Err(_) => {
-            eprintln!("Ignoring bad value for number_of_lines");
-            DEFAULT_NUMBER_OF_LINES
+    let is_colors = should_init_color(
+        config.get_no_colors(&options),
+        config.get_force_colors(&options),
+    );
+
+    let ignore_directories = match options.get_many::<String>("ignore_directory") {
+        Some(values) => values
+            .map(|v| v.as_str())
+            .map(PathBuf::from)
+            .collect::<Vec<PathBuf>>(),
+        None => vec![],
+    };
+
+    let ignore_from_file_result = match options.get_one::<String>("ignore_all_in_file") {
+        Some(val) => read_to_string(val)
+            .unwrap()
+            .lines()
+            .map(Regex::new)
+            .collect::<Vec<Result<Regex, Error>>>(),
+        None => vec![],
+    };
+    let ignore_from_file = ignore_from_file_result
+        .into_iter()
+        .filter_map(|x| x.ok())
+        .collect::<Vec<Regex>>();
+
+    let invert_filter_regexs = invert_filter_regexs
+        .into_iter()
+        .chain(ignore_from_file)
+        .collect::<Vec<Regex>>();
+
+    let by_filecount = options.get_flag("by_filecount");
+    let limit_filesystem = options.get_flag("limit_filesystem");
+    let follow_links = options.get_flag("dereference_links");
+
+    let simplified_dirs = simplify_dir_names(target_dirs);
+    let allowed_filesystems = limit_filesystem
+        .then(|| get_filesystem_devices(simplified_dirs.iter()))
+        .unwrap_or_default();
+
+    let ignored_full_path: HashSet<PathBuf> = ignore_directories
+        .into_iter()
+        .flat_map(|x| simplified_dirs.iter().map(move |d| d.join(&x)))
+        .collect();
+
+    let output_format = config.get_output_format(&options);
+
+    let ignore_hidden = config.get_ignore_hidden(&options);
+
+    let mut indicator = PIndicator::build_me();
+    if !config.get_disable_progress(&options) {
+        indicator.spawn(output_format.clone())
+    }
+
+    let walk_data = WalkData {
+        ignore_directories: ignored_full_path,
+        filter_regex: &filter_regexs,
+        invert_filter_regex: &invert_filter_regexs,
+        allowed_filesystems,
+        use_apparent_size: config.get_apparent_size(&options),
+        by_filecount,
+        ignore_hidden,
+        follow_links,
+        progress_data: indicator.data.clone(),
+        errors: errors_for_rayon,
+    };
+    let stack_size = config.get_custom_stack_size(&options);
+    init_rayon(&stack_size);
+
+    let top_level_nodes = walk_it(simplified_dirs, &walk_data);
+
+    let tree = match summarize_file_types {
+        true => get_all_file_types(&top_level_nodes, number_of_lines),
+        false => {
+            let agg_data = AggregateData {
+                min_size: config.get_min_size(&options),
+                only_dir: config.get_only_dir(&options),
+                only_file: config.get_only_file(&options),
+                number_of_lines,
+                depth,
+                using_a_filter: !filter_regexs.is_empty() || !invert_filter_regexs.is_empty(),
+            };
+            get_biggest(top_level_nodes, agg_data)
         }
     };
 
-    let temp_threads = options.value_of("threads").and_then(|threads| {
-        threads
-            .parse::<usize>()
-            .map_err(|_| eprintln!("Ignoring bad value for threads: {:?}", threads))
-            .ok()
-    });
-    // Bug in JWalk
-    // https://github.com/jessegrosjean/jwalk/issues/15
-    // We force it to use 2 threads if there is only 1 cpu
-    // as JWalk breaks if it tries to run on a single cpu
-    let threads = {
-        if temp_threads.is_none() && num_cpus::get() == 1 {
-            Some(2)
-        } else {
-            temp_threads
-        }
-    };
+    // Must have stopped indicator before we print to stderr
+    indicator.stop();
 
-    let depth = options.value_of("depth").and_then(|depth| {
-        depth
-            .parse::<u64>()
-            .map(|v| v + 1)
-            .map_err(|_| eprintln!("Ignoring bad value for depth"))
-            .ok()
-    });
-    if options.is_present("depth") && number_of_lines != DEFAULT_NUMBER_OF_LINES {
-        eprintln!("Use either -n or -d. Not both");
+    if errors_final.lock().unwrap().abort {
         return;
     }
 
-    let use_apparent_size = options.is_present("display_apparent_size");
-    let limit_filesystem = options.is_present("limit_filesystem");
-    let ignore_directories = options.values_of("ignore_directory").map(|r| r.collect());
+    let final_errors = walk_data.errors.lock().unwrap();
+    let failed_permissions = final_errors.no_permissions;
+    if !final_errors.file_not_found.is_empty() {
+        let err = final_errors
+            .file_not_found
+            .iter()
+            .map(|a| a.as_ref())
+            .collect::<Vec<&str>>()
+            .join(", ");
+        eprintln!("No such file or directory: {}", err);
+    }
+    if failed_permissions {
+        eprintln!("Did not have permissions for all directories");
+    }
+    if !final_errors.unknown_error.is_empty() {
+        let err = final_errors
+            .unknown_error
+            .iter()
+            .map(|a| a.as_ref())
+            .collect::<Vec<&str>>()
+            .join(", ");
+        eprintln!("Unknown Error: {}", err);
+    }
 
-    let simplified_dirs = simplify_dir_names(target_dirs);
-    let (permissions, nodes) = get_dir_tree(
-        &simplified_dirs,
-        ignore_directories,
-        use_apparent_size,
-        limit_filesystem,
-        threads,
-    );
-    let sorted_data = sort(nodes);
-    let biggest_ones = {
-        match depth {
-            None => find_big_ones(sorted_data, number_of_lines + simplified_dirs.len()),
-            Some(d) => trim_deep_ones(sorted_data, d, &simplified_dirs),
-        }
-    };
-    let tree = build_tree(biggest_ones, depth);
-
-    draw_it(
-        permissions,
-        options.is_present("display_full_paths"),
-        options.is_present("reverse"),
-        options.is_present("no_colors"),
-        tree,
-    );
-}
-
-fn build_tree(biggest_ones: Vec<(String, u64)>, depth: Option<u64>) -> Node {
-    let mut top_parent = Node::default();
-
-    // assume sorted order
-    for b in biggest_ones {
-        let n = Node {
-            name: b.0,
-            size: b.1,
-            children: Vec::default(),
+    if let Some(root_node) = tree {
+        let idd = InitialDisplayData {
+            short_paths: !config.get_full_paths(&options),
+            is_reversed: !config.get_reverse(&options),
+            colors_on: is_colors,
+            by_filecount,
+            is_screen_reader: config.get_screen_reader(&options),
+            output_format,
+            bars_on_right: config.get_bars_on_right(&options),
         };
-        recursively_build_tree(&mut top_parent, n, depth);
-    }
-    top_parent
-}
-
-fn recursively_build_tree(parent_node: &mut Node, new_node: Node, depth: Option<u64>) {
-    let new_depth = match depth {
-        None => None,
-        Some(0) => return,
-        Some(d) => Some(d - 1),
-    };
-    if let Some(c) = parent_node
-        .children
-        .iter_mut()
-        .find(|c| is_a_parent_of(&c.name, &new_node.name))
-    {
-        recursively_build_tree(c, new_node, new_depth);
-    } else {
-        parent_node.children.push(new_node);
+        draw_it(
+            idd,
+            config.get_no_bars(&options),
+            terminal_width,
+            &root_node,
+            config.get_skip_total(&options),
+        )
     }
 }
 
-#[cfg(test)]
-mod tests;
+fn init_rayon(stack_size: &Option<usize>) {
+    // Rayon seems to raise this error on 32-bit builds
+    // The global thread pool has not been initialized.: ThreadPoolBuildError { kind: GlobalPoolAlreadyInitialized }
+    if cfg!(target_pointer_width = "64") {
+        let result = panic::catch_unwind(|| {
+            match stack_size {
+                Some(n) => rayon::ThreadPoolBuilder::new()
+                    .stack_size(*n)
+                    .build_global(),
+                None => {
+                    let large_stack = usize::pow(1024, 3);
+                    let mut s = System::new();
+                    s.refresh_memory();
+                    let available = s.available_memory();
+
+                    if available > large_stack.try_into().unwrap() {
+                        // Larger stack size to handle cases with lots of nested directories
+                        rayon::ThreadPoolBuilder::new()
+                            .stack_size(large_stack)
+                            .build_global()
+                    } else {
+                        rayon::ThreadPoolBuilder::new().build_global()
+                    }
+                }
+            }
+        });
+        if result.is_err() {
+            eprintln!("Problem initializing rayon, try: export RAYON_NUM_THREADS=1")
+        }
+    }
+}

src/node.rs

@@ -0,0 +1,78 @@
+use crate::platform::get_metadata;
+use crate::utils::is_filtered_out_due_to_invert_regex;
+use crate::utils::is_filtered_out_due_to_regex;
+
+use regex::Regex;
+use std::cmp::Ordering;
+use std::path::PathBuf;
+
+#[derive(Debug, Eq, Clone)]
+pub struct Node {
+    pub name: PathBuf,
+    pub size: u64,
+    pub children: Vec<Node>,
+    pub inode_device: Option<(u64, u64)>,
+    pub depth: usize,
+}
+
+#[allow(clippy::too_many_arguments)]
+pub fn build_node(
+    dir: PathBuf,
+    children: Vec<Node>,
+    filter_regex: &[Regex],
+    invert_filter_regex: &[Regex],
+    use_apparent_size: bool,
+    is_symlink: bool,
+    is_file: bool,
+    by_filecount: bool,
+    depth: usize,
+) -> Option<Node> {
+    get_metadata(&dir, use_apparent_size).map(|data| {
+        let inode_device = if is_symlink && !use_apparent_size {
+            None
+        } else {
+            data.1
+        };
+
+        let size = if is_filtered_out_due_to_regex(filter_regex, &dir)
+            || is_filtered_out_due_to_invert_regex(invert_filter_regex, &dir)
+            || (is_symlink && !use_apparent_size)
+            || by_filecount && !is_file
+        {
+            0
+        } else if by_filecount {
+            1
+        } else {
+            data.0
+        };
+
+        Node {
+            name: dir,
+            size,
+            children,
+            inode_device,
+            depth,
+        }
+    })
+}
+
+impl PartialEq for Node {
+    fn eq(&self, other: &Self) -> bool {
+        self.name == other.name && self.size == other.size && self.children == other.children
+    }
+}
+
+impl Ord for Node {
+    fn cmp(&self, other: &Self) -> Ordering {
+        self.size
+            .cmp(&other.size)
+            .then_with(|| self.name.cmp(&other.name))
+            .then_with(|| self.children.cmp(&other.children))
+    }
+}
+
+impl PartialOrd for Node {
+    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
+        Some(self.cmp(other))
+    }
+}

src/platform.rs

@@ -0,0 +1,152 @@
+#[allow(unused_imports)]
+use std::fs;
+
+use std::path::Path;
+
+#[cfg(target_family = "unix")]
+fn get_block_size() -> u64 {
+    // All os specific implementations of MetadataExt seem to define a block as 512 bytes
+    // https://doc.rust-lang.org/std/os/linux/fs/trait.MetadataExt.html#tymethod.st_blocks
+    512
+}
+
+#[cfg(target_family = "unix")]
+pub fn get_metadata(d: &Path, use_apparent_size: bool) -> Option<(u64, Option<(u64, u64)>)> {
+    use std::os::unix::fs::MetadataExt;
+    match d.metadata() {
+        Ok(md) => {
+            if use_apparent_size {
+                Some((md.len(), Some((md.ino(), md.dev()))))
+            } else {
+                Some((md.blocks() * get_block_size(), Some((md.ino(), md.dev()))))
+            }
+        }
+        Err(_e) => None,
+    }
+}
+
+#[cfg(target_family = "windows")]
+pub fn get_metadata(d: &Path, use_apparent_size: bool) -> Option<(u64, Option<(u64, u64)>)> {
+    // On windows opening the file to get size, file ID and volume can be very
+    // expensive because 1) it causes a few system calls, and more importantly 2) it can cause
+    // windows defender to scan the file.
+    // Therefore we try to avoid doing that for common cases, mainly those of
+    // plain files:
+
+    // The idea is to make do with the file size that we get from the OS for
+    // free as part of iterating a folder. Therefore we want to make sure that
+    // it makes sense to use that free size information:
+
+    // Volume boundaries:
+    // The user can ask us not to cross volume boundaries. If the DirEntry is a
+    // plain file and not a reparse point or other non-trivial stuff, we assume
+    // that the file is located on the same volume as the directory that
+    // contains it.
+
+    // File ID:
+    // This optimization does deprive us of access to a file ID. As a
+    // workaround, we just make one up that hopefully does not collide with real
+    // file IDs.
+    // Hard links: Unresolved. We don't get inode/file index, so hard links
+    // count once for each link. Hopefully they are not too commonly in use on
+    // windows.
+
+    // Size:
+    // We assume (naively?) that for the common cases the free size info is the
+    // same as one would get by doing the expensive thing. Sparse, encrypted and
+    // compressed files are not included in the common cases, as one can image
+    // there being more than view on their size.
+
+    // Savings in orders of magnitude in terms of time, io and cpu have been
+    // observed on hdd, windows 10, some 100Ks files taking up some hundreds of
+    // GBs:
+    // Consistently opening the file: 30 minutes.
+    // With this optimization:         8 sec.
+
+    use std::io;
+    use winapi_util::Handle;
+    fn handle_from_path_limited<P: AsRef<Path>>(path: P) -> io::Result<Handle> {
+        use std::fs::OpenOptions;
+        use std::os::windows::fs::OpenOptionsExt;
+        const FILE_READ_ATTRIBUTES: u32 = 0x0080;
+
+        // So, it seems that it does does have to be that expensive to open
+        // files to get their info: Avoiding opening the file with the full
+        // GENERIC_READ is key:
+
+        // https://docs.microsoft.com/en-us/windows/win32/secauthz/generic-access-rights:
+        // "For example, a Windows file object maps the GENERIC_READ bit to the
+        // READ_CONTROL and SYNCHRONIZE standard access rights and to the
+        // FILE_READ_DATA, FILE_READ_EA, and FILE_READ_ATTRIBUTES
+        // object-specific access rights"
+
+        // The flag FILE_READ_DATA seems to be the expensive one, so we'll avoid
+        // that, and a most of the other ones. Simply because it seems that we
+        // don't need them.
+
+        let file = OpenOptions::new()
+            .access_mode(FILE_READ_ATTRIBUTES)
+            .open(path)?;
+        Ok(Handle::from_file(file))
+    }
+
+    fn get_metadata_expensive(
+        d: &Path,
+        use_apparent_size: bool,
+    ) -> Option<(u64, Option<(u64, u64)>)> {
+        use winapi_util::file::information;
+
+        let h = handle_from_path_limited(d).ok()?;
+        let info = information(&h).ok()?;
+
+        if use_apparent_size {
+            use filesize::PathExt;
+            Some((
+                d.size_on_disk().ok()?,
+                Some((info.file_index(), info.volume_serial_number())),
+            ))
+        } else {
+            Some((
+                info.file_size(),
+                Some((info.file_index(), info.volume_serial_number())),
+            ))
+        }
+    }
+
+    use std::os::windows::fs::MetadataExt;
+    match d.metadata() {
+        Ok(ref md) => {
+            const FILE_ATTRIBUTE_ARCHIVE: u32 = 0x20;
+            const FILE_ATTRIBUTE_READONLY: u32 = 0x01;
+            const FILE_ATTRIBUTE_HIDDEN: u32 = 0x02;
+            const FILE_ATTRIBUTE_SYSTEM: u32 = 0x04;
+            const FILE_ATTRIBUTE_NORMAL: u32 = 0x80;
+            const FILE_ATTRIBUTE_DIRECTORY: u32 = 0x10;
+            const FILE_ATTRIBUTE_SPARSE_FILE: u32 = 0x00000200;
+            const FILE_ATTRIBUTE_PINNED: u32 = 0x00080000;
+            const FILE_ATTRIBUTE_UNPINNED: u32 = 0x00100000;
+            const FILE_ATTRIBUTE_RECALL_ON_OPEN: u32 = 0x00040000;
+            const FILE_ATTRIBUTE_RECALL_ON_DATA_ACCESS: u32 = 0x00400000;
+            const FILE_ATTRIBUTE_OFFLINE: u32 = 0x00001000;
+            // normally FILE_ATTRIBUTE_SPARSE_FILE would be enough, however Windows sometimes likes to mask it out. see: https://stackoverflow.com/q/54560454
+            const IS_PROBABLY_ONEDRIVE: u32 = FILE_ATTRIBUTE_SPARSE_FILE
+                | FILE_ATTRIBUTE_PINNED
+                | FILE_ATTRIBUTE_UNPINNED
+                | FILE_ATTRIBUTE_RECALL_ON_OPEN
+                | FILE_ATTRIBUTE_RECALL_ON_DATA_ACCESS
+                | FILE_ATTRIBUTE_OFFLINE;
+            let attr_filtered = md.file_attributes()
+                & !(FILE_ATTRIBUTE_HIDDEN | FILE_ATTRIBUTE_READONLY | FILE_ATTRIBUTE_SYSTEM);
+            if ((attr_filtered & FILE_ATTRIBUTE_ARCHIVE) != 0
+                || (attr_filtered & FILE_ATTRIBUTE_DIRECTORY) != 0
+                || md.file_attributes() == FILE_ATTRIBUTE_NORMAL)
+                && !((attr_filtered & IS_PROBABLY_ONEDRIVE != 0) && use_apparent_size)
+            {
+                Some((md.len(), None))
+            } else {
+                get_metadata_expensive(d, use_apparent_size)
+            }
+        }
+        _ => get_metadata_expensive(d, use_apparent_size),
+    }
+}

src/progress.rs

@@ -0,0 +1,153 @@
+use std::{
+    collections::HashSet,
+    io::Write,
+    path::Path,
+    sync::{
+        atomic::{AtomicU64, AtomicU8, AtomicUsize, Ordering},
+        mpsc::{self, RecvTimeoutError, Sender},
+        Arc, RwLock,
+    },
+    thread::JoinHandle,
+    time::Duration,
+};
+
+use crate::display::human_readable_number;
+
+/* -------------------------------------------------------------------------- */
+
+pub const ORDERING: Ordering = Ordering::Relaxed;
+
+const SPINNER_SLEEP_TIME: u64 = 100;
+const PROGRESS_CHARS: [char; 4] = ['-', '\\', '|', '/'];
+const PROGRESS_CHARS_LEN: usize = PROGRESS_CHARS.len();
+
+pub trait ThreadSyncTrait<T> {
+    fn set(&self, val: T);
+    fn get(&self) -> T;
+}
+
+#[derive(Default)]
+pub struct ThreadStringWrapper {
+    inner: RwLock<String>,
+}
+
+impl ThreadSyncTrait<String> for ThreadStringWrapper {
+    fn set(&self, val: String) {
+        *self.inner.write().unwrap() = val;
+    }
+
+    fn get(&self) -> String {
+        (*self.inner.read().unwrap()).clone()
+    }
+}
+
+/* -------------------------------------------------------------------------- */
+
+// creating an enum this way allows to have simpler syntax compared to a Mutex or a RwLock
+#[allow(non_snake_case)]
+pub mod Operation {
+    pub const INDEXING: u8 = 0;
+    pub const PREPARING: u8 = 1;
+}
+
+#[derive(Default)]
+pub struct PAtomicInfo {
+    pub num_files: AtomicUsize,
+    pub total_file_size: AtomicU64,
+    pub state: AtomicU8,
+    pub current_path: ThreadStringWrapper,
+}
+
+impl PAtomicInfo {
+    pub fn clear_state(&self, dir: &Path) {
+        self.state.store(Operation::INDEXING, ORDERING);
+        let dir_name = dir.to_string_lossy().to_string();
+        self.current_path.set(dir_name);
+        self.total_file_size.store(0, ORDERING);
+        self.num_files.store(0, ORDERING);
+    }
+}
+
+#[derive(Default)]
+pub struct RuntimeErrors {
+    pub no_permissions: bool,
+    pub file_not_found: HashSet<String>,
+    pub unknown_error: HashSet<String>,
+    pub abort: bool,
+}
+
+/* -------------------------------------------------------------------------- */
+
+fn format_preparing_str(prog_char: char, data: &PAtomicInfo, output_display: &str) -> String {
+    let path_in = data.current_path.get();
+    let size = human_readable_number(data.total_file_size.load(ORDERING), output_display);
+    format!("Preparing: {path_in} {size} ... {prog_char}")
+}
+
+fn format_indexing_str(prog_char: char, data: &PAtomicInfo, output_display: &str) -> String {
+    let path_in = data.current_path.get();
+    let file_count = data.num_files.load(ORDERING);
+    let size = human_readable_number(data.total_file_size.load(ORDERING), output_display);
+    let file_str = format!("{file_count} files, {size}");
+    format!("Indexing: {path_in} {file_str} ... {prog_char}")
+}
+
+pub struct PIndicator {
+    pub thread: Option<(Sender<()>, JoinHandle<()>)>,
+    pub data: Arc<PAtomicInfo>,
+}
+
+impl PIndicator {
+    pub fn build_me() -> Self {
+        Self {
+            thread: None,
+            data: Arc::new(PAtomicInfo {
+                ..Default::default()
+            }),
+        }
+    }
+
+    pub fn spawn(&mut self, output_display: String) {
+        let data = self.data.clone();
+        let (stop_handler, receiver) = mpsc::channel::<()>();
+
+        let time_info_thread = std::thread::spawn(move || {
+            let mut progress_char_i: usize = 0;
+            let mut stdout = std::io::stdout();
+            let mut msg = "".to_string();
+
+            // While the timeout triggers we go round the loop
+            // If we disconnect or the sender sends its message we exit the while loop
+            while let Err(RecvTimeoutError::Timeout) =
+                receiver.recv_timeout(Duration::from_millis(SPINNER_SLEEP_TIME))
+            {
+                // Clear the text written by 'write!'& Return at the start of line
+                print!("\r{:width$}", " ", width = msg.len());
+                let prog_char = PROGRESS_CHARS[progress_char_i];
+
+                msg = match data.state.load(ORDERING) {
+                    Operation::INDEXING => format_indexing_str(prog_char, &data, &output_display),
+                    Operation::PREPARING => format_preparing_str(prog_char, &data, &output_display),
+                    _ => panic!("Unknown State"),
+                };
+
+                write!(stdout, "\r{msg}").unwrap();
+                stdout.flush().unwrap();
+
+                progress_char_i += 1;
+                progress_char_i %= PROGRESS_CHARS_LEN;
+            }
+            print!("\r{:width$}", " ", width = msg.len());
+            print!("\r");
+            stdout.flush().unwrap();
+        });
+        self.thread = Some((stop_handler, time_info_thread))
+    }
+
+    pub fn stop(self) {
+        if let Some((stop_handler, thread)) = self.thread {
+            stop_handler.send(()).unwrap();
+            thread.join().unwrap();
+        }
+    }
+}

src/tests.rs

@@ -1,412 +0,0 @@
-use super::*;
-
-use crate::display::DisplayData;
-use display::format_string;
-use std::fs::File;
-use std::io::Write;
-use std::panic;
-use std::path::PathBuf;
-use std::process::Command;
-use tempfile::Builder;
-use tempfile::TempDir;
-
-// fix! [rivy; 2020-22-01] "windows" result data can vary by host (size seems to be variable by one byte); fix code vs test and re-enable
-#[cfg_attr(target_os = "windows", ignore)]
-#[test]
-pub fn test_main() {
-    assert_cli::Assert::main_binary()
-        .with_args(&["src/test_dir"])
-        .stdout()
-        .is(main_output(true).as_str())
-        .unwrap();
-}
-
-// fix! [rivy; 2020-22-01] "windows" result data can vary by host (size seems to be variable by one byte); fix code vs test and re-enable
-#[cfg_attr(target_os = "windows", ignore)]
-#[test]
-pub fn test_main_long_paths() {
-    assert_cli::Assert::main_binary()
-        .with_args(&["-p", "src/test_dir"])
-        .stdout()
-        .is(main_output(false).as_str())
-        .unwrap();
-}
-
-// fix! [rivy; 2020-22-01] "windows" result data can vary by host (size seems to be variable by one byte); fix code vs test and re-enable
-#[cfg_attr(target_os = "windows", ignore)]
-#[test]
-pub fn test_main_multi_arg() {
-    assert_cli::Assert::main_binary()
-        .with_args(&["src/test_dir/many/", "src/test_dir/", "src/test_dir"])
-        .stdout()
-        .is(main_output(true).as_str())
-        .unwrap();
-}
-
-#[cfg(target_os = "macos")]
-fn main_output(short_paths: bool) -> String {
-    let d = DisplayData {
-        short_paths,
-        is_reversed: false,
-        colors_on: true,
-    };
-    format!(
-        "{}
-{}
-{}
-{}",
-        format_string("src/test_dir", true, &d, " 4.0K", "─┬"),
-        format_string("src/test_dir/many", true, &d, " 4.0K", " └─┬",),
-        format_string("src/test_dir/many/hello_file", true, &d, " 4.0K", "   ├──",),
-        format_string("src/test_dir/many/a_file", false, &d, "   0B", "   └──",),
-    )
-}
-
-#[cfg(target_os = "linux")]
-fn main_output(short_paths: bool) -> String {
-    let d = DisplayData {
-        short_paths,
-        is_reversed: false,
-        colors_on: true,
-    };
-    format!(
-        "{}
-{}
-{}
-{}",
-        format_string("src/test_dir", true, &d, "  12K", "─┬"),
-        format_string("src/test_dir/many", true, &d, " 8.0K", " └─┬",),
-        format_string("src/test_dir/many/hello_file", true, &d, " 4.0K", "   ├──",),
-        format_string("src/test_dir/many/a_file", false, &d, "   0B", "   └──",),
-    )
-}
-
-#[cfg(target_os = "windows")]
-fn main_output(short_paths: bool) -> String {
-    let d = DisplayData {
-        short_paths,
-        is_reversed: false,
-        colors_on: true,
-    };
-    format!(
-        "{}
-{}
-{}
-{}",
-        format_string("src/test_dir", true, &d, "   6B", "─┬"),
-        format_string("src/test_dir\\many", true, &d, "   6B", " └─┬",),
-        format_string(
-            "src/test_dir\\many\\hello_file",
-            true,
-            &d,
-            "   6B",
-            "   ├──",
-        ),
-        format_string("src/test_dir\\many\\a_file", false, &d, "   0B", "   └──",),
-    )
-}
-
-// fix! [rivy; 2020-22-01] "windows" result data can vary by host (size seems to be variable by one byte); fix code vs test and re-enable
-#[cfg_attr(target_os = "windows", ignore)]
-#[test]
-pub fn test_no_color_flag() {
-    assert_cli::Assert::main_binary()
-        .with_args(&["-c", "src/test_dir/"])
-        .stdout()
-        .is(no_color_flag_output().as_str())
-        .unwrap();
-}
-
-#[cfg(target_os = "macos")]
-fn no_color_flag_output() -> String {
-    "
- 4.0K ─┬ test_dir
- 4.0K  └─┬ many
- 4.0K    ├── hello_file
-   0B    └── a_file
-    "
-    .to_string()
-}
-
-#[cfg(target_os = "linux")]
-fn no_color_flag_output() -> String {
-    "
-  12K ─┬ test_dir
- 8.0K  └─┬ many
- 4.0K    ├── hello_file
-   0B    └── a_file
-    "
-    .to_string()
-}
-
-#[cfg(target_os = "windows")]
-fn no_color_flag_output() -> String {
-    "
-   6B ─┬ test_dir
-   6B  └─┬ many
-   6B    ├── hello_file
-   0B    └── a_file
-    "
-    .to_string()
-}
-
-// fix! [rivy; 2020-22-01] "windows" result data can vary by host (size seems to be variable by one byte); fix code vs test and re-enable
-#[cfg_attr(target_os = "windows", ignore)]
-#[test]
-pub fn test_apparent_size() {
-    let d = DisplayData {
-        short_paths: true,
-        is_reversed: false,
-        colors_on: true,
-    };
-    let r = format!(
-        "{}",
-        format_string("src/test_dir/many/hello_file", true, &d, "   6B", "   ├──",),
-    );
-
-    assert_cli::Assert::main_binary()
-        .with_args(&["-s", "src/test_dir"])
-        .stdout()
-        .contains(r.as_str())
-        .unwrap();
-}
-
-#[test]
-pub fn test_reverse_flag() {
-    // variable names the same length make the output easier to read
-    let a = "    ┌── a_file";
-    let b = "    ├── hello_file";
-    let c = "  ┌─┴ many";
-    let d = " ─┴ test_dir";
-
-    assert_cli::Assert::main_binary()
-        .with_args(&["-r", "src/test_dir"])
-        .stdout()
-        .contains(a)
-        .stdout()
-        .contains(b)
-        .stdout()
-        .contains(c)
-        .stdout()
-        .contains(d)
-        .unwrap();
-}
-
-#[test]
-pub fn test_d_flag_works() {
-    // We should see the top level directory but not the sub dirs / files:
-    assert_cli::Assert::main_binary()
-        .with_args(&["-d", "1", "-s", "src/test_dir"])
-        .stdout()
-        .doesnt_contain("hello_file")
-        .unwrap();
-}
-
-fn build_temp_file(dir: &TempDir) -> PathBuf {
-    let file_path = dir.path().join("notes.txt");
-    let mut file = File::create(&file_path).unwrap();
-    writeln!(file, "I am a temp file").unwrap();
-    file_path
-}
-
-// fix! [rivy; 2020-01-22] possible on "windows"?; `ln` is not usually an available command; creation of symbolic links requires special enhanced permissions
-//  ... ref: <https://superuser.com/questions/343074/directory-junction-vs-directory-symbolic-link> @@ <https://archive.is/gpTLE>
-#[cfg_attr(target_os = "windows", ignore)]
-#[test]
-pub fn test_soft_sym_link() {
-    let dir = Builder::new().tempdir().unwrap();
-    let file = build_temp_file(&dir);
-    let dir_s = dir.path().to_str().unwrap();
-    let file_path_s = file.to_str().unwrap();
-
-    let link_name = dir.path().join("the_link");
-    let link_name_s = link_name.to_str().unwrap();
-    let c = Command::new("ln")
-        .arg("-s")
-        .arg(file_path_s)
-        .arg(link_name_s)
-        .output();
-    assert!(c.is_ok());
-
-    let a = format!(" ─┬ {}", dir_s);
-    let b = format!("  ├── {}", file_path_s);
-    let c = format!("  └── {}", link_name_s);
-
-    assert_cli::Assert::main_binary()
-        .with_args(&["-p", &dir_s])
-        .stdout()
-        .contains(a.as_str())
-        .stdout()
-        .contains(b.as_str())
-        .stdout()
-        .contains(c.as_str())
-        .unwrap();
-}
-
-// Hard links are ignored as the inode is the same as the file
-// fix! [rivy; 2020-01-22] may fail on "usual" windows hosts as `ln` is not usually an available command
-#[test]
-pub fn test_hard_sym_link() {
-    let dir = Builder::new().tempdir().unwrap();
-    let file = build_temp_file(&dir);
-    let dir_s = dir.path().to_str().unwrap();
-    let file_path_s = file.to_str().unwrap();
-
-    let link_name = dir.path().join("the_link");
-    let link_name_s = link_name.to_str().unwrap();
-    let c = Command::new("ln")
-        .arg(file_path_s)
-        .arg(link_name_s)
-        .output();
-    assert!(c.is_ok());
-
-    let a = format!(" ─┬ {}", dir_s);
-    let b = format!("  └── {}", link_name_s);
-    let b2 = format!("  └── {}", file_path_s);
-
-    // Because this is a hard link the file and hard link look identical. Therefore
-    // we cannot guarantee which version will appear first.
-    let result = panic::catch_unwind(|| {
-        assert_cli::Assert::main_binary()
-            .with_args(&["-p", dir_s])
-            .stdout()
-            .contains(a.as_str())
-            .stdout()
-            .contains(b.as_str())
-            .unwrap();
-    });
-    if result.is_err() {
-        assert_cli::Assert::main_binary()
-            .with_args(&["-p", dir_s])
-            .stdout()
-            .contains(a.as_str())
-            .stdout()
-            .contains(b2.as_str())
-            .unwrap();
-    }
-}
-
-// Check we don't recurse down an infinite symlink tree
-// fix! [rivy; 2020-01-22] possible on "windows"?; `ln` is not usually an available command; creation of symbolic links requires special enhanced permissions
-//  ... ref: <https://superuser.com/questions/343074/directory-junction-vs-directory-symbolic-link> @@ <https://archive.is/gpTLE>
-#[cfg_attr(target_os = "windows", ignore)]
-#[test]
-pub fn test_recursive_sym_link() {
-    let dir = Builder::new().tempdir().unwrap();
-    let dir_s = dir.path().to_str().unwrap();
-
-    let link_name = dir.path().join("the_link");
-    let link_name_s = link_name.to_str().unwrap();
-
-    let c = Command::new("ln")
-        .arg("-s")
-        .arg(dir_s)
-        .arg(link_name_s)
-        .output();
-    assert!(c.is_ok());
-
-    let a = format!(" ─┬ {}", dir_s);
-    let b = format!("  └── {}", link_name_s);
-
-    assert_cli::Assert::main_binary()
-        .with_args(&["-p", dir_s])
-        .stdout()
-        .contains(a.as_str())
-        .stdout()
-        .contains(b.as_str())
-        .unwrap();
-}
-
-// Check against directories and files whos names are substrings of each other
-// fix! [rivy; 2020-22-01] "windows" result data can vary by host (size seems to be variable by one byte); fix code vs test and re-enable
-#[cfg_attr(target_os = "windows", ignore)]
-#[test]
-pub fn test_substring_of_names() {
-    assert_cli::Assert::main_binary()
-        .with_args(&["-c", "src/test_dir2"])
-        .stdout()
-        .is(no_substring_of_names_output().as_str())
-        .unwrap();
-}
-
-#[cfg(target_os = "linux")]
-fn no_substring_of_names_output() -> String {
-    "
-  24K ─┬ test_dir2
- 8.0K  ├─┬ dir
- 4.0K  │ └── hello
- 8.0K  ├─┬ dir_substring
- 4.0K  │ └── hello
- 4.0K  └── dir_name_clash
-    "
-    .into()
-}
-
-#[cfg(target_os = "macos")]
-fn no_substring_of_names_output() -> String {
-    "
-  12K ─┬ test_dir2
- 4.0K  ├─┬ dir
- 4.0K  │ └── hello
- 4.0K  ├── dir_name_clash
- 4.0K  └─┬ dir_substring
- 4.0K    └── hello
-    "
-    .into()
-}
-
-#[cfg(target_os = "windows")]
-fn no_substring_of_names_output() -> String {
-    "
-  16B ─┬ test_dir2
-   6B  ├─┬ dir_substring
-   6B  │ └── hello
-   5B  ├─┬ dir
-   5B  │ └── hello
-   5B  └── dir_name_clash
-    "
-    .into()
-}
-
-// Check against directories and files whos names are substrings of each other
-#[test]
-pub fn test_ignore_dir() {
-    assert_cli::Assert::main_binary()
-        .with_args(&["-c", "-X", "dir_substring", "src/test_dir2"])
-        .stdout()
-        .is(ignore_dir_output().as_str())
-        .unwrap();
-}
-
-#[cfg(target_os = "linux")]
-fn ignore_dir_output() -> String {
-    "
-  16K ─┬ test_dir2
- 8.0K  ├─┬ dir
- 4.0K  │ └── hello
- 4.0K  └── dir_name_clash
-    "
-    .into()
-}
-
-#[cfg(target_os = "macos")]
-fn ignore_dir_output() -> String {
-    "
- 8.0K ─┬ test_dir2
- 4.0K  ├─┬ dir
- 4.0K  │ └── hello
- 4.0K  └── dir_name_clash
-    "
-    .into()
-}
-
-#[cfg(target_os = "windows")]
-fn ignore_dir_output() -> String {
-    "
-  10B ─┬ test_dir2
-   5B  ├─┬ dir
-   5B  │ └── hello
-   5B  └── dir_name_clash
-    "
-    .into()
-}

src/utils.rs

@@ -0,0 +1,158 @@
+use platform::get_metadata;
+use std::collections::HashSet;
+use std::path::{Path, PathBuf};
+
+use crate::platform;
+use regex::Regex;
+
+pub fn simplify_dir_names<P: AsRef<Path>>(filenames: Vec<P>) -> HashSet<PathBuf> {
+    let mut top_level_names: HashSet<PathBuf> = HashSet::with_capacity(filenames.len());
+
+    for t in filenames {
+        let top_level_name = normalize_path(t);
+        let mut can_add = true;
+        let mut to_remove: Vec<PathBuf> = Vec::new();
+
+        for tt in top_level_names.iter() {
+            if is_a_parent_of(&top_level_name, tt) {
+                to_remove.push(tt.to_path_buf());
+            } else if is_a_parent_of(tt, &top_level_name) {
+                can_add = false;
+            }
+        }
+        for r in to_remove {
+            top_level_names.remove(&r);
+        }
+        if can_add {
+            top_level_names.insert(top_level_name);
+        }
+    }
+
+    top_level_names
+}
+
+pub fn get_filesystem_devices<'a, P: IntoIterator<Item = &'a PathBuf>>(paths: P) -> HashSet<u64> {
+    // Gets the device ids for the filesystems which are used by the argument paths
+    paths
+        .into_iter()
+        .filter_map(|p| match get_metadata(p, false) {
+            Some((_size, Some((_id, dev)))) => Some(dev),
+            _ => None,
+        })
+        .collect()
+}
+
+pub fn normalize_path<P: AsRef<Path>>(path: P) -> PathBuf {
+    // normalize path ...
+    // 1. removing repeated separators
+    // 2. removing interior '.' ("current directory") path segments
+    // 3. removing trailing extra separators and '.' ("current directory") path segments
+    // * `Path.components()` does all the above work; ref: <https://doc.rust-lang.org/std/path/struct.Path.html#method.components>
+    // 4. changing to os preferred separator (automatically done by recollecting components back into a PathBuf)
+    path.as_ref().components().collect()
+}
+
+pub fn is_filtered_out_due_to_regex(filter_regex: &[Regex], dir: &Path) -> bool {
+    if filter_regex.is_empty() {
+        false
+    } else {
+        filter_regex
+            .iter()
+            .all(|f| !f.is_match(&dir.as_os_str().to_string_lossy()))
+    }
+}
+
+pub fn is_filtered_out_due_to_invert_regex(filter_regex: &[Regex], dir: &Path) -> bool {
+    filter_regex
+        .iter()
+        .any(|f| f.is_match(&dir.as_os_str().to_string_lossy()))
+}
+
+fn is_a_parent_of<P: AsRef<Path>>(parent: P, child: P) -> bool {
+    let parent = parent.as_ref();
+    let child = child.as_ref();
+    child.starts_with(parent) && !parent.starts_with(child)
+}
+
+mod tests {
+    #[allow(unused_imports)]
+    use super::*;
+
+    #[test]
+    fn test_simplify_dir() {
+        let mut correct = HashSet::new();
+        correct.insert(PathBuf::from("a"));
+        assert_eq!(simplify_dir_names(vec!["a"]), correct);
+    }
+
+    #[test]
+    fn test_simplify_dir_rm_subdir() {
+        let mut correct = HashSet::new();
+        correct.insert(["a", "b"].iter().collect::<PathBuf>());
+        assert_eq!(simplify_dir_names(vec!["a/b/c", "a/b", "a/b/d/f"]), correct);
+        assert_eq!(simplify_dir_names(vec!["a/b", "a/b/c", "a/b/d/f"]), correct);
+    }
+
+    #[test]
+    fn test_simplify_dir_duplicates() {
+        let mut correct = HashSet::new();
+        correct.insert(["a", "b"].iter().collect::<PathBuf>());
+        correct.insert(PathBuf::from("c"));
+        assert_eq!(
+            simplify_dir_names(vec![
+                "a/b",
+                "a/b//",
+                "a/././b///",
+                "c",
+                "c/",
+                "c/.",
+                "c/././",
+                "c/././."
+            ]),
+            correct
+        );
+    }
+    #[test]
+    fn test_simplify_dir_rm_subdir_and_not_substrings() {
+        let mut correct = HashSet::new();
+        correct.insert(PathBuf::from("b"));
+        correct.insert(["c", "a", "b"].iter().collect::<PathBuf>());
+        correct.insert(["a", "b"].iter().collect::<PathBuf>());
+        assert_eq!(simplify_dir_names(vec!["a/b", "c/a/b/", "b"]), correct);
+    }
+
+    #[test]
+    fn test_simplify_dir_dots() {
+        let mut correct = HashSet::new();
+        correct.insert(PathBuf::from("src"));
+        assert_eq!(simplify_dir_names(vec!["src/."]), correct);
+    }
+
+    #[test]
+    fn test_simplify_dir_substring_names() {
+        let mut correct = HashSet::new();
+        correct.insert(PathBuf::from("src"));
+        correct.insert(PathBuf::from("src_v2"));
+        assert_eq!(simplify_dir_names(vec!["src/", "src_v2"]), correct);
+    }
+
+    #[test]
+    fn test_is_a_parent_of() {
+        assert!(is_a_parent_of("/usr", "/usr/andy"));
+        assert!(is_a_parent_of("/usr", "/usr/andy/i/am/descendant"));
+        assert!(!is_a_parent_of("/usr", "/usr/."));
+        assert!(!is_a_parent_of("/usr", "/usr/"));
+        assert!(!is_a_parent_of("/usr", "/usr"));
+        assert!(!is_a_parent_of("/usr/", "/usr"));
+        assert!(!is_a_parent_of("/usr/andy", "/usr"));
+        assert!(!is_a_parent_of("/usr/andy", "/usr/sibling"));
+        assert!(!is_a_parent_of("/usr/folder", "/usr/folder_not_a_child"));
+    }
+
+    #[test]
+    fn test_is_a_parent_of_root() {
+        assert!(is_a_parent_of("/", "/usr/andy"));
+        assert!(is_a_parent_of("/", "/usr"));
+        assert!(!is_a_parent_of("/", "/"));
+    }
+}

src/utils/mod.rs

@@ -1,363 +0,0 @@
-use jwalk::DirEntry;
-use std::cmp::Ordering;
-use std::collections::HashMap;
-use std::collections::HashSet;
-
-use jwalk::WalkDir;
-
-mod platform;
-use self::platform::*;
-
-#[derive(Debug, Default, Eq)]
-pub struct Node {
-    pub name: String,
-    pub size: u64,
-    pub children: Vec<Node>,
-}
-
-impl Ord for Node {
-    fn cmp(&self, other: &Self) -> Ordering {
-        if self.size == other.size {
-            self.name.cmp(&other.name)
-        } else {
-            self.size.cmp(&other.size)
-        }
-    }
-}
-
-impl PartialOrd for Node {
-    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
-        Some(self.cmp(other))
-    }
-}
-
-impl PartialEq for Node {
-    fn eq(&self, other: &Self) -> bool {
-        self.name == other.name && self.size == other.size && self.children == other.children
-    }
-}
-
-pub fn is_a_parent_of(parent: &str, child: &str) -> bool {
-    let path_parent = std::path::Path::new(parent);
-    let path_child = std::path::Path::new(child);
-    (path_child.starts_with(path_parent) && !path_parent.starts_with(path_child))
-}
-
-pub fn simplify_dir_names(filenames: Vec<&str>) -> HashSet<String> {
-    let mut top_level_names: HashSet<String> = HashSet::with_capacity(filenames.len());
-    let mut to_remove: Vec<String> = Vec::with_capacity(filenames.len());
-
-    for t in filenames {
-        let top_level_name = normalize_path(t);
-        let mut can_add = true;
-
-        for tt in top_level_names.iter() {
-            if is_a_parent_of(&top_level_name, tt) {
-                to_remove.push(tt.to_string());
-            } else if is_a_parent_of(tt, &top_level_name) {
-                can_add = false;
-            }
-        }
-        to_remove.sort_unstable();
-        top_level_names.retain(|tr| to_remove.binary_search(tr).is_err());
-        to_remove.clear();
-        if can_add {
-            top_level_names.insert(normalize_path(t).to_owned());
-        }
-    }
-
-    top_level_names
-}
-
-pub fn get_dir_tree(
-    top_level_names: &HashSet<String>,
-    ignore_directories: Option<Vec<&str>>,
-    apparent_size: bool,
-    limit_filesystem: bool,
-    threads: Option<usize>,
-) -> (bool, HashMap<String, u64>) {
-    let mut permissions = 0;
-    let mut data: HashMap<String, u64> = HashMap::new();
-    let restricted_filesystems = if limit_filesystem {
-        get_allowed_filesystems(top_level_names)
-    } else {
-        None
-    };
-
-    for b in top_level_names.iter() {
-        examine_dir(
-            &b,
-            apparent_size,
-            &restricted_filesystems,
-            &ignore_directories,
-            &mut data,
-            &mut permissions,
-            threads,
-        );
-    }
-    (permissions == 0, data)
-}
-
-fn get_allowed_filesystems(top_level_names: &HashSet<String>) -> Option<HashSet<u64>> {
-    let mut limit_filesystems: HashSet<u64> = HashSet::new();
-    for file_name in top_level_names.iter() {
-        if let Ok(a) = get_filesystem(file_name) {
-            limit_filesystems.insert(a);
-        }
-    }
-    Some(limit_filesystems)
-}
-
-pub fn normalize_path<P: AsRef<std::path::Path>>(path: P) -> std::string::String {
-    // normalize path ...
-    // 1. removing repeated separators
-    // 2. removing interior '.' ("current directory") path segments
-    // 3. removing trailing extra separators and '.' ("current directory") path segments
-    // * `Path.components()` does all the above work; ref: <https://doc.rust-lang.org/std/path/struct.Path.html#method.components>
-    // 4. changing to os preferred separator (automatically done by recollecting components back into a PathBuf)
-    path.as_ref()
-        .components()
-        .collect::<std::path::PathBuf>()
-        .to_string_lossy()
-        .to_string()
-}
-
-fn examine_dir(
-    top_dir: &str,
-    apparent_size: bool,
-    filesystems: &Option<HashSet<u64>>,
-    ignore_directories: &Option<Vec<&str>>,
-    data: &mut HashMap<String, u64>,
-    file_count_no_permission: &mut u64,
-    threads: Option<usize>,
-) {
-    let mut inodes: HashSet<(u64, u64)> = HashSet::new();
-    let mut iter = WalkDir::new(top_dir)
-        .preload_metadata(true)
-        .skip_hidden(false);
-    if let Some(threads_to_start) = threads {
-        iter = iter.num_threads(threads_to_start);
-    }
-    'entry: for entry in iter {
-        if let Ok(e) = entry {
-            let maybe_size_and_inode = get_metadata(&e, apparent_size);
-            if let Some(d) = ignore_directories {
-                for s in d {
-                    if e.path().to_string_lossy().contains(*s) {
-                        continue 'entry;
-                    }
-                }
-            }
-
-            match maybe_size_and_inode {
-                Some((size, maybe_inode)) => {
-                    if !should_ignore_file(apparent_size, filesystems, &mut inodes, maybe_inode) {
-                        process_file_with_size_and_inode(top_dir, data, e, size)
-                    }
-                }
-                None => *file_count_no_permission += 1,
-            }
-        } else {
-            *file_count_no_permission += 1
-        }
-    }
-}
-
-fn should_ignore_file(
-    apparent_size: bool,
-    restricted_filesystems: &Option<HashSet<u64>>,
-    inodes: &mut HashSet<(u64, u64)>,
-    maybe_inode: Option<(u64, u64)>,
-) -> bool {
-    if !apparent_size {
-        if let Some(inode_dev_pair) = maybe_inode {
-            // Ignore files on different devices (if flag applied)
-            if restricted_filesystems.is_some()
-                && !restricted_filesystems
-                    .as_ref()
-                    .unwrap()
-                    .contains(&inode_dev_pair.1)
-            {
-                return true;
-            }
-            // Ignore files already visited or symlinked
-            if inodes.contains(&inode_dev_pair) {
-                return true;
-            }
-            inodes.insert(inode_dev_pair);
-        }
-    }
-    false
-}
-
-fn process_file_with_size_and_inode(
-    top_dir: &str,
-    data: &mut HashMap<String, u64>,
-    e: DirEntry,
-    size: u64,
-) {
-    // This path and all its parent paths have their counter incremented
-    for path_name in e.path().ancestors() {
-        // This is required due to bug in Jwalk that adds '/' to all sub dir lists
-        // see: https://github.com/jessegrosjean/jwalk/issues/13
-        if path_name.to_string_lossy() == "/" && top_dir != "/" {
-            continue;
-        }
-        let path_name = path_name.to_string_lossy();
-        let s = data.entry(path_name.to_string()).or_insert(0);
-        *s += size;
-        if path_name == top_dir {
-            break;
-        }
-    }
-}
-
-pub fn sort_by_size_first_name_second(a: &(String, u64), b: &(String, u64)) -> Ordering {
-    let result = b.1.cmp(&a.1);
-    if result == Ordering::Equal {
-        a.0.cmp(&b.0)
-    } else {
-        result
-    }
-}
-
-pub fn sort(data: HashMap<String, u64>) -> Vec<(String, u64)> {
-    let mut new_l: Vec<(String, u64)> = data.iter().map(|(a, b)| (a.clone(), *b)).collect();
-    new_l.sort_unstable_by(sort_by_size_first_name_second);
-    new_l
-}
-
-pub fn find_big_ones(new_l: Vec<(String, u64)>, max_to_show: usize) -> Vec<(String, u64)> {
-    if max_to_show > 0 && new_l.len() > max_to_show {
-        new_l[0..max_to_show].to_vec()
-    } else {
-        new_l
-    }
-}
-
-pub fn trim_deep_ones(
-    input: Vec<(String, u64)>,
-    max_depth: u64,
-    top_level_names: &HashSet<String>,
-) -> Vec<(String, u64)> {
-    let mut result: Vec<(String, u64)> = Vec::with_capacity(input.len() * top_level_names.len());
-
-    for name in top_level_names {
-        let my_max_depth = name.matches(std::path::is_separator).count() + max_depth as usize;
-        let name_ref: &str = name.as_ref();
-
-        for &(ref k, ref v) in input.iter() {
-            if k.starts_with(name_ref) && k.matches(std::path::is_separator).count() <= my_max_depth
-            {
-                result.push((k.clone(), *v));
-            }
-        }
-    }
-    result
-}
-
-mod tests {
-    #[allow(unused_imports)]
-    use super::*;
-
-    #[test]
-    fn test_simplify_dir() {
-        let mut correct = HashSet::new();
-        correct.insert("a".to_string());
-        assert_eq!(simplify_dir_names(vec!["a"]), correct);
-    }
-
-    #[test]
-    fn test_simplify_dir_rm_subdir() {
-        let mut correct = HashSet::new();
-        correct.insert(
-            ["a", "b"]
-                .iter()
-                .collect::<std::path::PathBuf>()
-                .to_string_lossy()
-                .to_string(),
-        );
-        assert_eq!(simplify_dir_names(vec!["a/b", "a/b/c", "a/b/d/f"]), correct);
-    }
-
-    #[test]
-    fn test_simplify_dir_duplicates() {
-        let mut correct = HashSet::new();
-        correct.insert(
-            ["a", "b"]
-                .iter()
-                .collect::<std::path::PathBuf>()
-                .to_string_lossy()
-                .to_string(),
-        );
-        correct.insert("c".to_string());
-        assert_eq!(
-            simplify_dir_names(vec![
-                "a/b",
-                "a/b//",
-                "a/././b///",
-                "c",
-                "c/",
-                "c/.",
-                "c/././",
-                "c/././."
-            ]),
-            correct
-        );
-    }
-    #[test]
-    fn test_simplify_dir_rm_subdir_and_not_substrings() {
-        let mut correct = HashSet::new();
-        correct.insert("b".to_string());
-        correct.insert(
-            ["c", "a", "b"]
-                .iter()
-                .collect::<std::path::PathBuf>()
-                .to_string_lossy()
-                .to_string(),
-        );
-        correct.insert(
-            ["a", "b"]
-                .iter()
-                .collect::<std::path::PathBuf>()
-                .to_string_lossy()
-                .to_string(),
-        );
-        assert_eq!(simplify_dir_names(vec!["a/b", "c/a/b/", "b"]), correct);
-    }
-
-    #[test]
-    fn test_simplify_dir_dots() {
-        let mut correct = HashSet::new();
-        correct.insert("src".to_string());
-        assert_eq!(simplify_dir_names(vec!["src/."]), correct);
-    }
-
-    #[test]
-    fn test_simplify_dir_substring_names() {
-        let mut correct = HashSet::new();
-        correct.insert("src".to_string());
-        correct.insert("src_v2".to_string());
-        assert_eq!(simplify_dir_names(vec!["src/", "src_v2"]), correct);
-    }
-
-    #[test]
-    fn test_is_a_parent_of() {
-        assert!(is_a_parent_of("/usr", "/usr/andy"));
-        assert!(is_a_parent_of("/usr", "/usr/andy/i/am/descendant"));
-        assert!(!is_a_parent_of("/usr", "/usr/."));
-        assert!(!is_a_parent_of("/usr", "/usr/"));
-        assert!(!is_a_parent_of("/usr", "/usr"));
-        assert!(!is_a_parent_of("/usr/", "/usr"));
-        assert!(!is_a_parent_of("/usr/andy", "/usr"));
-        assert!(!is_a_parent_of("/usr/andy", "/usr/sibling"));
-        assert!(!is_a_parent_of("/usr/folder", "/usr/folder_not_a_child"));
-    }
-
-    #[test]
-    fn test_is_a_parent_of_root() {
-        assert!(is_a_parent_of("/", "/usr/andy"));
-        assert!(is_a_parent_of("/", "/usr"));
-        assert!(!is_a_parent_of("/", "/"));
-    }
-}

src/utils/platform.rs

@@ -1,65 +0,0 @@
-use jwalk::DirEntry;
-#[allow(unused_imports)]
-use std::fs;
-use std::io;
-
-#[cfg(target_family = "unix")]
-fn get_block_size() -> u64 {
-    // All os specific implementations of MetatdataExt seem to define a block as 512 bytes
-    // https://doc.rust-lang.org/std/os/linux/fs/trait.MetadataExt.html#tymethod.st_blocks
-    512
-}
-
-#[cfg(target_family = "unix")]
-pub fn get_metadata(d: &DirEntry, use_apparent_size: bool) -> Option<(u64, Option<(u64, u64)>)> {
-    use std::os::unix::fs::MetadataExt;
-    d.metadata.as_ref().unwrap().as_ref().ok().map(|md| {
-        let inode = Some((md.ino(), md.dev()));
-        if use_apparent_size {
-            (md.len(), inode)
-        } else {
-            (md.blocks() * get_block_size(), inode)
-        }
-    })
-}
-
-#[cfg(target_family = "windows")]
-pub fn get_metadata(d: &DirEntry, _use_apparent_size: bool) -> Option<(u64, Option<(u64, u64)>)> {
-    use winapi_util::file::information;
-    use winapi_util::Handle;
-
-    let h = Handle::from_path_any(d.path()).ok()?;
-    let info = information(&h).ok()?;
-
-    Some((
-        info.file_size(),
-        Some((info.file_index(), info.volume_serial_number())),
-    ))
-}
-
-#[cfg(all(not(target_family = "windows"), not(target_family = "unix")))]
-pub fn get_metadata(d: &DirEntry, _apparent: bool) -> Option<(u64, Option<(u64, u64)>)> {
-    d.metadata
-        .as_ref()
-        .unwrap()
-        .as_ref()
-        .ok()
-        .map(|md| (md.len(), None))
-}
-
-#[cfg(target_family = "unix")]
-pub fn get_filesystem(file_path: &str) -> Result<u64, io::Error> {
-    use std::os::unix::fs::MetadataExt;
-    let metadata = fs::metadata(file_path)?;
-    Ok(metadata.dev())
-}
-
-#[cfg(target_family = "windows")]
-pub fn get_filesystem(file_path: &str) -> Result<u64, io::Error> {
-    use winapi_util::file::information;
-    use winapi_util::Handle;
-
-    let h = Handle::from_path_any(file_path)?;
-    let info = information(&h)?;
-    Ok(info.volume_serial_number())
-}

tests/test_dir_hidden_entries/.hidden_file

@@ -0,0 +1,2 @@
+something
+.secret

tests/test_exact_output.rs

@@ -0,0 +1,224 @@
+use assert_cmd::Command;
+use std::ffi::OsStr;
+use std::str;
+use std::sync::Once;
+
+static INIT: Once = Once::new();
+
+/**
+ * This file contains tests that verify the exact output of the command.
+ * This output differs on Linux / Mac so the tests are harder to write and debug
+ * Windows is ignored here because the results vary by host making exact testing impractical
+ *
+ * Despite the above problems, these tests are good as they are the closest to 'the real thing'.
+ */
+
+//  Warning: File sizes differ on both platform and on the format of the disk.
+/// Copy to /tmp dir - we assume that the formatting of the /tmp partition
+/// is consistent. If the tests fail your /tmp filesystem probably differs
+fn copy_test_data(dir: &str) {
+    // First remove the existing directory - just in case it is there and has incorrect data
+    let last_slash = dir.rfind('/').unwrap();
+    let last_part_of_dir = dir.chars().skip(last_slash).collect::<String>();
+    let _ = Command::new("rm")
+        .arg("-rf")
+        .arg("/tmp/".to_owned() + &*last_part_of_dir)
+        .ok();
+
+    let _ = Command::new("cp")
+        .arg("-r")
+        .arg(dir)
+        .arg("/tmp/")
+        .ok()
+        .map_err(|err| eprintln!("Error copying directory for test setup\n{:?}", err));
+}
+
+fn initialize() {
+    INIT.call_once(|| {
+        copy_test_data("tests/test_dir");
+        copy_test_data("tests/test_dir2");
+        copy_test_data("tests/test_dir_unicode");
+    });
+}
+
+fn exact_output_test<T: AsRef<OsStr>>(valid_outputs: Vec<String>, command_args: Vec<T>) {
+    initialize();
+
+    let mut a = &mut Command::cargo_bin("dust").unwrap();
+
+    for p in command_args {
+        a = a.arg(p);
+    }
+
+    let output = str::from_utf8(&a.unwrap().stdout).unwrap().to_owned();
+
+    let will_fail = valid_outputs.iter().any(|i| output.contains(i));
+    if !will_fail {
+        eprintln!(
+            "output:\n{}\ndoes not contain any of:\n{}",
+            output,
+            valid_outputs.join("\n\n")
+        );
+    }
+    assert!(will_fail)
+}
+
+// "windows" result data can vary by host (size seems to be variable by one byte); fix code vs test and re-enable
+#[cfg_attr(target_os = "windows", ignore)]
+#[test]
+pub fn test_main_basic() {
+    // -c is no color mode - This makes testing much simpler
+    exact_output_test(main_output(), vec!["-c", "-B", "/tmp/test_dir/"])
+}
+
+#[cfg_attr(target_os = "windows", ignore)]
+#[test]
+pub fn test_main_multi_arg() {
+    let command_args = vec![
+        "-c",
+        "-B",
+        "/tmp/test_dir/many/",
+        "/tmp/test_dir",
+        "/tmp/test_dir",
+    ];
+    exact_output_test(main_output(), command_args);
+}
+
+fn main_output() -> Vec<String> {
+    // Some linux currently thought to be Manjaro, Arch
+    // Although probably depends on how drive is formatted
+    let mac_and_some_linux = r#"
+  0B     ┌── a_file    │░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░█ │   0%
+4.0K     ├── hello_file│█████████████████████████████████████████████████ │ 100%
+4.0K   ┌─┴ many        │█████████████████████████████████████████████████ │ 100%
+4.0K ┌─┴ test_dir      │█████████████████████████████████████████████████ │ 100%
+"#
+    .trim()
+    .to_string();
+
+    let ubuntu = r#"
+  0B     ┌── a_file    │                ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░█ │   0%
+4.0K     ├── hello_file│                ░░░░░░░░░░░░░░░░█████████████████ │  33%
+8.0K   ┌─┴ many        │                █████████████████████████████████ │  67%
+ 12K ┌─┴ test_dir      │█████████████████████████████████████████████████ │ 100%
+  "#
+    .trim()
+    .to_string();
+
+    vec![mac_and_some_linux, ubuntu]
+}
+
+#[cfg_attr(target_os = "windows", ignore)]
+#[test]
+pub fn test_main_long_paths() {
+    let command_args = vec!["-c", "-p", "-B", "/tmp/test_dir/"];
+    exact_output_test(main_output_long_paths(), command_args);
+}
+
+fn main_output_long_paths() -> Vec<String> {
+    let mac_and_some_linux = r#"
+  0B     ┌── /tmp/test_dir/many/a_file    │░░░░░░░░░░░░░░░░░░░░░░░░░░░░░█ │   0%
+4.0K     ├── /tmp/test_dir/many/hello_file│██████████████████████████████ │ 100%
+4.0K   ┌─┴ /tmp/test_dir/many             │██████████████████████████████ │ 100%
+4.0K ┌─┴ /tmp/test_dir                    │██████████████████████████████ │ 100%
+"#
+    .trim()
+    .to_string();
+    let ubuntu = r#"
+  0B     ┌── /tmp/test_dir/many/a_file    │         ░░░░░░░░░░░░░░░░░░░░█ │   0%
+4.0K     ├── /tmp/test_dir/many/hello_file│         ░░░░░░░░░░███████████ │  33%
+8.0K   ┌─┴ /tmp/test_dir/many             │         █████████████████████ │  67%
+ 12K ┌─┴ /tmp/test_dir                    │██████████████████████████████ │ 100%
+"#
+    .trim()
+    .to_string();
+    vec![mac_and_some_linux, ubuntu]
+}
+
+// Check against directories and files whose names are substrings of each other
+#[cfg_attr(target_os = "windows", ignore)]
+#[test]
+pub fn test_substring_of_names_and_long_names() {
+    let command_args = vec!["-c", "-B", "/tmp/test_dir2"];
+    exact_output_test(no_substring_of_names_output(), command_args);
+}
+
+fn no_substring_of_names_output() -> Vec<String> {
+    let ubuntu = "
+  0B   ┌── long_dir_name_what_a_very_long_dir_name_what_happens_when_this_goes..
+4.0K   ├── dir_name_clash
+4.0K   │ ┌── hello
+8.0K   ├─┴ dir
+4.0K   │ ┌── hello
+8.0K   ├─┴ dir_substring
+ 24K ┌─┴ test_dir2
+    "
+    .trim()
+    .into();
+
+    let mac_and_some_linux = "
+  0B   ┌── long_dir_name_what_a_very_long_dir_name_what_happens_when_this_goes..
+4.0K   │ ┌── hello
+4.0K   ├─┴ dir
+4.0K   ├── dir_name_clash
+4.0K   │ ┌── hello
+4.0K   ├─┴ dir_substring
+ 12K ┌─┴ test_dir2
+  "
+    .trim()
+    .into();
+    vec![mac_and_some_linux, ubuntu]
+}
+
+#[cfg_attr(target_os = "windows", ignore)]
+#[test]
+pub fn test_unicode_directories() {
+    let command_args = vec!["-c", "-B", "/tmp/test_dir_unicode"];
+    exact_output_test(unicode_dir(), command_args);
+}
+
+fn unicode_dir() -> Vec<String> {
+    // The way unicode & asian characters are rendered on the terminal should make this line up
+    let ubuntu = "
+  0B   ┌── ラウトは難しいです！.japan│                                  █ │   0%
+  0B   ├── 👩.unicode                │                                  █ │   0%
+4.0K ┌─┴ test_dir_unicode            │███████████████████████████████████ │ 100%
+    "
+    .trim()
+    .into();
+
+    let mac_and_some_linux = "
+0B   ┌── ラウトは難しいです！.japan│                                    █ │   0%
+0B   ├── 👩.unicode                │                                    █ │   0%
+0B ┌─┴ test_dir_unicode            │                                    █ │   0%
+    "
+    .trim()
+    .into();
+    vec![mac_and_some_linux, ubuntu]
+}
+
+#[cfg_attr(target_os = "windows", ignore)]
+#[test]
+pub fn test_apparent_size() {
+    let command_args = vec!["-c", "-s", "-b", "/tmp/test_dir"];
+    exact_output_test(apparent_size_output(), command_args);
+}
+
+fn apparent_size_output() -> Vec<String> {
+    // The apparent directory sizes are too unpredictable and system dependent to try and match
+    let one_space_before = r#"
+ 0B     ┌── a_file
+ 6B     ├── hello_file
+ "#
+    .trim()
+    .to_string();
+
+    let two_space_before = r#"
+  0B     ┌── a_file
+  6B     ├── hello_file
+ "#
+    .trim()
+    .to_string();
+
+    vec![one_space_before, two_space_before]
+}

tests/test_flags.rs

@@ -0,0 +1,250 @@
+use assert_cmd::Command;
+use std::ffi::OsStr;
+use std::str;
+
+/**
+ * This file contains tests that test a substring of the output using '.contains'
+ *
+ * These tests should be the same cross platform
+ */
+
+fn build_command<T: AsRef<OsStr>>(command_args: Vec<T>) -> String {
+    let mut cmd = &mut Command::cargo_bin("dust").unwrap();
+    for p in command_args {
+        cmd = cmd.arg(p);
+    }
+    let finished = &cmd.unwrap();
+    let stderr = str::from_utf8(&finished.stderr).unwrap();
+    assert_eq!(stderr, "");
+
+    str::from_utf8(&finished.stdout).unwrap().into()
+}
+
+// We can at least test the file names are there
+#[test]
+pub fn test_basic_output() {
+    let output = build_command(vec!["tests/test_dir/"]);
+
+    assert!(output.contains(" ┌─┴ "));
+    assert!(output.contains("test_dir "));
+    assert!(output.contains("  ┌─┴ "));
+    assert!(output.contains("many "));
+    assert!(output.contains("    ├── "));
+    assert!(output.contains("hello_file"));
+    assert!(output.contains("     ┌── "));
+    assert!(output.contains("a_file "));
+}
+
+#[test]
+pub fn test_output_no_bars_means_no_excess_spaces() {
+    let output = build_command(vec!["-b", "tests/test_dir/"]);
+    // If bars are not being shown we don't need to pad the output with spaces
+    assert!(output.contains("many"));
+    assert!(!output.contains("many    "));
+}
+
+#[test]
+pub fn test_reverse_flag() {
+    let output = build_command(vec!["-r", "-c", "tests/test_dir/"]);
+    assert!(output.contains(" └─┬ test_dir "));
+    assert!(output.contains("  └─┬ many "));
+    assert!(output.contains("    ├── hello_file"));
+    assert!(output.contains("    └── a_file "));
+}
+
+#[test]
+pub fn test_d_flag_works() {
+    // We should see the top level directory but not the sub dirs / files:
+    let output = build_command(vec!["-d", "1", "tests/test_dir/"]);
+    assert!(!output.contains("hello_file"));
+}
+
+#[test]
+pub fn test_d_flag_works_and_still_recurses_down() {
+    // We had a bug where running with '-d 1' would stop at the first directory and the code
+    // would fail to recurse down
+    let output = build_command(vec!["-d", "1", "-f", "-c", "tests/test_dir2/"]);
+    assert!(output.contains("1   ┌── dir"));
+    assert!(output.contains("4 ┌─┴ test_dir2"));
+}
+
+// Check against directories and files whose names are substrings of each other
+#[test]
+pub fn test_ignore_dir() {
+    let output = build_command(vec!["-c", "-X", "dir_substring", "tests/test_dir2/"]);
+    assert!(!output.contains("dir_substring"));
+}
+
+#[test]
+pub fn test_ignore_all_in_file() {
+    let output = build_command(vec![
+        "-c",
+        "-I",
+        "tests/test_dir_hidden_entries/.hidden_file",
+        "tests/test_dir_hidden_entries/",
+    ]);
+    assert!(output.contains(" test_dir_hidden_entries"));
+    assert!(!output.contains(".secret"));
+}
+
+#[test]
+pub fn test_with_bad_param() {
+    let mut cmd = Command::cargo_bin("dust").unwrap();
+    let result = cmd.arg("bad_place").unwrap();
+    let stderr = str::from_utf8(&result.stderr).unwrap();
+    assert!(stderr.contains("No such file or directory"));
+}
+
+#[test]
+pub fn test_hidden_flag() {
+    // Check we can see the hidden file normally
+    let output = build_command(vec!["-c", "tests/test_dir_hidden_entries/"]);
+    assert!(output.contains(".hidden_file"));
+    assert!(output.contains("┌─┴ test_dir_hidden_entries"));
+
+    // Check that adding the '-h' flag causes us to not see hidden files
+    let output = build_command(vec!["-c", "-i", "tests/test_dir_hidden_entries/"]);
+    assert!(!output.contains(".hidden_file"));
+    assert!(output.contains("┌── test_dir_hidden_entries"));
+}
+
+#[test]
+pub fn test_number_of_files() {
+    // Check we can see the hidden file normally
+    let output = build_command(vec!["-c", "-f", "tests/test_dir"]);
+    assert!(output.contains("1     ┌── a_file "));
+    assert!(output.contains("1     ├── hello_file"));
+    assert!(output.contains("2   ┌─┴ many"));
+    assert!(output.contains("2 ┌─┴ test_dir"));
+}
+
+#[test]
+pub fn test_show_files_by_type() {
+    // Check we can list files by type
+    let output = build_command(vec!["-c", "-t", "tests"]);
+    assert!(output.contains(" .unicode"));
+    assert!(output.contains(" .japan"));
+    assert!(output.contains(" .rs"));
+    assert!(output.contains(" (no extension)"));
+    assert!(output.contains("┌─┴ (total)"));
+}
+
+#[test]
+#[cfg(target_family = "unix")]
+pub fn test_show_files_only() {
+    let output = build_command(vec!["-c", "-F", "tests/test_dir"]);
+    assert!(output.contains("tests/test_dir/many/a_file"));
+    assert!(output.contains("tests/test_dir/many/hello_file"));
+    assert!(!output.contains("tests/test_dir/many "));
+}
+
+#[test]
+pub fn test_output_skip_total() {
+    let output = build_command(vec![
+        "--skip-total",
+        "tests/test_dir/many/hello_file",
+        "tests/test_dir/many/a_file",
+    ]);
+    assert!(output.contains("hello_file"));
+    assert!(!output.contains("(total)"));
+}
+
+#[test]
+pub fn test_output_screen_reader() {
+    let output = build_command(vec!["--screen-reader", "-c", "tests/test_dir/"]);
+    println!("{}", output);
+    assert!(output.contains("test_dir   0"));
+    assert!(output.contains("many       1"));
+    assert!(output.contains("hello_file 2"));
+    assert!(output.contains("a_file     2"));
+
+    // Verify no 'symbols' reported by screen reader
+    assert!(!output.contains('│'));
+
+    for block in ['█', '▓', '▒', '░'] {
+        assert!(!output.contains(block));
+    }
+}
+
+#[test]
+pub fn test_show_files_by_regex_match_lots() {
+    // Check we can see '.rs' files in the tests directory
+    let output = build_command(vec!["-c", "-e", "\\.rs$", "tests"]);
+    assert!(output.contains(" ┌─┴ tests"));
+    assert!(!output.contains("0B ┌── tests"));
+    assert!(!output.contains("0B ┌─┴ tests"));
+}
+
+#[test]
+pub fn test_show_files_by_regex_match_nothing() {
+    // Check there are no files named: '.match_nothing' in the tests directory
+    let output = build_command(vec!["-c", "-e", "match_nothing$", "tests"]);
+    assert!(output.contains("0B ┌── tests"));
+}
+
+#[test]
+pub fn test_show_files_by_regex_match_multiple() {
+    let output = build_command(vec![
+        "-c",
+        "-e",
+        "test_dir_hidden",
+        "-e",
+        "test_dir2",
+        "-n",
+        "100",
+        "tests",
+    ]);
+    assert!(output.contains("test_dir2"));
+    assert!(output.contains("test_dir_hidden"));
+    assert!(!output.contains("many")); // We do not find the 'many' folder in the 'test_dir' folder
+}
+
+#[test]
+pub fn test_show_files_by_invert_regex() {
+    let output = build_command(vec!["-c", "-f", "-v", "e", "tests/test_dir2"]);
+    // There are 0 files without 'e' in the name
+    assert!(output.contains("0 ┌── test_dir2"));
+
+    let output = build_command(vec!["-c", "-f", "-v", "a", "tests/test_dir2"]);
+    // There are 2 files without 'a' in the name
+    assert!(output.contains("2 ┌─┴ test_dir2"));
+
+    // There are 4 files in the test_dir2 hierarchy
+    let output = build_command(vec!["-c", "-f", "-v", "match_nothing$", "tests/test_dir2"]);
+    assert!(output.contains("4 ┌─┴ test_dir2"));
+}
+
+#[test]
+pub fn test_show_files_by_invert_regex_match_multiple() {
+    // We ignore test_dir2 & test_dir_unicode, leaving the test_dir folder
+    // which has the 'many' folder inside
+    let output = build_command(vec![
+        "-c",
+        "-v",
+        "test_dir2",
+        "-v",
+        "test_dir_unicode",
+        "-n",
+        "100",
+        "tests",
+    ]);
+    assert!(!output.contains("test_dir2"));
+    assert!(!output.contains("test_dir_unicode"));
+    assert!(output.contains("many"));
+}
+
+#[test]
+pub fn test_no_color() {
+    let output = build_command(vec!["-c"]);
+    // Red is 31
+    assert!(!output.contains("\x1B[31m"));
+    assert!(!output.contains("\x1B[0m"));
+}
+
+#[test]
+pub fn test_force_color() {
+    let output = build_command(vec!["-C"]);
+    // Red is 31
+    assert!(output.contains("\x1B[31m"));
+    assert!(output.contains("\x1B[0m"));
+}

tests/tests.rs

@@ -0,0 +1 @@
+

tests/tests_symlinks.rs

@@ -0,0 +1,141 @@
+use assert_cmd::Command;
+use std::fs::File;
+use std::io::Write;
+use std::path::PathBuf;
+use std::str;
+
+use tempfile::Builder;
+use tempfile::TempDir;
+
+// File sizes differ on both platform and on the format of the disk.
+// Windows: `ln` is not usually an available command; creation of symbolic links requires special enhanced permissions
+
+fn build_temp_file(dir: &TempDir) -> PathBuf {
+    let file_path = dir.path().join("notes.txt");
+    let mut file = File::create(&file_path).unwrap();
+    writeln!(file, "I am a temp file").unwrap();
+    file_path
+}
+
+fn link_it(link_path: PathBuf, file_path_s: &str, is_soft: bool) -> String {
+    let link_name_s = link_path.to_str().unwrap();
+    let mut c = Command::new("ln");
+    if is_soft {
+        c.arg("-s");
+    }
+    c.arg(file_path_s);
+    c.arg(link_name_s);
+    assert!(c.output().is_ok());
+    link_name_s.into()
+}
+
+#[cfg_attr(target_os = "windows", ignore)]
+#[test]
+pub fn test_soft_sym_link() {
+    let dir = Builder::new().tempdir().unwrap();
+    let file = build_temp_file(&dir);
+    let dir_s = dir.path().to_str().unwrap();
+    let file_path_s = file.to_str().unwrap();
+
+    let link_name = dir.path().join("the_link");
+    let link_name_s = link_it(link_name, file_path_s, true);
+
+    let c = format!(" ├── {}", link_name_s);
+    let b = format!(" ┌── {}", file_path_s);
+    let a = format!("─┴ {}", dir_s);
+
+    let mut cmd = Command::cargo_bin("dust").unwrap();
+    // Mac test runners create long filenames in tmp directories
+    let output = cmd
+        .args(["-p", "-c", "-s", "-w", "999", dir_s])
+        .unwrap()
+        .stdout;
+
+    let output = str::from_utf8(&output).unwrap();
+
+    assert!(output.contains(a.as_str()));
+    assert!(output.contains(b.as_str()));
+    assert!(output.contains(c.as_str()));
+}
+
+#[cfg_attr(target_os = "windows", ignore)]
+#[test]
+pub fn test_hard_sym_link() {
+    let dir = Builder::new().tempdir().unwrap();
+    let file = build_temp_file(&dir);
+    let dir_s = dir.path().to_str().unwrap();
+    let file_path_s = file.to_str().unwrap();
+
+    let link_name = dir.path().join("the_link");
+    link_it(link_name, file_path_s, false);
+
+    let file_output = format!(" ┌── {}", file_path_s);
+    let dirs_output = format!("─┴ {}", dir_s);
+
+    let mut cmd = Command::cargo_bin("dust").unwrap();
+    // Mac test runners create long filenames in tmp directories
+    let output = cmd.args(["-p", "-c", "-w", "999", dir_s]).unwrap().stdout;
+
+    // The link should not appear in the output because multiple inodes are now ordered
+    // then filtered.
+    let output = str::from_utf8(&output).unwrap();
+    assert!(output.contains(dirs_output.as_str()));
+    assert!(output.contains(file_output.as_str()));
+}
+
+#[cfg_attr(target_os = "windows", ignore)]
+#[test]
+pub fn test_hard_sym_link_no_dup_multi_arg() {
+    let dir = Builder::new().tempdir().unwrap();
+    let dir_link = Builder::new().tempdir().unwrap();
+    let file = build_temp_file(&dir);
+    let dir_s = dir.path().to_str().unwrap();
+    let dir_link_s = dir_link.path().to_str().unwrap();
+    let file_path_s = file.to_str().unwrap();
+
+    let link_name = dir_link.path().join("the_link");
+    let link_name_s = link_it(link_name, file_path_s, false);
+
+    let mut cmd = Command::cargo_bin("dust").unwrap();
+
+    // Mac test runners create long filenames in tmp directories
+    let output = cmd
+        .args(["-p", "-c", "-w", "999", "-b", dir_link_s, dir_s])
+        .unwrap()
+        .stdout;
+
+    // The link or the file should appear but not both
+    let output = str::from_utf8(&output).unwrap();
+    let has_file_only = output.contains(file_path_s) && !output.contains(&link_name_s);
+    let has_link_only = !output.contains(file_path_s) && output.contains(&link_name_s);
+    assert!(has_file_only || has_link_only);
+}
+
+#[cfg_attr(target_os = "windows", ignore)]
+#[test]
+pub fn test_recursive_sym_link() {
+    let dir = Builder::new().tempdir().unwrap();
+    let dir_s = dir.path().to_str().unwrap();
+
+    let link_name = dir.path().join("the_link");
+    let link_name_s = link_it(link_name, dir_s, true);
+
+    let a = format!("─┬ {}", dir_s);
+    let b = format!(" └── {}", link_name_s);
+
+    let mut cmd = Command::cargo_bin("dust").unwrap();
+    let output = cmd
+        .arg("-p")
+        .arg("-c")
+        .arg("-r")
+        .arg("-s")
+        .arg("-w")
+        .arg("999")
+        .arg(dir_s)
+        .unwrap()
+        .stdout;
+    let output = str::from_utf8(&output).unwrap();
+
+    assert!(output.contains(a.as_str()));
+    assert!(output.contains(b.as_str()));
+}