Merge pull request #94 from SocketDev/cg/humanReadableIssues

Add link and human readable issue names

Author: charliegerard

lib/commands/info/index.js

@@ -175,7 +175,7 @@ async function fetchPackageData (pkgName, pkgVersion, { includeAllIssues }, spin
       const issueSummary = formatSeverityCount(severityCount)
       console.log('\n')
       spinner[strict ? 'fail' : 'succeed'](`Package has these issues: ${issueSummary}`)
-      formatPackageIssuesDetails(data)
+      formatPackageIssuesDetails(data, outputMarkdown)
     } else {
       console.log('\n')
       spinner.succeed('Package has no issues')
@@ -197,26 +197,35 @@ async function fetchPackageData (pkgName, pkgVersion, { includeAllIssues }, spin
 
 /**
  * @param {import('@socketsecurity/sdk').SocketSdkReturnType<'getIssuesByNPMPackage'>["data"]} packageData
+ * @param {boolean} outputMarkdown
  * @returns {void[]}
  */
-function formatPackageIssuesDetails (packageData) {
+function formatPackageIssuesDetails (packageData, outputMarkdown) {
   const issueDetails = packageData.filter(d => d.value?.severity === 'high' || d.value?.severity === 'critical')
-  const uniqueIssues = issueDetails.reduce((/** @type {{ [key: string]: number }} */ acc, issue) => {
+
+  const uniqueIssues = issueDetails.reduce((/** @type {{ [key: string]: {count: Number, label: string | undefined} }} */ acc, issue) => {
   const { type } = issue
     if (type) {
       if (!acc[type]) {
-        acc[type] = 1
+        acc[type] = {
+          label: issue.value?.label,
+          count: 1
+        }
       } else {
-        acc[type]++
+        // @ts-ignore
+        acc[type].count += 1
       }
     }
     return acc
   }, {})
+
+  const format = new ChalkOrMarkdown(!!outputMarkdown)
   return Object.keys(uniqueIssues).map(issue => {
-    if (uniqueIssues[issue] === 1) {
-      return console.log(`- ${issue}`)
+    const issueWithLink = format.hyperlink(`${uniqueIssues[issue]?.label}`, `https://socket.dev/npm/issue/${issue}`, { fallbackToUrl: true })
+    if (uniqueIssues[issue]?.count === 1) {
+      return console.log(`- ${issueWithLink}`)
     }
-    return console.log(`- ${issue}: ${uniqueIssues[issue]}`)
+    return console.log(`- ${issueWithLink}: ${uniqueIssues[issue]?.count}`)
   })
 }
 

package-lock.json

@@ -82,7 +82,7 @@
   "dependencies": {
     "@apideck/better-ajv-errors": "^0.3.6",
     "@socketsecurity/config": "^2.0.0",
-    "@socketsecurity/sdk": "^0.7.2",
+    "@socketsecurity/sdk": "^0.7.3",
     "chalk": "^5.1.2",
     "globby": "^13.1.3",
     "hpagent": "^1.2.0",