# 🛠️ xcodebuild.nvim

A plugin designed to let you migrate your app development from Xcode to Neovim.
It provides all essential actions for development including building, debugging, and testing.

<img src="./media/testing.png" style="border-radius: 8px;" alt="xcodebuild.nvim - unit tests" />
&nbsp;
<img src="./media/debugging.png" style="border-radius: 8px;" alt="xcodebuild.nvim - debugging" />

## ✨  Features

- [x] Support for iOS, iPadOS, watchOS, tvOS, visionOS, and macOS.
- [x] Support for Swift Packages (building & testing).
- [x] Project-based configuration.
- [x] Project Manager to deal with project files without using Xcode.
- [x] Assets Manager to manage images, colors, and data assets.
- [x] Test Explorer to visually present a tree with all tests and results.
- [x] Built using official command line tools like `xcodebuild` and `xcrun simctl`.
- [x] Actions to build, run, debug, and test apps on simulators and physical devices.
- [x] Previews for SwiftUI, UIKit, and AppKit views.
- [x] Environment variables and run arguments management.
- [x] Buffer integration with test results (code coverage, success & failure marks, duration,
      extra diagnostics).
- [x] Code coverage report with customizable levels.
- [x] Advanced log parser to detect all errors, warnings, and failing tests.
- [x] [nvim-tree], [neo-tree], and [oil.nvim] integration that automatically reflects
      all file tree operations and updates Xcode project.
- [x] [nvim-dap] integration to let you easily build, run, and debug apps.
- [x] [nvim-dap-ui] integration to show app logs in the console window.
- [x] [lualine.nvim] integration to show selected device, test plan, and other project settings.
- [x] [swift-snapshot-testing] integration to present diff views for failing snapshot tests.
- [x] [Quick] integration to show test results for tests written using [Quick] framework.
- [x] [Swift Testing] integration to show test results for tests written using [Swift Testing] framework.
- [x] [Swift Macros] approval flow.
- [x] Auto-detection of the target membership for new files.
- [x] Picker with all available plugin actions.
- [x] Highly customizable (many config options, auto commands, highlights, and user commands).

## 📦  Installation

Read [Wiki] to learn how to install and configure the plugin.

## 📚  Documentation

Everything about the plugin is described in the [Wiki]. You can find there all available commands,
integrations, settings, and examples.

## 🎥  Demo

### Testing

xcodebuild.nvim supports code coverage, test explorer, diagnostics, snapshot tests, Quick framework, and more!

https://github.com/user-attachments/assets/50f8848e-e90b-4b0b-a0ee-79e836982f12

### Working With Code

Neovim can be easily integrated with SwiftLint, SwiftFormat, Copilot, and more.
In the video, you can see basic navigation, diagnostics, formatting, linting, code completion, and of course,
launching the app on a simulator.

https://github.com/user-attachments/assets/67b844f8-c1bd-453d-be64-0592b904e3c2

### Debugging

The plugin allows you to debug both on simulators and physical devices. You get access to all basic things like breakpoints,
variables inspection, call stack, lldb, etc. You can even see app logs.

https://github.com/user-attachments/assets/27644dcd-ef4e-4471-8ddc-cf1c9d2ca27e

### Previews

