node-addon-api 3.1.0 → 3.2.0

package/package.json

@@ -115,6 +115,10 @@
       "name": "ikokostya",
       "url": "https://github.com/ikokostya"
     },
+    {
+      "name": "Jack Xia",
+      "url": "https://github.com/JckXia"
+    },
     {
       "name": "Jake Barnes",
       "url": "https://github.com/DuBistKomisch"
@@ -139,6 +143,10 @@
       "name": "Jinho Bang",
       "url": "https://github.com/romandev"
     },
+    {
+      "name": "José Expósito",
+      "url": "https://github.com/JoseExposito"
+    },
     {
       "name": "joshgarde",
       "url": "https://github.com/joshgarde"
@@ -155,6 +163,10 @@
       "name": "Kevin Eady",
       "url": "https://github.com/KevinEady"
     },
+    {
+      "name": "Kévin VOYER",
+      "url": "https://github.com/kecsou"
+    },
     {
       "name": "kidneysolo",
       "url": "https://github.com/kidneysolo"
@@ -175,6 +187,10 @@
       "name": "legendecas",
       "url": "https://github.com/legendecas"
     },
+    {
+      "name": "LongYinan",
+      "url": "https://github.com/Brooooooklyn"
+    },
     {
       "name": "Lovell Fuller",
       "url": "https://github.com/lovell"
@@ -296,8 +312,7 @@
       "url": "https://github.com/ZzqiZQute"
     }
   ],
-  "dependencies": {},
-  "description": "Node.js API (N-API)",
+  "description": "Node.js API (Node-API)",
   "devDependencies": {
     "benchmark": "^2.1.4",
     "bindings": "^1.5.0",
@@ -329,6 +344,11 @@
     "type": "git",
     "url": "git://github.com/nodejs/node-addon-api.git"
   },
+  "files": [
+    "*.{c,h,gyp,gypi}",
+    "package-support.json",
+    "tools/"
+  ],
   "scripts": {
     "prebenchmark": "node-gyp rebuild -C benchmark",
     "benchmark": "node benchmark",
@@ -339,10 +359,10 @@
     "predev:incremental": "node-gyp configure build -C test --debug",
     "dev:incremental": "node test",
     "doc": "doxygen doc/Doxyfile",
-    "lint": "node tools/clang-format.js",
-    "lint:fix": "git-clang-format '*.h', '*.cc'"
+    "lint": "node tools/clang-format",
+    "lint:fix": "node tools/clang-format --fix"
   },
   "pre-commit": "lint",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "support": true
 }

package/tools/clang-format.js

@@ -4,40 +4,60 @@ const spawn = require('child_process').spawnSync;
 const path = require('path');
 
 const filesToCheck = ['*.h', '*.cc'];
-const CLANG_FORMAT_START = process.env.CLANG_FORMAT_START || 'master';
+const CLANG_FORMAT_START = process.env.CLANG_FORMAT_START || 'main';
 
 function main(args) {
+  let fix = false;
+  while (args.length > 0) {
+    switch (args[0]) {
+      case '-f':
+      case '--fix':
+        fix = true;
+      default:
+    }
+    args.shift();
+  }
+
   let clangFormatPath = path.dirname(require.resolve('clang-format'));
   const options = ['--binary=node_modules/.bin/clang-format', '--style=file'];
+  if (fix) {
+    options.push(CLANG_FORMAT_START);
+  } else {
+    options.push('--diff', CLANG_FORMAT_START);
+  }
 
   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);
+  if (result.stderr) {
+    console.error('Error running git-clang-format:', result.stderr);
     return 2;
   }
 
   const clangFormatOutput = result.stdout.trim();
+  // Bail fast if in fix mode.
+  if (fix) {
+    console.log(clangFormatOutput);
+    return 0;
+  }
+  // Detect if there is any complains from clang-format
   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"';
