Merge branch 'master' into 8437-windows

.circleci/config.yml

@@ -26,26 +26,6 @@ services_steps: &services_steps
         path: junit
 
 jobs:
-  danger:
-    docker:
-      - image: cimg/node:16.15
-    steps:
-      - checkout
-
-      - run:
-          name: Install dependencies
-          command: npm ci
-          environment:
-            CYPRESS_INSTALL_BINARY: 0
-
-      - run:
-          name: Danger
-          when: always
-          environment:
-            # https://github.com/gatsbyjs/gatsby/pull/11555
-            NODE_ENV: test
-          command: npm run danger ci
-
   services:
     docker:
       - image: cimg/node:16.15
@@ -77,13 +57,6 @@ workflows:
               ignore:
                 - master
                 - gh-pages
-      - danger:
-          filters:
-            branches:
-              ignore:
-                - master
-                - gh-pages
-                - /dependabot\/.*/
   # on-commit-with-cache:
   #   jobs:
   #     - npm-install:
@@ -102,9 +75,3 @@ workflows:
   #         filters:
   #           branches:
   #             ignore: master
-  #     - danger:
-  #         requires:
-  #           - npm-install
-  #         filters:
-  #           branches:
-  #             ignore: /dependabot\/.*/

.github/workflows/danger.yml

@@ -0,0 +1,29 @@
+name: Danger
+on:
+  pull_request_target:
+    types: [opened, edited, reopened, synchronize]
+
+permissions:
+  checks: write
+  pull-requests: write
+  statuses: write
+
+jobs:
+  danger:
+    runs-on: ubuntu-latest
+    if: github.actor != 'dependabot[bot]'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup
+        uses: ./.github/actions/setup
+        with:
+          node-version: 16
+
+      - name: Danger
+        run: npm run danger ci
+        env:
+          # https://github.com/gatsbyjs/gatsby/pull/11555
+          NODE_ENV: test
+          GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'

package.json

@@ -219,7 +219,7 @@
     "npm-run-all": "^4.1.5",
     "open-cli": "^7.1.0",
     "portfinder": "^1.0.32",
-    "prettier": "2.8.1",
+    "prettier": "2.8.2",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
     "react-error-overlay": "^6.0.11",

services/pipenv-helpers.js

@@ -1,11 +1,28 @@
+/**
+ * Common functions and utilities for tasks related to pipenv
+ *
+ * @module
+ */
+
 import Joi from 'joi'
 import { InvalidParameter } from './index.js'
 
+/**
+ * Joi schema for validating dependency.
+ *
+ * @type {Joi}
+ */
 const isDependency = Joi.object({
   version: Joi.string(),
   ref: Joi.string(),
 }).required()
 
+/**
+ * Joi schema for validating lock file object.
+ * Checks if the lock file object has required properties and the properties are valid.
+ *
+ * @type {Joi}
+ */
 const isLockfile = Joi.object({
   _meta: Joi.object({
     requires: Joi.object({
@@ -16,6 +33,18 @@ const isLockfile = Joi.object({
   develop: Joi.object().pattern(Joi.string(), isDependency),
 }).required()
 
+/**
+ * Determines the dependency version based on the dependency type.
+ *
+ * @param {object} attrs - Refer to individual attributes
+ * @param {string} attrs.kind - Wanted dependency type ('dev' or 'default'), defaults to 'default'
+ * @param {string} attrs.wantedDependency - Name of the wanted dependency
+ * @param {object} attrs.lockfileData - Object containing lock file data
+ * @throws {Error} - Error if unknown dependency type provided
+ * @throws {InvalidParameter} - Error if wanted dependency is not present in lock file data
+ * @throws {InvalidParameter} - Error if version or ref is not present for the wanted dependency
+ * @returns {object} Object containing wanted dependency version or ref
+ */
 function getDependencyVersion({
   kind = 'default',
   wantedDependency,