Skip to content

Commit 0998323

Browse files
Updated Readme
1 parent 5c8d1e2 commit 0998323

File tree

2 files changed

+16
-101
lines changed

2 files changed

+16
-101
lines changed

README.md

Lines changed: 13 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,25 @@
11
# DebugTrace for Dart
22

3-
**Fast and intelligent debugging for Dart developers**
3+
**Say goodbye to manual print statements and hello to efficient debugging**
44

5-
DebugTrace is a VS Code extension that supercharges your Dart debugging workflow by automatically generating contextual debug statements. Say goodbye to manual print statements and hello to efficient debugging.
5+
DebugTrace is a VS Code extension that supercharges your Dart debugging by automatically generating contextual debug statements.
66

7-
## 🚀 Features
8-
9-
### Smart Variable Detection
10-
- **Automatic Variable Recognition**: Place your cursor on any variable and instantly generate debug logs
11-
- **Contextual Information**: Includes file name, line number, and variable values
12-
- **Multi-line Statement Support**: Intelligently handles complex objects, arrays, and function calls
13-
14-
### Customizable Output
15-
- **Two Log Types**: Choose between `print()` for console output or `debugPrint()` for Flutter apps
16-
- **Custom Prefixes**: Personalize your debug messages with emojis or text
17-
- **Flexible Formatting**: Control message wrapping and separator lines
18-
19-
### Bulk Operations
20-
- **Mass Management**: Comment, uncomment, or delete all DebugTrace logs at once
21-
- **Clean Workflow**: Easily remove debug statements before production
7+
### Basic Usage
8+
1. **Place cursor** on any variable in your Dart file
9+
2. `Ctrl+L` / `Cmd+L` for instant log insertion
2210

23-
## 📦 Installation
11+
## 🎮 Commands & Shortcuts
2412

25-
1. Open VS Code
26-
2. Go to Extensions (Ctrl+Shift+X / Cmd+Shift+X)
27-
3. Search for "DebugTrace"
28-
4. Click Install
13+
| Command | Shortcut | Description |
14+
|---------|----------|-------------|
15+
| `DebugTrace: Insert Log` | `Ctrl+L` / `Cmd+L` | Generate debug log for variable at cursor |
16+
| `DebugTrace: Insert Log with Message` | `Ctrl+Shift+L` / `Cmd+Shift+L` | Generate debug log with custom message |
17+
| `DebugTrace: Delete All Logs` | `Ctrl+Alt+L` / `Cmd+Alt+L` | Remove all DebugTrace logs from file |
18+
| `DebugTrace: Comment All Logs` | `Ctrl+Alt+C` / `Cmd+Alt+C` | Comment out all DebugTrace logs |
19+
| `DebugTrace: Uncomment All Logs` | `Ctrl+Alt+U` / `Cmd+Alt+U` | Uncomment all DebugTrace logs |
2920

3021
## 🎯 Quick Start
3122

32-
### Basic Usage
33-
1. **Place cursor** on any variable in your Dart file
34-
2. **Open Command Palette** (Ctrl+Shift+P / Cmd+Shift+P)
35-
3. **Run** `DebugTrace: Insert Log`
36-
4. **Debug statement** appears below the variable
37-
3823
### Example
3924
```dart
4025
String userName = "Alice";
@@ -70,63 +55,6 @@ Customize DebugTrace through VS Code settings:
7055
}
7156
```
7257

73-
### Log Types Explained
74-
75-
| Log Type | Best For | Description |
76-
|----------|----------|-------------|
77-
| `print()` | Console Dart apps, simple debugging | Standard Dart console output |
78-
| `debugPrint()` | Flutter apps | Throttled output, debug-mode only, better for Flutter |
79-
80-
**When to use `debugPrint()`:**
81-
- Building Flutter applications
82-
- Heavy debug output (prevents message dropping)
83-
- Want logs automatically removed in release builds
84-
- Working with Flutter's logging system
85-
86-
**When to use `print()`:**
87-
- Simple Dart console applications
88-
- Basic debugging needs
89-
- Want output in all build modes
90-
91-
## 🎮 Commands & Shortcuts
92-
93-
| Command | Shortcut | Description |
94-
|---------|----------|-------------|
95-
| `DebugTrace: Insert Log` | `Ctrl+L` / `Cmd+L` | Generate debug log for variable at cursor |
96-
| `DebugTrace: Insert Log with Message` | `Ctrl+Shift+L` / `Cmd+Shift+L` | Generate debug log with custom message |
97-
| `DebugTrace: Delete All Logs` | `Ctrl+Alt+L` / `Cmd+Alt+L` | Remove all DebugTrace logs from file |
98-
| `DebugTrace: Comment All Logs` | `Ctrl+Alt+C` / `Cmd+Alt+C` | Comment out all DebugTrace logs |
99-
| `DebugTrace: Uncomment All Logs` | `Ctrl+Alt+U` / `Cmd+Alt+U` | Uncomment all DebugTrace logs |
100-
101-
### 🎯 Quick Access
102-
- **Most used**: `Ctrl+L` / `Cmd+L` for instant log insertion
103-
- **Custom messages**: `Ctrl+Shift+L` / `Cmd+Shift+L` for logs with your own text
104-
- **Bulk cleanup**: `Ctrl+Alt+L` / `Cmd+Alt+L` to remove all logs before commit
105-
106-
## 🔧 Smart Insertion
107-
108-
DebugTrace intelligently analyzes your code structure:
109-
110-
### Complex Objects
111-
```dart
112-
Map<String, dynamic> user = {
113-
'name': 'John',
114-
'age': 30,
115-
'email': 'john@example.com'
116-
};
117-
// Log inserted here ✅
118-
```
119-
120-
### Function Calls
121-
```dart
122-
List<String> result = processData(
123-
param1,
124-
param2,
125-
param3
126-
);
127-
// Log inserted here ✅
128-
```
129-
13058
## 🎨 Why DebugTrace?
13159

13260
### The Problem
@@ -141,19 +69,6 @@ List<String> result = processData(
14169
- **🎛️ Consistent format**: Team-wide standardized debug messages
14270
- **🧹 Easy cleanup**: Remove all debug logs with one command
14371

144-
## 🏆 Best Practices
145-
146-
### Development Workflow
147-
1. **Debug with DebugTrace** during development
148-
2. **Use bulk comment** for temporary disable
149-
3. **Bulk delete** before committing to version control
150-
4. **Configure team settings** for consistent output
151-
152-
### Performance Tips
153-
- Use `debugPrint()` for Flutter apps (throttled output, debug-mode only)
154-
- Use `print()` for simple Dart console apps (works everywhere)
155-
- Enable file info during development, disable for production logs
156-
15772
## 📋 Requirements
15873

15974
- **VS Code**: Version 1.74.0 or higher

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"name": "debugtrace",
3-
"displayName": "DebugTrace",
4-
"description": "Fast and intelligent debugging for Dart developers. Choose between print() and debugPrint() for optimal logging.",
5-
"version": "1.0.0",
3+
"displayName": "Debug Trace",
4+
"description": "Shortcut tool for debugging statement for Dart developers. Choose between print() and debugPrint().",
5+
"version": "1.0.1",
66
"publisher": "PrashantGupta",
77
"license": "MIT",
88
"icon": "icon.png",

0 commit comments

Comments
 (0)