debug-log-patterns

Included with Lifetime

$97 forever

Language-specific debug logging patterns and best practices. Reference when adding instrumentation for Dart/Flutter, Kotlin/Android, Swift/iOS, or JavaScript/TypeScript applications.

Code Review

What this skill does


# Debug Log Patterns

## Overview

This skill provides copy-paste-ready logging patterns for common debugging scenarios across multiple languages. Use these patterns when instrumenting code during PDCA debug cycles.

## Supported Languages

| Language | File | Primary Use Case |
|----------|------|------------------|
| Dart/Flutter | `references/dart-flutter.md` | Flutter mobile/web apps |
| Kotlin/Android | `references/kotlin-android.md` | Native Android apps |
| Swift/iOS | `references/swift-ios.md` | Native iOS apps |
| JavaScript/TypeScript | `references/javascript-typescript.md` | Web apps, Node.js, React Native |

## Universal Conventions

### Log Format Standard

All logs should follow this format for consistency:
```
[ClassName] methodName: description key=value
```

### Log Levels

| Level | When to Use |
|-------|-------------|
| DEBUG/TRACE | Detailed flow tracing, variable values |
| INFO | Significant events, state transitions |
| WARN | Unexpected but recoverable situations |
| ERROR | Failures that affect functionality |

### Common Patterns (All Languages)

#### Pattern: Method Entry/Exit
```
[ClassName] methodName: ENTER params=(param1, param2)
[ClassName] methodName: EXIT result=value
```

#### Pattern: Conditional Branch
```
[ClassName] methodName: condition branch=TAKEN/SKIPPED reason=why
```

#### Pattern: Loop Iteration
```
[ClassName] methodName: loop iteration=N/total item=current
```

#### Pattern: State Transition
```
[ClassName] methodName: state from=oldState to=newState trigger=event
```

#### Pattern: Async Operation
```
[ClassName] operationName: START
[ClassName] operationName: SUCCESS result=summary
[ClassName] operationName: ERROR error=message
```

## Quick Selection Guide

**Debugging Flutter/Dart app?**
-> See `references/dart-flutter.md`

**Debugging Android native (Kotlin)?**
-> See `references/kotlin-android.md`

**Debugging iOS native (Swift)?**
-> See `references/swift-ios.md`

**Debugging web/Node.js/React?**
-> See `references/javascript-typescript.md`

## Best Practices

1. **Be specific** - Include actual values, not just "value changed"
2. **Be consistent** - Use the same format throughout the codebase
3. **Be temporary** - Remove debug logs after issue is resolved
4. **Be contextual** - Include enough info to understand without seeing code
5. **Be careful with sensitive data** - Never log passwords, tokens, PII

## References

- `references/dart-flutter.md` - Dart/Flutter logging patterns
- `references/kotlin-android.md` - Kotlin/Android logging patterns
- `references/swift-ios.md` - Swift/iOS logging patterns
- `references/javascript-typescript.md` - JavaScript/TypeScript logging patterns

Files: 5

Size: 33.6 KB

Complexity: 46/100

Category: Code Review

Source: https://github.com/xmgrex/ccx-arsenal/tree/main/plugins/pdca-debug-suite/skills/debug-log-patterns

Related in Code Review

gstack

Included

Fast headless browser for QA testing and site dogfooding. Navigate pages, interact with elements, verify state, diff before/after, take annotated screenshots, test responsive layouts, forms, uploads, dialogs, and capture bug evidence. Use when asked to open or test a site, verify a deployment, dogfood a user flow, or file a bug with screenshots. (gstack)

Code Reviewscriptsfeatured

startup-due-diligence

Included

Legal due diligence review for seed-stage and Series A startups (US, Delaware C-Corp focus). Supports both investor and founder perspectives. Capabilities include: (1) Interactive document review and issue spotting; (2) Document request list generation; (3) Cap table and SAFE/convertible note analysis; (4) Red flag identification with severity ratings; (5) Diligence report generation. TRIGGERS: due diligence, DD, startup investment, cap table review, Series A, seed round, investor diligence, legal review startup, SAFE analysis, convertible note, 409A, founder vesting.

Code Reviewscripts

interview-master

Included

This skill should be used when the user asks to "generate interview questions", "prepare for interview", "optimize resume", "conduct mock interview", "analyze git commits for resume", "generate resume from code", "review my resume", or mentions interview preparation, career assistance, or extracting project experience from git history. Provides comprehensive interview and career development guidance for both job seekers and interviewers.

Code Reviewscripts

fix-issue

Included

Fixes GitHub issues using parallel analysis agents for root cause investigation, code exploration, and regression detection. Reads issue context from gh CLI, searches codebase and memory for related patterns, generates a fix with tests, and links the resolution back to the issue via PR. Includes prevention analysis to avoid recurrence. Use when debugging errors, resolving regressions, fixing bugs, or triaging issues.

Code Reviewscripts

sf-apex

Included

Generates and reviews Salesforce Apex code with 150-point scoring. TRIGGER when: user writes, reviews, or fixes Apex classes, triggers, test classes, batch/queueable/schedulable jobs, or touches .cls/.trigger files. DO NOT TRIGGER when: LWC JavaScript (use sf-lwc), Flow XML (use sf-flow), SOQL-only queries (use sf-soql), or non-Salesforce code.

Code Reviewscripts

swift-development

Included

Comprehensive Swift development for building, testing, and deploying iOS/macOS applications. Use when Claude needs to: (1) Build Swift packages or Xcode projects from command line, (2) Run tests with XCTest or Swift Testing framework, (3) Manage iOS simulators with simctl, (4) Handle code signing, provisioning profiles, and app distribution, (5) Format or lint Swift code with SwiftFormat/SwiftLint, (6) Work with Swift Package Manager (SPM), (7) Implement Swift 6 concurrency patterns (async/await, actors, Sendable), (8) Create SwiftUI views with MVVM architecture, (9) Set up Core Data or SwiftData persistence, or any other Swift/iOS/macOS development tasks.

Code Reviewscripts