Skip to content

Commit

Permalink
build: new build targets for debug purposes
Browse files Browse the repository at this point in the history
In this project, we can use the following command to test examples.
$ npm test

It might be very inefficient, especially, if the number of files
increases. So, this patch introduces new build targets for debugging
purpose as follows:
$ npm run-script dev                # Build with --debug option
$ npm run-script dev:incremental    # Incremental dev build

This idea comes from @DaAitch.

PR-URL: nodejs/node-addon-api#186
Reviewed-By: Gabriel Schulhof <gabriel.schulhof@intel.com>
Reviewed-By: NickNaso <nicoladelgobbo@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
  • Loading branch information
John French committed Mar 4, 2019
1 parent 23c549a commit 180d0c8
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,20 @@ npm install
npm test --disable-deprecated
```

### **Debug**

To run the **node-addon-api** tests with `--debug` option:

```
npm run-script dev
```

If you want faster build, you might use the following option:

```
npm run-script dev:incremental
```

Take a look and get inspired by our **[test suite](https://github.com/nodejs/node-addon-api/tree/master/test)**

<a name="resources"></a>
Expand Down
4 changes: 4 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@
"scripts": {
"pretest": "node-gyp rebuild -C test",
"test": "node test",
"predev": "node-gyp rebuild -C test --debug",
"dev": "node test",
"predev:incremental": "node-gyp configure build -C test --debug",
"dev:incremental": "node test",
"doc": "doxygen doc/Doxyfile"
},
"version": "1.6.2"
Expand Down

0 comments on commit 180d0c8

Please sign in to comment.