Purpose

This toolchain transcompiles W3C Web IDL and Version 2 to the NAN C++ code. This tool improve efficiency of Node.js Addon developing, allows developers focus on spec definition and actual implementation codes.

This bindings code is highly repetitive, primarily passing values (arguments and return values) between V8 and native and doing various conversions and checks (e.g., type checking), hence it is mostly machine-generated.

Quick Start

Init workspace

npm init

Install widl-nan

npm install --save ssh://git@github.com/01org/widl-nan.git

Compile your Web IDL

./node_modules/.bin/widl-nan <your_widl_file>

Check Web IDL examples under https://github.com/01org/widl-nan/tree/master/test, basically each supported feature has a test case.

(Optional) Init helper files.

./node_modules/.bin/widl-nan -i

Or you need write the implementation C++ files, binding.gyp and addon.cpp from scratch.

Build the addon

node-gyp rebuild

Contribution

Coding style guideline

We're following Chromium coding style for different languages: C++, Python and JavaScript. Please run style checker python ./tools/lint.py before submitting your code. depot_tools need to be installed and added to PATH env.

Commit message guideline

A comprehensive commit message will help reviewer to understand what your PR is trying to resolve. There are lots of article to share experience how to write a good commit message, please Google them or check any commit message on mature projects. For eg: https://cs.chromium.org/

To close a related issue, we highly suggest to use Closing issues via commit messages format, for eg: Fixes.

License

The MIT License (MIT)

Copyright (c) 2016 Intel Corporation. All rights reserved.

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.