Skip to main content

Edit directory with vim

Project description

VDIR - Edit directory with vim

Heavily inspired by vidir from moreutils and edir.

With a few different design choices:

  • vdir always prompts before applying changes

  • vdir doesn't integrate with git (for not accidentally messing up your staging area)

  • vdir displays an (arguably) pretty-looking preview of the changes

  • vdir pads sequence number to same width for visual block operations

  • vdir references LS_COLORS for coloring

  • vdir supports stage/unstage items dynamically

  • vdir supports stage/unstage items dynamically from shell commands' output

    • Shell commands could be piped
  • vdir supports sorting staged items by several attributes, each of them could be reversed

  • vdir treats symbolic links as files instead of resolving them

  • vdir supports editing symbolic links

Examples (shell)

Edit the current diretory:

sh$ vdir

Manage certain files:

sh$ vdir *.txt

Manage found files:

sh$ fd --type f | vdir

Examples (vim)

A vdir's vim session looks like this:

# ═════════════════════════════════════════════════════════════════════════════
# - Add paths to stage them. Globs are recognized.
# - Add a '#' before id to untrack an item.
# - Add a '+' before id to expand non-hidden items under the directory.
# - Add a '*' before id to expand all items under the directory.
# - Add a '@' before id to resolve the soft link.
# - Stage items by shell command output: (globs are not supported here)
#   $ find . -type f | grep py
# - Sort with:
#   :sort [-][type|isdir|isfile|isfifo|islink|path|basename|name|dirname|size|atime|mtime|ctime|birthtime] ...
# - Setup default vd.vimrc with:
#   $ vdir --vimrc
# ═════════════════════════════════════════════════════════════════════════════

110 ││ LICENSE
120 ││ README.md
131 ││ __pycache__/
140 ││ pyproject.toml
151 ││ vdir/

Paths could be added directly for next round editing.

Shell commands could be used to add paths in batch. Shell commands could be piped, but note that commands are ran one-by-one, i.e. each command's stdout is collected, returncode is checked, and then all pipe to stdin of the next command.

If one command fails (i.e. returncode != 0), the pipeline stops, and stderr is appended in comment.

The inventory could be sorted with :sort command. Several attributes are available, each of them could be prefixed with - for reversing the order.

When you're done, save and quit, and vdir prompts you the changes like this:

[info] Delete:[LICENSE]
[info] Rename:[README.mdd]
Continue? [(Y)es / (n)o / (e)dit / (r)edo] _
  • y to apply and continue with another vim session
  • Empty input to apply and quit
  • n to cancel the edit
  • ctrl+c to cancel the edit if you're scared of the change
  • e to continue editing
  • r to restart with initial contents

Installation

vdir

sh$ pipx install vdir

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vdir-0.3.0.tar.gz (93.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vdir-0.3.0-py3-none-any.whl (116.0 kB view details)

Uploaded Python 3

File details

Details for the file vdir-0.3.0.tar.gz.

File metadata

  • Download URL: vdir-0.3.0.tar.gz
  • Upload date:
  • Size: 93.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Hatch/1.16.5 cpython/3.14.3 HTTPX/0.28.1

File hashes

Hashes for vdir-0.3.0.tar.gz
Algorithm Hash digest
SHA256 dbe248b2a24cdeeaf38794382675598d7bc43e16ad9b805055b8c8b7e74c7f12
MD5 7ffef340e70a971ea4c474a8695fa9cb
BLAKE2b-256 820dc9d1f0e01eafe26aa813eeb9280f8932f6ce01ae4d5ee1e40ceb330992ec

See more details on using hashes here.

File details

Details for the file vdir-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: vdir-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 116.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Hatch/1.16.5 cpython/3.14.3 HTTPX/0.28.1

File hashes

Hashes for vdir-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4d4be74e0c68688692cab3d84b37d01d01a5463409f2eb8d755d4c40ae48baaf
MD5 060226fe432fa16e475ff0b94ef856e6
BLAKE2b-256 9af24690e94b9efe1e2d648391e1075b0a285551e647837139932210ccf8490f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page