.eslintrc.json

@@ -0,0 +1,215 @@
+{
+  "parserOptions": {
+    "ecmaVersion": 2020,
+    "ecmaFeatures": {
+      "jsx": true
+    },
+    "sourceType": "module"
+  },
+
+  "env": {
+    "es6": true,
+    "node": true
+  },
+
+  "plugins": [
+    "import",
+    "node",
+    "promise",
+    "standard"
+  ],
+
+  "globals": {
+    "document": "readonly",
+    "navigator": "readonly",
+    "window": "readonly"
+  },
+
+  "rules": {
+    "accessor-pairs": "error",
+    "array-bracket-spacing": ["error", "never"],
+    "arrow-spacing": ["error", { "before": true, "after": true }],
+    "block-spacing": ["error", "always"],
+    "brace-style": ["error", "1tbs", { "allowSingleLine": true }],
+    "camelcase": ["error", { "properties": "never" }],
+    "comma-dangle": ["error", {
+      "arrays": "never",
+      "objects": "never",
+      "imports": "never",
+      "exports": "never",
+      "functions": "never"
+    }],
+    "comma-spacing": ["error", { "before": false, "after": true }],
+    "comma-style": ["error", "last"],
+    "computed-property-spacing": ["error", "never"],
+    "constructor-super": "error",
+    "curly": ["error", "multi-line"],
+    "dot-location": ["error", "property"],
+    "dot-notation": ["error", { "allowKeywords": true }],
+    "eol-last": "error",
+    "eqeqeq": ["error", "always", { "null": "ignore" }],
+    "func-call-spacing": ["error", "never"],
+    "generator-star-spacing": ["error", { "before": true, "after": true }],
+    "handle-callback-err": ["error", "^(err|error)$" ],
+    "indent": ["error", 2, {
+      "SwitchCase": 1,
+      "VariableDeclarator": 1,
+      "outerIIFEBody": 1,
+      "MemberExpression": 1,
+      "FunctionDeclaration": { "parameters": 1, "body": 1 },
+      "FunctionExpression": { "parameters": 1, "body": 1 },
+      "CallExpression": { "arguments": 1 },
+      "ArrayExpression": 1,
+      "ObjectExpression": 1,
+      "ImportDeclaration": 1,
+      "flatTernaryExpressions": true,
+      "ignoreComments": false,
+      "ignoredNodes": ["TemplateLiteral *"]
+    }],
+    "key-spacing": ["error", { "beforeColon": false, "afterColon": true }],
+    "keyword-spacing": ["error", { "before": true, "after": true }],
+    "lines-between-class-members": ["error", "always", { "exceptAfterSingleLine": true }],
+    "new-cap": ["error", { "newIsCap": true, "capIsNew": false, "properties": true }],
+    "new-parens": "error",
+    "no-array-constructor": "error",
+    "no-async-promise-executor": "error",
+    "no-caller": "error",
+    "no-case-declarations": "error",
+    "no-class-assign": "error",
+    "no-compare-neg-zero": "error",
+    "no-cond-assign": "error",
+    "no-const-assign": "error",
+    "no-constant-condition": ["error", { "checkLoops": false }],
+    "no-control-regex": "error",
+    "no-debugger": "error",
+    "no-delete-var": "error",
+    "no-dupe-args": "error",
+    "no-dupe-class-members": "error",
+    "no-dupe-keys": "error",
+    "no-duplicate-case": "error",
+    "no-empty-character-class": "error",
+    "no-empty-pattern": "error",
+    "no-eval": "error",
+    "no-ex-assign": "error",
+    "no-extend-native": "error",
+    "no-extra-bind": "error",
+    "no-extra-boolean-cast": "error",
+    "no-extra-parens": ["error", "functions"],
+    "no-fallthrough": "error",
+    "no-floating-decimal": "error",
+    "no-func-assign": "error",
+    "no-global-assign": "error",
+    "no-implied-eval": "error",
+    "no-inner-declarations": ["error", "functions"],
+    "no-invalid-regexp": "error",
+    "no-irregular-whitespace": "error",
+    "no-iterator": "error",
+    "no-labels": ["error", { "allowLoop": false, "allowSwitch": false }],
+    "no-lone-blocks": "error",
+    "no-misleading-character-class": "error",
+    "no-prototype-builtins": "error",
+    "no-useless-catch": "error",
+    "no-mixed-operators": ["error", {
+      "groups": [
+        ["==", "!=", "===", "!==", ">", ">=", "<", "<="],
+        ["&&", "||"],
+        ["in", "instanceof"]
+      ],
+      "allowSamePrecedence": true
+    }],
+    "no-mixed-spaces-and-tabs": "error",
+    "no-multi-spaces": "error",
+    "no-multi-str": "error",
+    "no-multiple-empty-lines": ["error", { "max": 1, "maxEOF": 0 }],
+    "no-negated-in-lhs": "error",
+    "no-new": "error",
+    "no-new-func": "error",
+    "no-new-object": "error",
+    "no-new-require": "error",
+    "no-new-symbol": "error",
+    "no-new-wrappers": "error",
+    "no-obj-calls": "error",
+    "no-octal": "error",
+    "no-octal-escape": "error",
+    "no-path-concat": "error",
+    "no-proto": "error",
+    "no-redeclare": ["error", { "builtinGlobals": false }],
+    "no-regex-spaces": "error",
+    "no-return-assign": ["error", "except-parens"],
+    "no-self-assign": ["error", { "props": true }],
+    "no-self-compare": "error",
+    "no-sequences": "error",
+    "no-shadow-restricted-names": "error",
+    "no-sparse-arrays": "error",
+    "no-tabs": "error",
+    "no-template-curly-in-string": "error",
+    "no-this-before-super": "error",
+    "no-throw-literal": "off",
+    "no-trailing-spaces": "error",
+    "no-undef": "error",
+    "no-undef-init": "error",
+    "no-unexpected-multiline": "error",
+    "no-unmodified-loop-condition": "error",
+    "no-unneeded-ternary": ["error", { "defaultAssignment": false }],
+    "no-unreachable": "error",
+    "no-unsafe-finally": 0,
+    "no-unsafe-negation": "error",
+    "no-unused-expressions": ["error", { "allowShortCircuit": true, "allowTernary": true, "allowTaggedTemplates": true }],
+    "no-unused-vars": ["error", { "vars": "all", "args": "none", "ignoreRestSiblings": true }],
+    "no-use-before-define": ["error", { "functions": false, "classes": false, "variables": false }],
+    "no-useless-call": "error",
+    "no-useless-computed-key": "error",
+    "no-useless-constructor": "error",
+    "no-useless-escape": "error",
+    "no-useless-rename": "error",
+    "no-useless-return": "error",
+    "no-void": "error",
+    "no-whitespace-before-property": "error",
+    "no-with": "error",
+    "object-curly-newline": ["error", { "multiline": true, "consistent": true }],
+    "object-curly-spacing": ["error", "always"],
+    "object-property-newline": ["error", { "allowMultiplePropertiesPerLine": true }],
+    "one-var": ["error", { "initialized": "never" }],
+    "operator-linebreak": ["error", "after", { "overrides": { "?": "before", ":": "before", "|>": "before" } }],
+    "padded-blocks": ["error", { "blocks": "never", "switches": "never", "classes": "never" }],
+    "prefer-const": ["error", {"destructuring": "all"}],
+    "prefer-promise-reject-errors": "error",
+    "quote-props": ["error", "as-needed"],
+    "quotes": ["error", "single", { "avoidEscape": true, "allowTemplateLiterals": false }],
+    "rest-spread-spacing": ["error", "never"],
+    "semi": ["error", "never"],
+    "semi-spacing": ["error", { "before": false, "after": true }],
+    "space-before-blocks": ["error", "always"],
+    "space-before-function-paren": ["error", "always"],
+    "space-in-parens": ["error", "never"],
+    "space-infix-ops": "error",
+    "space-unary-ops": ["error", { "words": true, "nonwords": false }],
+    "spaced-comment": ["error", "always", {
+      "line": { "markers": ["*package", "!", "/", ",", "="] },
+      "block": { "balanced": true, "markers": ["*package", "!", ",", ":", "::", "flow-include"], "exceptions": ["*"] }
+    }],
+    "symbol-description": "error",
+    "template-curly-spacing": ["error", "never"],
+    "template-tag-spacing": ["error", "never"],
+    "unicode-bom": ["error", "never"],
+    "use-isnan": "error",
+    "valid-typeof": ["error", { "requireStringLiterals": true }],
+    "wrap-iife": ["error", "any", { "functionPrototypeMethods": true }],
+    "yield-star-spacing": ["error", "both"],
+    "yoda": ["error", "never"],
+
+    "import/export": "error",
+    "import/first": "error",
+    "import/no-absolute-path": ["error", { "esmodule": true, "commonjs": true, "amd": false }],
+    "import/no-duplicates": "error",
+    "import/no-named-default": "error",
+    "import/no-webpack-loader-syntax": "error",
+
+    "node/no-deprecated-api": "error",
+    "node/process-exit-as-throw": "error",
+
+    "promise/param-names": "off",
+
+    "standard/no-callback-literal": "error"
+  }
+}

