node-can-bridge: Add support for Linux and macOS

.github/workflows/build.yml

@@ -0,0 +1,43 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
+    name: "Build - ${{ matrix.os }}"
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20'
+
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.10'
+
+    - name: Install Python setup tools
+      run: |
+          pip install setuptools
+
+    - name: Install dependencies
+      run: npm install
+
+    - name: Pretest
+      run: npm run pretest
+
+    - name: Test
+      run: npm test

.github/workflows/release.yml

@@ -0,0 +1,46 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
+    name: "Release - ${{ matrix.os }}"
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20'
+
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.10'
+    - name: Install Python setup tools
+      run: |
+          pip install setuptools
+
+    - name: Install dependencies
+      run: npm install
+
+    - name: Build
+      run: npm run build
+
+    - name: Create release
+      uses: softprops/action-gh-release@v2
+      with:
+        files: dist/*
+        tag_name: ${{ github.ref }}
+        name: ${{ github.ref }}
+        body: |
+          This is a release for version ${{ github.ref }}.
+          It contains the compiled files from the build process.

README.md

@@ -2,14 +2,28 @@
 
 This package enables Node.js applications to use a CAN bus over USB.
 
-## Making a release
+## Compiling
+
+### Prerequisites
+
+- Supported version of NodeJS (preferably a LTS version)
+- A C/C++ compiler that supports C++20
+- Internet connection to pull from upstream [CANBridge](https://github.com/unofficial-rev-port/CANBridge)
+
+### Steps
+
+1. Clone repository
+2. Run `npm i` to install dependencies and compile the Node APIs
+3. To test, run `npm run pretest` to prepare the testing and `npm test` to actually perform the testing of the repository
+
+## Making a release (for repository owners)
 
 1. Check out the `main` branch
 2. Update `version` field in `package.json`
 3. Run `npm install`
 4. Commit change to git
 5. Run `git tag v<version>`
 6. Run `git push`
-7. Run `git push --tags` 
+7. Run `git push --tags`
 8. Run `npm publish --access public`
 9. Create a new release on GitHub with an explanation of the changes

binding.gyp

@@ -5,7 +5,7 @@
       'sources': [
         'src/addon.cc',
         'src/canWrapper.cc',
-       ],
+      ],
       'include_dirs': [
         "src/",
         "externalCompileTimeDeps/include",
@@ -15,30 +15,71 @@
         "NAPI_VERSION=<(napi_build_version)"
       ],
       'dependencies': ["<!(node -p \"require('node-addon-api').gyp\")"],
-      'libraries': [
-            # These files were placed by download-CanBridge.mjs
-            '<(module_root_dir)/externalCompileTimeDeps/CANBridge.lib',
-            '<(module_root_dir)/externalCompileTimeDeps/wpiHal.lib',
-            '<(module_root_dir)/externalCompileTimeDeps/wpiutil.lib',
+      'conditions': [
+        ['OS=="mac"', {
+            'libraries': [
+                # These files were placed by download-CanBridge.mjs
+                '<(module_root_dir)/externalCompileTimeDeps/libCANBridge.a',
+            ],
+            'copies': [{
+                'destination': './build/Release',
+                'files': [
+                    # These files were placed in the prebuilds folder by download-CanBridge.mjs
+                    '<(module_root_dir)/prebuilds/darwin-osxuniversal/libCANBridge.dylib',
+                    '<(module_root_dir)/prebuilds/darwin-osxuniversal/libwpiHal.dylib',
+                    '<(module_root_dir)/prebuilds/darwin-osxuniversal/libwpiutil.dylib',
+                ]
+            }],
+        }],
+        ['OS=="win"', {
+            'libraries': [
+                # These files were placed by download-CanBridge.mjs
+                '<(module_root_dir)/externalCompileTimeDeps/CANBridge.lib',
+                '<(module_root_dir)/externalCompileTimeDeps/wpiHal.lib',
+                '<(module_root_dir)/externalCompileTimeDeps/wpiutil.lib',
+            ],
+            'copies': [{
+                'destination': './build/Release',
+                'files': [
+                    # These files were placed in the prebuilds folder by download-CanBridge.mjs
+                    '<(module_root_dir)/prebuilds/win32-x64/CANBridge.dll',
+                    '<(module_root_dir)/prebuilds/win32-x64/wpiHal.dll',
+                    '<(module_root_dir)/prebuilds/win32-x64/wpiutil.dll',
+                ]
+            }],
+        }],
+        ['OS=="linux"', {
+            'libraries': [
+                # These files were placed by download-CanBridge.mjs
+                '<(module_root_dir)/externalCompileTimeDeps/libCANBridge.a',
+            ],
+            'copies': [{
+                'destination': './build/Release',
+                'files': [
+                    # These files were placed in the prebuilds folder by download-CanBridge.mjs
+                    '<(module_root_dir)/prebuilds/linux-x64/libCANBridge.so',
+                    '<(module_root_dir)/prebuilds/linux-x64/libwpiHal.so',
+                    '<(module_root_dir)/prebuilds/linux-x64/libwpiutil.so',
+                ]
+            }],
+        }],
       ],
-      'copies': [{
-        'destination': './build/Release',
-        'files': [
-          # These files were placed in the prebuilds folder by download-CanBridge.mjs
-          '<(module_root_dir)/prebuilds/win32-x64/CANBridge.dll',
-          '<(module_root_dir)/prebuilds/win32-x64/wpiHal.dll',
-          '<(module_root_dir)/prebuilds/win32-x64/wpiutil.dll',
-        ]
-      }],
       'msvs_settings': {
         'VCCLCompilerTool': {
             'ExceptionHandling': 1,
             'AdditionalOptions': [ '-std:c++20' ],
             'RuntimeLibrary': 0
         },
       },
-      "cflags_cc!": ["-std=c++20", '-fno-exceptions'],
-      "cflags!": ["-std=c++20", '-fno-exceptions'],
+      "xcode_settings": {
+          "CLANG_CXX_LANGUAGE_STANDARD": "c++20",
+          'GCC_ENABLE_CPP_EXCEPTIONS': 'YES',
+          'GCC_ENABLE_CPP_RTTI': 'YES',
+          "OTHER_CPLUSPLUSFLAGS": ["-fexceptions"],
+          # 'MACOSX_DEPLOYMENT_TARGET': '14.0',
+      },
+      "cflags_cc": ["-std=c++20", '-fexceptions'],
+      "cflags": ["-std=c++20", '-fexceptions'],
     }
   ]
 }

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rev-robotics/can-bridge",
-    "version": "3.2.0",
+    "version": "3.2.6",
     "author": "REV Robotics",
     "description": "Access CAN Data from a USB device in Node.js",
     "license": "MIT",
@@ -24,9 +24,9 @@
         "typescript": "^5.0.2"
     },
     "scripts": {
-        "install": "node-gyp-build \"node scripts/download-CanBridge.mjs\"",
+        "install": "node scripts/download-CanBridge.mjs && node-gyp rebuild",
         "prepublishOnly": "node scripts/download-CanBridge.mjs && tsc && prebuildify --napi",
-        "pretest": "node-gyp-build && tsc",
+        "pretest": "node-gyp rebuild && tsc",
         "test": "node --napi-modules test/test_binding.js"
     },
     "engines": {