Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fireplusteam/ios-swift-for-vs-code

VS Code extension to Write/Debug/Build/Test iOS applications on Visual Studio Code
https://github.com/fireplusteam/ios-swift-for-vs-code

apple code debug extension ide ios ios-swift macos objective-c studio swift tvos visionos visual vs vscode watchos xcode xcodebuild

Last synced: 24 days ago
JSON representation

VS Code extension to Write/Debug/Build/Test iOS applications on Visual Studio Code

Host: GitHub
URL: https://github.com/fireplusteam/ios-swift-for-vs-code
Owner: fireplusteam
License: other
Created: 2024-01-05T08:57:15.000Z (10 months ago)
Default Branch: main
Last Pushed: 2024-09-29T16:50:23.000Z (about 1 month ago)
Last Synced: 2024-09-30T02:21:41.370Z (about 1 month ago)
Topics: apple, code, debug, extension, ide, ios, ios-swift, macos, objective-c, studio, swift, tvos, visionos, visual, vs, vscode, watchos, xcode, xcodebuild
Language: TypeScript
Homepage:
Size: 10.7 MB
Stars: 20
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

README

# vscode-ios README

📦[VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=FirePlusTeam.vscode-ios) | 🐞
[Github Issues](https://github.com/fireplusteam/ios_vs_code/issues)

You can support this project by giving a star on GitHub ⭐️

[![GitHub](https://img.shields.io/github/stars/fireplusteam/ios_vs_code?style=social)](https://github.com/fireplusteam/ios_vs_code)

Develop/Build/Debug/Test your xCode projects in VS Code with your favorite extensions.

Before use it make sure you've installed all **dependencies** required for this extension.

## Autocomplete

[![Autocomplete](https://img.youtube.com/vi/0dXQGY0IIEA/0.jpg)](https://youtu.be/0dXQGY0IIEA)

## 🌳 File Tree Integration

[![🌳 File Tree Integration](https://img.youtube.com/vi/3C-abUZGkgE/0.jpg)](https://youtu.be/3C-abUZGkgE)

## Features

- Supports iOS/MacOS/WatchOS/VisionOS/TvOS
- Swift/Objective-C/C++ autocompletion
- Compatibility with CodeLLDB
- Debug/Run iOS app
- Debug/Run unit/snapshot tests. Support running single/multiple tests for a class/target/set of classes
- Support code coverage
- Run an application on multiple simulator with a single command
- Support project/workspace
- Support launch configuration for app
- Support diff snapshots testing
- Add/Delete/Rename/Move files/folders inside vscode
- VS Code workspace generation based on Xcode project/workspace
- Parsing build/test logs and display in Problems panel in real time

Instead of xCode preview you can use hot reloading [InjectionIII](https://github.com/johnno1962/InjectionIII) which works great with this extension:

- HotReloading & Injection with [HotReloading](https://github.com/johnno1962/HotReloading)
- SwiftUI injection property wrapper with [Inject](https://github.com/krzysztofzablocki/Inject) or [HotSwiftUI](https://github.com/johnno1962/HotSwiftUI)

## Dependencies

Before an extension is activated, there's a automatic check if those dependencies are installed and if not, it's ask a user to install them automatically.
Use the following guide to install them manually if any it doesn't work for you:

**Required Dependencies**:

- **Xcode** and simulators. Make sure that your Xcode is installed in `/Application/Xcode/` folder

- **homebrew**:

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```

- **xcbeautify** tool to prettify the building log output and :

```bash
brew install xcbeautify
```

- **xcodeproj** gem library to make possible to add/delete/rename files in your Xcode project directly from vs code.

```bash
brew install ruby
gem install xcodeproj
```

**Note:**
As [sourcekit-lsp](https://github.com/apple/sourcekit-lsp) updates indexes while building, If you want to have indexes updating even if you have compile errors, you need to give **a full disk control** to Visual Studio Code in Security Settings which allows to install a proxy service for Apple **XCBBuildService** automatically when an extension is activated.
This's just needed to override the **continueBuildingAfterError** property when you build the app and gives you all errors in the project and compile flags possible used by sourcekit for indexing.

## How to use

- Once you installed all the dependencies, you can open a folder which contains the iOS project, it project or workspace is located in the local folder then an extension will ask you if you want to configure it otherwise you need to perform command "iOS: Select Project/Workspace" and pick the right project/workspace to work with. You can also switch between multiple projects if they are located in the same folder/subfolders

- There's ios launch configuration that can be added to launch.json file to run and debug ios project (there's also "iOS: Run App & Debug" snippet)

```json
"configurations": [
{
"type": "xcode-lldb",
"name": "iOS: Run App & Debug",
"request": "launch",
"target": "app",
"isDebuggable": true,
"buildBeforeLaunch": "always"
}
]
```

- Also there're automatically added build tasks which can be used by pressing standard "**Cmd+Shift+B**" shortcut.

- To make autocompletion to work you may need to clean the project and build it entirely for the first time.

## Extension Settings

This extension contributes the following settings:

- `vscode-ios.watcher.singleModule`: Enable/disable the autocomplete watch build to update indexes whenever a you modified a file.
- `vscode-ios.xcb.build.service`: if Enabled, it will ask a user sudo password to replace XCBBuildService with a proxy service which would enhance the Autocomplete feature. This's used to continue compile a project even if there's multiple errors, so all flags are updated

## Known Issues

- You still need Xcode to use SwiftUI preview or edit storyboard/assets/project settings.
- [sourcekit-lsp](https://github.com/apple/sourcekit-lsp) use indexing while build. if you find definition or references is not work correctly, just build it to update index or restart Swift LSP in VS Code.
- When running for the first time, **you need to ensure that the log is complete**, otherwise some files cannot obtain the correct flags.
- If Generating of project is not working as expected or generates some kind of errors if Xcode opens the same project file, you simply need to update **xcodeproj** lib and ruby library to the latest

```bash
gem install xcodeproj
```

## Release Notes

### 0.4.0

It's still under development, so you can face some bugs