Skip to content

Removing bug from package name. #2211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!--
Thank you for reporting an issue!

Remember, this issue tracker is for reporting issues ONLY with node-gyp.
Remember, this issue tracker is for reporting issues ONLY with node-nnabt.

If you have an issue installing a specific module, please file an issue on
that module's issue tracker (`npm issues modulename`). Open issue here only if
you are sure this is an issue with node-gyp, not with the module you are
you are sure this is an issue with node-nnabt, not with the module you are
trying to build.

Fill out the form below. We probably won't investigate an issue that does not
Expand All @@ -18,13 +18,13 @@ provide the basic information we require.
* **Compiler**: <!-- `cc -v` (UNIX) or `msbuild /version & cl` (Windows) -->
* **Module**: <!-- what you tried to build/install -->

<details><summary>Verbose output (from npm or node-gyp):</summary>
<details><summary>Verbose output (from npm or node-nnabt):</summary>

```
Paste your log here, between the backticks. It can be:
- npm --verbose output,
- or contents of npm-debug.log,
- or output of node-gyp rebuild --verbose.
- or output of node-nnabt rebuild --verbose.
Include the command you were trying to run.

This should look like this:
Expand Down
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
gyp/test
nnabt/test
node_modules
test/.node-gyp
test/.node-nnabt
.ncu
.nyc_output
package-lock.json
656 changes: 328 additions & 328 deletions CHANGELOG.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Contributing to node-gyp
# Contributing to node-nnabt

## Code of Conduct

Please read the
[Code of Conduct](https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md)
which explains the minimum behavior expectations for node-gyp contributors.
which explains the minimum behavior expectations for node-nnabt contributors.

<a id="developers-certificate-of-origin"></a>
## Developer's Certificate of Origin 1.1
Expand Down
70 changes: 35 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# `node-gyp` - Node.js native addon build tool
# `node-nnabt` - Node.js native addon build tool

[![Travis CI](https://travis-ci.com/nodejs/node-gyp.svg?branch=master)](https://travis-ci.com/nodejs/node-gyp)
[![Build Status](https://github.com/nodejs/node-gyp/workflows/Python_tests/badge.svg)](https://github.com/nodejs/node-gyp/actions?workflow=Python_tests)
[![Travis CI](https://travis-ci.com/nodejs/node-nnabt.svg?branch=master)](https://travis-ci.com/nodejs/node-nnabt)
[![Build Status](https://github.com/nodejs/node-nnabt/workflows/Python_tests/badge.svg)](https://github.com/nodejs/node-nnabt/actions?workflow=Python_tests)

`node-gyp` is a cross-platform command-line tool written in Node.js for
`node-nnabt` is a cross-platform command-line tool written in Node.js for
compiling native addon modules for Node.js. It contains a vendored copy of the
[gyp-next](https://github.com/nodejs/gyp-next) project that was previously used
[nnabt-next](https://github.com/nodejs/nnabt-next) project that was previously used
by the Chromium team, extended to support the development of Node.js native addons.

Note that `node-gyp` is _not_ used to build Node.js itself.
Note that `node-nnabt` is _not_ used to build Node.js itself.

Multiple target versions of Node.js are supported (i.e. `0.8`, ..., `4`, `5`, `6`,
etc.), regardless of what version of Node.js is actually installed on your system
(`node-gyp` downloads the necessary development files or headers for the target version).
(`node-nnabt` downloads the necessary development files or headers for the target version).

## Features

Expand All @@ -21,10 +21,10 @@ etc.), regardless of what version of Node.js is actually installed on your syste

## Installation

You can install `node-gyp` using `npm`:
You can install `node-nnabt` using `npm`:

``` bash
$ npm install -g node-gyp
$ npm install -g node-nnabt
```

Depending on your operating system, you will need to install:
Expand Down Expand Up @@ -65,17 +65,17 @@ Install tools and configuration manually:

### Configuring Python Dependency

`node-gyp` requires that you have installed a compatible version of Python, one of: v2.7, v3.5, v3.6,
`node-nnabt` requires that you have installed a compatible version of Python, one of: v2.7, v3.5, v3.6,
v3.7, or v3.8. If you have multiple Python versions installed, you can identify which Python
version `node-gyp` should use in one of the following ways:
version `node-nnabt` should use in one of the following ways:

1. by setting the `--python` command-line option, e.g.:

``` bash
$ node-gyp <command> --python /path/to/executable/python
$ node-nnabt <command> --python /path/to/executable/python
```

2. If `node-gyp` is called by way of `npm`, *and* you have multiple versions of
2. If `node-nnabt` is called by way of `npm`, *and* you have multiple versions of
Python installed, then you can set `npm`'s 'python' config key to the appropriate
value:

Expand Down Expand Up @@ -103,23 +103,23 @@ The next step is to generate the appropriate project build files for the current
platform. Use `configure` for that:

``` bash
$ node-gyp configure
$ node-nnabt configure
```

Auto-detection fails for Visual C++ Build Tools 2015, so `--msvs_version=2015`
needs to be added (not needed when run by npm as configured above):
``` bash
$ node-gyp configure --msvs_version=2015
$ node-nnabt configure --msvs_version=2015
```

__Note__: The `configure` step looks for a `binding.gyp` file in the current
directory to process. See below for instructions on creating a `binding.gyp` file.
__Note__: The `configure` step looks for a `binding.nnabt` file in the current
directory to process. See below for instructions on creating a `binding.nnabt` file.

Now you will have either a `Makefile` (on Unix platforms) or a `vcxproj` file
(on Windows) in the `build/` directory. Next, invoke the `build` command:

``` bash
$ node-gyp build
$ node-nnabt build
```

Now you have your compiled `.node` bindings file! The compiled bindings end up
Expand All @@ -129,13 +129,13 @@ you can require the `.node` file with Node.js and run your tests!
__Note:__ To create a _Debug_ build of the bindings file, pass the `--debug` (or
`-d`) switch when running either the `configure`, `build` or `rebuild` commands.

## The `binding.gyp` file
## The `binding.nnabt` file

A `binding.gyp` file describes the configuration to build your module, in a
A `binding.nnabt` file describes the configuration to build your module, in a
JSON-like format. This file gets placed in the root of your package, alongside
`package.json`.

A barebones `gyp` file appropriate for building a Node.js addon could look like:
A barebones `nnabt` file appropriate for building a Node.js addon could look like:

```python
{
Expand All @@ -150,17 +150,17 @@ A barebones `gyp` file appropriate for building a Node.js addon could look like:

## Further reading

Some additional resources for Node.js native addons and writing `gyp` configuration files:
Some additional resources for Node.js native addons and writing `nnabt` configuration files:

* ["Going Native" a nodeschool.io tutorial](http://nodeschool.io/#goingnative)
* ["Hello World" node addon example](https://github.com/nodejs/node/tree/master/test/addons/hello-world)
* [gyp user documentation](https://gyp.gsrc.io/docs/UserDocumentation.md)
* [gyp input format reference](https://gyp.gsrc.io/docs/InputFormatReference.md)
* [*"binding.gyp" files out in the wild* wiki page](https://github.com/nodejs/node-gyp/wiki/%22binding.gyp%22-files-out-in-the-wild)
* [nnabt user documentation](https://nnabt.gsrc.io/docs/UserDocumentation.md)
* [nnabt input format reference](https://nnabt.gsrc.io/docs/InputFormatReference.md)
* [*"binding.nnabt" files out in the wild* wiki page](https://github.com/nodejs/node-nnabt/wiki/%22binding.nnabt%22-files-out-in-the-wild)

## Commands

`node-gyp` responds to the following commands:
`node-nnabt` responds to the following commands:

| **Command** | **Description**
|:--------------|:---------------------------------------------------------------
Expand All @@ -176,7 +176,7 @@ Some additional resources for Node.js native addons and writing `gyp` configurat

## Command Options

`node-gyp` accepts the following command options:
`node-nnabt` accepts the following command options:

| **Command** | **Description**
|:----------------------------------|:------------------------------------------
Expand Down Expand Up @@ -210,34 +210,34 @@ Some additional resources for Node.js native addons and writing `gyp` configurat
Use the form `npm_config_OPTION_NAME` for any of the command options listed
above (dashes in option names should be replaced by underscores).

For example, to set `devdir` equal to `/tmp/.gyp`, you would:
For example, to set `devdir` equal to `/tmp/.nnabt`, you would:

Run this on Unix:

```bash
$ export npm_config_devdir=/tmp/.gyp
$ export npm_config_devdir=/tmp/.nnabt
```

Or this on Windows:

```console
> set npm_config_devdir=c:\temp\.gyp
> set npm_config_devdir=c:\temp\.nnabt
```

### `npm` configuration

Use the form `OPTION_NAME` for any of the command options listed above.

For example, to set `devdir` equal to `/tmp/.gyp`, you would run:
For example, to set `devdir` equal to `/tmp/.nnabt`, you would run:

```bash
$ npm config set [--global] devdir /tmp/.gyp
$ npm config set [--global] devdir /tmp/.nnabt
```

**Note:** Configuration set via `npm` will only be used when `node-gyp`
is run via `npm`, not when `node-gyp` is run directly.
**Note:** Configuration set via `npm` will only be used when `node-nnabt`
is run via `npm`, not when `node-nnabt` is run directly.

## License

`node-gyp` is available under the MIT license. See the [LICENSE
`node-nnabt` is available under the MIT license. See the [LICENSE
file](LICENSE) for details.
8 changes: 4 additions & 4 deletions addon.gypi → addon.nnabti
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@
'<(node_root_dir)/<(node_engine_include_dir)'
],
'defines!': [
'BUILDING_UV_SHARED=1', # Inherited from common.gypi.
'BUILDING_V8_SHARED=1', # Inherited from common.gypi.
'BUILDING_UV_SHARED=1', # Inherited from common.nnabti.
'BUILDING_V8_SHARED=1', # Inherited from common.nnabti.
],
'defines': [
'NODE_GYP_MODULE_NAME=>(_target_name)',
Expand Down Expand Up @@ -67,14 +67,14 @@

['_win_delay_load_hook=="true"', {
# If the addon specifies `'win_delay_load_hook': 'true'` in its
# binding.gyp, link a delay-load hook into the DLL. This hook ensures
# binding.nnabt, link a delay-load hook into the DLL. This hook ensures
# that the addon will work regardless of whether the node/iojs binary
# is named node.exe, iojs.exe, or something else.
'conditions': [
[ 'OS=="win"', {
'defines': [ 'HOST_BINARY=\"<(node_host_binary)<(EXECUTABLE_SUFFIX)\"', ],
'sources': [
'<(node_gyp_dir)/src/win_delay_load_hook.cc',
'<(node_nnabt_dir)/src/win_delay_load_hook.cc',
],
'msvs_settings': {
'VCLinkerTool': {
Expand Down
22 changes: 11 additions & 11 deletions bin/node-gyp.js → bin/node-nnabt.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@

'use strict'

process.title = 'node-gyp'
process.title = 'node-nnabt'

const envPaths = require('env-paths')
const gyp = require('../')
const nnabt = require('../')
const log = require('npmlog')
const os = require('os')

/**
* Process and execute the selected commands.
*/

const prog = gyp()
const prog = nnabt()
var completed = false
prog.parseArgv(process.argv)
prog.devDir = prog.opts.devdir
Expand All @@ -22,12 +22,12 @@ var homeDir = os.homedir()
if (prog.devDir) {
prog.devDir = prog.devDir.replace(/^~/, homeDir)
} else if (homeDir) {
prog.devDir = envPaths('node-gyp', { suffix: '' }).cache
prog.devDir = envPaths('node-nnabt', { suffix: '' }).cache
} else {
throw new Error(
"node-gyp requires that the user's home directory is specified " +
"node-nnabt requires that the user's home directory is specified " +
'in either of the environmental variables HOME or USERPROFILE. ' +
'Overide with: --devdir /path/to/.node-gyp')
'Overide with: --devdir /path/to/.node-nnabt')
}

if (prog.todo.length === 0) {
Expand All @@ -41,7 +41,7 @@ if (prog.todo.length === 0) {

log.info('it worked if it ends with', 'ok')
log.verbose('cli', process.argv)
log.info('using', 'node-gyp@%s', prog.version)
log.info('using', 'node-nnabt@%s', prog.version)
log.info('using', 'node@%s | %s | %s', process.versions.node, process.platform, process.arch)

/**
Expand Down Expand Up @@ -92,7 +92,7 @@ function run () {
console.log(version)
})
} else {
console.log('No node development files installed. Use `node-gyp install` to install a version.')
console.log('No node development files installed. Use `node-nnabt install` to install a version.')
}
} else if (arguments.length >= 2) {
console.log.apply(console, [].slice.call(arguments, 1))
Expand Down Expand Up @@ -126,13 +126,13 @@ function errorMessage () {
.map(JSON.stringify).join(' '))
log.error('cwd', process.cwd())
log.error('node -v', process.version)
log.error('node-gyp -v', 'v' + prog.package.version)
log.error('node-nnabt -v', 'v' + prog.package.version)
}

function issueMessage () {
errorMessage()
log.error('', ['Node-gyp failed to build your package.',
'Try to update npm and/or node-gyp and if it does not help file an issue with the package author.'
log.error('', ['Node-nnabt failed to build your package.',
'Try to update npm and/or node-nnabt and if it does not help file an issue with the package author.'
].join('\n'))
}

Expand Down
4 changes: 0 additions & 4 deletions gyp/README.md

This file was deleted.

Loading