Skip to content

Latest commit

 

History

History
115 lines (80 loc) · 4.83 KB

README.md

File metadata and controls

115 lines (80 loc) · 4.83 KB
Raw

Blade Build System

license NewBSD Python Code Style Platform

██████╗ ██╗      █████╗ ██████╗ ███████╗
██╔══██╗██║     ██╔══██╗██╔══██╗██╔════╝
██████╔╝██║     ███████║██║  ██║█████╗
██╔══██╗██║     ██╔══██║██║  ██║██╔══╝
██████╔╝███████╗██║  ██║██████╔╝███████╗
╚═════╝ ╚══════╝╚═╝  ╚═╝╚═════╝ ╚══════╝

An easy-to-use, fast and modern build system for trunk based development in large-scale monorepo codebase.

Click here to read 中文文档.

Build Status

Build Status codebeat badge Coverage

Demo

First, let's see a cool demo:

asciicast

Releases

The code on the master branch is development version and should be considered as alpha version. Please prefer using the version on the tags in your formal environment. We will release the verified version on the large-scale internal code base to the tag from time to time.

  • Version 2.0 is in release candidate! It includes the following notable changes:

    • minimal python version 2.7, support python 3
    • Support Java, scala building
    • Full support to Python
    • Support custom extensions
    • Only use ninja as backend build system, increases speed dramatically.

Please follow the Upgrade Notes to upgrade.

Stargazers over time

Stargazers over time

Brief

Blade is designed to be a modern build system. It is powerful and easy to use. It supports building multiple languages, such as c/c++, java, python, scala, protobuf, etc. It analyzes the target dependency automatically and integrates compiling, linking, testing(includes incremental testing and parallel testing) and static code inspectiontogether. It aims to improve the clarity and simplicity of the building rules for a project.

With Blade, you can compile, link and test multiple targets by just inputting one simple command line. For example:

Build and test all targets in common directory recursively.

blade test common...

Build and test targets as 32 bit

blade test -m32 common...

Build and test targets as debug mode

blade test -pdebug common...

And you can combine the flags together:

blade test -m32 -pdebug common...

Features

  • Auto dependency analysis, includes header files and libraries.
  • Test integration: built-in support of gtest. Support incremental testing and parallel testing.
  • Simple syntax, easy to use.
  • Simple command line interface similar to git/svn.
  • Memory leak checking in tests(with gperftools).
  • Bash command line completion.
  • Colorful diagnostic message displaying.
  • Vim integration, includes syntax highlighting, quick fix.

Documentation

Credits

  • Blade is inspired by Google's public information about their build system. Here is a reference article from Google's official blog: build in cloud: how build system works.

    Later in 2015, they released it with partial rewritten as bazel open-source build system.

  • Blade generates Ninja script internally, so of course it depends on ninja.

  • Python is a powerful and easy-to-used language, we like python.

  • Some libraries open sourced by Google, such as protobuf, gtest, gperftools are handy and powerful, we have integrated these libraries.