Skip to content

Javascript console.log statements at the tip of your fingers

Notifications You must be signed in to change notification settings

vlpak/SublimeLogMagic

 
 

Repository files navigation

SublimeLogMagic

Easily log javascript variables and parameters with keyboard shortcuts.

Installing

Clone this repository into your Sublime Packages directory (Package Control support coming soon).

Usage

Simply press cmd+alt+j (ctrl+alt+j) to produce magic downwards or cmd+alt+k (ctrl+alt+k) to produce magic upwards.

You can also run these commands manually:

  • LogMagic Statement (down)
  • LogMagic Statement (up)

Features

Log quickly

Any log statement is just a keyboard shortuct away

Log anything quickly

Log anything

LogMagic inspects the current line and tries to extract interesting information from it:

  • variable assignments
  • function parameters in a function definition
  • parameters in a function call
  • supports ES6 destructuring
  • supports ES6 optional parameters
  • supports flowtype (to some extent)
  • ignores known values such as numbers, true, false, null and undefined
  • falls back to printing L<line number> if it fails to parse anything meaningful

Cycle through log types

Press the same keyboard shortcuts when already on a log statement to cycle through log, info, warn and error.

Log cycle

Up / Down support

You can add the log statement on the previous or the next line. This is especially helpful in case of return statements.

Log upwards

Logging upwards can also change what's logged. Eg in the following case we're more interested in the arguments passed to the callback than the variable assignment.

Log upwards smartly

ES6 destructuring support

LogMagic can parse destructuring and extract the necessary variable names from it (even in case of renamed properties)

Log ES6 destructuring

Flowtype support

Flowtype is cool. Best effort has been made to ignore flowtype's annotations and still produce a meaningful log statement (but expect kinks and bugs here).

Log with Flowtype

Customizing

There are no customizable settings (feel free to make an issue).

You can override the custom keyboard shortcuts by adding this to your personal keyboard shortcuts file:

[
    { "keys": ["super+alt+j"], "command": "log_magic_down", "context":
        [
            { "operand": "source.js", "operator": "equal", "match_all": true, "key": "selector" },
        ]
    },
    { "keys": ["super+alt+k"], "command": "log_magic_up", "context":
        [
            { "operand": "source.js", "operator": "equal", "match_all": true, "key": "selector" },
        ]
    }
]

Contributing

Issues are welcome, so are PRs ;)

Btw this plugin should theoretically mostly work for most C-based languages (although by default the keyboard shortcuts are only enabled for JavaScript and it spits out console.* statements).

About

Javascript console.log statements at the tip of your fingers

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%