The plugin allows you to display previews for SwiftUI, UIKit, and AppKit views.
The setup is quite easy, you just need to install [snacks.nvim] to enable image
support and [xcodebuild-nvim-preview] package to add previews to your project.
See [Wiki](https://github.com/wojciech-kulik/xcodebuild.nvim/wiki/Integrations#-previews)
for more details.

https://github.com/user-attachments/assets/ec6c6e96-667a-40a3-a9d3-a75c9c9cf272

&nbsp;

## 💛  Sponsors

Big thanks to all the sponsors who support this project 🍻!

### Monthly Sponsors

<table>
  <tr>
    <td><a href="https://github.com/kg8m"><img src="https://avatars.githubusercontent.com/u/694547" width="40" height="40" alt="@kg8m" title="kg8m"></a></td>
    <td><a href="https://github.com/soundsmitten"><img src="https://avatars.githubusercontent.com/u/852801" width="40" height="40" alt="@soundsmitten" title="soundsmitten"></a></td>
    <td><a href="https://github.com/jwcross"><img src="https://avatars.githubusercontent.com/u/2405246" width="40" height="40" alt="@jwcross" title="jwcross"></a></td>
    <td><a href="https://github.com/TimPapler"><img src="https://avatars.githubusercontent.com/u/5990580" width="40" height="40" alt="@TimPapler" title="TimPapler"></a></td>
    <td><a href="https://github.com/dosboxd"><img src="https://avatars.githubusercontent.com/u/16291547" width="40" height="40" alt="@dosboxd" title="dosboxd"></a></td>
  </tr>
</table>

### One Time Sponsors

<table>
  <tr>
    <td><a href="https://github.com/kujohn"><img src="https://avatars.githubusercontent.com/u/1356936" width="40" height="40" alt="@kujohn" title="kujohn"></a></td>
    <td><a href="https://github.com/iMostfa"><img src="https://avatars.githubusercontent.com/u/2325884" width="40" height="40" alt="@iMostfa" title="iMostfa"></a></td>
    <td><a href="https://github.com/bainfu"><img src="https://avatars.githubusercontent.com/u/221679" width="40" height="40" alt="@bainfu" title="bainfu"></a></td>
    <td><a href="https://github.com/emrearmagan"><img src="https://avatars.githubusercontent.com/u/45041965" width="40" height="40" alt="@emrearmagan" title="emrearmagan"></a></td>
    <td><a href="https://github.com/RomanVolkov"><img src="https://avatars.githubusercontent.com/u/2831223" width="40" height="40" alt="@RomanVolkov" title="RomanVolkov"></a></td>
  </tr>
</table>

### Past Monthly Sponsors

<table>
  <tr>
    <td><a href="https://github.com/humblehacker"><img src="https://avatars.githubusercontent.com/u/117582" width="40" height="40" alt="@humblehacker" title="humblehacker"></a></td>
    <td><a href="https://github.com/m-housh"><img src="https://avatars.githubusercontent.com/u/9305678" width="40" height="40" alt="@m-housh" title="m-housh"></a></td>
    <td><a href="https://github.com/Almaz5200"><img src="https://avatars.githubusercontent.com/u/21291840" width="40" height="40" alt="@Almaz5200" title="Almaz5200"></a></td>
    <td><a href="https://github.com/stephenhuh"><img src="https://avatars.githubusercontent.com/u/6165538" width="40" height="40" alt="@stephenhuh" title="stephenhuh"></a></td>
    <td><a href="https://github.com/joeldrotleff"><img src="https://avatars.githubusercontent.com/u/2484624" width="40" height="40" alt="@joeldrotleff" title="joeldrotleff"></a></td>
  </tr>
</table>

## 🤓 My Other Projects

- [Snippety](https://snippety.app) - Snippets manager for macOS & iOS
- [FlashSpace](https://github.com/wojciech-kulik/FlashSpace) - Fast virtual workspace manager for macOS
- [Smog Poland](https://smog-polska.pl) - Air quality monitoring app for Poland
- [XcodeProjectCLI] - Open Source CLI tool to manage Xcode project

&nbsp;

[Wiki]: https://github.com/wojciech-kulik/xcodebuild.nvim/wiki
[nvim-tree]: https://github.com/nvim-tree/nvim-tree.lua
[neo-tree]: https://github.com/nvim-neo-tree/neo-tree.nvim
[oil.nvim]: https://github.com/stevearc/oil.nvim
[nvim-dap]: https://github.com/mfussenegger/nvim-dap
[nvim-dap-ui]: https://github.com/rcarriga/nvim-dap-ui
[nvim-treesitter]: https://github.com/nvim-treesitter/nvim-treesitter
[swift-snapshot-testing]: https://github.com/pointfreeco/swift-snapshot-testing
[Quick]: https://github.com/Quick/Quick
[lualine.nvim]: https://github.com/nvim-lualine/lualine.nvim
[Swift Testing]: https://developer.apple.com/xcode/swift-testing/
[snacks.nvim]: https://github.com/folke/snacks.nvim
[xcodebuild-nvim-preview]: https://github.com/wojciech-kulik/xcodebuild-nvim-preview
[XcodeProjectCLI]: https://github.com/wojciech-kulik/XcodeProjectCLI
[Swift Macros]: https://docs.swift.org/swift-book/documentation/the-swift-programming-language/macros/