livingdocs-cli 2.3.0 → 2.3.1

package/README.md

@@ -42,7 +42,7 @@ OPTIONS
   -s, --src=src    The folder with your .html component templates
 ```
 
-_See code: [src/commands/component-library/build.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.3.0/src/commands/component-library/build.js)_
+_See code: [src/commands/component-library/build.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.3.1/src/commands/component-library/build.js)_
 
 ## `livingdocs-cli config:print`
 
@@ -57,7 +57,7 @@ OPTIONS
   -p, --project=project  If used configuration options are loaded from .livingdocs-cli file.
 ```
 
-_See code: [src/commands/config/print.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.3.0/src/commands/config/print.js)_
+_See code: [src/commands/config/print.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.3.1/src/commands/config/print.js)_
 
 ## `livingdocs-cli design-server:start`
 
@@ -75,7 +75,7 @@ OPTIONS
   --verbose
 ```
 
-_See code: [src/commands/design-server/start.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.3.0/src/commands/design-server/start.js)_
+_See code: [src/commands/design-server/start.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.3.1/src/commands/design-server/start.js)_
 
 ## `livingdocs-cli help [COMMAND]`
 
@@ -117,7 +117,7 @@ OPTIONS
   --format=js|js/html|json  The format of the files written.
 ```
 
-_See code: [src/commands/project-config/download.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.3.0/src/commands/project-config/download.js)_
+_See code: [src/commands/project-config/download.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.3.1/src/commands/project-config/download.js)_
 
 ## `livingdocs-cli project-config:import-design`
 
@@ -134,7 +134,7 @@ OPTIONS
   -u, --designUri=designUri  (required) URL of the design to import
 ```
 
-_See code: [src/commands/project-config/import-design.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.3.0/src/commands/project-config/import-design.js)_
+_See code: [src/commands/project-config/import-design.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.3.1/src/commands/project-config/import-design.js)_
 
 ## `livingdocs-cli project-config:plan`
 
@@ -159,7 +159,7 @@ OPTIONS
                          Can be set by the environment variable 'LI_TOKEN'.
 ```
 
-_See code: [src/commands/project-config/plan.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.3.0/src/commands/project-config/plan.js)_
+_See code: [src/commands/project-config/plan.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.3.1/src/commands/project-config/plan.js)_
 
 ## `livingdocs-cli project-config:publish`
 
@@ -184,5 +184,5 @@ OPTIONS
                          Can be set by the environment variable 'LI_TOKEN'.
 ```
 
-_See code: [src/commands/project-config/publish.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.3.0/src/commands/project-config/publish.js)_
+_See code: [src/commands/project-config/publish.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.3.1/src/commands/project-config/publish.js)_
 <!-- commandsstop -->

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.3.0","commands":{"component-library:build":{"id":"component-library:build","description":"Build a Component Library JSON file","pluginName":"livingdocs-cli","pluginType":"core","aliases":[],"flags":{"src":{"name":"src","type":"option","char":"s","description":"The folder with your .html component templates"},"dist":{"name":"dist","type":"option","char":"d","description":"The folder where the output will be written."}},"args":[]},"config:print":{"id":"config:print","description":"Print current CLI configuration","pluginName":"livingdocs-cli","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","char":"p","description":"If used configuration options are loaded from .livingdocs-cli file."},"env":{"name":"env","type":"option","char":"e","description":"If used configuration options are loaded from .livingdocs-cli file."}},"args":[]},"design-server:start":{"id":"design-server:start","description":"Start a design server for development","pluginName":"livingdocs-cli","pluginType":"core","aliases":[],"flags":{"port":{"name":"port","type":"option","char":"p","description":"The port of the design-server.","default":9030},"dist":{"name":"dist","type":"option","char":"d","description":"The folder to load designs from.","required":true},"assets":{"name":"assets","type":"option","description":"Asset folder to serve static files."},"basePath":{"name":"basePath","type":"option","description":"The basePath to set in `assets.basePath`."},"verbose":{"name":"verbose","type":"boolean","allowNo":false}},"args":[]},"project-config:download":{"id":"project-config:download","description":"Download a project configuration","pluginName":"livingdocs-cli","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","char":"p","description":"If used configuration options are loaded from .livingdocs-cli file."},"env":{"name":"env","type":"option","char":"e","description":"If used configuration options are loaded from .livingdocs-cli file."},"token":{"name":"token","type":"option","char":"t","description":"Access Token for your project (needs `public-api:config:read` permission).\nCan be set by the environment variable 'LI_TOKEN'.","required":true},"host":{"name":"host","type":"option","char":"h","description":"The livingdocs host.\nCan be set by the environment variable 'LI_HOST'.","required":true,"default":"http://localhost:9090"},"dist":{"name":"dist","type":"option","char":"d","description":"The folder where the output will be written."},"format":{"name":"format","type":"option","description":"The format of the files written.","options":["js","js/html","json"]}},"args":[]},"project-config:drafts":{"id":"project-config:drafts","description":"List project configuration drafts","pluginName":"livingdocs-cli","pluginType":"core","hidden":true,"aliases":[],"flags":{"token":{"name":"token","type":"option","char":"t","description":"Access Token for your project (needs `public-api:config:read` permission).\nCan be set by the environment variable 'LI_TOKEN'.","required":true},"host":{"name":"host","type":"option","char":"h","description":"The livingdocs host.\nCan be set by the environment variable 'LI_HOST'.","default":"http://localhost:9090"}},"args":[]},"project-config:import-design":{"id":"project-config:import-design","description":"Import a design into a given project configuration","pluginName":"livingdocs-cli","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","char":"p","description":"If used configuration options are loaded from .livingdocs-cli file."},"env":{"name":"env","type":"option","char":"e","description":"If used configuration options are loaded from .livingdocs-cli file."},"dist":{"name":"dist","type":"option","char":"d","description":"The folder where the output will be written.","required":true},"designUri":{"name":"designUri","type":"option","char":"u","description":"URL of the design to import","required":true}},"args":[]},"project-config:plan":{"id":"project-config:plan","description":"See what would be updated in a publish command","pluginName":"livingdocs-cli","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","char":"p","description":"If used configuration options are loaded from .livingdocs-cli file."},"env":{"name":"env","type":"option","char":"e","description":"If used configuration options are loaded from .livingdocs-cli file."},"token":{"name":"token","type":"option","char":"t","description":"Access Token for your project (needs `public-api:config:write` permission).\nCan be set by the environment variable 'LI_TOKEN'.","required":true},"host":{"name":"host","type":"option","char":"h","description":"The livingdocs host.\nCan be set by the environment variable 'LI_HOST'.","required":true,"default":"http://localhost:9090"},"source":{"name":"source","type":"option","char":"s","description":"The folder or filename to the project config."},"dist":{"name":"dist","type":"option","char":"d","description":"The folder where the output will be written."}},"args":[]},"project-config:publish":{"id":"project-config:publish","description":"Publish a project configuration to your project","pluginName":"livingdocs-cli","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","char":"p","description":"If used configuration options are loaded from .livingdocs-cli file."},"env":{"name":"env","type":"option","char":"e","description":"If used configuration options are loaded from .livingdocs-cli file."},"token":{"name":"token","type":"option","char":"t","description":"Access Token for your project (needs `public-api:config:write` permission).\nCan be set by the environment variable 'LI_TOKEN'.","required":true},"host":{"name":"host","type":"option","char":"h","description":"The livingdocs host.\nCan be set by the environment variable 'LI_HOST'.","required":true,"default":"http://localhost:9090"},"source":{"name":"source","type":"option","char":"s","description":"The folder or filename to the project config."},"dist":{"name":"dist","type":"option","char":"d","description":"The folder where the output will be written."}},"args":[]},"project-config:upload":{"id":"project-config:upload","description":"Upload a ChannelConfig into a draft for your project","pluginName":"livingdocs-cli","pluginType":"core","hidden":true,"aliases":[],"flags":{"project":{"name":"project","type":"option","char":"p","description":"If used configuration options are loaded from .livingdocs-cli file."},"env":{"name":"env","type":"option","char":"e","description":"If used configuration options are loaded from .livingdocs-cli file."},"token":{"name":"token","type":"option","char":"t","description":"Access Token for your project (needs `public-api:config:write` permission).\nCan be set by the environment variable 'LI_TOKEN'.","required":true},"host":{"name":"host","type":"option","char":"h","description":"The livingdocs host.\nCan be set by the environment variable 'LI_HOST'.","required":true,"default":"http://localhost:9090"},"source":{"name":"source","type":"option","char":"s","description":"The folder or filename to the project config.","required":true},"draftName":{"name":"draftName","type":"option","description":"The name of the draft the config will be saved under.","required":true}},"args":[]},"project-config:upload_assets":{"id":"project-config:upload_assets","description":"Upload assets to your project","pluginName":"livingdocs-cli","pluginType":"core","hidden":true,"aliases":[],"flags":{"token":{"name":"token","type":"option","char":"t","description":"Access Token for your project (needs `public-api:config:write` permission).\nCan be set by the environment variable 'LI_TOKEN'.","required":true},"host":{"name":"host","type":"option","char":"h","description":"The livingdocs host.\nCan be set by the environment variable 'LI_HOST'.","default":"http://localhost:9090"},"assets":{"name":"assets","type":"option","char":"a","description":"The folder where you asset files are located."}},"args":[]}}}
+{"version":"2.3.1","commands":{"component-library:build":{"id":"component-library:build","description":"Build a Component Library JSON file","pluginName":"livingdocs-cli","pluginType":"core","aliases":[],"flags":{"src":{"name":"src","type":"option","char":"s","description":"The folder with your .html component templates"},"dist":{"name":"dist","type":"option","char":"d","description":"The folder where the output will be written."}},"args":[]},"config:print":{"id":"config:print","description":"Print current CLI configuration","pluginName":"livingdocs-cli","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","char":"p","description":"If used configuration options are loaded from .livingdocs-cli file."},"env":{"name":"env","type":"option","char":"e","description":"If used configuration options are loaded from .livingdocs-cli file."}},"args":[]},"design-server:start":{"id":"design-server:start","description":"Start a design server for development","pluginName":"livingdocs-cli","pluginType":"core","aliases":[],"flags":{"port":{"name":"port","type":"option","char":"p","description":"The port of the design-server.","default":9030},"dist":{"name":"dist","type":"option","char":"d","description":"The folder to load designs from.","required":true},"assets":{"name":"assets","type":"option","description":"Asset folder to serve static files."},"basePath":{"name":"basePath","type":"option","description":"The basePath to set in `assets.basePath`."},"verbose":{"name":"verbose","type":"boolean","allowNo":false}},"args":[]},"project-config:download":{"id":"project-config:download","description":"Download a project configuration","pluginName":"livingdocs-cli","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","char":"p","description":"If used configuration options are loaded from .livingdocs-cli file."},"env":{"name":"env","type":"option","char":"e","description":"If used configuration options are loaded from .livingdocs-cli file."},"token":{"name":"token","type":"option","char":"t","description":"Access Token for your project (needs `public-api:config:read` permission).\nCan be set by the environment variable 'LI_TOKEN'.","required":true},"host":{"name":"host","type":"option","char":"h","description":"The livingdocs host.\nCan be set by the environment variable 'LI_HOST'.","required":true,"default":"http://localhost:9090"},"dist":{"name":"dist","type":"option","char":"d","description":"The folder where the output will be written."},"format":{"name":"format","type":"option","description":"The format of the files written.","options":["js","js/html","json"]}},"args":[]},"project-config:drafts":{"id":"project-config:drafts","description":"List project configuration drafts","pluginName":"livingdocs-cli","pluginType":"core","hidden":true,"aliases":[],"flags":{"token":{"name":"token","type":"option","char":"t","description":"Access Token for your project (needs `public-api:config:read` permission).\nCan be set by the environment variable 'LI_TOKEN'.","required":true},"host":{"name":"host","type":"option","char":"h","description":"The livingdocs host.\nCan be set by the environment variable 'LI_HOST'.","default":"http://localhost:9090"}},"args":[]},"project-config:import-design":{"id":"project-config:import-design","description":"Import a design into a given project configuration","pluginName":"livingdocs-cli","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","char":"p","description":"If used configuration options are loaded from .livingdocs-cli file."},"env":{"name":"env","type":"option","char":"e","description":"If used configuration options are loaded from .livingdocs-cli file."},"dist":{"name":"dist","type":"option","char":"d","description":"The folder where the output will be written.","required":true},"designUri":{"name":"designUri","type":"option","char":"u","description":"URL of the design to import","required":true}},"args":[]},"project-config:plan":{"id":"project-config:plan","description":"See what would be updated in a publish command","pluginName":"livingdocs-cli","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","char":"p","description":"If used configuration options are loaded from .livingdocs-cli file."},"env":{"name":"env","type":"option","char":"e","description":"If used configuration options are loaded from .livingdocs-cli file."},"token":{"name":"token","type":"option","char":"t","description":"Access Token for your project (needs `public-api:config:write` permission).\nCan be set by the environment variable 'LI_TOKEN'.","required":true},"host":{"name":"host","type":"option","char":"h","description":"The livingdocs host.\nCan be set by the environment variable 'LI_HOST'.","required":true,"default":"http://localhost:9090"},"source":{"name":"source","type":"option","char":"s","description":"The folder or filename to the project config."},"dist":{"name":"dist","type":"option","char":"d","description":"The folder where the output will be written."}},"args":[]},"project-config:publish":{"id":"project-config:publish","description":"Publish a project configuration to your project","pluginName":"livingdocs-cli","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","char":"p","description":"If used configuration options are loaded from .livingdocs-cli file."},"env":{"name":"env","type":"option","char":"e","description":"If used configuration options are loaded from .livingdocs-cli file."},"token":{"name":"token","type":"option","char":"t","description":"Access Token for your project (needs `public-api:config:write` permission).\nCan be set by the environment variable 'LI_TOKEN'.","required":true},"host":{"name":"host","type":"option","char":"h","description":"The livingdocs host.\nCan be set by the environment variable 'LI_HOST'.","required":true,"default":"http://localhost:9090"},"source":{"name":"source","type":"option","char":"s","description":"The folder or filename to the project config."},"dist":{"name":"dist","type":"option","char":"d","description":"The folder where the output will be written."}},"args":[]},"project-config:upload":{"id":"project-config:upload","description":"Upload a ChannelConfig into a draft for your project","pluginName":"livingdocs-cli","pluginType":"core","hidden":true,"aliases":[],"flags":{"project":{"name":"project","type":"option","char":"p","description":"If used configuration options are loaded from .livingdocs-cli file."},"env":{"name":"env","type":"option","char":"e","description":"If used configuration options are loaded from .livingdocs-cli file."},"token":{"name":"token","type":"option","char":"t","description":"Access Token for your project (needs `public-api:config:write` permission).\nCan be set by the environment variable 'LI_TOKEN'.","required":true},"host":{"name":"host","type":"option","char":"h","description":"The livingdocs host.\nCan be set by the environment variable 'LI_HOST'.","required":true,"default":"http://localhost:9090"},"source":{"name":"source","type":"option","char":"s","description":"The folder or filename to the project config.","required":true},"draftName":{"name":"draftName","type":"option","description":"The name of the draft the config will be saved under.","required":true}},"args":[]},"project-config:upload_assets":{"id":"project-config:upload_assets","description":"Upload assets to your project","pluginName":"livingdocs-cli","pluginType":"core","hidden":true,"aliases":[],"flags":{"token":{"name":"token","type":"option","char":"t","description":"Access Token for your project (needs `public-api:config:write` permission).\nCan be set by the environment variable 'LI_TOKEN'.","required":true},"host":{"name":"host","type":"option","char":"h","description":"The livingdocs host.\nCan be set by the environment variable 'LI_HOST'.","default":"http://localhost:9090"},"assets":{"name":"assets","type":"option","char":"a","description":"The folder where you asset files are located."}},"args":[]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "livingdocs-cli",
   "description": "Livingdocs Command Line Utility",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "author": "Livingdocs AG",
   "repository": "livingdocsIO/livingdocs-cli",
   "homepage": "https://github.com/livingdocsIO/livingdocs-cli",
@@ -86,11 +86,11 @@
     "isCi": true,
     "name": "Drone",
     "service": "drone",
-    "commit": "b794df59cabaa3a259571d0bf38ffa215820f09c",
-    "build": "94",
+    "commit": "b75862ecb749403df0d0e1409bb5985ce34e6ce4",
+    "build": "96",
     "branch": "master",
     "isPr": false,
     "slug": "livingdocsIO/livingdocs-cli",
-    "date": "2022-01-08T14:01:02.392Z"
+    "date": "2022-01-20T17:38:54.308Z"
   }
 }

package/src/commands/project-config/plan.js

@@ -3,7 +3,7 @@ const {Command} = require('@oclif/command')
 const sharedFlags = require('../../lib/cli/shared_flags')
 const liApi = require('../../lib/api/livingdocs_api')
 const errorReporter = require('../../lib/api/error_reporter')
-const resultReporter = require('../../lib/api/channel_config_result_reporter')
+const resultReporter = require('../../lib/api/project_config_result_reporter')
 const readChannelConfig = require('../../lib/read_channel_config')
 
 class PlanCommand extends Command {
@@ -27,7 +27,7 @@ class PlanCommand extends Command {
 
     await liApi.plan({host, token, channelConfig: config})
       .then((result) => {
-        resultReporter(result, this.log)
+        resultReporter({result, log: this.log})
       })
       .catch(reportError)
   }

package/src/commands/project-config/publish.js

@@ -5,7 +5,7 @@ const inquirer = require('inquirer')
 const sharedFlags = require('../../lib/cli/shared_flags')
 const liApi = require('../../lib/api/livingdocs_api')
 const errorReporter = require('../../lib/api/error_reporter')
-const resultReporter = require('../../lib/api/channel_config_result_reporter')
+const resultReporter = require('../../lib/api/project_config_result_reporter')
 const readChannelConfig = require('../../lib/read_channel_config')
 const updateRevisionNumber = require('../../lib/update_revision_number')
 
@@ -21,7 +21,7 @@ class PublishCommand extends Command {
   }
 
   async run () {
-    const {token, host, source, dist} = this.parse(PublishCommand).flags
+    const {token, host, source, dist, env} = this.parse(PublishCommand).flags
     const reportError = errorReporter(this.log, host, {verbose: true})
 
     if (!source && !dist) throw new Error('Missing a source param')
@@ -36,7 +36,11 @@ class PublishCommand extends Command {
     await liApi.plan({host, token, channelConfig: config})
       .then((result) => {
         ok = result.ok
-        resultReporter(result, this.log)
+
+        // early return if there are no chagnes
+        if (!result.patches?.length) ok = false
+
+        resultReporter({result, log: this.log})
       })
       .catch(reportError)
 
@@ -46,14 +50,14 @@ class PublishCommand extends Command {
       name: 'continue',
       type: 'confirm',
       default: false,
-      message: `Are you sure to publish to production?`
+      message: `Are you sure to publish${env ? ` to ${env}` : ''}?`
     }])
 
     if (!answers.continue) return
 
     await liApi.publish({host, token, channelConfig: config})
       .then((result) => {
-        resultReporter(result, this.log)
+        resultReporter({result, log: this.log})
         updateRevisionNumber({
           source: source || dist,
           revisionNumberBefore: config.$baseRevision,

package/src/commands/project-config/upload.js

@@ -4,7 +4,7 @@ const {Command, flags} = require('@oclif/command')
 const sharedFlags = require('../../lib/cli/shared_flags')
 const liApi = require('../../lib/api/livingdocs_api')
 const errorReporter = require('../../lib/api/error_reporter')
-const resultReporter = require('../../lib/api/channel_config_result_reporter')
+const resultReporter = require('../../lib/api/project_config_result_reporter')
 const readChannelConfig = require('../../lib/read_channel_config')
 
 class UploadCommand extends Command {
@@ -38,7 +38,7 @@ class UploadCommand extends Command {
 
     await liApi.uploadDraft({host, token, channelConfig: config})
       .then((result) => {
-        resultReporter(result, this.log)
+        resultReporter({result, log: this.log})
       })
       .catch(reportError)
   }

package/src/lib/api/{channel_config_result_reporter.js → project_config_result_reporter.js}

@@ -2,7 +2,7 @@ const chalk = require('chalk')
 const dedent = require('dedent')
 const diff = require('diff')
 
-module.exports = function (result, log) {
+module.exports = function ({result, log, omitPatches}) {
   function info (msg) { log(msg) }
   function success (msg) { log(chalk.green(msg)) }
   function error (msg) { log(chalk.red(msg)) }
@@ -31,39 +31,34 @@ module.exports = function (result, log) {
   }
 
   if (result.ok) {
-    const count = result.patches.length
-    if (!result.patches || count === 0) {
+    const count = result.patches?.length
+    if (!count) {
       info(dedent`
         ✓ No Changes.
       `)
-    } else {
-      if (result.plan) {
-        info(dedent`
-          Plan
-          ----
-        `)
-        info(`\nPatches (${count}):\n`)
-      } else {
-        success(dedent`
-          ✓ Success. Channel Config Published.
-
-            Revision: ${result.revisionNumber}
-            DesignVersion: ${result.designVersion || '-'}
-        `)
-        info(`\nApplied Patches (${result.patches.length}):`)
-      }
+    } else if (result.plan) {
+      info(dedent`
+        Plan
+        ----
+      `)
+      info(`\nPatches (${count}):\n`)
 
       for (const patch of result.patches) {
         info(`• [${patch.action}] ${patch.pointer}`)
         info(`${calcDiff(patch)}`)
       }
 
-
       if (count === 1) info(`\n✓ The patch looks good.\n`)
       else info(`\n✓ All ${count} patches look good.\n`)
-    }
+    } else {
+      success(dedent`
+        ✓ Success. Channel Config Published.
 
-    return
+          Revision: ${result.revisionNumber}
+          DesignVersion: ${result.designVersion || '-'}
+      `)
+      info(`\nApplied Patches (${result.patches.length}):`)
+    }
   }
 
   if (result.schemaErrors) {