Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Chakroun-Anas/turbo-console-log
https://github.com/Chakroun-Anas/turbo-console-log
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/Chakroun-Anas/turbo-console-log
- Owner: Chakroun-Anas
- Created: 2018-02-28T07:02:32.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-21T22:14:57.000Z (8 months ago)
- Last Synced: 2024-07-22T00:46:39.444Z (about 2 months ago)
- Language: TypeScript
- Size: 483 KB
- Stars: 589
- Watchers: 11
- Forks: 141
- Open Issues: 92
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesomeLibrary - turbo-console-log - fantastic debug tool (语言资源库 / typescript)
README
# 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](https://donate.stripe.com/3cs28j2es9mxaGI7st) 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](https://www.turboconsolelog.io/documentation/features/insert-log-message)
### 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](https://www.turboconsolelog.io/documentation/features/comment-inserted-log-messages)
### 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](https://www.turboconsolelog.io/documentation/features/uncomment-log-messages)
### 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](https://www.turboconsolelog.io/documentation/features/delete-log-messages)
## 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
- [Introducing Our New Website](https://www.turboconsolelog.io/articles/introducing-new-website)
- [Motivation behind Turbo Console Log](https://www.turboconsolelog.io/articles/motivation-behind-tcl)
## Contact
- Support: [[email protected]](mailto:[email protected])
- Feedback: [[email protected]](mailto:[email protected])
- Sponsorship: [[email protected]](mailto:[email protected])
## Release Notes
See the [Changelog file](https://marketplace.visualstudio.com/items/ChakrounAnas.turbo-console-log/changelog) 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