caio/clice

Files

ykiko c14b8de18f chore: remove xmake, clean up unused files, simplify CLI parsing (#392 )

## Summary
- **Remove xmake build system**: delete `xmake.lua`, `test-xmake.yml`
workflow, and all xmake-related pixi tasks
- **Migrate packaging to CMake**: `publish-clice.yml` now uses `cmake
-DCLICE_RELEASE=ON` instead of xmake pack
- **Clean up**: remove unused `tests/uv.lock`, `.xmake/` from
`.gitignore`, xmake references from docs
- **Benchmark CI**: change trigger from `pull_request` to
`workflow_dispatch` (manual only)
- **Simplify CLI parsing**: use `DecoKV(style =
KVStyle::JoinedOrSeparate)` in `clice.cc` and `unit_tests.cc`, replacing
verbose `DecoKVStyled` with manual `static_cast` bitmask; use comma
separators; explicit `names` only for underscore fields

## Test plan
- [x] `pixi run cmake-build RelWithDebInfo` compiles successfully
- [x] Verify `pixi run test` passes
- [x] Verify `pixi run package` produces correct archives via CMake
release build
- [x] Verify benchmark workflow can be triggered manually via `gh
workflow run benchmark`

🤖 Generated with [Claude Code](https://claude.com/claude-code)

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Chores**
* Consolidated CI workflows; some automated triggers converted to manual
invocation
* Standardized shell for workflow steps and removed legacy build
workflow
* Switched packaging/build tasks to a CMake/Ninja flow and updated
artifact paths
  * Adjusted ignore rules to include previously-ignored build metadata

* **Documentation**
* Removed XMake-specific build and test instructions; docs now reflect
the CMake-based workflow

* **Style**
* Updated CLI option declaration style (no user-facing flag name
changes)

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

2026-04-05 17:33:20 +08:00

4.0 KiB

Raw Blame History

Build from Source

clice depends on C++23 features and requires a modern C++ toolchain. We also need to link against LLVM/Clang to parse ASTs. To speed up builds, the default configuration downloads our published clice-llvm prebuilt package. This assumes your local environment matches the prebuilt environment closely (especially when enabling Address Sanitizer or LTO).

To simplify setup and keep builds reproducible, we strongly recommend pixi to manage the development environment. Dependency versions are pinned in pixi.toml.

If you prefer not to use pixi, see Manual Build below.

Quick Start

Install pixi following the official guide.

We ship several tasks; the commands below configure, build, and run tests:

# configure && build (default RelWithDebInfo)
pixi run build

# unit && integration
pixi run test

For finer-grained tasks (first argument sets the build type):

pixi run cmake-config Debug
pixi run cmake-build Debug
pixi run unit-test Debug
pixi run integration-test Debug

Tip

If you want to develop directly with cmake, ninja, clang++, etc., run pixi shell to enter a shell with all env vars configured.

Manual Build

If you plan to build manually, first ensure your toolchain matches the versions defined in pixi.toml.

Compatibility: In theory clice does not rely on compiler-specific extensions, so mainstream compilers (GCC/Clang/MSVC) should work. However, CI only guarantees specific versions of Clang. Other compilers or versions are supported on a best-effort basis. Please open an issue or PR if you hit problems.

CMake

cmake -B build -G Ninja \
    -DCMAKE_BUILD_TYPE=RelWithDebInfo \
    -DCMAKE_TOOLCHAIN_FILE=cmake/toolchain.cmake \
    -DCLICE_ENABLE_TEST=ON

Note: CMAKE_TOOLCHAIN_FILE is optional. If your toolchain exactly matches ours, you can use the predefined cmake/toolchain.cmake; otherwise remove that flag.

Optional build options:

Option	Default	Effect
LLVM_INSTALL_PATH	""	Build clice with LLVM from a custom path
CLICE_ENABLE_TEST	OFF	Build clice unit tests
CLICE_USE_LIBCXX	OFF	Build clice with libc++ (adds `-std=libc++`); if enabled, ensure the LLVM libs are also built with libc++
CLICE_CI_ENVIRONMENT	OFF	Enable the `CLICE_CI_ENVIRONMENT` macro; some tests only run in CI

About LLVM

clice calls Clang APIs to parse C++ code, so it must link against LLVM/Clang. Because clice uses Clang's private headers (usually absent from distro packages), the system LLVM package cannot be used directly.

Two ways to satisfy this dependency:

We publish prebuilt binaries of the LLVM version we use at clice-llvm for CI and release builds. During builds, cmake downloads these LLVM libs by default.

Important

For debug LLVM builds, we enable address sanitizer, which depends on compiler-rt and is very sensitive to compiler version. If you use a debug build, ensure your clang compiler-rt version matches the one defined in pixi.toml.

Build LLVM/Clang yourself to match your environment. If the default prebuilt binaries fail due to ABI or library version mismatches, or you need a custom debug build, use this approach. We provide scripts/build-llvm.py to build the required LLVM libs, or refer to LLVM's official guide Building LLVM with CMake.

4.0 KiB Raw Blame History