.github/settings.yml

@@ -0,0 +1,2 @@
+---
+_extends: 'open-source-project-boilerplate'

.github/workflows/benchmark-comment.yml

@@ -0,0 +1,92 @@
+---
+name: Benchmark CLI - Comment
+
+on:
+  issue_comment:
+    types: [created, edited]
+
+jobs:
+  comment-handler:
+    name: Trigger Benchmarks
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Handle Incoming Comment
+        env:
+          DISPATCH_REPO: "benchmarks"
+          DISPATCH_OWNER: "npm"
+          EVENT_NAME: ${{ github.event_name }}
+          EVENT_ACTION: ${{ github.event.action }}
+          OWNER: ${{ github.event.repository.owner.login }}
+          REPO: ${{ github.event.repository.name }}
+          ISSUE_NUMBER: ${{ github.event.issue.number }}
+          COMMENT_BODY: ${{ github.event.comment.body }}
+          COMMENT_ID: ${{ github.event.comment.id }}
+          COMMENT_NODE_ID: ${{ github.event.comment.node_id }}
+          COMMENT_ACTIONABLE: ${{ startsWith(github.event.comment.body, 'test this please ✅') }}
+          AUTH_TOKEN: ${{ secrets.NPM_DEPLOY_USER_PAT }}
+        run: |
+          # Comment Handler
+
+          # Creates an exit early condition if there are errors
+          # Exit early if `jq` is not present
+          set -e
+          jq --version
+
+          # Figure out if comment came from pull-request or issue
+          IS_PR=$(curl -s https://api.github.com/repos/${OWNER}/${REPO}/issues/${ISSUE_NUMBER} | jq -cr '.pull_request.url')
+
+          if [ "${IS_PR}" != "null" ]; then
+            echo "Comment from pull/${ISSUE_NUMBER}."
+
+            # It is a pull-request; check comment body for correct phrase
+            if [ "${COMMENT_ACTIONABLE}" == "true" ]; then
+              # Fetch pull-request information
+              PR_DATA=$(curl -s "${IS_PR}")
+              PR_OWNER=$(echo "${PR_DATA}" | jq '.head.repo.owner.login')
+              PR_REPO=$(echo "${PR_DATA}" | jq '.head.repo.name')
+              PR_COMMIT_SHA=$(curl -s "${IS_PR}/commits" | jq -r '.[0].sha')
+
+              # dispatch request for benchmarks
+              echo "Dispatching request..."
+              curl \
+                -s \
+                -X POST https://api.github.com/repos/${DISPATCH_OWNER}/${DISPATCH_REPO}/dispatches \
+                -H "Accept: application/vnd.github.everest-preview+json" \
+                -H "Authorization: token ${AUTH_TOKEN}" \
+                -d \
+                '
+                {
+                  "event_type": "'"${EVENT_NAME}"'",
+                  "client_payload": {
+                    "pr_id": "'"${ISSUE_NUMBER}"'",
+                    "repo": "'"${PR_REPO}"'",
+                    "owner": "'"${PR_OWNER}"'",
+                    "commit_sha": "'"${PR_COMMIT_SHA}"'"
+                  }
+                }'
+
+              # Create reaction on comment to confirm dispatch was sent
+              curl \
+                -s \
+                -X POST https://api.github.com/graphql \
+                -H "Content-Type: application/json" \
+                -H "Authorization: token ${AUTH_TOKEN}" \
+                -d \
+                '
+                {
+                  "query": "mutation($inputData:AddReactionInput!) { addReaction(input:$inputData) { reaction { content } } }",
+                  "variables": {
+                    "inputData": {
+                      "subjectId": "'"${COMMENT_NODE_ID}"'",
+                      "content": "ROCKET"
+                    }
+                  }
+                }'
+            else
+              echo "Comment not actionable."
+            fi
+          else
+            echo "Comment not from pull-request."
+          fi

.github/workflows/benchmark.yml

@@ -0,0 +1,68 @@
+---
+name: Benchmark Suite
+
+on:
+  push:
+    branches:
+      - "latest"
+  pull_request:
+    branches:
+      - "**"
+
+jobs:
+  build:
+    name: Trigger Benchmarks
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Handle Incoming Pull-Request
+        env:
+          DISPATCH_REPO: "benchmarks"
+          DISPATCH_OWNER: "npm"
+          EVENT_NAME: ${{ github.event_name }}
+          EVENT_ACTION: ${{ github.event.action }}
+          REPO: ${{ github.event.repository.name }}
+          PR_NUMBER: ${{ github.event.pull_request.number }}
+          PR_OWNER: ${{ github.event.pull_request.head.repo.owner.login }}
+          PR_COMMITS_URL: ${{ github.event.pull_request.commits_url }}
+          PR_COMMIT_SHA: ${{ github.event.pull_request.head.sha }}
+          AUTH_TOKEN: ${{ secrets.NPM_DEPLOY_USER_PAT }}
+        run: |
+          # Dispatch Handler
+
+          dispatch_request () {
+            echo "Dispatching request..."
+            REF_SHA=$1
+            curl \
+              -s \
+              -X POST https://api.github.com/repos/${DISPATCH_OWNER}/${DISPATCH_REPO}/dispatches \
+              -H "Accept: application/vnd.github.everest-preview+json" \
+              -H "Authorization: token ${AUTH_TOKEN}" \
+              -d \
+              '
+              {
+                "event_type": "'"${EVENT_NAME}"'",
+                "client_payload": {
+                  "pr_id": "'"${PR_NUMBER}"'",
+                  "repo": "'"${REPO}"'",
+                  "owner": "'"${PR_OWNER}"'",
+                  "commit_sha": "'"${REF_SHA}"'"
+                }
+              }'
+          }
+
+          if [ "${AUTH_TOKEN}" != "" ]; then
+            if [ "${EVENT_ACTION}" == "opened" ]; then
+              # Fetch the head commit sha, since it doesn't exist in the body of this event
+              COMMIT_SHA=$(curl -s "${PR_COMMITS_URL}" | jq -r '.[0].sha')
+
+              # Dispatch request for benchmarks
+              dispatch_request "${COMMIT_SHA}"
+            else
+              # Dispatch request for benchmarks
+              dispatch_request "${PR_COMMIT_SHA}"
+            fi
+          else
+            echo "NO AUTH - FORK PULL REQUEST"
+          fi