gnm

generator-napi-module

A yeoman generator to create a next-generation Node native module using N-API

Showing:

Popularity

Downloads/wk

4

GitHub Stars

34

Maintenance

Last Commit

3yrs ago

Contributors

5

Package

Dependencies

6

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

generator-napi-module NPM version Build Status Dependency Status

A yeoman generator to create a next-generation Node native module using N-API

Use this module to quickly generate a skeleton module using N-API, the new API for Native addons introduced in Node 8. This module automatically sets up your gyp files to use node-addon-api, the C++ wrappers for N-API and generates a wrapper JS module. Optionally, it can even configure the generated project to use TypeScript instead!

Installation

First, install Yeoman and generator-napi-module using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-napi-module

Create a directory for your N-API module:

mkdir <moduleName>
cd <moduleName>

Then generate your new project:

yo napi-module

This will generate a really simple N-API module- think of this as the Hello world of N-API modules. If you want a slightly more complicated module that is similar to what you'd write in a real world N-API module, run the following command:

yo napi-module --intermediate

Getting To Know Yeoman

  • Yeoman has a heart of gold.
  • Yeoman is a person with feelings and opinions, but is very easy to work with.
  • Yeoman can be too opinionated at times but is easily convinced not to be.
  • Feel free to learn more about Yeoman.

Contributing

This project accepts pull requests! To contribute a change:

  1. Fork this repo
  2. Run npm install to install your dependencies
  3. Make your changes
  4. Run npm run build to compile the TypeScript file
  5. Run npm run test to verify that the unit tests pass
  6. Run npm link to "install" your generator
  7. Create a scratch directory: 7.1. Run yo napi-module 7.2. Run npm test

If all looks good, submit your PR!

License

MIT © Hitesh Kanwathirtha

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial