node-addon-api 2.0.2 → 3.1.0

package/node_api.gyp

@@ -0,0 +1,9 @@
+{
+  'targets': [
+    {
+      'target_name': 'nothing',
+      'type': 'static_library',
+      'sources': [ 'nothing.c' ]
+    }
+  ]
+}

package/noexcept.gypi

@@ -0,0 +1,16 @@
+{
+  'defines': [ 'NAPI_DISABLE_CPP_EXCEPTIONS' ],
+  'cflags': [ '-fno-exceptions' ],
+  'cflags_cc': [ '-fno-exceptions' ],
+  'msvs_settings': {
+    'VCCLCompilerTool': {
+      'ExceptionHandling': 0,
+      'EnablePREfast': 'true',
+    },
+  },
+  'xcode_settings': {
+    'CLANG_CXX_LIBRARY': 'libc++',
+    'MACOSX_DEPLOYMENT_TARGET': '10.7',
+    'GCC_ENABLE_CPP_EXCEPTIONS': 'NO',
+  },
+}

package/package-support.json

@@ -0,0 +1,21 @@
+{
+  "versions": [
+    {
+      "version": "*",
+      "target": {
+        "node": "active"
+      },
+      "response": {
+        "type": "time-permitting",
+        "paid": false,
+        "contact": {
+          "name": "node-addon-api team",
+          "url": "https://github.com/nodejs/node-addon-api/issues"
+        }
+      },
+      "backing": [ { "project": "https://github.com/nodejs" },
+                   { "foundation": "https://openjsf.org/" }
+      ]
+    }
+  ]
+}

package/package.json

@@ -11,6 +11,10 @@
       "name": "Alba Mendez",
       "url": "https://github.com/jmendeth"
     },
+    {
+      "name": "András Timár, Dr",
+      "url": "https://github.com/timarandras"
+    },
     {
       "name": "Andrew Petersen",
       "url": "https://github.com/kirbysayshi"
@@ -31,6 +35,10 @@
       "name": "Arunesh Chandra",
       "url": "https://github.com/aruneshchandra"
     },
+    {
+      "name": "Azlan Mukhtar",
+      "url": "https://github.com/azlan"
+    },
     {
       "name": "Ben Berman",
       "url": "https://github.com/rivertam"
@@ -43,6 +51,10 @@
       "name": "Bill Gallafent",
       "url": "https://github.com/gallafent"
     },
+    {
+      "name": "blagoev",
+      "url": "https://github.com/blagoev"
+    },
     {
       "name": "Bruce A. MacNaughton",
       "url": "https://github.com/bmacnaughton"
@@ -51,14 +63,30 @@
       "name": "Cory Mickelson",
       "url": "https://github.com/corymickelson"
     },
+    {
+      "name": "Daniel Bevenius",
+      "url": "https://github.com/danbev"
+    },
+    {
+      "name": "Darshan Sen",
+      "url": "https://github.com/RaisinTen"
+    },
     {
       "name": "David Halls",
       "url": "https://github.com/davedoesdev"
     },
+    {
+      "name": "Dmitry Ashkadov",
+      "url": "https://github.com/dmitryash"
+    },
     {
       "name": "Dongjin Na",
       "url": "https://github.com/nadongguri"
     },
+    {
+      "name": "Ferdinand Holzer",
+      "url": "https://github.com/fholzer"
+    },
     {
       "name": "Eric Bickle",
       "url": "https://github.com/ebickle"
@@ -67,14 +95,26 @@
       "name": "Gabriel Schulhof",
       "url": "https://github.com/gabrielschulhof"
     },
+    {
+      "name": "Guenter Sandner",
+      "url": "https://github.com/gms1"
+    },
     {
       "name": "Gus Caplan",
       "url": "https://github.com/devsnek"
     },
+    {
+      "name": "Helio Frota",
+      "url": "https://github.com/helio-frota"
+    },
     {
       "name": "Hitesh Kanwathirtha",
       "url": "https://github.com/digitalinfinity"
     },
