add: schema improvements (#18)

* fix docs

* add format in schema validation

* fix loggerr instance

* Apply suggestions from code review

Co-authored-by: Jordan Harband <[email protected]>

Co-authored-by: Jordan Harband <[email protected]>

Author: Eomm

.github/workflows/test.yml

@@ -11,8 +11,10 @@ jobs:
     strategy:
       matrix:
         node-version: [10.x, 12.x, 14.x]
+        os: [ubuntu-latest, windows-latest]
+
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v2
     - name: Use Node.js ${{ matrix.node-version }}
       uses: actions/setup-node@v1
       with:

README.md

@@ -11,7 +11,7 @@
 
 When an author releases an Open Source package there are many different levels
 of support they may intend to provide.  The [Node.js Package Maintenence Working Group](https://github.com/nodejs/package-maintenance)
-is working to propose [a spec](https://github.com/nodejs/package-maintenance/issues/220) to help package authors declare their intended support goals.  This package provides
+is working to propose [a spec](https://github.com/nodejs/package-maintenance/blob/HEAD/docs/PACKAGE-SUPPORT.md) to help package authors declare their intended support goals.  This package provides
 some tooling around working with the format proposed.
 
 This repository is managed by the [Package Maintenance Working Group](https://github.com/nodejs/package-maintenance), see [Governance](https://github.com/nodejs/package-maintenance/blob/master/Governance.md).
@@ -48,9 +48,9 @@ commands is provided in [command line usage](./doc/command-line-usage.md).
 The simplest way to run the tool is to simply run:
 
 ```
-npx support show
+npx @pkgjs/support show
 ```
 
 ```
-npx support validate
+npx @pkgjs/support validate
 ```

bin/support

@@ -1,2 +1,2 @@
 #! /usr/bin/env node
-require('../lib/cli')()(process.argv.slice(2))
+require('../lib/cli')()(process.argv.slice(2));

doc/command-line-usage.md

@@ -41,9 +41,9 @@ For example once node.js and the package support tool are installed to show
 the package support for a module (the support module itself in this example):
 
 ```shell
-npm install support
-cd node_modules/support
-npx support show
+npm install @pkgjs/support
+cd node_modules/@pkgjs/support
+npx @pkgjs/support show
 ```
 
 with a stripped down version of the the output to make it more easily readable being:
@@ -92,7 +92,7 @@ as when the package.json specifies that there is support info but it is not avai
 For example:
 
 ```
-npx show --canonical
+npx @pkgjs/support show --canonical
 ```
 
 
@@ -129,7 +129,7 @@ add the `--fetch` option which will pull the remote support information when nec
 The following command/options will always show the most up to date package support information
 at the cost of fetching from remote sites.
 ```
-npx show --canonical --fetch
+npx @pkgjs/support show --canonical --fetch
 ```
 
 `--fetch` can also be used without `--canonical` in which case the remote support
@@ -143,7 +143,7 @@ support info in these cases you can use the `--base-path` option to specify the
 most root from which packge support files can be read:
 
 ```shell
-npx support  --base-path=${cwd}/../.. show
+npx @pkgjs/support --base-path=${cwd}/../.. show
 ```
 
 In the case where the required base path is not specified, and the file is outside
@@ -226,5 +226,5 @@ support info in these cases you can use the `--base-path` option to specify the
 most root from which packge support files can be read:
 
 ```shell
-npx support  --base-path=${cwd}/../.. validate
+npx @pkgjs/support --base-path=${cwd}/../.. validate
 ```

lib/cli/index.js

@@ -1,7 +1,7 @@
 'use strict';
 const yargs = require('yargs/yargs');
 const path = require('path');
-const Loggerr = require('loggerr');
+const { Loggerr } = require('loggerr');
 
 module.exports = (options = {}) => {
   // Defaults cli configuration

package.json

@@ -28,10 +28,10 @@
     "@npmcli/arborist": "^0.0.0",
     "ajv": "^6.11.0",
     "better-ajv-errors": "^0.6.7",
+    "fs-extra": "^8.1.0",
     "got": "^11.1.3",
-    "loggerr": "^3.0.0-0",
+    "loggerr": "^3.0.0-2",
     "normalize-url": "^5.0.0",
-    "fs-extra": "^8.1.0",
     "yargs": "^15.0.2"
   },
   "devDependencies": {

schema.json

@@ -22,7 +22,7 @@
       "required": ["version"],
       "properties": {
         "version": { "$ref": "#SemVerRange" },
-        "expires": { "type": "string" },
+        "expires": { "type": "string", "format": "date-time" },
         "target": { "$ref": "#SupportTarget" },
         "response": {
           "oneOf": [{
@@ -125,8 +125,8 @@
       "required": ["name"],
       "properties": {
         "name": { "type": "string" },
-        "email": { "type": "string" },
-        "url": { "type": "string" }
+        "email": { "type": "string", "format": "email" },
+        "url": { "type": "string", "format": "uri" }
       }
     },
 

support-element-schema.json

@@ -29,7 +29,7 @@
       "required": ["type", "url"],
       "properties": {
         "type": { "enum": [ "git" ] },
-        "url": { "type": "string" },
+        "url": { "type": "string", "format": "uri" },
         "directory": { "type": "string" }
       },
       "additionalProperties": false