dev.md

XBase Development

This a quick guide to understand and edit xbase source code.

• Project Organization
• Development Setup

Project Organization

Here's an overview of the project architecture to help you contribute.

xbase source code

• Server Startup and OS Signal Handler Logic main.rs
• State Initialization and Access Logic state.rs
• Server/Client Logic (server/*)
  • Request Definition and Handler request.rs
  • Response Definition response.rs
  • Client Handler stream.rs
  • Register Handler register.rs
  • Drop Handler drop.rs
  • Run Handler run.rs
  • Build Handler build.rs
  • Runners Handler runners.rs
  • ProjectInfo Handler project_info.rs
• Project Runtime runtime/*
  • Messages that can be processed by Project Runtime
• Project Running runner/*
• Project Watching watcher/*
• Project Supportproject/*
  • XCodeGen Project Support xcodegen.rs
  • Tuist Project Support tuist.rs
  • Barebone Project Support barebone.rs
  • Swift Package Support swift.rs
• General Purpose Types types.rs
• Serializable/Deserializable Errors error.rs

sourcekit-helper crate

Build server implementing BSP protocol required because sourcekit-lsp can't define compile arguments required to jump to definition and symbol definition.

Development Setup

Clone the repo

git clone https://github.com/xbase-lab/xbase

Install in debug mode

Do all the setup required to watch and develop

make install_debug

Start watchers

Watch all the products and trigger recompile when the source code changes.

make watch