Skip to content

Latest commit

 

History

History
157 lines (122 loc) · 3.64 KB

README.md

File metadata and controls

157 lines (122 loc) · 3.64 KB
Raw

SYNOPSIS

Hyper-build is an opinionated c++ build-tool and package manager. It uses git and node.js. It's made for use with the datcxx project, see this page.

INSTALL

npm install -g datcxx/hyper-build

USAGE

All projects must have a package.json.

build -h

INIT

Use the init command to automatically create a package.json file.

build init

ADD DEPENDENCY

Use the add command to add a dependency.

build add foo/bar

Adding a dependency with a hash will lock the dependency and install that exact commit at install-time. Without a hash, the dependency will get assigned the latest commit hash of the remote at install-time.

build add foo/bar ceda12f

ADD DEV DEPENDENCY

Use the add command with the -d flag to add a development dependency.

build add -d foo/bar

INSTALL DEPENDENCIES

Use the -i flag to recursively install dependencies.

build -i

TESTING

Use the test command to run the test script from the package.json. This will automatically discover and use all of dependecy headers and source files. This will check for and try to run pretest and posttest scripts if possible.

build test

BUILDING

To build your project, don't specify any commands just type build. Use the DEBUG=true environment variable if you want to print what the compiler is being asked to do. The build tool will discover all dependecy headers and source files.

build

When no command is specified, all flags are passed to the compiler. For example following flags are sent to the compiler.

build -g -O0

PACKAGE.JSON

FIELDS

name

Name is required. But unlike npm the name and version do not create a unique identity in the world for your package. In fact, version is not used at all.

description

Put a description in it. It’s a string. This helps you remember what the package does.

files

A list of files to include. Nothing is included by default. Does not currently support globs.

repository

A string that specifies the place where the code lives. This is helpful for people who want to contribute.

scripts

The “scripts” property is a dictionary containing script commands that are run at various times in the lifecycle of your package. The key is the lifecycle event, and the value is the command to run at that point. The following scripts are supported.

  • install Run AFTER the package is installed.
  • pretest Run BEFORE the test command.
  • test Run by the test command.
  • posttest Run AFTER the test command.

The test script is special because it will automatically discover headers and compilation units needed by your dependencies.

You can also create your own arbitrary scripts and run them with the command build run <script-name>.

The compiler property (Optional, string) defaults to clang++.

EXAMPLE

{
  "name": "hypercore",
  "description": "Hypercore is a secure, distributed append-only log.",
  "repository": "git@github.com:datcxx/cxx-hypercore.git",
  "dependencies": {
    "git@github.com:datcxx/cxx-flat-tree": "c051eac4"
  },
  "devDependencies": {
    "git@github.com:heapwolf/cxx-tap": "a255ffb3"
  },
  "scripts": {
    "test": [
      "clang++ -std=c++2a -stdlib=libc++",
      "test/index.cxx lib/hypercore.so -o test/index",
      "&& ./test/index"
    ],
    "greeting": "echo Hello, World"
  },
  "flags": [
    "-shared",
    "-stdlib=libc++",
    "-std=c++2a",
    "-ferror-limit=2",
    "-o ./lib/hypercore.so"
  ],
  "files": [
    "index.hxx",
    "index.cxx"
  ]
}