Multiple fixes (#25)

* src: handle malformed JSON better

Report an error if the JSON in package-support.json
is malformed instead of silently failing

Signed-off-by: Michael Dawson <[email protected]>

* src: validate as per spec for backing

Allow backing to be an array a the top level as per
the spec: https://github.com/nodejs/package-maintenance/blob/main/docs/PACKAGE-SUPPORT.md#support-backing

Author: mhdawson

lib/cli/commands/validate.js

@@ -46,16 +46,21 @@ module.exports = function (opts) {
           argv['base-path'],
           argv.fetch);
         if (supportData.resolved) {
-          const supportDataJSON = JSON.parse(supportData.contents);
           try {
-            const result = support.validate(supportDataJSON, true);
-            if (result) {
-              console.log('Your support information is valid!');
-              return;
+            const supportDataJSON = JSON.parse(supportData.contents);
+            try {
+              const result = support.validate(supportDataJSON, true);
+              if (result) {
+                console.log('Your support information is valid!');
+                return;
+              }
+            } catch (e) {
+              console.log('Error in support JSON');
+              console.log(e.prettyValidationErrors);
             }
           } catch (e) {
-            console.log('Error in support JSON');
-            console.log(e.prettyValidationErrors);
+            console.log('Your support information is not properly formed');
+            console.log(e.message);
           }
         } else {
           console.log('support info not resolved: ' + supportData.url);

schema.json

@@ -33,7 +33,15 @@
             "items": { "$ref": "#SupportResponse" }
           }]
         },
-        "backing": { "$ref": "#SupportBacking" }
+        "backing": {
+          "oneOf": [{
+              "$ref": "#SupportBacking"
+            }, {
+            "type": "array",
+            "minItems": 1,
+            "items": { "$ref": "#SupportBacking" }
+          }]
+        }
       },
       "additionalProperties": false
     },

test/cli/validate-invalid-json/command

@@ -0,0 +1 @@
+validate 

test/cli/validate-invalid-json/expected

@@ -0,0 +1,2 @@
+Your support information is not properly formed
+Unexpected end of JSON input

test/cli/validate-invalid-json/package-support.json

@@ -0,0 +1,5 @@
+{
+  "name": "@pkgjs/validate-multiple-backing",
+  "version": "0.0.1",
+  "support": true
+}

test/cli/validate-invalid-json/package.json

@@ -0,0 +1 @@
+validate 

test/cli/validate-multiple-backing/command

@@ -0,0 +1 @@
+Your support information is valid!

test/cli/validate-multiple-backing/expected

@@ -0,0 +1,22 @@
+{
+  "versions": [
+    {
+      "version": "*",
+      "target": {
+        "node": "lts"
+      },
+      "response": {
+        "type": "time-permitting",
+        "paid": false,
+        "contact": {
+          "name": "node-addon-api team",
+          "url": "https://github.com/nodejs/node-addon-api/issues"
+        }
+      },
+      "backing": [
+        { "project": "https://github.com/nodejs" },
+        { "foundation": "https://openjsf.org/" }
+      ]
+    }
+  ]
+}

test/cli/validate-multiple-backing/package-support.json

@@ -0,0 +1,5 @@
+{
+  "name": "@pkgjs/validate-multiple-backing",
+  "version": "0.0.1",
+  "support": true
+}