gypkg

A GYP-based package manager for C projects.

Why?

GYP is a very lovely way to manage dependencies, however the amount of the boilerplate code required to build the project is very huge:

• Project's own gyp repository checkout
• common.gypi file with default compiler warning flags, etc
• gyp_project_name executable python script that sets proper GYP defines and executes gyp_main.py
• Dependencies has to be checked out into the project tree
• Subdependencies can't be easily shared between different dependencies (a depends on b and c; b depends on c)

All of this has to be repeated in every project, but fear not - gypkg fixes this and also a dependency management problem as well.

Installation

# Node.js is required to run this
npm install -g gypkg

Usage

A .gyp file for a C project may be written like this:

{
  "targets": [{
    "target_name": "proj",

    # So far this returns only `static_library`
    "type": "<!(gypkg type)",

    "variables": {
      "gypkg_deps": [
        # repo-addr@semver => path/to/file.gyp:target_name
        "git://github.com/libuv/libuv@^1.9.1 => uv.gyp:libuv",
      ],
    },

    "dependencies": [
      "<!@(gypkg deps <(gypkg_deps))"
    ],

    "direct_dependent_settings": [
      "include_dirs": [ "include" ],
    ],

    "sources": [
      "src/main.c",
    ],
  }]
}

Then a gypkg CLI tool can be used to generate a Makefile (or any other build system's file support by GYP):

gypkg gen file.gyp -- -Duv_library=static-library
make -C out/ -j9

gen command will install all dependencies into gypkg_deps and will update them automatically on next gen call.

Dependency management

gypkg supports local and remote (git) dependencies. Remote dependencies are installed into gypkg_deps/ folder in the root directory of the project (the one that has the main .gyp file). Nested dependencies still live in the same gypkg_deps/ in the root directory.

The syntax for declaring dependencies is:

• /path/to/dependency => /sub/path/to/main.gyp:target_name - use local dependency
• git://github.com/author/project => /path/to/main.gyp:target_name - checkout the latest commit of remote dependency. Note that (https:// and git@ are supported too)
• git://github.com/author/project#branch => /path/to/main.gyp:target_name - checkout particular branch/hash of remote dependency
• git://github.com/author/project@semver => /path/to/main.gyp:target_name - checkout whole repository and find the latest version-tag (the on that starts with v) that matches the particular semver.

See Usage section above, or Examples below for particular gist of how GYP file may look like.

Examples

• file-shooter.gyp

LICENSE

This software is licensed under the MIT License.

Copyright Fedor Indutny, 2016.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.