Skip to content

Latest commit

 

History

History
305 lines (239 loc) · 7.58 KB

README.md

File metadata and controls

305 lines (239 loc) · 7.58 KB
Raw

Linux macOS Windows

Intro

A cargo-like modern cpp build tools, aimed to combine all existing best practices, rather than re-inventing them from scratch.

  • dependency management: conan2
    • you can also directly declare a header-only lib on git as a dependency since we already have tons of such libs
    • you can also directly declare a cppship lib on git as a dependency
    • we will not support import arbitrary libs on git since it will make our package less composable
  • build: cmake
    • Cppship use cmake as the underlying build tool
    • You can also run cppship cmake to convert a cppship project to CMake project
  • tests: google test
  • benches: google bench
  • format: clang-format
  • lint: clang-tidy

Further details can be found in wiki

Goals

  • Super easy to start a new project without any googling and boilerplate code
  • Super easy to use a thirdparty package
  • Packages can be composed arbitrarily
  • Newbees can create a standard project easily, including tests, benchmarks, examples, documents, format, lint
  • Do simple things simple, but reserve mechanism for hard things

The above goals are achieved by the following features:

  • Use cppship init <name> or cppship init --lib <name> to start a new project
  • Use conan2 to import dependencies
    • You can also import a header-only package on git or a cppship package on git
    • Git-based dependencies are not stable, and is subject to change
  • Cppship packages can import other cppship packages as dependencies (not stable now)
  • Creating a test, benchmark, example only involves a single file creation
  • Project structure are standardized, by default you only need to create cpp files and cppship run or cppship test or cppship bench without any configuration or boilerplate code

Demo

demo

Install

Predefined packages

MacOS

$ brew install qqiangwu/tap/cppship

Linux

Try homebrew, or build it yourself, see below.

CMake

We can use cmake to build cppship

mkdir build
cmake -B build -S . -DCMAKE_BUILD_TYPE=Debug -DCMAKE_EXPORT_COMPILE_COMMANDS=ON

cmake --build build -j8
cmake --build build -j8 --target install

Cppship

We can also use cppship to build cppship

# install
cppship install

Tutorial

Cppship will generate cmake projects based on your directory structure and cppship.toml.

See examples

cppship.toml

[package]
# (required) your lib or binary name
name = "cppship"
# (required)
version = "0.0.1"
authors = []
# (optional) specifiy you cppstd
std = 20

[dependencies]
# conan dependencies
boost = { version = "1.81.0", components = ["headers"], options = { header_only = true } }
toml11 = "3.7.1"
fmt = "9.1.0"
range-v3 = "0.12.0"
bshoshany-thread-pool = "3.3.0"
ms-gsl = "4.0.0"
argparse = "2.9"
spdlog = "1.11.0"
# git header-only libs
scope_guard = { git = "https://github.com/Neargye/scope_guard.git", commit = "fa60305b5805dcd872b3c60d0bc517c505f99502" }

# git cppship header only lib
header_only = { git = "https://github.com/cppship/demo_header_only.git", commit = "93f6793" }

# git cppship lib
simple_lib = { git = "https://github.com/cppship/demo_lib.git", commit = "25dbedf" }

[dev-dependencies]
scnlib = "1.1.2"

[profile]
definitions = ["BOOST_PROCESS_USE_STD_FS"]
ubsan = true
asan = true
tsan = false
leak = false

[target.'cfg(not(compiler = "msvc"))'.profile]
cxxflags = ["-Wall", "-Wextra", "-Werror", "-Wno-unused-parameter", "-Wno-missing-field-initializers"]

[target.'cfg(compiler = "msvc")'.profile]
cxxflags = ["/Zc:__cplusplus", "/Zc:preprocessor", "/MP"]

[profile.debug]
# appends to cxxflags in [profile]
cxxflags = ["-g"]

# merged with definitions in [profile]
definitions = ["C"]

[profile.release]
# appends to cxxflags in [profile]
cxxflags = ["-O3", "-DNDEBUG"]

header-only lib

make sure your project have the following structure:

  • include: lib include dir
  • tests: test cpp files go here, optional, lib will be its dependency

lib

make sure your project have the following structure:

  • include: lib include dir
  • lib: lib cpp files go here
  • tests: test cpp files go here, optional, lib will be its dependency

binary

make sure your project have the following structure:

  • src: binary cpp files go here, currently only one binary is supported

lib + binary

  • include: lib include dir
  • lib: lib cpp files go here
  • src: bin cpp files go here, lib will be its dependency
  • tests: test cpp files go here, optional, lib and gtest will be its dependency

multiple binaries

  • src/main.cpp: primary binary named with your project name
  • src/bin/xxx.cpp: binary xxx
  • src/bin/yyy.cpp: binary yyy

inner tests

  • lib/a_test.cpp: will be viewed as a test
  • lib/sub/b_test.cpp: will be viewed as a test

examples

  • include
  • lib
  • src
  • tests
  • examples
    • ex1.cpp: depends on lib
    • ex2.cpp: depends on lib

benchmarks

  • benches
    • b1.cpp: depends on lib, google benchmark
    • b2.cpp: depends on lib, google benchmark

Convert to cmake project

You can easily convert a cppship project into a cmake project:

# CMakeFiles.txt and conanfiles.txt will be generated under the project root dir
cppship cmake

# Build with cmake
cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug
cmake --build build

Usage

Init

# init a binary
cppship init demo
cd demo
cppship run
cppship test

# init a library
cppship init demolib --lib
cd demolib
cppship build

build

# debug build
cppship build

# release build
cppship build -r

# dry-run, config cmake and generate compile_commands.json under build
cppship build -d

# build tests only
cppship build --tests

# build examples only
cppship build --examples

# build benches only
cppship build --benches

# build binaries only
cppship build --bins

run

cppship run
cppship run -- a b c extra_args

# run a binary
cppship run --bin <name>

# run an example
cppship run --example <name>

test

cppship test
cppship test --rerun-failed
cppship test <testname>
cppship test -R <testname-regex>

bench

cppship bench

cppship bench <bench-name>

install

cppship install

clean

cppship clean

format

We will use clang-format to format our code

# by default, only format files changed since last commit
# dry-run and warn
cppship fmt
# only fmt git cached files
cppship fmt --cached
# fix it
cppship fmt -f

# reun against commit
cppship fmt -c <commit>

# format all files
cppship fmt -a
cppship fmt -a -f

lint

We will use clang-tidy to lint your code

# by default, only lint files changed since last commit
cppship lint
# lint git cached files
cppship lint --cached
# lint all
cppship lint -a
# lint against commit
cppship lint -c <commit>

Integration with VSCode

Now cppship has no extensions for VSCode, but use clangd is enough. Just write your project and run cppship build -d, which will create build/compile_commands.json. Clangd will find it and do its work.