Cap-go

debugging-capacitor

2
0
# Install this skill:
npx skills add Cap-go/capacitor-skills --skill "debugging-capacitor"

Install specific skill from multi-skill repository

# Description

Comprehensive debugging guide for Capacitor applications. Covers WebView debugging, native debugging, crash analysis, network inspection, and common issues. Use this skill when users report bugs, crashes, or need help diagnosing issues.

# SKILL.md


name: debugging-capacitor
description: Comprehensive debugging guide for Capacitor applications. Covers WebView debugging, native debugging, crash analysis, network inspection, and common issues. Use this skill when users report bugs, crashes, or need help diagnosing issues.


Debugging Capacitor Applications

Complete guide to debugging Capacitor apps on iOS and Android.

When to Use This Skill

  • User reports app crashes
  • User needs to debug WebView/JavaScript
  • User needs to debug native code
  • User has network/API issues
  • User sees unexpected behavior
  • User asks how to debug

Quick Reference: Debugging Tools

Platform WebView Debug Native Debug Logs
iOS Safari Web Inspector Xcode Debugger Console.app
Android Chrome DevTools Android Studio adb logcat

WebView Debugging

iOS: Safari Web Inspector

  1. Enable on device:
  2. Settings > Safari > Advanced > Web Inspector: ON
  3. Settings > Safari > Advanced > JavaScript: ON

  4. Enable in Xcode (capacitor.config.ts):

const config: CapacitorConfig = {
  ios: {
    webContentsDebuggingEnabled: true, // Required for iOS 16.4+
  },
};
  1. Connect Safari:
  2. Open Safari on Mac
  3. Develop menu > [Device Name] > [App Name]
  4. If no Develop menu: Safari > Settings > Advanced > Show Develop menu

  5. Debug:

  6. Console: View JavaScript logs
  7. Network: Inspect API calls
  8. Elements: Inspect DOM
  9. Sources: Set breakpoints

Android: Chrome DevTools

  1. Enable in config (capacitor.config.ts):
const config: CapacitorConfig = {
  android: {
    webContentsDebuggingEnabled: true,
  },
};
  1. Connect Chrome:
  2. Open Chrome on computer
  3. Navigate to chrome://inspect
  4. Your device/emulator should appear
  5. Click "inspect" under your app

  6. Debug features:

  7. Console: JavaScript logs
  8. Network: API requests
  9. Performance: Profiling
  10. Application: Storage, cookies

Remote Debugging with VS Code

Install "Debugger for Chrome" extension:

// .vscode/launch.json
{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "chrome",
      "request": "attach",
      "name": "Attach to Android WebView",
      "port": 9222,
      "webRoot": "${workspaceFolder}/dist"
    }
  ]
}

Native Debugging

iOS: Xcode Debugger

  1. Open in Xcode:
bunx cap open ios
  1. Set breakpoints:
  2. Click line number in Swift/Obj-C files
  3. Or use breakpoint set --name methodName in LLDB

  4. Run with debugger:

  5. Product > Run (Cmd + R)
  6. Or click Play button

  7. LLDB Console commands:

# Print variable
po myVariable

# Print object description
p myObject

# Continue execution
continue

# Step over
next

# Step into
step

# Print backtrace
bt
  1. View crash logs:
  2. Window > Devices and Simulators
  3. Select device > View Device Logs

Android: Android Studio Debugger

  1. Open in Android Studio:
bunx cap open android
  1. Attach debugger:
  2. Run > Attach Debugger to Android Process
  3. Select your app

  4. Set breakpoints:

  5. Click line number in Java/Kotlin files

  6. Debug console:

# Evaluate expression
myVariable

# Run method
myObject.toString()
  1. Logcat shortcuts:
  2. View > Tool Windows > Logcat
  3. Filter by package: package:com.yourapp

Console Logging

JavaScript Side

// Basic logging
console.log('Debug info:', data);
console.warn('Warning:', issue);
console.error('Error:', error);

// Grouped logs
console.group('API Call');
console.log('URL:', url);
console.log('Response:', response);
console.groupEnd();

// Table format
console.table(arrayOfObjects);

// Timing
console.time('operation');
// ... operation
console.timeEnd('operation');

Native Side (iOS)

import os.log

let logger = Logger(subsystem: "com.yourapp", category: "MyPlugin")

// Log levels
logger.debug("Debug message")
logger.info("Info message")
logger.warning("Warning message")
logger.error("Error message")

// With data
logger.info("User ID: \(userId)")

// Legacy NSLog (shows in Console.app)
NSLog("Legacy log: %@", message)

Native Side (Android)

import android.util.Log

// Log levels
Log.v("MyPlugin", "Verbose message")
Log.d("MyPlugin", "Debug message")
Log.i("MyPlugin", "Info message")
Log.w("MyPlugin", "Warning message")
Log.e("MyPlugin", "Error message")

// With exception
Log.e("MyPlugin", "Error occurred", exception)

Common Issues and Solutions

Issue: App Crashes on Startup

Diagnosis:

# iOS - Check crash logs
xcrun simctl spawn booted log stream --level debug | grep -i crash