+    const fixCmd = 'npm run lint:fix';
     console.error(`
-      ERROR: please run ${fixCmd} to format changes in your commit
+      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
+        main 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}".`);
+        Or you can run "env CLANG_FORMAT_START=upstream/main ${fixCmd}".`);
     return 1;
   }
 }

package/.clang-format

@@ -1,111 +0,0 @@
----
-Language:        Cpp
-# BasedOnStyle:  Google
-AccessModifierOffset: -1
-AlignAfterOpenBracket: Align
-AlignConsecutiveAssignments: false
-AlignConsecutiveDeclarations: false
-AlignEscapedNewlines: Right
-AlignOperands:   true
-AlignTrailingComments: true
-AllowAllParametersOfDeclarationOnNextLine: true
-AllowShortBlocksOnASingleLine: false
-AllowShortCaseLabelsOnASingleLine: false
-AllowShortFunctionsOnASingleLine: Inline
-AllowShortIfStatementsOnASingleLine: true
-AllowShortLoopsOnASingleLine: true
-AlwaysBreakAfterDefinitionReturnType: None
-AlwaysBreakAfterReturnType: None
-AlwaysBreakBeforeMultilineStrings: false
-AlwaysBreakTemplateDeclarations: true
-BinPackArguments: false
-BinPackParameters: false
-BraceWrapping:
-  AfterClass:      false
-  AfterControlStatement: false
-  AfterEnum:       false
-  AfterFunction:   false
-  AfterNamespace:  false
-  AfterObjCDeclaration: false
-  AfterStruct:     false
-  AfterUnion:      false
-  AfterExternBlock: false
-  BeforeCatch:     false
-  BeforeElse:      false
-  IndentBraces:    false
-  SplitEmptyFunction: true
-  SplitEmptyRecord: true
-  SplitEmptyNamespace: true
-BreakBeforeBinaryOperators: None
-BreakBeforeBraces: Attach
-BreakBeforeInheritanceComma: false
-BreakBeforeTernaryOperators: true
-BreakConstructorInitializersBeforeComma: false
-BreakConstructorInitializers: BeforeColon
-BreakAfterJavaFieldAnnotations: false
-BreakStringLiterals: true
-ColumnLimit:      80
-CommentPragmas:  '^ IWYU pragma:'
-CompactNamespaces: false
-ConstructorInitializerAllOnOneLineOrOnePerLine: true
-ConstructorInitializerIndentWidth: 4
-ContinuationIndentWidth: 4
-Cpp11BracedListStyle: true
-DerivePointerAlignment: false
-DisableFormat:   false
-ExperimentalAutoDetectBinPacking: false
-FixNamespaceComments: true
-ForEachMacros:
-  - foreach
-  - Q_FOREACH
-  - BOOST_FOREACH
-IncludeBlocks:   Preserve
-IncludeCategories:
-  - Regex:           '^<ext/.*\.h>'
-    Priority:        2
-  - Regex:           '^<.*\.h>'
-    Priority:        1
-  - Regex:           '^<.*'
-    Priority:        2
-  - Regex:           '.*'
-    Priority:        3
-IncludeIsMainRegex: '([-_](test|unittest))?$'
-IndentCaseLabels: true
-IndentPPDirectives: None
-IndentWidth:     2
-IndentWrappedFunctionNames: false
-JavaScriptQuotes: Leave
-JavaScriptWrapImports: true
-KeepEmptyLinesAtTheStartOfBlocks: false
-MacroBlockBegin: ''
-MacroBlockEnd:   ''
-MaxEmptyLinesToKeep: 1
-NamespaceIndentation: None
-ObjCBlockIndentWidth: 2
-ObjCSpaceAfterProperty: false
-ObjCSpaceBeforeProtocolList: false
-PenaltyBreakAssignment: 2
-PenaltyBreakBeforeFirstCallParameter: 1
-PenaltyBreakComment: 300
-PenaltyBreakFirstLessLess: 120
-PenaltyBreakString: 1000
-PenaltyExcessCharacter: 1000000
-PenaltyReturnTypeOnItsOwnLine: 200
-PointerAlignment: Left
-ReflowComments:  true
-SortIncludes:    true
-SortUsingDeclarations: true
-SpaceAfterCStyleCast: false
-SpaceAfterTemplateKeyword: true
-SpaceBeforeAssignmentOperators: true
-SpaceBeforeParens: ControlStatements
-SpaceInEmptyParentheses: false
-SpacesBeforeTrailingComments: 2
-SpacesInAngles:  false
-SpacesInContainerLiterals: true
-SpacesInCStyleCastParentheses: false
-SpacesInParentheses: false
-SpacesInSquareBrackets: false
-Standard:        Auto
-TabWidth:        8
-UseTab:          Never

package/.editorconfig

@@ -1,8 +0,0 @@
-root = true
-
-[*]
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-indent_style = space
-indent_size = 2

package/.github/workflows/ci.yml

@@ -1,55 +0,0 @@
-name: Node.js CI
-
-on: [push, pull_request]
-
-jobs:
-  test:
-    timeout-minutes: 30
-    strategy:
-      matrix:
-        node-version:
-          - node/10
-          - node/12
-          - node/14
-          - node/15
-        compiler:
-          - gcc
-          - clang
-        os:
-          - ubuntu-16.04 # ubuntu-18.04/ubuntu-latest missing package g++-4.9
-          - macos-latest
-    runs-on: ${{ matrix.os }}
-    steps:
-    - uses: actions/checkout@v2
-    - name: Install system dependencies
-      run: |
-        if [ "${{ matrix.compiler }}" = "gcc" -a "${{ matrix.os }}" = ubuntu-* ]; then
-          sudo add-apt-repository ppa:ubuntu-toolchain-r/test
-          sudo apt-get update
-          sudo apt-get install g++-4.9
-        fi
-    - name: Use Node.js ${{ matrix.node-version }}
-      run: |
-        git clone --branch v1.4.2 --depth 1 https://github.com/jasongin/nvs ~/.nvs
-        . ~/.nvs/nvs.sh
-        nvs --version
-        nvs add ${{ matrix.node-version }}
-        nvs use ${{ matrix.node-version }}
-        node --version
-        npm --version
-        npm install
-    - name: npm test
-      run: |
-        if [ "${{ matrix.compiler }}" = "gcc" ]; then
-          export CC="gcc" CXX="g++"
-        fi
-        if [ "${{ matrix.compiler }}" = "gcc" -a "${{ matrix.os }}" = ubuntu-* ]; then
-          export CC="gcc-4.9" CXX="g++-4.9" AR="gcc-ar-4.9" RANLIB="gcc-ranlib-4.9" NM="gcc-nm-4.9"
-        fi
-        if [ "${{ matrix.compiler }}" = "clang" ]; then
-          export CC="clang" CXX="clang++"
-        fi
-        export CFLAGS="$CFLAGS -O3 --coverage" LDFLAGS="$LDFLAGS --coverage"
-        echo "CFLAGS=\"$CFLAGS\" LDFLAGS=\"$LDFLAGS\""
-        npm run pretest -- --verbose
-        node test

package/.github/workflows/linter.yml

@@ -1,24 +0,0 @@
-name: Style Checks
-
-on: [push, pull_request]
-
-jobs:
-  lint:
-    if: github.repository == 'nodejs/node-addon-api'
-    strategy:
-      matrix:
-        node-version: [14.x]
-        os: [ubuntu-latest]
-
-    runs-on: ${{ matrix.os }}
-    steps:
-    - uses: actions/checkout@v2
-      with:
-        fetch-depth: 0
-    - run: git branch -a
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: npm install
-    - run: CLANG_FORMAT_START=refs/remotes/origin/master npm run lint

package/.github/workflows/stale.yml

@@ -1,18 +0,0 @@
-name: "Close stale issues"
-on:
-  schedule:
-  - cron: "0 0 * * *"
-
-jobs:
-  stale:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/stale@v1
-      with:
-        repo-token: ${{ secrets.GITHUB_TOKEN }}
-        stale-issue-message: 'This issue is stale because it has been open many days with no activity. It will be closed soon unless the stale label is removed or a comment is made.'
-        stale-issue-label: 'stale'
-        exempt-issue-label: 'never stale'
-        days-before-stale: 90
-        days-before-close: 30
-

package/.travis.yml

@@ -1,58 +0,0 @@
-language: c++
-compiler:
-  - clang
-  - gcc
-# For Linux, use an Ubuntu 14 image
-dist: trusty
-os:
-  - linux
-  - osx
-env:
-  global:
-    # https://github.com/jasongin/nvs/blob/master/doc/CI.md
-    - NVS_VERSION=1.4.2
-  matrix:
-    - NODEJS_VERSION=node/10
-    - NODEJS_VERSION=node/12
-    - NODEJS_VERSION=node/14
-    - NODEJS_VERSION=nightly
-matrix:
-  fast_finish: true
-  allow_failures:
-    - env: NODEJS_VERSION=nightly
-cache:
-  directories:
-    - node_modules
-    - $HOME/.npm
-addons:
-  apt:
-    sources:
-      - ubuntu-toolchain-r-test
-    packages:
-      - g++-4.9
-before_install:
-  # coveralls
-  - pip2 install --user cpp-coveralls
-  # compilers
-  - if [ "$CXX" = "g++" -a "$TRAVIS_OS_NAME" = "linux" ]; then export CXX="g++-4.9" CC="gcc-4.9" AR="gcc-ar-4.9" RANLIB="gcc-ranlib-4.9" NM="gcc-nm-4.9" ; fi
-  - if [ "$CXX" = "clang++" ]; then export NPMOPT=--clang=1 ; fi
-  - export CFLAGS="$CFLAGS -O3 --coverage" LDFLAGS="$LDFLAGS --coverage"
-  - echo "CFLAGS=\"$CFLAGS\" LDFLAGS=\"$LDFLAGS\""
-  # nvs
-  - git clone --branch v$NVS_VERSION --depth 1 https://github.com/jasongin/nvs ~/.nvs
-  - . ~/.nvs/nvs.sh
-  - nvs --version
-  # node.js
-  - nvs add $NODEJS_VERSION
-  - nvs use $NODEJS_VERSION
-  - node --version
-  - npm --version
-install:
-  - npm install $NPMOPT
-script:
-  # Travis CI sets NVM_NODEJS_ORG_MIRROR, but it makes node-gyp fail to download headers for nightly builds.
-  - unset NVM_NODEJS_ORG_MIRROR
-
-  - npm test
-after_success:
-  - cpp-coveralls --gcov-options '\-lp' --build-root test/build --exclude test

package/CODE_OF_CONDUCT.md

@@ -1,4 +0,0 @@
-# Code of Conduct
-
-The Node.js Code of Conduct, which applies to this project, can be found at
-https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md.

package/CONTRIBUTING.md

@@ -1,66 +0,0 @@
-# **node-addon-api** Contribution Philosophy
-
-The **node-addon-api** team loves contributions. There are many ways in which you can
-contribute to **node-addon-api**:
-- Source code fixes
-- Additional tests
-- Documentation improvements
-- Joining the N-API working group and participating in meetings
-
-## Source changes
-
-**node-addon-api** is meant to be a thin convenience wrapper around N-API. With this
-in mind, contributions of any new APIs that wrap around a core N-API API will
-be considered for merge. However, changes that wrap existing **node-addon-api**
-APIs are encouraged to instead be provided as an ecosystem module. The
-**node-addon-api** team is happy to link to a curated set of modules that build on
-top of **node-addon-api** if they have broad usefulness to the community and promote
-a recommended idiom or pattern.
-
-### Rationale
-
-The N-API team considered a couple different approaches with regards to changes
-extending **node-addon-api**
-- Larger core module - Incorporate these helpers and patterns into **node-addon-api**
-- Extras package - Create a new package (strawman name '**node-addon-api**-extras')
-that contain utility classes and methods that help promote good patterns and
-idioms while writing native addons with **node-addon-api**.
-- Ecosystem - Encourage creation of a module ecosystem around **node-addon-api**
-where folks can build on top of it.
-
-#### Larger Core
-This is probably our simplest option in terms of immediate action needed. It
-would involve landing any open PRs against **node-addon-api**, and continuing to
-encourage folks to make PRs for utility helpers against the same repository.
-
-The downside of the approach is the following:
-- Less coherency for our API set
-- More maintenance burden on the N-API WG core team.
-
-#### Extras Package
-This involves us spinning up a new package which contains the utility classes
-and methods. This has the benefit of having a separate module where helpers
-which make it easier to implement certain patterns and idioms for native addons
-easier.
-
-The downside of this approach is the following:
-- Potential for confusion - we'll need to provide clear documentation to help the
-community understand where a particular contribution should be directed to (what
-belongs in **node-addon-api** vs **node-addon-api-extras**)
-- Need to define the level of support/API guarantees
-- Unclear if the maintenance burden on the N-API WG is reduced or not
-
-#### Ecosystem
-This doesn't require a ton of up-front work from the N-API WG. Instead of
-accepting utility PRs into **node-addon-api** or creating and maintaining a new
-module, the WG will encourage the creation of an ecosystem of modules that
-build on top of **node-addon-api**, and provide some level of advertising for these
-modules (listing them out on the repository/wiki, using them in workshops/tutorials
-etc).
-
-The downside of this approach is the following:
-- Potential for lack of visibility - evangelism and education is hard, and module
-authors might not find right patterns and instead implement things themselves
-- There might be greater friction for the N-API WG in evolving APIs since the
-ecosystem would have taken dependencies on the API shape of **node-addon-api**
-

package/appveyor.yml

@@ -1,37 +0,0 @@
-environment:
-  # https://github.com/jasongin/nvs/blob/master/doc/CI.md
-  NVS_VERSION: 1.4.2
-  matrix:
-    - NODEJS_VERSION: node/10
-    - NODEJS_VERSION: node/12
-    - NODEJS_VERSION: node/14
-    - NODEJS_VERSION: nightly
-
-os: Visual Studio 2017
-platform:
-  - x86
-  - x64
-
-install:
-  # nvs
-  - git clone --branch v%NVS_VERSION% --depth 1 https://github.com/jasongin/nvs %LOCALAPPDATA%\nvs
-  - set PATH=%LOCALAPPDATA%\nvs;%PATH%
-  - nvs --version
-  # node.js
-  - nvs add %NODEJS_VERSION%/%PLATFORM%
-  - nvs use %NODEJS_VERSION%/%PLATFORM%
-  - node --version
-  - node -p process.arch
-  - npm --version
-  # app
-  - npm install
-
-test_script:
-  - npm test
-
-build: off
-
-version: "{build}"
-
-cache:
-  - node_modules

package/benchmark/README.md

@@ -1,47 +0,0 @@
-# Benchmarks
-
-## Running the benchmarks
-
-From the parent directory, run
-
-```bash
-npm run-script benchmark
-```
-
-The above script supports the following arguments:
-
-* `--benchmarks=...`: A semicolon-separated list of benchmark names. These names
-    will be mapped to file names in this directory by appending `.js`.
-
-## Adding benchmarks
-
-The steps below should be followed when adding new benchmarks.
-
-0. Decide on a name for the benchmark. This name will be used in several places.
-   This example will use the name `new_benchmark`.
-
-0. Create files `new_benchmark.cc` and `new_benchmark.js` in this directory.
-
-0. Copy an existing benchmark in `binding.gyp` and change the target name prefix
-    and the source file name to `new_benchmark`. This should result in two new
-    targets which look like this:
-
-    ```gyp
-      {
-        'target_name': 'new_benchmark',
-        'sources': [ 'new_benchmark.cc' ],
-        'includes': [ '../except.gypi' ],
-      },
-      {
-        'target_name': 'new_benchmark_noexcept',
-        'sources': [ 'new_benchmark.cc' ],
-        'includes': [ '../noexcept.gypi' ],
-      },
-    ```
-
-    There should always be a pair of targets: one bearing the name of the
-    benchmark and configured with C++ exceptions enabled, and one bearing the
-    same name followed by the suffix `_noexcept` and configured with C++
-    exceptions disabled. This will ensure that the benchmark can be written to
-    cover both the case where C++ exceptions are enabled and the case where they
-    are disabled.

package/benchmark/binding.gyp

@@ -1,25 +0,0 @@
-{
-  'target_defaults': { 'includes': ['../common.gypi'] },
-  'targets': [
-    {
-      'target_name': 'function_args',
-      'sources': [ 'function_args.cc' ],
-      'includes': [ '../except.gypi' ],
-    },
-    {
-      'target_name': 'function_args_noexcept',
-      'sources': [ 'function_args.cc' ],
-      'includes': [ '../noexcept.gypi' ],
-    },
-    {
-      'target_name': 'property_descriptor',
-      'sources': [ 'property_descriptor.cc' ],
-      'includes': [ '../except.gypi' ],
-    },
-    {
-      'target_name': 'property_descriptor_noexcept',
-      'sources': [ 'property_descriptor.cc' ],
-      'includes': [ '../noexcept.gypi' ],
-    },
-  ]
-}