Skip to content

Opinionated build system generator based on CMake

License

Notifications You must be signed in to change notification settings

holepunchto/bare-make

Repository files navigation

bare-make

Opinionated build system generator based on CMake. It generates build files for Ninja using Clang as the compiler toolchain across all supported systems, ensuring a consistent and reliable compilation process. Beyond forcing the build system and compiler toolchain, everything is still plain CMake, making it easy to eject to the normal CMake flow as necessary.

npm i [-g] bare-make

Usage

Like CMake, builds happen in three steps: You first generate a build system, then run the build system, and finally install the built artefacts. To perform the steps programmatically from JavaScript, do:

const make = require('bare-make')

await make.generate()
await make.build()
await make.install()

The steps can also be performed interactively from the command line using the included CLI:

bare-make generate
bare-make build
bare-make install

Testing

To run tests for projects that use enable_testing() and add_test(), do:

await make.test()

Tests can also be run from the command line:

bare-make test

API

await generate([options])

Options include:

options = {
  source: '.',
  build: 'build',
  platform: os.platform(),
  arch: os.arch(),
  simulator: false,
  cache: true,
  sanitize,
  debug,
  withDebugSymbols,
  withMinimalSize,
  define,
  cwd: path.resolve('.'),
  verbose: false,
  stdio
}

await build([options])

Options include:

options = {
  build: 'build',
  target,
  clean: false,
  parallel,
  cwd: path.resolve('.'),
  verbose: false,
  stdio
}

await install([options])

Options include:

options = {
  build: 'build',
  prefix: 'prebuilds',
  component,
  link: false,
  strip: false,
  parallel,
  cwd: path.resolve('.'),
  verbose: false,
  stdio
}

await test([options])

Options include:

options = {
  build: 'build',
  timeout: 30,
  parallel,
  cwd: path.resolve('.'),
  verbose: false,
  stdio
}

CLI

bare-make generate [flags]

Flags include:

--source|-s <path>
--build|-b <path>
--platform|-p <name>
--arch|-a <name>
--simulator
--no-cache
--debug|-d
--with-debug-symbols
--with-minimal-size
--sanitize <name>
--define|-D <var>[:<type>]=<value>
--verbose
--help|-h

bare-make build [flags]

Flags include:

--build|-b <path>
--target|-t <name>
--clean|-c
--parallel|-j <number>
--verbose
--help|-h

bare-make install [flags]

Flags include:

--build|-b <path>
--prefix|-p <path>
--component|-c <name>
--link|-l
--strip|-s
--parallel|-j <number>
--verbose
--help|-h

bare-make test [flags]

Flags include:

--build|-b <path>
--timeout <seconds>
--parallel|-j <number>
--verbose
--help|-h

License

Apache-2.0

About

Opinionated build system generator based on CMake

Resources

License

Stars

Watchers

Forks