+    {
+      "name": "ikokostya",
+      "url": "https://github.com/ikokostya"
+    },
     {
       "name": "Jake Barnes",
       "url": "https://github.com/DuBistKomisch"
@@ -87,6 +127,10 @@
       "name": "Jason Ginchereau",
       "url": "https://github.com/jasongin"
     },
+    {
+      "name": "Jeroen Janssen",
+      "url": "https://github.com/japj"
+    },
     {
       "name": "Jim Schlight",
       "url": "https://github.com/jschlight"
@@ -99,10 +143,26 @@
       "name": "joshgarde",
       "url": "https://github.com/joshgarde"
     },
+    {
+      "name": "Kasumi Hanazuki",
+      "url": "https://github.com/hanazuki"
+    },
+    {
+      "name": "Kelvin",
+      "url": "https://github.com/kelvinhammond"
+    },
     {
       "name": "Kevin Eady",
       "url": "https://github.com/KevinEady"
     },
+    {
+      "name": "kidneysolo",
+      "url": "https://github.com/kidneysolo"
+    },
+    {
+      "name": "Koki Nishihara",
+      "url": "https://github.com/Nishikoh"
+    },
     {
       "name": "Konstantin Tarkus",
       "url": "https://github.com/koistya"
@@ -115,10 +175,18 @@
       "name": "legendecas",
       "url": "https://github.com/legendecas"
     },
+    {
+      "name": "Lovell Fuller",
+      "url": "https://github.com/lovell"
+    },
     {
       "name": "Luciano Martorella",
       "url": "https://github.com/lmartorella"
     },
+    {
+      "name": "mastergberry",
+      "url": "https://github.com/mastergberry"
+    },
     {
       "name": "Mathias Küsel",
       "url": "https://github.com/mathiask88"
@@ -143,6 +211,10 @@
       "name": "Mikhail Cheshkov",
       "url": "https://github.com/mcheshkov"
     },
+    {
+      "name": "nempoBu4",
+      "url": "https://github.com/nempoBu4"
+    },
     {
       "name": "Nicola Del Gobbo",
       "url": "https://github.com/NickNaso"
@@ -151,10 +223,18 @@
       "name": "Nick Soggin",
       "url": "https://github.com/iSkore"
     },
+    {
+      "name": "Nikolai Vavilov",
+      "url": "https://github.com/seishun"
+    },
     {
       "name": "Nurbol Alpysbayev",
       "url": "https://github.com/anurbol"
     },
+    {
+      "name": "pacop",
+      "url": "https://github.com/pacop"
+    },
     {
       "name": "Philipp Renoth",
       "url": "https://github.com/DaAitch"
@@ -199,17 +279,35 @@
       "name": "Tux3",
       "url": "https://github.com/tux3"
     },
+    {
+      "name": "Vlad Velmisov",
+      "url": "https://github.com/Velmisov"
+    },
     {
       "name": "Yohei Kishimoto",
       "url": "https://github.com/morokosi"
+    },
+    {
+      "name": "Yulong Wang",
+      "url": "https://github.com/fs-eire"
+    },
+    {
+      "name": "Ziqiu Zhao",
+      "url": "https://github.com/ZzqiZQute"
     }
   ],
   "dependencies": {},
   "description": "Node.js API (N-API)",
   "devDependencies": {
+    "benchmark": "^2.1.4",
+    "bindings": "^1.5.0",
+    "clang-format": "^1.4.0",
+    "fs-extra": "^9.0.1",
+    "pre-commit": "^1.2.2",
     "safe-buffer": "^5.1.1"
   },
   "directories": {},
+  "gypfile": false,
   "homepage": "https://github.com/nodejs/node-addon-api",
   "keywords": [
     "n-api",
@@ -232,13 +330,19 @@
     "url": "git://github.com/nodejs/node-addon-api.git"
   },
   "scripts": {
+    "prebenchmark": "node-gyp rebuild -C benchmark",
+    "benchmark": "node benchmark",
     "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"
+    "doc": "doxygen doc/Doxyfile",
+    "lint": "node tools/clang-format.js",
+    "lint:fix": "git-clang-format '*.h', '*.cc'"
   },
