@vcmap/plugin-cli 1.0.1 → 1.1.1

package/README.md

@@ -1,5 +1,5 @@
-# @vcmplugin/plugin-cli
-The `vcmplugin` cli helps develop and build plugins for the **vcMAP**.
+# @vcmap/plugin-cli
+The `vcmplugin` cli helps develop and build plugins for the **VC MAP**.
 
 For more information on plugin development refer to [map plugin examples](https://github.com/virtualcitySYSTEMS/map-plugin-examples),
 which provides documentations and a tutorial on plugin development.
@@ -33,7 +33,7 @@ To create a new plugin template, run the following within your projects root:
 ```
 vcmplugin create
 ```
-This will open a command prompt helping you to create the basic [structure of a plugin](https://github.com/virtualcitySYSTEMS/map-plugin-examples/doc/VCM_Plugin.md#2-structure-of-a-plugin).
+This will open a command prompt helping you to create the basic [structure of a plugin](https://github.com/virtualcitySYSTEMS/map-plugin-examples/blob/main/doc/VCM_Plugin.md#2-structure-of-a-plugin).
 
 
 ### 2. Serving a plugin for development
@@ -81,7 +81,7 @@ the `package.json` and use `npm run` to execute:
     "serve": "vcmplugin serve --vcm ./vcm"
   },
   "devDependencies": {
-    "vcmplugin-cli": "^0.1.1"
+    "@vcmap/plugin-cli": "^0.1.1"
   }
 }
 ```

package/cli.js

@@ -8,12 +8,12 @@ program.version(version);
 
 program
   .command('create')
-  .action(create);
+  .safeAction(create);
 
 program
   .command('pack')
   .defaultBuildOptions()
-  .action(pack);
+  .safeAction(pack);
 
 program
   .command('serve')
@@ -30,13 +30,13 @@ program
     prev.push(val);
     return prev;
   }, [])
-  .action(serve);
+  .safeAction(serve);
 
 program
   .command('build')
   .defaultBuildOptions()
   .option('--development', 'set mode to development')
   .option('--watch', 'watch file changes')
-  .action(build);
+  .safeAction(build);
 
 program.parse(process.argv);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vcmap/plugin-cli",
-  "version": "1.0.1",
+  "version": "1.1.1",
   "description": "A CLI to help develop and build plugins for the virtualcityMAP",
   "main": "index.js",
   "bin": {

package/src/context.js

@@ -1,4 +1,5 @@
 const path = require('path');
+const fs = require('fs');
 
 let context = null;
 
@@ -6,7 +7,10 @@ function setContext(c) {
   if (context) {
     throw new Error('cannot set context twice');
   }
-  context = c;
+  if (!fs.existsSync(c) || !fs.statSync(c).isDirectory()) {
+    throw new Error('context must be an existing directory');
+  }
+  context = path.resolve(c);
 }
 
 function getContext() {

package/src/create.js

@@ -6,6 +6,7 @@ const util = require('util');
 const childProcess = require('child_process');
 const { logger } = require('@vcsuite/cli-logger');
 const { version, name } = require('../package.json');
+const { LicenseType, writeLicense } = require('./licenses');
 
 /**
  * @typedef {Object} PluginTemplateOptions
@@ -92,7 +93,13 @@ async function createPluginTemplate(options) {
       '};'].join('\n'),
   );
 
-  await Promise.all([writePackagePromise, writeConfigPromise, writeReadmePromise, writeIndexPromise]);
+  await Promise.all([
+    writePackagePromise,
+    writeConfigPromise,
+    writeReadmePromise,
+    writeIndexPromise,
+    writeLicense(options.author, options.license, pluginPath),
+  ]);
 
   logger.spin('installing dependencies...');
   const exec = util.promisify(childProcess.exec);
@@ -162,10 +169,15 @@ async function create() {
       initial: 'author <email>',
     },
     {
-      type: 'text',
+      type: 'select',
       name: 'license',
       message: 'License',
-      initial: 'ISC',
+      initial: 0,
+      choices: Object.values(LicenseType)
+        .map(type => ({
+          title: type,
+          value: type,
+        })),
     },
     {
       type: 'text',

package/src/defaultCommand.js

@@ -1,8 +1,14 @@
 const { Command } = require('commander');
+const { logger } = require('@vcsuite/cli-logger');
+const { setContext } = require('./context');
 
 Command.prototype.defaultOptions = function defaultOptions() {
   this
     .option('-n, --plugin-name [name]', 'a name override to use. extracts the name from the package.json by default')
+    .option('--context [path]', 'an optional context, default is cwd', (value) => {
+      setContext(value);
+      return value;
+    })
     .option('--no-condense-whitespace', 'do not condense white space')
     .option('-e, --entry <entry>', 'entrypoint override');
 
@@ -17,3 +23,17 @@ Command.prototype.defaultBuildOptions = function defaultBuildOptions() {
 
   return this;
 };
+
+Command.prototype.safeAction = function safeAction(action) {
+  this.action(async (options) => {
+    try {
+      await action(options);
+    } catch (e) {
+      if (e) {
+        logger.error(e);
+      }
+      logger.stopSpinner();
+      process.exit(1);
+    }
+  });
+};

package/src/licenses.js

@@ -0,0 +1,133 @@
+const fs = require('fs');
+const path = require('path');
+
+/**
+ * @param {string} user
+ * @param {number} year
+ * @returns {string}
+ */
+function mit(user, year) {
+  return `
+Copyright ${year} ${user}
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated 
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, 
+and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO 
+THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS 
+OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+`;
+}
+
+/**
+ * @param {string} user
+ * @param {number} year
+ * @returns {string}
+ */
+function apache(user, year) {
+  return `
+Copyright ${year} ${user}
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+`;
+}
+
+/**
+ * @param {string} user
+ * @param {number} year
+ * @returns {string}
+ */
+function gpl3(user, year) {
+  return `
+Copyright (C) ${year} ${user}
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+`;
+}
+
+/**
+ * @param {string} user
+ * @param {number} year
+ * @returns {string}
+ */
+function isc(user, year) {
+  return `
+Copyright (c) ${year}, ${user}
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+`;
+}
+
+/**
+ * @enum {string}
+ */
+const LicenseType = {
+  MIT: 'MIT',
+  ISC: 'ISC',
+  'APACHE-2.0': 'APACHE-2.0',
+  'GPL-3.0': 'GPL-3.0',
+};
+
+/**
+ * @type {Object<LicenseType, function(string, number):string>}
+ */
+const LicenseTypeFunctions = {
+  [LicenseType.MIT]: mit,
+  [LicenseType['GPL-3.0']]: gpl3,
+  [LicenseType.ISC]: isc,
+  [LicenseType['APACHE-2.0']]: apache,
+};
+
+/**
+ * @param {string} user
+ * @param {LicenseType} type
+ * @param {string} pluginPath
+ * @returns {Promise<void>}
+ */
+function writeLicense(user, type, pluginPath) {
+  const year = new Date().getFullYear();
+  const text = LicenseTypeFunctions[type](user, year);
+
+  return fs.promises.writeFile(path.join(pluginPath, 'LICENSE.md'), text);
+}
+
+module.exports = {
+  writeLicense,
+  LicenseType,
+};

package/src/serve.js

@@ -109,6 +109,7 @@ function getConfigJson(vcm, name, { auth, config: configFile }) {
 
 async function serve(options) {
   logger.spin('Starting development server...');
+  // eslint-disable-next-line prefer-const
   let { vcm, index } = options;
   const pluginName = options.pluginName || await getPluginName();
   const isWebVcm = /^https?:\/\//.test(vcm);
@@ -125,6 +126,7 @@ async function serve(options) {
           target: vcm,
           changeOrigin: true,
           auth: options.auth,
+          followRedirects: true,
         };
       });
   }