feat(create): Add support create command (#40)

* feat(create): add "support create" command basic functionality

Author: rodion-arr

README.md

@@ -23,6 +23,7 @@ A command line tool is provided which supports the following commands:
 * show - show the support info for the package tree.
 * validate - validate support info for a package, to be used by a 
   maintainer before publishing.
+* create - setup a support declaration for a package.
 
 These commands support the following options:
 
@@ -47,3 +48,7 @@ npx @pkgjs/support show
 ```
 npx @pkgjs/support validate
 ```
+
+```
+npx @pkgjs/support create
+```

doc/command-line-usage.md

@@ -1,6 +1,6 @@
 # Using the package support tool from the command line
 
-There are 2 main uses cases for the package support tool
+There are 2 main use cases for the package support tool
 
 * Package Maintainers - document and communicate expectations to consumers
 * Package Consumers - understand more about their key dependencies and where they 
@@ -164,24 +164,35 @@ where the `support` entry was:
 
 Package maintainers want to add and manage the support information for their modules.
 
-Ultimately we'll want commands help generate the support info, but as a first step
-the `validate` command is provided which validates that the info is in the
-right format/locations. 
+[Integration into package.json](https://github.com/nodejs/package-maintenance/blob/HEAD/docs/PACKAGE-SUPPORT.md#integration-into-packagejson)
+explains the options for providing support info and what goes into the package.json for
+each case.
 
-To add support information a maintainer needs to:
+In order to add support information a maintainer can use `create` command.
 
-* add information to the package.json which specifies were to find the support info
-* provide a file with the package support info.
+`npx @pkgjs/support create` is run from the directory that contains the `package.json` for the package.
+It will ask few questions (e.g. what Node.js version your package support or how quickly you are able to respond to issues)
+in order to build proper `package-support.json` file.
+This command can also build [`backing`](https://github.com/nodejs/package-maintenance/blob/HEAD/docs/PACKAGE-SUPPORT.md#support-backing) field based on your `.github/FUNDING.yml` file or `"funding"` field from `package.json`.
 
-The `validate` command checks that both the information added to the package.json
-and the file containing the support info (package-support.json by default) is valid.
+`create` command will create `package-support.json` file in current working directory for you
+and will update `package.json` in order to set `"support: true"` field.
 
+`create` command has `-y|--yes` flag which does pretty much the same as `npm init -y` but with package support info.
+It will create `package-support.json` file with default commonly-used values.
+This can be used in case you want to get some basic scaffolding and edit file manually.
 
-[Integration into package.json](https://github.com/nodejs/package-maintenance/blob/HEAD/docs/PACKAGE-SUPPORT.md#integration-into-packagejson)
-explains the options for providing support info and what goes into the package.json for
-each case.
+```shell
+npx @pkgjs/support create -y
+```
+
+In case package support information was added manually - `@pkgjs/support` also provides
+ability to validate this infomation automatically according to official schema.
+
+The `validate` command checks that both the information added to the package.json
+and the file containing the support info (package-support.json by default) is valid.
 
-`npx @pkgjs/support validate` is run from the directory that contains the package.json for the package.
+`npx @pkgjs/support validate` is run from the directory that contains the `package.json` for the package.
 Depending the how the `support` section in the package.json is configured validate will:
 
 * validate the format of the `support` section in the package.json conforms to the

index.js

@@ -5,6 +5,7 @@ const normalizeUrl = require('normalize-url');
 const Ajv = require('ajv');
 const got = require('got');
 const betterAjvErrors = require('better-ajv-errors');
+const create = require('./lib/cli/create');
 
 let ajv;
 let compiledSchema;
@@ -15,6 +16,7 @@ const schema = module.exports.schema = require('./schema.json');
 const supportElementSchema = module.exports.schema = require('./support-element-schema.json');
 
 module.exports.defaultPackageSupport = 'package-support.json';
+module.exports.create = create;
 
 function getBetterAjvErrorsOptions (cli) {
   const options = { format: 'js' };
@@ -128,3 +130,38 @@ module.exports.getSupportData = async (pkg, pkgPath, preferCanonical, basePathOv
   }
   return supportInfo;
 };
+
+/**
+ * Returns list of target Node.js versions for package-support.json file
+ */
+module.exports.getNodeJsTargetVersionsList = () => {
+  return [
+    'abandoned',
+    'none',
+    'all',
+    'lts',
+    'active',
+    'lts_active',
+    'lts_latest',
+    'supported',
+    'current'
+  ];
+};
+
+/**
+ * Returns list of response types for package-support.json file
+ */
+module.exports.getSupportResponseTypesList = () => {
+  const schemaOptions = [
+    'none',
+    'time-permitting',
+    'best-effort',
+    '24-7'
+  ];
+
+  for (let daysForResponse = 1; daysForResponse <= 7; daysForResponse++) {
+    schemaOptions.push(`regular-${daysForResponse}`);
+  }
+
+  return schemaOptions;
+};

lib/cli/commands/create.js

@@ -0,0 +1,25 @@
+'use strict';
+const support = require('../../../index.js');
+
+module.exports = function (opts) {
+  return {
+    command: 'create',
+    desc: 'Setup a support declaration for a package',
+    builder: function (yargs) {
+      return yargs
+        .option('yes', {
+          desc: 'Apply default values',
+          type: 'boolean',
+          alias: 'y'
+        });
+    },
+    handler: async function (argv) {
+      try {
+        await support.create(argv.y);
+        console.log('Support info created');
+      } catch (error) {
+        console.error(error.message);
+      }
+    }
+  };
+};

lib/cli/commands/setup.js

@@ -0,0 +1,14 @@
+{
+  "versions": [
+    {
+      "version": "*",
+      "target": {
+        "node": ""
+      },
+      "response": {
+        "type": ""
+      },
+      "backing": {}
+    }
+  ]
+}