#cli #pipe #filter #utility

app proximity-sort

Simple command-line utility for sorting inputs by proximity to a path argument

8 stable releases

1.0.7 Aug 3, 2020
1.0.6 May 8, 2020
1.0.4 Feb 13, 2019
1.0.3 Dec 4, 2018
1.0.2 Sep 20, 2018

#121 in Command line utilities

50 downloads per month

MIT/Apache

10KB
229 lines

proximity-sort

Crates.io Build Status

This script provides a simple command-line utility that sorts its inputs by their path proximity to a given path. For example, for a path foo/bar.txt, the following input:

quox.txt
foo/bar.txt
foo/baz.txt

Would yield an output of:

foo/bar.txt
foo/baz.txt
quox.txt

The lines are sorted by the number of leading path components shared between the input path and the provided path.

This program was primarily written to allow context-aware suggestions for fzf (requested in junegunn/fzf.vim#360 and junegunn/fzf.vim#492) without making modifications to fzf itself (see junegunn/fzf#1380).

Installation

If you have Rust installed, you can install this with:

cargo install proximity-sort

Usage

It can be used with fzf by running:

$ fd -t f | proximity-sort path/to/file | fzf --tiebreak=index

And you can add it to your .vimrc with:

function! s:list_cmd()
  let base = fnamemodify(expand('%'), ':h:.:S')
  return base == '.' ? 'fd -t f' : printf('fd -t f | proximity-sort %s', expand('%'))
endfunction

command! -bang -nargs=? -complete=dir Files
  \ call fzf#vim#files(<q-args>, {'source': s:list_cmd(),
  \                               'options': '--tiebreak=index'}, <bang>0)

Paths of the same proximity are sorted alphabetically:

$ echo "banana\napple/pie\napple" | proximity-sort . -s
> apple
> banana
> apple/pie

Dependencies

~770KB
~11K SLoC