Support requireReason

index.d.ts

@@ -14,9 +14,15 @@ interface Vuln {
     paths: Array<string>
 }
 
+enum VulnResolutionValidationError {
+    REASON_MISSING = 'reasonMissing',
+    REASON_MISMATCH = 'reasonMismatch',
+};
+
 interface VulnResolution extends Vuln {
-    resolutions: Arry<{
+    resolutions: Array<{
         path: string,
-        resolution: any
+        resolution: any,
+        validationError: VulnResolutionValidationError | undefined
     }>
 }

src/check/auditChecker.js

@@ -1,34 +1,33 @@
-const { getResolution, RESOLUTIONS } = require('audit-resolve-core');
+const { getResolution, getValidationError, RESOLUTIONS, VALIDATIONS } = require('audit-resolve-core');
 
 
 module.exports = {
     /**
-     *
-     *
      * @param {Array<Vuln>} audit
-     * @returns {Array<VulnResolution} 
+     * @returns {Array<VulnResolution}
      */
     getUnresolved(audit = []) {
-        return audit.map(item => {
+        return audit.map(vuln => {
             let unresolved = false;
-            item.resolutions = item.paths.map(path => {
-                const resolution = getResolution({ id: item.id, path })
+            let validationError = undefined;
+            vuln.resolutions = vuln.paths.map(path => {
+                const resolution = getResolution({ id: vuln.id, path })
                 if (resolution) {
                     if (resolution === RESOLUTIONS.EXPIRED) {
                         unresolved = true
                     }
                     if (resolution === RESOLUTIONS.NONE) {
                         unresolved = true
                     }
+                    validationError = getValidationError({ id: vuln.id, path });
                 } else {
                     unresolved = true
                 }
-                return { path, resolution }
-
+                return { path, resolution, validationError }
             })
-            if (unresolved) {
-                return item
+            if (unresolved || validationError) {
+                return vuln
             }
-        }).filter(a => a);
+        }).filter(vuln => vuln);
     }
-}
+}

src/views/package.js

@@ -1,4 +1,4 @@
-const { RESOLUTIONS } = require('audit-resolve-core');
+const { RESOLUTIONS, VALIDATIONS } = require('audit-resolve-core');
 
 const safePrint = require('util').promisify(process.stdout.write.bind(process.stdout))
 const severityNumber = {
@@ -12,9 +12,15 @@ reportMessages = {
     [RESOLUTIONS.EXPIRED]: "! decision to ignore expired"
 }
 
+validationMessages = {
+    [VALIDATIONS.REASON_MISSING]: "'reason' field missing",
+    [VALIDATIONS.REASON_MISMATCH]: "'reason' field doesn't respect regex specified in audit-resolve file / rules.requiresReasonMatch"
+}
+
 function reportResolution(resolution) {
     return reportMessages[resolution] || ""
 }
+
 const view = {
     /**
      *
@@ -26,7 +32,10 @@ const view = {
             `--------------------------------------------------`
         );
         console.log(`[${issue.severity}] ${issue.name}: ${issue.title} (${issue.id})`);
-        console.log(issue.resolutions.map(({ path, resolution }) => `  ${path} ${reportResolution(resolution)}`).join("\n"));
+        console.log(issue.resolutions.map(({ path, resolution, validationError }) => {
+            const validationErrorMsg = validationError ? (`\n  Invalid resolution: ${validationMessages[validationError]}` || '') : ''
+            return `  ${path} ${reportResolution(resolution)}${validationErrorMsg}`
+        }).join("\n"));
     },
     printOhnoes() {
         console.log(