nad

v0.2.1

Node Addon Developer, a tool to inject your addon code into a copy of the node codebase in order to integrate with IDEs and debuggers easily. For more information about how to use this package see README

Latest version published 10 years ago

License: MIT

Package Health Score

39 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Limited

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
0.2.1	\|	02/2015	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.0	\|	01/2015		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.0.4	\|	09/2014		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

No

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (5)

GitHub Stars: 75
Forks: 5
Contributors: 2

Direct Usage Popularity

The npm package nad receives a total of 5 downloads a week. As such, we scored nad popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package nad, we found that it has been starred 75 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 2
Funding: Yes

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like nad is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 4
Open PR: 1
Last Release: 10 years ago
Last Commit: 10 years ago

Further analysis of the maintenance status of nad based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for nad is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 10 years
Dependencies: 8 Direct
Versions: 8
Install Size: 0 B
Dist-tags: 1
# of Files: 0
Maintainers: 1
TS Typings: No

nad has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

nad

Node Addon Developer, a tool to inject your addon code into a copy of the node codebase in order to integrate with IDEs and debuggers easily.

level-sample

Installation

npm install -g nad

Getting Started

nad init my-addon
cd my-addon

## Try the node-gyp build
node ./my-addon.js

## Generate Xcode project and open it (nad build runs nad configure automatically with defaults)
## By default nad builds with Ninja (brew install ninja). Run "nad configure --make" to build with Make instead.
nad build
nad open

## Select node target in Xcode and try to build if it fails see ## Caveats and nad fix

Changes To Your Code

nad uses your binding.gyp file to determine what to inject into the node build
however in order for the binding resolution to work when you run it as an addon as well as when you run it from within node, do the following

Install nad-bindings:

npm install -S nad-bindings

Replace binding resolution in your addon. As an example here is the diff for leveldown:

-    , binding           = require('bindings')('leveldown.node').leveldown
+    , binding           = require('nad-bindings')('leveldown').leveldown

CLI

nad init

Initializes nad project in current dir, i.e. nad init my-addon

nad configure

usage: nad configure  

  Overrides configuration options for building your node addon project.

OPTIONS:

  -h, --help      Print this help message.
  --cc            C compiler to use (default: clang)
  --cxx           C++ compiler to use (default: clang++)
  --link          Linker to use (default: clang++)
  --target        node version into which to inject the addon (default: version of node in path or --nodedir)
  --nodedir       Directory that contains source code of node into which to inject the addon (overrides target) (default: ./node-)
  --nodename      Name of the node you are using, defaults to iojs.
  --make          By default nad builds with Ninja cause it's much faster. In order to use make instead supply this flag.

Once `nad configure` ran successfully use `nad build` to build with your addon.

EXAMPLES:

  # Fetch and compile node v0.10.31 with gcc, link with ld
  nad configure --cc gcc --cxx gcc --link ld --target 0.10.31

  # Use the node installation we cloned locally
  nad configure --nodedir ../node

nad build

Injects project in current folder into node build and rebuilds it.

nad open

Opens the Xcode project for the addon in the current folder.

nad fetch

Fetches source for configured node version.

nad inject

Injects project in current folder into node build.

nad restore

Restores node build to its original state by removing the addon project that was injected previously.

nad help

Prints help about nad configure

Caveats

For `node

nad::injectNodeExtensions(node_extensions_h_file, node_extensions_cc_file, extensions, cb)

Injects source into node_extensions.h file to include NODE_EXT_LIST_ITEM macro calls for all valid targets of the addon.

This is only necessary for node < v0.11 since node_extensions.h and node_extensions.cc drastically changed during 0.11 development until they completely disappeared around v0.11.12. Starting with v0.11.13 an addon module can be loaded dynamically even if it is not registered in the source code.

Example

For targets [ 'node_foo', 'node_bar' ] it injects following code into node_extensions.h

/* START nad INJECTION, PLEASE DO NOT REMOVE /
#ifdef NODE_FOO_ADDON
NODE_EXT_LIST_ITEM(node_bar)
#endif
#ifdef NODE_BAR_ADDON
NODE_EXT_LIST_ITEM(node_bar)
#endif
/* END nad INJECTION, PLEASE DO NOT REMOVE /

Then it modifies node_extensions.cc in order to find our addons even if they don't start with node_.

Parameters:

Name	Type	Description
`node_extensions_h_file`	string	full path to `node_extensions.h`
`node_extensions_cc_file`	string	full path to `node_extensions.cc`
`extensions`	Array.<string>	the extensions to insert
`cb`	function	called back when injection is completed

Source:

inject-node_extensions.js , lineno 10

nad::injectNodeGyp(projectDir, nodeDir, cb)

Injects necessary adjustments into node.gyp in order to include files of the addon found inside binding.gyp in the node build.

Parameters:

Name	Type	Description
`projectDir`	string	full path to the directory of the addon project (where the `binding.gyp` file lives)
`nodeDir`	string	full path to the directory at which the node source code is located (alongside `node.gyp`)
`cb`	function	invoked when finished

Source:

inject-node_gyp.js , lineno 13

generated with docme

License

MIT

nad dependencies

gyp-reader minimist mkdirp npmlog semver update-section xtend yawn

nad development dependencies

FAQs

What is nad?

Node Addon Developer, a tool to inject your addon code into a copy of the node codebase in order to integrate with IDEs... Visit Snyk Advisor to see a full health score report for nad, including popularity, security, maintenance & community analysis.

Is nad popular?

The npm package nad receives a total of 5 weekly downloads. As such, nad popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is nad well maintained?

We found indications that nad is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is nad safe to use?

While scanning the latest version of nad, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 20 December-2024, at 07:08 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected