@nzz/q-cli 1.5.1 → 1.5.6

package/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "[svelte]": {
+    "editor.defaultFormatter": "svelte.svelte-vscode"
+  }
+}

package/README.md

@@ -1,6 +1,6 @@
 # Q cli [![Build Status](https://travis-ci.com/nzzdev/Q-cli.svg?branch=dev)](https://travis-ci.com/nzzdev/Q-cli)
 
-**Maintainer**: [manuelroth](https://github.com/manuelroth)
+**Maintainer**: [Nicolas Staub](https://github.com/fromdusttilldawn)
 
 ## Table of contents
 
@@ -26,6 +26,21 @@ nvm use
 npm install
 ```
 
+For testing local changes of Q-cli, one can link the local package to the global installation of Q-cli:
+
+```bash
+cd Q-cli
+npm link
+```
+
+Q commands will now use the local Q-cli.
+
+To unlink, simply install Q-cli again globally:
+
+```bash
+npm install @nzz/q-cli -g
+```
+
 [to the top](#table-of-contents)
 
 ## Functionality

package/bin/commands/bootstrap.js

@@ -4,6 +4,7 @@ const replaceInFile = require("replace-in-file");
 const chalk = require("chalk");
 const errorColor = chalk.red;
 const successColor = chalk.green;
+const warningColor = chalk.yellow;
 
 module.exports = async function (type, name, basedir) {
   if (fs.existsSync(basedir)) {
@@ -31,6 +32,11 @@ module.exports = async function (type, name, basedir) {
     );
     await replaceInFile(replaceOptions);
     console.log(successColor(`Q ${type} is now bootstrapped in ${basedir}`));
+
+    if (type === "tool")
+      console.log(
+        warningColor("Search for 'TODO:' inside the new tool to get started!")
+      );
   } catch (error) {
     console.error(
       errorColor(

package/bin/commands/updateItem/helpers.js

@@ -84,20 +84,49 @@ async function getUpdatedItem(
       environment
     );
 
-    const updatedItem = deepmerge(existingItem, item, {
+    // Merge options:
+    // File of files property will be updated (if file exists on destination)
+    // If it doesn't exist it is appended to the files array
+    // All other properties are overwritten from source config
+    const options = {
       arrayMerge: (destArr, srcArr) => srcArr,
-    });
-
-    const validationResult = validateItem(toolSchema, updatedItem);
-    if (validationResult.isValid) {
-      return deepmerge(existingItem, updatedItem, {
-        arrayMerge: (destArr, srcArr) => srcArr,
-      });
-    } else {
-      throw new Error(
-        `A problem occured while validating item with id ${environment.id} on ${environment.name} environment: ${validationResult.errorsText}`
-      );
-    }
+      customMerge: (key) => {
+        if (key === "files") {
+          return (destArr, srcArr) => {
+            if (destArr.length <= 0) {
+              return srcArr;
+            }
+
+            srcArr.forEach((fileObj) => {
+              let destIndex = destArr.findIndex(
+                (destFileObj) =>
+                  destFileObj.file.originalName === fileObj.file.originalName
+              );
+
+              if (destIndex !== -1) {
+                destArr[destIndex] = fileObj;
+              } else {
+                destArr.push(fileObj);
+              }
+            });
+            return destArr;
+          };
+        }
+      },
+    };
+
+    // merges existing item with the item defined in q.config.json
+    const updatedItem = deepmerge(existingItem, item, options);
+    // normalizes the item which removes additional properties not defined in the schema
+    // and validates the item against the schema
+    const normalizedItem = getNormalizedItem(
+      toolSchema,
+      updatedItem,
+      environment
+    );
+    // the normalized item is merged with the existing item. This is done because properties such as _id and _rev
+    // defined in the existing item are removed during normalization, because they are not defined in the schema
+    return deepmerge(existingItem, normalizedItem, options);
   } catch (error) {
     console.error(errorColor(error.message));
     process.exit(1);
@@ -168,12 +197,17 @@ function validateConfig(config) {
   };
 }
 
-function validateItem(schema, item) {
+function getNormalizedItem(schema, item, environment) {
   const isValid = ajv.validate(schema, item);
-  return {
-    isValid: isValid,
-    errorsText: ajv.errorsText(),
-  };
+  if (!isValid) {
+    throw new Error(
+      `A problem occured while validating item with id ${environment.id} on ${
+        environment.name
+      } environment: ${ajv.errorsText()}`
+    );
+  }
+
+  return item;
 }
 
 function getEnvironments(qConfig, environmentFilter) {

package/bin/commands/updateItem/resourcesHelpers.js

@@ -223,11 +223,13 @@ async function uploadResource(qServer, accessToken, cookie, resourcePath) {
         headers: headers,
         body: form,
       });
+      const body = await response.json();
+
       if (response.ok) {
-        return await response.json();
+        return body;
       } else {
         throw new Error(
-          `Error occured while uploading the resource at ${resourcePath}. Please check your connection and try again.\nResponse: ${response.status} - ${response.statusText}`
+          `Error occured while uploading the resource at ${resourcePath}. Please check your connection and try again.\nResponse: ${body.statusCode} ${body.error} - ${body.message}`
         );
       }
     } else {

package/dev-server/routes/rendering-info.js

@@ -47,7 +47,6 @@ module.exports = {
         allowUnknown: true,
       },
     },
-    cors: true,
   },
   handler: async function (request, h) {
     try {

package/dev-server/routes/tool-default.js

@@ -52,7 +52,6 @@ module.exports = {
           allowUnknown: true,
         },
       },
-      cors: true,
     },
     handler: async (request, h) => {
       let payload = null;
@@ -89,7 +88,6 @@ module.exports = {
           allowUnknown: true,
         },
       },
-      cors: true,
     },
     handler: async (request, h) => {
       if (request.query.appendItemToPayload) {

package/dev-server/server.js

@@ -5,6 +5,9 @@ const Path = require("path");
 const server = new Hapi.Server({
   port: process.env.PORT || 5000,
   routes: {
+    cors: {
+      origin: ["*"],
+    },
     files: {
       relativeTo: Path.join(__dirname, "public"),
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nzz/q-cli",
-  "version": "1.5.1",
+  "version": "1.5.6",
   "description": "Cli tool to setup new Q tools, new Q server implementations and start Q dev server to test developing Q tools",
   "main": "index.js",
   "scripts": {

package/skeletons/custom-code-skeleton/.nvmrc

@@ -1 +1 @@
-14
+16

package/skeletons/custom-code-skeleton/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "[svelte]": {
+    "editor.defaultFormatter": "svelte.svelte-vscode"
+  }
+}