# Android - Check logcat
adb logcat *:E | grep -i "fatal\|crash"

Common causes:
1. Missing plugin registration
2. Invalid capacitor.config
3. Missing native dependencies

Solution checklist:
- [ ] Run bunx cap sync
- [ ] iOS: cd ios/App && pod install
- [ ] Check Info.plist permissions
- [ ] Check AndroidManifest.xml permissions

Issue: Plugin Method Not Found

Error: Error: "MyPlugin" plugin is not implemented on ios/android

Diagnosis:

import { Capacitor } from '@capacitor/core';

// Check if plugin exists
console.log('Plugins:', Capacitor.Plugins);
console.log('MyPlugin available:', !!Capacitor.Plugins.MyPlugin);

Solutions:
1. Ensure plugin is installed: bun add @capgo/plugin-name
2. Run sync: bunx cap sync
3. Check plugin is registered (native code)

Issue: Network Requests Failing

Diagnosis:

// Add request interceptor
const originalFetch = window.fetch;
window.fetch = async (...args) => {
  console.log('Fetch:', args[0]);
  try {
    const response = await originalFetch(...args);
    console.log('Response status:', response.status);
    return response;
  } catch (error) {
    console.error('Fetch error:', error);
    throw error;
  }
};

Common causes:
1. iOS ATS blocking HTTP: Add to Info.plist:

<key>NSAppTransportSecurity</key>
<dict>
    <key>NSAllowsArbitraryLoads</key>
    <true/>
</dict>
  1. Android cleartext blocked: Add to capacitor.config.ts:
server: {
  cleartext: true, // Only for development!
}
  1. CORS issues: Use native HTTP:
import { CapacitorHttp } from '@capacitor/core';

const response = await CapacitorHttp.request({
  method: 'GET',
  url: 'https://api.example.com/data',
});

Issue: Permission Denied

Diagnosis:

import { Permissions } from '@capacitor/core';

// Check permission status
const status = await Permissions.query({ name: 'camera' });
console.log('Camera permission:', status.state);

iOS: Check Info.plist has usage descriptions:

<key>NSCameraUsageDescription</key>
<string>We need camera access to scan documents</string>

Android: Check AndroidManifest.xml:

<uses-permission android:name="android.permission.CAMERA" />

Issue: White Screen on Launch

Diagnosis:
1. Check WebView console for errors (Safari/Chrome)
2. Check if dist/ folder exists
3. Verify webDir in capacitor.config.ts

Solutions:

# Rebuild web assets
bun run build

# Sync to native
bunx cap sync

# Check config
cat capacitor.config.ts

Diagnosis:

import { App } from '@capacitor/app';

App.addListener('appUrlOpen', (event) => {
  console.log('Deep link:', event.url);
});

iOS: Check Associated Domains entitlement and apple-app-site-association file.

Android: Check intent filters in AndroidManifest.xml.

Performance Debugging

JavaScript Performance

// Mark performance
performance.mark('start');
// ... operation
performance.mark('end');
performance.measure('operation', 'start', 'end');

const measures = performance.getEntriesByName('operation');
console.log('Duration:', measures[0].duration);

iOS Performance (Instruments)

  1. Product > Profile (Cmd + I)
  2. Choose template:
  3. Time Profiler: CPU usage
  4. Allocations: Memory usage
  5. Network: Network activity

Android Performance (Profiler)

  1. View > Tool Windows > Profiler
  2. Select:
  3. CPU: Method tracing
  4. Memory: Heap analysis
  5. Network: Request timeline

Memory Debugging

JavaScript Memory Leaks

Use Chrome DevTools Memory tab:
1. Take heap snapshot
2. Perform action
3. Take another snapshot
4. Compare snapshots

iOS Memory (Instruments)

# Run with Leaks instrument
xcrun instruments -t Leaks -D output.trace YourApp.app

Android Memory (LeakCanary)

Add to build.gradle:

debugImplementation 'com.squareup.leakcanary:leakcanary-android:2.12'

Debugging Checklist

When debugging issues:

  • [ ] Check WebView console (Safari/Chrome DevTools)
  • [ ] Check native logs (Xcode Console/Logcat)
  • [ ] Verify plugin is installed and synced
  • [ ] Check permissions (Info.plist/AndroidManifest)
  • [ ] Test on real device (not just simulator)
  • [ ] Try clean build (rm -rf node_modules && bun install)
  • [ ] Verify capacitor.config.ts settings
  • [ ] Check for version mismatches (capacitor packages)

Resources

  • Capacitor Debugging Guide: https://capacitorjs.com/docs/guides/debugging
  • Safari Web Inspector: https://webkit.org/web-inspector
  • Chrome DevTools: https://developer.chrome.com/docs/devtools
  • Xcode Debugging: https://developer.apple.com/documentation/xcode/debugging
  • Android Studio Debugging: https://developer.android.com/studio/debug

# Supported AI Coding Agents

This skill is compatible with the SKILL.md standard and works with all major AI coding agents:

Learn more about the SKILL.md standard and how to use these skills with your preferred AI coding agent.