0.1.1 • Published 6 years ago

node-qbs v0.1.1

Weekly downloads
3
License
MIT
Repository
github
Last release
6 years ago

Node Qbs

NPM

A Qbs-based build system for Node.js native modules

Usage

To use this package, add the module node-qbs to your package.json as a development dependency:

npm install --save-dev node-qbs

Then do ./node_modules/.bin/nqbs init in your package directory.

Use NodeAddon module like so:

Product {
  Depends { name: 'Node.Addon' }
}

Or Node.AddonProduct:

import Node

Node.AddonProduct {
}

Add to your package.json:

...
"scripts": {
    "install": "nqbs rebuild"
},
...

To require your addon use require('node-qbs')('Addon').

CLI command nqbs

Usage: nqbs <command> [options] -- [qbs-args]

Commands:

CommandSinceDescription
help0.0.1Show general or command-specific help.
init0.1.0Initialize project for node-qbs.
qbs0.0.1Translate to qbs.
build0.0.1Build native addon.
clean0.0.1Remove the files generated during a build.
rebuild0.0.1Runs clean and build in a row.
install node-version0.0.4Translate to node-gyp with --ensure option.
Installs node header files for the given version.
list0.0.4Translate to node-gyp. Lists the currently installed node header versions.
remove 0.0.4Translate to node-gyp. Removes the node header files for the given version.

Options:

OptionTypeSinceDescription
--helpboolean0.0.1Show help
--qbsstring0.0.1Path to qbs executable.
--profilestring0.0.6Qbs profile.
--npmstring0.0.1Path to npm executable.
--debug, -dboolean0.0.1Debug build variant.
--jobs, -j number0.0.1Use concurrent build jobs.
must be an integer greater than zero.
The default is the number of cores.
--pwd, --directory, -Cstring0.0.1Run command in different directory.
--archstring0.0.1Set target architecture.
--node-version, --target, -tstring0.0.1Node version to build for. []
--devdirstring0.0.1SDK download directory.
--versionboolean0.0.1Show version number

Node module

It is devided in to submodules:

  • Headers (for node and v8 headers),
  • Nan (for Native Abstractions for Node.js headers)
  • and Addon (for both).

Has Probes: HeadersProbe and NanProbe.

And AddonProduct, which has all you need for node addon.

Node.Headers module

Wraps Node.HeadersProbe, and has same properties.

PropertyTypeSinceDefaultDescription
nodestring0.0.1"node"Path to node executable.
npmstring0.0.4"npm"Path to npm executable.
devdirstring0.0.1"~/.node-gyp"SDK download directory.
versionstring0.0.1node --versionNode version to build for.

Node.Nan module

Wraps Node.NanProbe, and has same properties.

PropertyTypeSinceDefaultDescription
nodestring0.0.1"node"Path to node executable.
npmstring0.0.4"npm"Path to npm executable.

Node.Addon module

Depends on Headers and Nan. Wraps their properties.

PropertyTypeSinceDefaultDescription
installAddonbool0.0.2trueInstall or not node.addon product.
nanbool0.0.1trueUse Nan module

Provide file tags:

TagSinceDescription
"node.addon"0.0.1This tag is attached to node addons
0.2.1

3 years ago

0.2.0

3 years ago

0.2.3

3 years ago

0.2.2

3 years ago

0.2.4

3 years ago

0.1.1

6 years ago

0.1.0

6 years ago

0.0.9

6 years ago

0.0.8

6 years ago

0.0.7

6 years ago

0.0.6

6 years ago

0.0.5

6 years ago

0.0.4

6 years ago

0.0.3

6 years ago

0.0.2

6 years ago

0.0.1

6 years ago