Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rmariano/vim-config

Vim configuration
https://github.com/rmariano/vim-config

colour-schemes editor linux vim vim-configuration viml

Last synced: about 1 month ago
JSON representation

Vim configuration

Awesome Lists containing this project

README 

        
Vim Configuration

=================



.. image:: https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square

   :target: LICENSE

   :alt: MIT license



This is an ongoing project of that sets up

a particular configuration for improved productivity.



The goal is to develop a good configuration for the Vim editor, tailored

for Python development.



It does not change the behavior of VIM, since this configuration only

adds comfortable shortcuts, and settings that are recommended for

software development (coding good practices).



.. contents ::



Installation

------------



Instant

^^^^^^^



Copy and paste the following command in your terminal:



.. code:: bash



    mkdir -p ~/.vim && wget -O ~/.vim/Makefile -N https://raw.github.com/rmariano/vim-config/master/Makefile && make -C ~/.vim install



Automatic

^^^^^^^^^



Use the included `Makefile `_ script which downloads and replaces the

files on their latest versions. Bear in mind that requires ``wget`` and

``Makefile`` which comes installed in most of the distributions.



.. code:: bash



    make install



Or, if you want to install a particular version (tag or branch).



.. code:: bash



    make install BRANCH=



Note: this is supported from version ``>=v0.4``.



The previous methods rely on getting the files from the Internet, but

alternatively, if you have already downloaded the project, and unpacked it

somewhere in your file system, you can install it by running:



.. code:: bash



    make deploy



That will copy the files to their respective locations. Note that this will

replace any previous instances of those file you might have had there. If you

want to start over, you could simply run ``make clean``, which will remove the

files for this project (not the extra packages, though).



Features

--------

The leader key (````) can be customized, but it's mapped to ``-`` by

default.



* ```` + ``j``: Toggle the margin at the column number set by ``textwidth``.



* ```` + ``tw`` will highlight trailing white spaces.



* ```` + ``w`` will remove them (they'll also be automatically removed

  when saving :-)



* ``autoindent`` & ``smartindent``.



* ```` + ``c`` Will *comment* out lines of code, and

  ```` + ``u`` will *uncomment* them out. Both apply to normal and visual modes.



* Function keys



  * ````: toggle spell check.

  * ````: Correct files automatically



    * XML: auto-format & indent.

    * Python: PEP-8, sort imports, format with black, and run ``flake8`` checks.



  * ````: toggle paste mode.



  * ````: Run checks in the file (currently only Python is supported).



* ```` +  ``nh`` as a shortcut for ``:nohlsearch`` (No highlight).



* A color scheme I like.



* Customizations for certain file types: Python, YAML, XML, and more to come over time.



* A status line with useful information (file name with path, modification

  flag, file type, column, lines, and position (in %).



* ``;t`` available for searching development tags, such as ``TODO`` or

  ``FIXME``, rendering the results in a quick fix window. Warning: searches

  recursively.



* ```` + ``n``, ```` + ``p`` for moving to the *next* and

  *previous* entries in the quick-fix window, respectively. ```` + ``q``

  for closing it.



* ```` + ``e`` to toggle line numbers (enabled by default).



* Can save files with ``sudo`` that were opened with less permissions: ``:w!!``

  to ``sudo`` save the file.



* Mappings for managing tabs



  * ```` + ``tn``:  **T**\ab **N**\ew, opens a new tab to the right.

  * ```` + ``to``:  **T**\ab **O**\nly, close all tabs but the current one.

  * ```` + ``tc``:  **T**\ab **C**\lose, close current tab.

  * ```` + ``tm``:  **T**\ab **M**\ove, current to the end.



* Window splits properly configured



  * New vertical splits, to the right



  * ````: for moving between splits (instead of ````).

    Same for ``h``, ``k``, or ``l`` respectively.



* `Ctrl` + `C`: Copy selected content to clipboard.



* Other features



  * ``scrolloff=10``: offset of 10 lines when scrolling

  * Performance improvements

  * Silent bells

  * Set hidden buffers



Color scheme

------------



The color scheme requires the terminal to support 256 colors. Most of the

terminals already support this, but some terminal multiplexers like ``tmux``

might require to be run as: ``tmux -2`` in order to support this.



In addition, just the command-line classic Vim version is supported, so no

support for ``Gvim`` or graphical versions is included for the color scheme,

although pull requests are welcomed.



Captures

^^^^^^^^



Here are some examples of how the color scheme looks like.



.. image:: https://rmariano.github.io/itarch/vim-capture1.png

   :target: https://rmariano.github.io/itarch/vim-capture1.png

   :width: 883px

   :height: 391px

   :alt: Vim capture 1

   :align: center



Please note this might depend on the configuration of your terminal as well.



.. image:: https://rmariano.github.io/itarch/vim-capture2.png

   :target: https://rmariano.github.io/itarch/vim-capture2.png

   :width: 574px

   :height: 596px

   :alt: Vim capture 2

   :align: center



Contributing

------------



If you want to try the project, and tweak the settings, I would recommend you

to clone the repository, and use the development deployment, which creates

symlinks of the files in this project, like:



.. code:: bash



    make dev-deploy



In addition, take a moment to read the contributing guidelines.



Dependencies

------------



* Vim 8+

* Linux, OSX (Other platforms are supported on a best-effort basis).



External plug-ins

^^^^^^^^^^^^^^^^^



I prefer to keep the ``.vimrc`` configuration as simple as possible, so this

project is a collection of settings, configurations, and helpers. That

maintains the Vim installation as general as possible.



However, on a daily basis, we might want some extra, few plug-ins.



These are `flake8 `_,

`fugitive vim `_, and

`NERDTree `_.



**Please note**: The installation of the extra dependencies requires ``Vim

8.0`` or newer, since it install the external projects as packages.



They can be installed with:



.. code:: bash



    make extras



Enjoy!