💻 🤘 Make logging in Vim great as it has never been
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
autoload
doc
ftdetect
ftplugin
plugin
LICENSE
README.md
jslog-vim.gif

README.md

💻 🤘 lognroll-vim

Keep on loggin' in the free world

jslog-vim.gif

What is lognroll-vim?

It's a plugin aiming to help us developers to save time in writing all that console.log ;) This goal is pursue basically adding a couple of mappings for you. At the moment, only JavaScript and TypeScript environments are supported, but in the future it's not excluded support for other languages.

Global variables configuration:

Variable Type Default Value Meaning
g:lognroll#enable_insert_mode number 1 Define wether the mappings should be active also in insert mode or not
g:lognroll#enable_brackets number 1 Define wether the variable should be logged inside curly brackets or not
g:lognroll#lognroll_js_console string 'console' Define the console function to call
g:lognroll#lognroll_js_actions string[] [ 'log', 'info', 'warn', 'error' ] Define the method of the console the user wants to map

What are the default mappings?

One of the core concept behind this plugin, is to expose mnemonic key combination. For this reason, every mapping, both in INSERT and NORMAL mode, begin with:

    co, that stands for console

Followed by the action you want to perform, in a vimish way. So, for example, in case of log:

    l, that stands for log

Therefore the complete mapping will be:

    col

By default, you will find 4 levels of logging for JS: log, info, warn, error, which bring these mappings:

  • col, console.log
  • coi, console.info
  • cow, console.warn
  • coe, console.error

⚠️ If you don't want to have mappings also for INSERT mode, just add this line to your .vimrc:

let g:lognroll#enable_insert_mode = 0

In which way the variable is logged?

By default, the variable will be surrounded by curly brackets, for example, if you have the cursor on the word dumbString, and type col, the variable will be logged one line below, like this:

const dumbString = "I'm a string";
console.log({ dumbString })

⚠️ If you don't want to use brackets, just add the following line to the .vimrc:

    let g:lognroll#enable_brackets = 0

It's possible to use a custom logger?

Yes.

Maybe you don't want to rely on default console, and you prefer tools like PinoJS. Well, just specify in the .vimrc the name of the console you want to use like this:

    let g:lognroll_js_console = 'pino'

Now typing col will produce the following output:

    pino.log({ dumbString })

It's possible to specify the methods of the console?

Yes.

If you want to use also console.dir() besides the default methods, you just have to enumerate in the .vimrc all the methods you want to use, like this:

    let g:lognroll_js_actions = [ 'log', 'info', 'warn', 'error', 'dir' ]

Now typing cod will produce the following output:

    console.dir({ dumbString })

⚠️ Pay attention to redaclare all the methods you want to use, for example, this line:

    let g:lognroll_js_actions = [ 'dir' ]

will leave you with only the cod mappings, and nothing else. Be sure to enumerate all the methods you want to use. Also, be aware that all the new methods you add will have as mappings the same root of default ones co, and the first letter of the method as ending. So, if you add table to lognroll_js_actions, the mapping will be:

    cot

It's possible to log all the variables of a function?

Yes.

While col will log only the word you are on, cola will log all the arguments of the function. The result will be the following:

function sum(a, b) {
  return a + b
}
console.log({ a, b })

⚠️ Pay attention to position the cursor inside the brackets of the function call, anywhere inside the brackets, but inside the brackets, as the relative vim mapping is yi(, that yanks everything inside the brackets.

It's possible to overwrite default mappings?

Yes.

The following is the table of the available <Plug> command:

Plug command Mode Default Map
(lnr_insert_log) insert col
(lnr_insert_info) insert coi
(lnr_insert_warn) insert cow
(lnr_insert_error) insert coe
(lnr_normal_log) normal col
(lnr_normal_info) normal coi
(lnr_normal_warn) normal cow
(lnr_normal_error) normal coe
(lnr_normal_logargs) normal cola
(lnr_normal_infoargs) normal coia
(lnr_normal_warnargs) normal cowa
(lnr_normal_errorargs) normal coea

For example, If you want to remap the mapping in NORMAL mode for console.log from col to ll, add this line to your .vimrc:

    nmap ll <Plug>(lnr_normal_log)

⚠️ For the new method you eventually could add, like console.dir, the <Plug> function will be:

    (lnr_normal_dir) becasue:

  • lnr stands for lognroll and is always the first word
  • insert or normal, specify the MODE you want to map
  • the last word is the name of the console method you are calling, so log, warn etc.

What languages are supported?

At the moment, only JavaScript and TypeScript (also *.jsx and *.tsx ), but I think that in some basic way, this plugin could be extended to other languages too.

Contributions are welcome! If you want to add support for a specific language, just add an issue with some details about the ideas and the goals you have, and don't hesitate to open a pull request. As soon as I can, work and life permitting, I will check it out. The only constraint is to follow the same mnemonic way of defining mappings, possibly starting with co.

Installation

  • Vundle, add the following line to your ~/.vimrc:

    Bundle 'glippi/lognroll-vim'

    $ vim +'PluginInstall! lognroll-vim' +qall

  • vim-plug, add the following to your plugin section:

    Plug 'glippi/lognroll-vim'

    $ vim +PlugInstall

  • NeoBundle, add the following line to your ~/.vimrc:

    NeoBundle 'glippi/lognroll-vim'

    $ vim +NeoBundleInstall +qall

  • Pathogen, execute the following in your shell:

    $ cd ~/.vim/bundle

    $ git clone https://github.com/glippi/lognroll-vim.git

If you are not using a package manager, download the tarball and execute the following steps:

$ cp lognroll-vim-master.tar.gz ~/.vim
$ cd ~/.vim
$ tar --strip-components=1 --overwrite -zxf lognroll-vim-master.tar.gz
$ rm lognroll-vim-master.tar.gz

License

Copyright (c) Gabriele Lippi. Distributed under the same terms as Vim itself. See :help license.