Debugger for Console

Effortlessly generate console debugging information for various languages.

This document also has a 简体中文 version.

Why not Turbo Console Log?

First of all, I have to admit that it is really great, and even the motivation of my plug-in is because of it, but I did find some problems in use (maybe I was wrong😜).

1. Even if a single emoji can be replaced, Byt all statements can only appear in the console as the same emoji.
2. When multiple cursors are inserted, they are inserted in sequence, which may leave many modification records locally.
3. Cannot output different log messages from different file types in the current workspace.
4. Can't customize what you create. For example, sometimes I want to use debugger instead of console.log.
5. Creating multiple lines of cursor in the same line will create multiple statements, and the order is not guaranteed.
6. Occasionally I want a clean log output, but I don't want to create it manually.
7. Unable to create log outside array/object/function.
8. ...

! Let me reiterate that there is nothing wrong with it, but it can't meet my needs in some ways. If you have these problems, you might as well try this plugin, which is free anyway. 😇

If you think it works, you might as well give me a ⭐, which is my greatest encouragement. Thank you for your use~

Features

1. Swiftly generate console debugging information across multiple languages.
2. Insert debugging statements before or after the current line.
3. Remove all debugging statements within the document.
4. Comment and uncomment all debugging statements in the document.
5. Insert debugging statements at multiple cursor locations.
6. Merge multiple cursors on the same line.
7. Hot update the latest workbench configuration.(without restarting your editor.)

Installing

This extension is freely available in the Visual Studio Code Marketplace.

Usage

Keybindings

Create the statement before the line

ctrl + shift + ↑(ArrowUp)

Create the statement after the line

ctrl + shift + ↓(ArrowDown)

Automatically find object/array/function boundaries

ctrl + shift + ↓(ArrowDown)

Remove all statements on document

ctrl + shift + ←(Backspace)

Comment all statements on document

ctrl + shift + /

Uncomment all statements on document

ctrl + shift + u

Multi cursor

Merge multiple cursors on the same line:

command

> debugger-for-console.create: Insert after the current line

> debugger-for-console.before: Insert before the current line

> debugger-for-console.remove: Delete all statements

> debugger-for-console.comment: Comment all statements

> debugger-for-console.uncomment: Uncomment all statements

> debugger-for-console.update: Use the latest configuration (This allows your modifications to take effect immediately without restarting your editor.)

[!IMPORTANT] if you find that the indentation of the statement you created is incorrect, please check the indentation method and size configured in your current file or the whole project. The default of the plugin is: 2 indented spaces.

Configuration

You can personalize the statements you wish to insert via the Settings. (This plugin can also serve as a straightforward code snippet tool.)

// Default Settings
{
  // Specify the type of quotation marks to use when inserting statements
  // Note: Some languages that require the use of double quotes may not support this feature, e.g., Go, C#, rust
  "debugger-for-console.quote": "'",

  // Whether or not whether to insert an emoji
  "debugger-for-console.emoji": true,

  // Set the relative path depth of files
  "debugger-for-console.fileDepth": 2,

  // Whether or not whether to insert the line number
  "debugger-for-console.lineNumber": true,

  // Show variables and logos in rows. (Very effective when the content is long.)
  "debugger-for-console.outputNewline": false,

  // Is it possible to output only one parameter.
  // The log output method in some languages does not support multiple functions, such as `Java`
  "debugger-for-console.onlyOutputVariable": "auto",

  // Whether to insert an empty line before or after the log message or not.
  "debugger-for-console.insertEmptyLine": "none",

  // Reduce the excessively long path and variable name (when it is more than 8 characters, automatically use `...` instead of the middle content)
  "debugger-for-console.ellipsis": true,

  // Customize debugging statements for different languages
  "debugger-for-console.wrappers": {
    "php": "var_dump({VALUE})",
    "python": "print({VALUE})",
    "rust": "println!({VALUE})",
    "go": "println({VALUE})",
    "csharp": "Console.Log({VALUE})",
    // TIPS: The keys `javascript`, `typescript`, `javascriptreact`, `typescriptreact`, `vue`, `html`, and `svelte` all correspond to JavaScript.
    "javascript": "console.log({VALUE})",
    "default": "console.log({VALUE})"
  }
}

examples

{
  "debugger-for-console.outputNewline": false,
  "debugger-for-console.onlyVariable": "enable",
  "debugger-for-console.wrappers": {
    // "javascript": "debugger"
    // "javascript": "print({VALUE})",
    "javascript": "console.error('%c {VALUE}', 'color: red', {VALUE})"
    // "javascript": "console.warn('Custom Wrapper', {VALUE})"
  }
}