Skip to content

Latest commit

 

History

History
100 lines (59 loc) · 6.72 KB

README.md

File metadata and controls

100 lines (59 loc) · 6.72 KB

Official Website

https://www.turboconsolelog.io

Main Functionality

Turbo Console Log extension makes debugging much easier by automating the operation of writing meaningful log message.

Sponsorship

Since the extension is free and open source, we need your support to continue developing and maintaining it. If you are interested in sponsoring the project, u can do it through the following Link or contact us at [email protected]. For more information please visit: https://www.turboconsolelog.io/sponsorship

Core Features

Full documentation of the core features can be found in the official website: https://www.turboconsolelog.io/documentation/features

I) Insert a meaningful log message

Two steps:

  • Selecting or hovering the variable which is the subject of the debugging (Manual selection will always take over the hover selection)

  • Pressing ctrl + alt + L (Windows) or ctrl + option + L (Mac)

The log message will be inserted in the next line relative to the selected variable like the following:

console.log('🚀 ~ classWrappingVariable ~ functionWrappingVariable ~ variable', variable);

The log function and the content of the log message can be customized in the extension settings (see Settings section for more details).

Multiple cursor selection is also supported.

See It In Action

II) Comment all log messages, inserted by the extension, from the current document

All it takes to comment all log messages, inserted by the extension, from the current document is to press alt + shift + c (Windows) or option + shift + c (Mac)

See It In Action

III) Uncomment all log messages, inserted by the extension, from the current document

All it takes to uncomment all log messages, inserted by the extension, from the current document is to press alt + shift + u (Windows) or option + shift + u (Mac)

See It In Action

IV) Delete all log messages, inserted by the extension, from the current document

All it takes to delete all log messages, inserted by the extension, from the current document is to press alt + shift + d (Windows) or option + shift + d (Mac)

See It In Action

Settings

Full documentation of the settings can be found in the official website: https://www.turboconsolelog.io/documentation/settings

Properties:

Feature Description Setting Default
Custom Prefix The prefix of the log message logMessagePrefix 🚀
Custom Suffix The suffix of the log message logMessageSuffix :
Log Type The type of the log message logType log
Custom Log Function Custom log function to use in the inserted log message, when specified logType property will be ignored logFunction console.log
Delimiter Inside Message The delimiter that will separate the different log message elements (file name, line number, class, function, and variable) delimiterInsideMessage ~
Quote Double quotes ("") or single quotes ('') quote "
Add Semicolon In The End Whether to put a semicolon at the end of the log message or not addSemicolonInTheEnd true
Insert Enclosing Class Whether to insert or not the enclosing class of the selected variable in the log message insertEnclosingClass true
Insert Enclosing Function Whether to insert or not the enclosing function of the selected variable in the log message insertEnclosingFunction true
Include File Name And Line Number Whether to include the file name and the line number of the log message includeFileNameAndLineNum true
Wrap Log Message Whether to wrap the log message or not wrapLogMessage true
Insert Empty Line Before Log Message Whether to insert an empty line before the log message or not insertEmptyLineBeforeLogMessage true
Insert Empty Line After Log Message Whether to insert an empty line after the log message or not insertEmptyLineAfterLogMessage true

Roadmap

https://www.turboconsolelog.io/roadmap

Articles

Contact

Release Notes

See the Changelog file for details.

Participate

You're more than welcome to participate in the development of the extension by creating pull requests and submitting issues, link of the project in github: https://github.com/Chakroun-Anas/turbo-console-log

License

MIT Copyright © Turbo Console Log