diff options
author | Michael Smith <mikesmiffy128@gmail.com> | 2022-05-22 22:47:23 +0100 |
---|---|---|
committer | Michael Smith <mikesmiffy128@gmail.com> | 2022-05-22 22:47:23 +0100 |
commit | 95aea6b533e71e478d61d18fac71cca116c56a4d (patch) | |
tree | 1a1f42f723772258cc54551495826768f374474a /opt/sleuth/README.markdown |
Add all the plugins I currently use
Diffstat (limited to 'opt/sleuth/README.markdown')
-rw-r--r-- | opt/sleuth/README.markdown | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/opt/sleuth/README.markdown b/opt/sleuth/README.markdown new file mode 100644 index 0000000..de4aadf --- /dev/null +++ b/opt/sleuth/README.markdown @@ -0,0 +1,49 @@ +# sleuth.vim + +This plugin automatically adjusts `'shiftwidth'` and `'expandtab'` +heuristically based on the current file, or, in the case the current file is +new, blank, or otherwise insufficient, by looking at other files of the same +type in the current and parent directories. In lieu of adjusting +`'softtabstop'`, `'smarttab'` is enabled. + +Compare to [DetectIndent][]. I wrote this because I wanted something fully +automatic. My goal is that by installing this plugin, you can remove all +indenting related configuration from your vimrc. + +[DetectIndent]: http://www.vim.org/scripts/script.php?script_id=1171 + +## Installation + +Install using your favorite package manager, or use Vim's built-in package +support: + + mkdir -p ~/.vim/pack/tpope/start + cd ~/.vim/pack/tpope/start + git clone https://tpope.io/vim/sleuth.git + vim -u NONE -c "helptags sleuth/doc" -c q + +## Notes + +* Searching for other files of the same type continues up the directory + hierarchy until a match is found. This means, for example, the indent for + the first file in a brand new Ruby project might very well be derived from + your `.irbrc`. I consider this a feature. +* If your file is consistently indented with hard tabs, `'shiftwidth'` will be + set to your `'tabstop'`. Otherwise, a `'tabstop'` of 8 is enforced. +* The algorithm is rolled from scratch, fairly simplistic, and only lightly + battle tested. It's probably not (yet) as good as [DetectIndent][]. + Let me know what it fails on for you. + +## Self-Promotion + +Like sleuth.vim? Follow the repository on +[GitHub](https://github.com/tpope/vim-sleuth) and vote for it on +[vim.org](http://www.vim.org/scripts/script.php?script_id=4375). And if +you're feeling especially charitable, follow [tpope](http://tpo.pe/) on +[Twitter](http://twitter.com/tpope) and +[GitHub](https://github.com/tpope). + +## License + +Copyright © Tim Pope. Distributed under the same terms as Vim itself. +See `:help license`. |