Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nisargjhaveri/vscode-ios-debug
iOS debugging in Visual Studio Code
https://github.com/nisargjhaveri/vscode-ios-debug
Last synced: 3 months ago
JSON representation
iOS debugging in Visual Studio Code
- Host: GitHub
- URL: https://github.com/nisargjhaveri/vscode-ios-debug
- Owner: nisargjhaveri
- Created: 2021-08-27T08:07:00.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-20T16:43:19.000Z (5 months ago)
- Last Synced: 2024-06-21T10:45:23.113Z (5 months ago)
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=nisargjhaveri.ios-debug
- Size: 3.83 MB
- Stars: 86
- Watchers: 10
- Forks: 10
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# ios-debug · iOS Debugging in VS Code
Debug iOS apps directly from VS Code.
# Features
- Install and launch apps for debugging automatically based on the VS Code launch config.
- Debugging on both iOS devices and simulators.
- Pick a connected device or installed simulator for debugging.
- Seamlessly debug on locally connected devices when working using [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview).
- All other debugging features supported by [CodeLLDB](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb) extension.
# Requirements
- MacOS X with full Xcode installation
# Quick Start
Here is a minimal launch configuration to get you started
```
{
"name": "Launch App",
"type": "lldb",
"request": "launch",
"program": "${workspaceFolder}/build/Debug-${command:ios-debug.targetSdk}/.app",
"iosBundleId": "",
"iosTarget": "select",
},
```
Look at the [examples/Sample App/.vscode](./examples/Sample%20App/.vscode) for a working example of VS Code config for a sample app.
# How to use
## Launch config options
The extension depends on [CodeLLDB](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb) for most debugging features and extends the same to support launching and attaching to iOS targets.
Here are some of the common options used for setting up the launch config for debugging on iOS.
When `request` is set to `launch`, the app is launched on the iOS device or simulator and attached for debugging. When `request` is set to `attach`, the debugger tries to attach to the app already launched on the iOS device or simulator.
|parameter |type|req | |
|-------------------|----|:--:|---------|
|**name** |string|Y| Launch configuration name.
|**type** |string|Y| Set to `lldb`.
|**request** |string|Y| Set to `launch` or `attach`.
|**program** |string|Y| Path to the built `.app` file for your app.
|**iosBundleId** |string|Y| App bundle identifier for the specified app.
|**iosTarget** |string|Y| If this config should target iOS.
- `false` (default) if this config is not for iOS debugging
- `"select"` if the target picker should be shown
- `"last-selected"` if last selected target should be used if available
|**iosInstallApp** |string| | Whether to install the app on target before launching. Only available with `request = launch`.
- `true` (default) Install the app specified by `program` before launching.
- `false` Do not install the app. Directly launch the already installed app on the target.
|**args** |[string]| | Command line parameters to pass while launching the app. Only available with `request = launch`.
|**env** |dictionary| | Additional environment variables when launching the app. Only available with `request = launch`.
## Target selection
If you specify `"iosTarget": "select"` in your launch config, the target picket will be shown when you start the debugging.
If you want to select or change target otherwise, you can do that by the following methods.
- From the status bar item showing the previously selected target or "Select target".
- Accessing `Select iOS Target` command from the command palette.
## Commands
The extension exposes a few commands that can be used in tasks or launch config as parameters. You can use `${command:ios-debug.}` inside your launch configs or task definitions, which will be resolved to the return value of the command.
- `ios-debug.targetUDID` - Selected target's UDID
- `ios-debug.targetType` - Selected target's type. Either "Simulator" or "Device"
- `ios-debug.targetName` - Selected target's name.
- `ios-debug.targetSdk` - Selected target's sdk type. Either "iphonesimulator" or "iphoneos"
## Remote Development
The extension supports debugging on locally connected devices when using [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). If the setup is correct, the locally connected devices will automatically be listed in the target picker.
[iOS Debug Companion](https://marketplace.visualstudio.com/items?itemName=nisargjhaveri.ios-debug-companion) extension is required for this to work. It'll automatically prompt to install this extension when needed.
`ios-debug.shareLocalDevices` configuration can be tweaked to control whether to allow debugging on local devices or not based on your requirements.
Your local machine may need additional setup for this to work depending on the OS.
- macOS: No additional setup should be required.
- Windows: [iTunes](https://www.apple.com/in/itunes/) needs to installed. Make sure "Apple Mobile Device Service (AMDS)" is running if the local devices are still not visible.
- Linux: [usbmuxd](https://github.com/libimobiledevice/usbmuxd) needs to be installed and running.
# Known limitations
- UI debugging features (e.g. Debug View Hierarchy, etc.) for iOS are out-of-scope for now. You need to use Xcode for that.
- "Restart" debugging doesn't work reliably from VS Code. You need to stop and start debugging again.