An XCode replacement-ish development environment that aims to be your reliable XCode alternative to develop exciting new [apple] software products
Table of Content
-
👁 Overview -
🌝 Motivation -
🌟 Features -
💆 Generators -
🛠 Requirements -
🦾 Installation -
🎮 Usage -
⚙️ Defaults -
🩺 Debugging -
🎥 Preview
👁
Overview
XBase enables you to build, watch, and run xcode products from within your favorite editor. It supports running products on iOS, watchOS and tvOS simulators, along with real-time logging, and some lsp features such as auto-completion and code navigation. (
Furthermore, XBase has built-in support for a variety of XCode project generators, which allow you to avoid launching XCode or manually editing '*.xcodeproj' anytime you add or remove files. We strongly advise you to use one ... at least till XBase supports adding/removing files and folders, along with other requirements. (
- Watch XBase repo to remain up to date on fresh improvements and exciting new features.
- Checkout Milestones for planned future features and releases.
- Visit CONTRIBUTING.md to have your setup to start contributing and support the project.
Please be aware that XBase is still WIP, so don't hesitate to report bugs, ask questions or suggest new exciting features.
🌝
Motivation
I chose to dive into iOS/macOS app development after purchasing an M1 MacBook. However, coming from vim/shell environment and being extremely keyboard oriented, I couldn't handle the transition to a closed sourced, opinionated, mouse-driven development environment. I've considered alternatives like XVim2 and the built-in vim emulator, however still, I'd catch myself frequently hunting for my mouse.
As a long-time vim user who has previously developed a several lua/nvim plugins, I decided to invest some effort in simplifying my development workflow for producing 'xOS' products.
🌟
Features
- Auto-Completion and Code navigation
Auto-generate compilation database on directory changes + a custom build server that assists sourcekit-lsp in providing code navigation and auto-completion for project symbols. - Multi-nvim instance support
Multiple nvim instance support without process duplications and shared state. For instance, you can stop a watch service that was being run from a different instance. - Auto-start/stop main background daemon
Daemon will start and stop automatically based on the number of connected client instances. - Multi Target/Project Support
Work on multiple projects at one nvim instance at the same time. TODO - Simulator Support
Run your products on simulators relative to your target's platform. (+ watch build and ran on change) - Runtime/Build Logging
Real-time logging of build logs and 'print()' commands - Statusline Support
Global variable to update statusline with build/run commands, see Statusline - Zero Footprint
Light resource usage. I've been using XBase for a while; it typically uses 0.1 percent RAM and 0 percent CPU. - Multi XCodeProj Support
Auto-generate xcodeproj, when it doesn't exists, generator config files a updated or new files/directories added or removed.
💆
Generators
XBase primarily supports two project generators: XcodeGen and Tuist.
XCodeGen is recommended if you are just starting started with xcodeproj generators since it is considerably simpler with a yml-based configuration language. Having said that, Tuist is more powerful and packed with features, of which xcodeproj generation is but one.
XBase's support for generators is available in the following forms:
- Identification.
- Auto-generate xcodeproj if you haven't haven't generate it by hand.
- Auto-generate xcodeproj when you edit the generator config files.
- Auto-compile project when xcodeproj get regenerated.
- Code Completion and navigation (#tuist)
Limitations
XCodeGen
- No support for custom named yml config files, only
project.yml.
Other Generators
With current XBase architecture, it should be pretty easy to add support for yet another awesome xcodeproj generator. feel free to get started with CONTRIBUTING.md or open a github issue
🛠
Requirements
- neovim v0.7.0 or nightly
- rust 1.60.0 or up (see rust getting started)
- telescope.nvim
- plenary.nvim
🦾
Installation
To install XBase on your system you need run make install. This will run cargo build --release on all the required binaries in addition to a lua library. The binaries will be moved to path/to/repo/bin and the lua library will be moved to path/to/repo/lua/libxbase.so.
With packer
use {
'tami5/xbase',
run = 'make install',
requires = {
"nvim-lua/plenary.nvim",
"nvim-telescope/telescope.nvim"
},
config = function()
require'xbase'.setup({}) -- see default configuration bellow
end
}
With vim-plug
Plug 'nvim-lua/plenary.nvim'
Plug 'nvim-telescope/telescope.nvim'
Plug 'tami5/xbase', { 'do': 'make install' }
lua require'xbase'.setup()
With dein
call dein#add('nvim-lua/plenary.nvim')
call dein#add('nvim-telescope/telescope.nvim')
call dein#add('tami5/xbase', { 'build': 'make install' })
lua require'xbase'.setup()
🎮
Usage
TLDR:
- Install XBase
- run
require'xbase'.setup({ --[[ see default configuration ]] }) - Open xcodeproj codebase.
- Wait for first time project setup finish.
- Start coding
- Use available actions which can be configure with shortcuts bellow
When you start a neovim instance with a root that contains project.yml, Project.swift, or *.xcodeproj, the daemon server will auto-start if no instance is running, and register the project once for recompile-watch. To communicate with your deamon, checkout the configurable shortcuts.
Statusline
XBase provide feline provider, other statusline plugins support are welcomed. However, using vim.g.xbase_watch_build_status you can easily setup statusline indicators.
require("xbase.util").feline_provider() -- append to feline setup function
⚙️
Defaults
-- NOTE: Defaults
{
--- Log level. Set to error to ignore everything: { "trace", "debug", "info", "warn", "error" }
log_level = "debug",
--- Default log buffer direction: { "horizontal", "vertical", "float" }
default_log_buffer_direction = "horizontal",
--- Statusline provider configurations
statusline = {
watching = { icon = "", color = "#1abc9c" },
running = { icon = "⚙", color = "#e0af68" },
device_running = { icon = "", color = "#4a6edb" },
success = { icon = "", color = "#1abc9c" },
failure = { icon = "", color = "#db4b4b" },
show_progress = false,
},
--- TODO(nvim): Limit devices platform to select from
simctl = {
iOS = {
"iPhone 13 Pro",
"iPad (9th generation)",
},
},
mappings = {
--- Whether xbase mapping should be disabled.
enable = true,
--- Open build picker. showing targets and configuration.
build_picker = "<leader>b", --- set to 0 to disable
--- Open run picker. showing targets, devices and configuration
run_picker = "<leader>r", --- set to 0 to disable
--- Open watch picker. showing run or build, targets, devices and configuration
watch_picker = "<leader>s", --- set to 0 to disable
--- A list of all the previous pickers
all_picker = "<leader>ef", --- set to 0 to disable
--- horizontal toggle log buffer
toggle_split_log_buffer = "<leader>ls",
--- vertical toggle log buffer
toggle_vsplit_log_buffer = "<leader>lv",
}
}
🩺
Debugging
Read logs
# Daemon logs
tail -f /tmp/xbase-daemon.log
# Build Server logs
tail -f /tmp/xbase-server.log
🎥
Preview
Watch build service.
On error it opens a log buffer where you can inspect what went wrong, otherwise only the statusline get updated.
![[logger] append title](https://avatars.githubusercontent.com/in/15368?v=4)
193 Dec 28, 2022
9.3k Jan 5, 2023
520 Dec 25, 2022
4 Aug 5, 2022
4 Mar 5, 2023
34 Mar 18, 2023
66 Apr 9, 2023
189 Jun 23, 2023
690 Jun 29, 2023
3 Mar 30, 2024
39 May 6, 2024
20.3k Jan 8, 2023
8.7k Dec 31, 2022
3.6k Dec 30, 2022
1.4k Dec 29, 2022
5k Jan 1, 2023
292 Jan 9, 2023
6 Jan 24, 2022