Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lambdalisue/vim-findent
Find and apply a reasonable indent rule of the current buffer.
https://github.com/lambdalisue/vim-findent
Last synced: about 2 months ago
JSON representation
Find and apply a reasonable indent rule of the current buffer.
- Host: GitHub
- URL: https://github.com/lambdalisue/vim-findent
- Owner: lambdalisue
- Created: 2015-11-25T14:10:38.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-02-13T18:19:55.000Z (7 months ago)
- Last Synced: 2024-07-24T01:06:26.588Z (about 2 months ago)
- Language: Vim Script
- Homepage:
- Size: 54.7 KB
- Stars: 22
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
vim-findent [](https://travis-ci.org/lambdalisue/vim-findent) [](https://ci.appveyor.com/project/lambdalisue/vim-findent/branch/master)
===============================================================================
*vim-findent* is a plugin to find and apply reasonable values of `expandtab`, `shiftwidth`, `tabstop`, and `softtabstop` (an indent rule) from the content of the current buffer.
vim-findent is a small and simple Vim plugin, compares to existing similar plugins such as [vim-sleuth](https://github.com/tpope/vim-sleuth) or [detectindent](https://github.com/ciaranm/detectindent).
This plugin only provides two commands and no default `FileType` `autocmd` is provided, mean that users can control the behavior of automatic detection by defining `autocmd` by themselves.
The detection algorithm is much simpler as well compared to vim-sleuth or detectindent.
While we are living in a real world and we are editing pre-formatted codes, I don't really think we need a super perfect but complex algorithm.
A faster and simpler algorithm would be better.
See [Test cases](./test/dat) to figure out what kind of indent rules can be detected via this plugin.
Install
-------------------------------------------------------------------------------
Use Vundle.vim, neobundle.vim, or other vim plugin manager to install it like:
```vim
" Vundle.vim
Plugin 'lambdalisue/vim-findent'
" neobundle.vim
NeoBundle 'lambdalisue/vim-findent'
" neobundle.vim (Lazy)
NeoBundleLazy 'lambdalisue/vim-findent', {
\ 'autoload': {
\ 'commands': [
\ 'Findent',
\ 'FindentRestore',
\ ],
\}}
" neobundle.vim (Lazy: with completion)
NeoBundleLazy 'lambdalisue/vim-findent', {
\ 'autoload': {
\ 'commands': [
\ {
\ 'name': 'Findent',
\ 'complete': 'customlist,findent#FindentComplete',
\ },
\ {
\ 'name': 'FindentRestore',
\ 'complete': 'customlist,findent#FindentRestoreComplete',
\ },
\ ],
\}}
```
If you are not using any vim plugin manager, you can copy the repository to
your `$VIM` directory to enable the plugin.
Usage
-------------------------------------------------------------------------------
Call `:Findent` to find and apply reasonable `expandtab`, `shiftwidth`, `tabstop`, and `softtabstop` (an indent rule) of
the current buffer.
It automatically use a middle part of the content to detect the reasonable indent rule and apply to the local setting (`setlocal`).
If you want to control the region of content used for detection, use visual selection to select the region prior to the command.
Call `:FindentRestore` to restore a previous indent rule of the current buffer or call `:Findent!` to re-apply forcedly.
If you want to make this detection automatic, use `autocmd` like:
```vim
augroup findent
autocmd!
autocmd FileType javascript Findent
autocmd FileType css Findent
augroup END
```
If you feel annoying for the detection message, use '--no-messages':
```vim
augroup findent
autocmd!
autocmd FileType javascript Findent --no-messages
autocmd FileType css Findent --no-messages
augroup END
```
Or if you want to completely suppress messages, use '--no-warnings' as well:
```vim
augroup findent
autocmd!
autocmd FileType javascript Findent --no-messages --no-warnings
autocmd FileType css Findent --no-messages --no-warnings
augroup END
```
In this case, `Findent` reserve the specified options into a buffer variable and
actual `Findent` call will be performed on `BufWinEnter` autocmd.
This is required to make sure that the `Findent` command is called only after `FileType` autocmd or `ftplugin`.
See `:help Findent-autocmd` for more detail about this behavior.
Command and Variable
-------------------------------------------------------------------------------
See `:help vim-findent-command` or `:help vim-findent-variable`.
License
--------------------------------------------------------------------------------
Copyright (c) 2015 Alisue, hashnote.net
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files
(the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of the Software,
and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.