replacer.vim

This plugin will help users find and replace terms in a given folder.

• Prerequisites
  • For hacking
• Installation
• Usage
• Commands
• License
• Bugs
• Contributing
  • Documentation
• Changelog

Prerequisites

• A machine with a UNIX-like operating system
• vim (Note, this plugin has only been tested on v8.2)

For hacking

Any changes to the vimdocs will require:

• go
• md2vim (go install github.com/FooSoft/md2vim@latest)

Installation

To install this plugin with Pathogen:

cd $HOME/.vim/bundle/
git clone https://github.com/kohrVid/replacer.vim.git

To install with Vim-Plug, add the following to ~/.vimrc or init.vim and then restart vim:

Plug 'kohrVid/replacer.vim'

Usage

Rename directories:

:RenameDirs "old_directory", "new_directory"
:RenameDirs "old_directory", "new_directory", "./path/to/directory/"

Rename files:

:RenameFiles "old_file", "new_file"
:RenameFiles "old_file", "new_file", "./path/to/file/"

Find and replace terms in a directory:

:FindAndReplace "old_term", "new_term"
:FindAndReplace "old_term", "new_term", "./path/to/file/"

Commands

*:FindAndReplace* [args] FindAndReplace finds instances of the first argument across multiple files and replaces it with the second argument. By default, find and replace is run across all visible files in the current project directory. If needed a different relative file path can be specified as a third argument. To prevent issues with git, the command cannot alter hidden files.

*:RenameDirs* [args] RenameDirs recursively renames directories in a relative path. By default, it renames subdirectories of the current project's location by replacing instances of the first argument with the second argument in the new directory name. If needed, a different path to the directories can be specified as a third argument.

*:RenameFiles* [args] RenameFiles recursively renames files at a relative path. By default, it renames files located in the current directory (and its subdirectories) by replacing instances of the first argument with the second argument in the new file name. If needed, a different path to the file can be specified as a third argument.

License

Copyright © 2021 Jessica Été. Distributed under the MIT license.

Bugs

Please raise an issue if any bugs are spotted whilst using this plugin.

Contributing

Please raise a pull request if you would like to contribute.

Documentation

All changes to the vimdocs must be made in the appropriate section of this README first. Once that is done, the following script must be run to update the vimdocs:

./doc/generate_vimdoc.sh

Changelog