-  "version": "2.0.2"
+  "pre-commit": "lint",
+  "version": "3.1.0",
+  "support": true
 }

package/tools/README.md

@@ -1,4 +1,10 @@
-# Migration Script
+# Tools
+
+## clang-format
+
+The clang-format checking tools is designed to check changed lines of code compared to given git-refs.
+
+## Migration Script
 
 The migration tool is designed to reduce repetitive work in the migration process. However, the script is not aiming to convert every thing for you. There are usually some small fixes and major reconstruction required.
 
@@ -42,17 +48,17 @@ and define it as
 This way, the `Napi::ObjectWrap` constructor will be invoked after the object has been instantiated and `Napi::ObjectWrap` can use the `this` pointer to create a reference to the wrapped object.
 
   2. Move your original constructor code into the new constructor. Delete your original constructor.
-  3. In your class initialization function, associate native methods in the following way. The `&` character before methods is required because they are not static methods but instance methods.
+  3. In your class initialization function, associate native methods in the following way.
 ```
 Napi::FunctionReference constructor;
 
 void [ClassName]::Init(Napi::Env env, Napi::Object exports, Napi::Object module) {
   Napi::HandleScope scope(env);
   Napi::Function ctor = DefineClass(env, "Canvas", {
-    InstanceMethod("Func1", &[ClassName]::Func1),
-    InstanceMethod("Func2", &[ClassName]::Func2),
-    InstanceAccessor("Value", &[ClassName]::ValueGetter),
-    StaticMethod("MethodName", &[ClassName]::StaticMethod),
+    InstanceMethod<&[ClassName]::Func1>("Func1"),
+    InstanceMethod<&[ClassName]::Func2>("Func2"),
+    InstanceAccessor<&[ClassName]::ValueGetter>("Value"),
+    StaticMethod<&[ClassName]::StaticMethod>("MethodName"),
     InstanceValue("Value", Napi::[Type]::New(env, value)),
   });
 

package/tools/clang-format.js

@@ -0,0 +1,47 @@
+#!/usr/bin/env node
+
+const spawn = require('child_process').spawnSync;
+const path = require('path');
+
+const filesToCheck = ['*.h', '*.cc'];
+const CLANG_FORMAT_START = process.env.CLANG_FORMAT_START || 'master';
+
+function main(args) {
+  let clangFormatPath = path.dirname(require.resolve('clang-format'));
+  const options = ['--binary=node_modules/.bin/clang-format', '--style=file'];
+
+  const gitClangFormatPath = path.join(clangFormatPath,
+    'bin/git-clang-format');
+  const result = spawn('python', [
+    gitClangFormatPath,
+    ...options,
+    '--diff',
+    CLANG_FORMAT_START,
+    'HEAD',
+    ...filesToCheck
+  ], { encoding: 'utf-8' });
+
+  if (result.error) {
+    console.error('Error running git-clang-format:', result.error);
+    return 2;
+  }
+
+  const clangFormatOutput = result.stdout.trim();
+  if (clangFormatOutput !== '' &&
+      clangFormatOutput !== ('no modified files to format') &&
+      clangFormatOutput !== ('clang-format did not modify any files')) {
+    console.error(clangFormatOutput);
+    const fixCmd = '"npm run lint:fix"';
+    console.error(`
+      ERROR: please run ${fixCmd} to format changes in your commit
+        Note that when running the command locally, please keep your local
+        master branch and working branch up to date with nodejs/node-addon-api
+        to exclude un-related complains.
+        Or you can run "env CLANG_FORMAT_START=upstream/master ${fixCmd}".`);
+    return 1;
+  }
+}
+
+if (require.main === module) {
+  process.exitCode = main(process.argv.slice(2));
+}

package/tools/conversion.js

@@ -22,10 +22,8 @@ if (disable != "--disable" && dir != "--disable") {
        [ /[ ]*"nan": *"[^"]+"(,|)[\n\r]/g, '' ]
     ],
     'binding.gyp': [
-       [ /([ ]*)'include_dirs': \[/g, '$1\'include_dirs\': [\n$1  \'<!@(node -p "require(\\\'node-addon-api\\\').include")\',' ],
-       [ /([ ]*)"include_dirs": \[/g, '$1"include_dirs": [\n$1  "<!@(node -p \\"require(\'node-addon-api\').include\\")",' ],
-       [ /([ ]*)'dependencies': \[/g, '$1\'dependencies\': [\n$1  \'<!(node -p "require(\\\'node-addon-api\\\').gyp")\','],
-       [ /([ ]*)"dependencies": \[/g, '$1"dependencies": [\n$1  "<!(node -p \'require(\\\"node-addon-api\\\").gyp\')",'],
+       [ /([ ]*)'include_dirs': \[/g, '$1\'include_dirs\': [\n$1  \'<!(node -p "require(\\\'node-addon-api\\\').include_dir")\',' ],
+       [ /([ ]*)"include_dirs": \[/g, '$1"include_dirs": [\n$1  "<!(node -p \\"require(\'node-addon-api\').include_dir\\")",' ],
        [ /[ ]*("|')<!\(node -e ("|'|\\"|\\')require\(("|'|\\"|\\')nan("|'|\\"|\\')\)("|'|\\"|\\')\)("|')(,|)[\r\n]/g, '' ],
        [ /([ ]*)("|')target_name("|'): ("|')(.+?)("|'),/g, '$1$2target_name$2: $4$5$6,\n      $2cflags!$2: [ $2-fno-exceptions$2 ],\n      $2cflags_cc!$2: [ $2-fno-exceptions$2 ],\n      $2xcode_settings$2: { $2GCC_ENABLE_CPP_EXCEPTIONS$2: $2YES$2,\n        $2CLANG_CXX_LIBRARY$2: $2libc++$2,\n        $2MACOSX_DEPLOYMENT_TARGET$2: $210.7$2,\n      },\n      $2msvs_settings$2: {\n        $2VCCLCompilerTool$2: { $2ExceptionHandling$2: 1 },\n      },' ],
     ]
@@ -37,10 +35,8 @@ if (disable != "--disable" && dir != "--disable") {
       [ /[ ]*"nan": *"[^"]+"(,|)[\n\r]/g, '' ]
     ],
     'binding.gyp': [
-      [ /([ ]*)'include_dirs': \[/g, '$1\'include_dirs\': [\n$1  \'<!@(node -p "require(\\\'node-addon-api\\\').include")\',' ],
-      [ /([ ]*)"include_dirs": \[/g, '$1"include_dirs": [\n$1  "<!@(node -p \'require(\\\"node-addon-api\\\").include\')",' ],
-      [ /([ ]*)'dependencies': \[/g, '$1\'dependencies\': [\n$1  \'<!(node -p "require(\\\'node-addon-api\\\').gyp")\','],
-      [ /([ ]*)"dependencies": \[/g, '$1"dependencies": [\n$1  "<!(node -p \'require(\\\"node-addon-api\\\").gyp\')",'],
+      [ /([ ]*)'include_dirs': \[/g, '$1\'include_dirs\': [\n$1  \'<!(node -p "require(\\\'node-addon-api\\\').include_dir")\',' ],
+      [ /([ ]*)"include_dirs": \[/g, '$1"include_dirs": [\n$1  "<!(node -p \'require(\\\"node-addon-api\\\").include_dir\')",' ],
       [ /[ ]*("|')<!\(node -e ("|'|\\"|\\')require\(("|'|\\"|\\')nan("|'|\\"|\\')\)("|'|\\"|\\')\)("|')(,|)[\r\n]/g, '' ],
       [ /([ ]*)("|')target_name("|'): ("|')(.+?)("|'),/g, '$1$2target_name$2: $4$5$6,\n      $2cflags!$2: [ $2-fno-exceptions$2 ],\n      $2cflags_cc!$2: [ $2-fno-exceptions$2 ],\n      $2defines$2: [ $2NAPI_DISABLE_CPP_EXCEPTIONS$2 ],\n      $2conditions$2: [\n        [\'OS==\"win\"\', { $2defines$2: [ $2_HAS_EXCEPTIONS=1$2 ] }]\n      ]' ],
     ]