.github/ISSUE_TEMPLATE.md

@@ -13,7 +13,7 @@ provide the basic information we require.
 
 -->
 
-Please look thru your error log for the string `gyp info using node-gyp@` and if the version number is less than the [current release of node-gyp](https://github.com/nodejs/node-gyp/releases) then __please upgrade__ using the instructions at https://github.com/nodejs/node-gyp/blob/master/docs/Updating-npm-bundled-node-gyp.md and try your command again.
+Please look thru your error log for the string `gyp info using node-gyp@` and if the version number is less than the [current release of node-gyp](https://github.com/nodejs/node-gyp/releases) then __please upgrade__ using the instructions at https://github.com/nodejs/node-gyp/blob/main/docs/Updating-npm-bundled-node-gyp.md and try your command again.
 
 Requests for help with [`node-sass` are very common](https://github.com/nodejs/node-gyp/issues?q=label%3A%22Node+Sass+--%3E+Dart+Sass%22). Please be aware that this package is deprecated, you should seek alternatives and avoid opening new issues about it here.
 

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,13 +1,13 @@
 <!--
 Thank you for your pull request. Please review the below requirements.
 
-Contributor guide: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md
+Contributor guide: https://github.com/nodejs/node/blob/main/CONTRIBUTING.md
 -->
 
 ##### Checklist
 <!-- Remove items that do not apply. For completed items, change [ ] to [x]. -->
 
-- [ ] `npm install && npm test` passes
+- [ ] `npm install && npm run lint && npm test` passes
 - [ ] tests are included <!-- Bug fixes and new features should include tests -->
 - [ ] documentation is changed or added
 - [ ] commit message follows [commit guidelines](https://github.com/googleapis/release-please#how-should-i-write-my-commits)

.github/scripts/check-engines.js

@@ -0,0 +1,41 @@
+const { join } = require('path')
+const semver = require('semver')
+const Arborist = require('@npmcli/arborist')
+
+const run = async (path, useEngines) => {
+  const pkgPath = join(path, 'package.json')
+  const pkg = require(pkgPath)
+
+  const engines = useEngines || pkg.engines.node
+
+  const arb = new Arborist({ path })
+  const tree = await arb.loadActual({ forceActual: true })
+  const deps = await tree.querySelectorAll(`#${pkg.name} > .prod:attr(engines, [node])`)
+
+  const invalid = []
+  for (const dep of deps) {
+    const depEngines = dep.target.package.engines.node
+    if (!semver.subset(engines, depEngines)) {
+      invalid.push({
+        name: `${dep.name}@${dep.version}`,
+        location: dep.location,
+        engines: depEngines
+      })
+    }
+  }
+
+  if (invalid.length) {
+    const msg = 'The following production dependencies are not compatible with ' +
+`\`engines.node: ${engines}\` found in \`${pkgPath}\`:\n` + invalid.map((dep) => [
+  `${dep.name}:`,
+  `  engines.node: ${dep.engines}`,
+  `  location: ${dep.location}`
+    ].join('\n')).join('\n')
+    throw new Error(msg)
+  }
+}
+
+run(process.cwd(), ...process.argv.slice(2)).then(() => console.log('Success')).catch((err) => {
+  console.error(err)
+  process.exitCode = 1
+})

.github/workflows/release-please.yml

@@ -4,53 +4,65 @@ on:
   push:
     branches:
       - main
+  pull_request:
 
 jobs:
   release-please:
+    outputs:
+      pr: ${{ steps.release.outputs.pr }}
+    permissions:
+      contents: write # to create release commit (google-github-actions/release-please-action)
+      pull-requests: write # to create release PR (google-github-actions/release-please-action)
+
     runs-on: ubuntu-latest
     steps:
-      - uses: google-github-actions/release-please-action@v2
-        id: release
-        with:
-          package-name: node-gyp
-          release-type: node
-          changelog-types: >
-            [{"type":"feat","section":"Features","hidden":false},
-            {"type":"fix","section":"Bug Fixes","hidden":false},
-            {"type":"bin","section":"Core","hidden":false},
-            {"type":"gyp","section":"Core","hidden":false},
-            {"type":"lib","section":"Core","hidden":false},
-            {"type":"src","section":"Core","hidden":false},
-            {"type":"test","section":"Tests","hidden":false},
-            {"type":"build","section":"Core","hidden":false},
-            {"type":"clean","section":"Core","hidden":false},
-            {"type":"configure","section":"Core","hidden":false},
-            {"type":"install","section":"Core","hidden":false},
-            {"type":"list","section":"Core","hidden":false},
-            {"type":"rebuild","section":"Core","hidden":false},
-            {"type":"remove","section":"Core","hidden":false},
-            {"type":"deps","section":"Core","hidden":false},
-            {"type":"python","section":"Core","hidden":false},
-            {"type":"lin","section":"Core","hidden":false},
-            {"type":"linux","section":"Core","hidden":false},
-            {"type":"mac","section":"Core","hidden":false},
-            {"type":"macos","section":"Core","hidden":false},
-            {"type":"win","section":"Core","hidden":false},
-            {"type":"windows","section":"Core","hidden":false},
-            {"type":"zos","section":"Core","hidden":false},
-            {"type":"doc","section":"Doc","hidden":false},
-            {"type":"docs","section":"Doc","hidden":false},
-            {"type":"readme","section":"Doc","hidden":false},
-            {"type":"chore","section":"Miscellaneous","hidden":false},
-            {"type":"refactor","section":"Miscellaneous","hidden":false},
-            {"type":"ci","section":"Miscellaneous","hidden":false},
-            {"type":"meta","section":"Miscellaneous","hidden":false}]
+    - uses: google-github-actions/release-please-action@v2
+      id: release
+      with:
+        package-name: node-gyp
+        release-type: node
+        changelog-types: >
+          [{"type":"feat","section":"Features","hidden":false},
+          {"type":"fix","section":"Bug Fixes","hidden":false},
+          {"type":"bin","section":"Core","hidden":false},
+          {"type":"gyp","section":"Core","hidden":false},
+          {"type":"lib","section":"Core","hidden":false},
+          {"type":"src","section":"Core","hidden":false},
+          {"type":"test","section":"Tests","hidden":false},
+          {"type":"build","section":"Core","hidden":false},
+          {"type":"clean","section":"Core","hidden":false},
+          {"type":"configure","section":"Core","hidden":false},
+          {"type":"install","section":"Core","hidden":false},
+          {"type":"list","section":"Core","hidden":false},
+          {"type":"rebuild","section":"Core","hidden":false},
+          {"type":"remove","section":"Core","hidden":false},
+          {"type":"deps","section":"Core","hidden":false},
+          {"type":"python","section":"Core","hidden":false},
+          {"type":"lin","section":"Core","hidden":false},
+          {"type":"linux","section":"Core","hidden":false},
+          {"type":"mac","section":"Core","hidden":false},
+          {"type":"macos","section":"Core","hidden":false},
+          {"type":"win","section":"Core","hidden":false},
+          {"type":"windows","section":"Core","hidden":false},
+          {"type":"zos","section":"Core","hidden":false},
+          {"type":"doc","section":"Doc","hidden":false},
+          {"type":"docs","section":"Doc","hidden":false},
+          {"type":"readme","section":"Doc","hidden":false},
+          {"type":"chore","section":"Miscellaneous","hidden":false},
+          {"type":"refactor","section":"Miscellaneous","hidden":false},
+          {"type":"ci","section":"Miscellaneous","hidden":false},
+          {"type":"meta","section":"Miscellaneous","hidden":false}]
+        # Standard Conventional Commits: `feat` and `fix`
+        # node-gyp subdirectories: `bin`, `gyp`, `lib`, `src`, `test`
+        # node-gyp subcommands: `build`, `clean`, `configure`, `install`, `list`, `rebuild`, `remove`
+        # Core abstract category: `deps`
+        # Languages/platforms: `python`, `lin`, `linux`, `mac`, `macos`, `win`, `window`, `zos`
+        # Documentation: `doc`, `docs`, `readme`
+        # Standard Conventional Commits: `chore` (under "Miscellaneous")
+        # Miscellaneous abstract categories: `refactor`, `ci`, `meta`
 
-          # Standard Conventional Commits: `feat` and `fix`
-          # node-gyp subdirectories: `bin`, `gyp`, `lib`, `src`, `test`
-          # node-gyp subcommands: `build`, `clean`, `configure`, `install`, `list`, `rebuild`, `remove`
-          # Core abstract category: `deps`
-          # Languages/platforms: `python`, `lin`, `linux`, `mac`, `macos`, `win`, `window`, `zos`
-          # Documentation: `doc`, `docs`, `readme`
-          # Standard Conventional Commits: `chore` (under "Miscellaneous")
-          # Miscellaneous abstract categories: `refactor`, `ci`, `meta`
+  test:
+    name: Release Test
+    needs: [ release-please ]
+    if: needs.release-please.outputs.pr
+    uses: ./.github/workflows/tests.yml

.github/workflows/tests.yml

@@ -1,33 +1,108 @@
 # https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources
-# TODO: Line 48, enable pytest --doctest-modules
+# TODO: add `python -m pytest --doctest-modules`
 
 name: Tests
 on:
   push:
     branches: [ main ]
   pull_request:
     branches: [ main ]
+  workflow_call:
+
+permissions:
+  contents: read # to fetch code (actions/checkout)
+
 jobs:
-  Lint_Python:
+  lint-python:
+    name: Lint Python
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - run: pip install --user ruff
-    - run: ruff --format=github --select="E,F,PLC,PLE,UP,W,YTT" --ignore="PLC1901,S101,UP031" --target-version=py37 .
-  Tests:
+    - run: ruff --output-format=github --select="E,F,PLC,PLE,UP,W,YTT" --ignore="E721,PLC1901,S101,UP031" --target-version=py38 .
+
+  lint-js:
+    name: Lint JS
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v4
+    - name: Use Node.js 20.x
+      uses: actions/setup-node@v4
+      with:
+        node-version: 20.x
+    - name: Install Dependencies
+      run: npm install
+    - name: Lint
+      run: npm run lint
+
+  check-engines:
+    name: Check Engines
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v4
+    - name: Use Node.js 20.x
+      uses: actions/setup-node@v4
+      with:
+        node-version: 20.x
+    - name: Install Dependencies
+      run: npm install
+    - name: Check Engines
+      run: |
+        # TODO: move this to its own action
+        npm install @npmcli/arborist@7 semver@7 --no-save
+        node .github/scripts/check-engines.js
+
+  test-pack:
+    name: Test Pack
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v4
+    - name: Use Node.js 20.x
+      uses: actions/setup-node@v4
+      with:
+        node-version: 20.x
+    - name: Update npm
+      run: npm install npm@latest -g
+    - name: Install Dependencies
+      run: npm install
+    - name: Pack
+      id: pack
+      env:
+        NODE_GYP_TEMP_DIR: '${{ runner.temp }}/node-gyp'
+      run: |
+        mkdir -p $NODE_GYP_TEMP_DIR
+        npm pack
+        tar xzf *.tgz -C $NODE_GYP_TEMP_DIR --strip-components=1
+        cp -r test/ $NODE_GYP_TEMP_DIR/test/
+        echo "dir=$NODE_GYP_TEMP_DIR" >> "$GITHUB_OUTPUT"
+    - name: Test
+      working-directory: ${{ steps.pack.outputs.dir }}
+      env:
+        FULL_TEST: '1'
+      run: |
+        npm install
+        npm test
+
+  tests:
+    # lint-python takes ~5 seconds, so wait for it to pass before running the full matrix of tests.
+    needs: [lint-python] 
     strategy:
       fail-fast: false
       max-parallel: 15
       matrix:
+        os: [macos, ubuntu, windows]
+        python: ["3.8", "3.10", "3.12"]
         node: [16.x, 18.x, 20.x]
-        python: ["3.8", "3.11"]
-        os: [macos-latest, ubuntu-latest, windows-latest]
-    runs-on: ${{ matrix.os }}
+    name: ${{ matrix.os }} - ${{ matrix.python }} - ${{ matrix.node }}
+    runs-on: ${{ matrix.os }}-latest
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
       - name: Use Python ${{ matrix.python }}
@@ -38,18 +113,24 @@ jobs:
           PYTHON_VERSION: ${{ matrix.python }}  # Why do this?
       - name: Install Dependencies
         run: |
-          npm install --no-progress
+          npm install
           pip install pytest
-      - name: Set Windows environment
-        if: startsWith(matrix.os, 'windows')
+      - name: Set Windows Env
+        if: runner.os == 'Windows'
         run: |
           echo 'GYP_MSVS_VERSION=2015' >> $Env:GITHUB_ENV
           echo 'GYP_MSVS_OVERRIDE_PATH=C:\\Dummy' >> $Env:GITHUB_ENV
-      - name: Run Python tests
+      - name: Run Python Tests
         run: python -m pytest
-      # - name: Run doctests with pytest
-      #   run: python -m pytest --doctest-modules
-      - name: Environment Information
-        run: npx envinfo
-      - name: Run Node tests
-        run: npm test
+      - name: Run Tests (macOS or Linux)
+        if: runner.os != 'Windows'
+        shell: bash
+        run: npm test --python="${pythonLocation}/python"
+        env:
+          FULL_TEST: ${{ (matrix.node == '20.x' && matrix.python == '3.12') && '1' || '0' }}
+      - name: Run Tests (Windows)
+        if: runner.os == 'Windows'
+        shell: pwsh
+        run: npm run test --python="${env:pythonLocation}\\python.exe"
+        env:
+          FULL_TEST: ${{ (matrix.node == '20.x' && matrix.python == '3.12') && '1' || '0' }}

.github/workflows/visual-studio.yml

@@ -6,28 +6,29 @@ on:
     branches: [ main ]
   pull_request:
     branches: [ main ]
+
+permissions:
+  contents: read # to fetch code (actions/checkout)
+
 jobs:
   visual-studio:
     strategy:
       fail-fast: false
       max-parallel: 8
       matrix:
-        os: [windows-latest]
-        msvs-version: [2016, 2019, 2022]  # https://github.com/actions/virtual-environments/tree/main/images/win
+        include:
+          - os: windows-2019
+            msvs-verison: 2019
+          - os: windows-2022
+            msvs-version: 2022
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install Dependencies
-        run: |
-          npm install --no-progress
-          # npm audit fix --force
-      - name: Set Windows environment
-        if: startsWith(matrix.os, 'windows')
-        run: |
-          echo 'GYP_MSVS_VERSION=${{ matrix.msvs-version }}' >> $Env:GITHUB_ENV
-          echo 'GYP_MSVS_OVERRIDE_PATH=C:\\Dummy' >> $Env:GITHUB_ENV
-      - name: Environment Information
-        run: npx envinfo
+        run: npm install
       - name: Run Node tests
-        run: npm test
+        shell: pwsh
+        run: |
+          $pythonLocation = (Get-Command python).Source
+          npm run test --python="${pythonLocation}" --msvs-version="${{ matrix.msvs-version }}"

.gitignore

@@ -1,7 +1,8 @@
+.ncu
+.nyc_output
 *.swp
 gyp/test
 node_modules
-test/.node-gyp
-.ncu
-.nyc_output
+node-gyp-*.tgz
 package-lock.json
+test/.node-gyp