livingdocs-cli 2.1.2 → 2.4.0

package/README.md

@@ -9,11 +9,15 @@ Livingdocs Command Line Interface
 
 ## Setup
 
-```sh-session
-$ npm install -g livingdocs-cli
-$ livingdocs-cli --help
+```bash
+npm install -g livingdocs-cli
+livingdocs-cli --help
 ```
 
+## Documentation
+
+[Livingdocs CLI documentation](https://docs.livingdocs.io/reference-docs/cli)
+
 # Commands Reference
 <!-- commands -->
 * [`livingdocs-cli component-library:build`](#livingdocs-cli-component-librarybuild)
@@ -38,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.1.2/src/commands/component-library/build.js)_
+_See code: [src/commands/component-library/build.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.4.0/src/commands/component-library/build.js)_
 
 ## `livingdocs-cli config:print`
 
@@ -53,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.1.2/src/commands/config/print.js)_
+_See code: [src/commands/config/print.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.4.0/src/commands/config/print.js)_
 
 ## `livingdocs-cli design-server:start`
 
@@ -64,14 +68,15 @@ USAGE
   $ livingdocs-cli design-server:start
 
 OPTIONS
-  -d, --dist=dist      (required) The folder to load designs from.
-  -p, --port=port      [default: 9030] The port of the design-server.
-  --assets=assets      Asset folder to serve static files.
-  --basePath=basePath  The basePath to set in `assets.basePath`.
+  -a, --address=address  The address of the design-server.
+  -d, --dist=dist        (required) The folder to load designs from.
+  -p, --port=port        [default: 9030] The port of the design-server.
+  --assets=assets        Asset folder to serve static files.
+  --basePath=basePath    The basePath to set in `assets.basePath`.
   --verbose
 ```
 
-_See code: [src/commands/design-server/start.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.1.2/src/commands/design-server/start.js)_
+_See code: [src/commands/design-server/start.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.4.0/src/commands/design-server/start.js)_
 
 ## `livingdocs-cli help [COMMAND]`
 
@@ -113,7 +118,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.1.2/src/commands/project-config/download.js)_
+_See code: [src/commands/project-config/download.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.4.0/src/commands/project-config/download.js)_
 
 ## `livingdocs-cli project-config:import-design`
 
@@ -130,7 +135,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.1.2/src/commands/project-config/import-design.js)_
+_See code: [src/commands/project-config/import-design.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.4.0/src/commands/project-config/import-design.js)_
 
 ## `livingdocs-cli project-config:plan`
 
@@ -141,7 +146,7 @@ USAGE
   $ livingdocs-cli project-config:plan
 
 OPTIONS
-  -d, --dist=dist        (required) The folder or filename to the channelConfig.
+  -d, --dist=dist        The folder where the output will be written.
   -e, --env=env          If used configuration options are loaded from .livingdocs-cli file.
 
   -h, --host=host        (required) [default: http://localhost:9090] The livingdocs host.
@@ -149,22 +154,24 @@ OPTIONS
 
   -p, --project=project  If used configuration options are loaded from .livingdocs-cli file.
 
+  -s, --source=source    The folder or filename to the project config.
+
   -t, --token=token      (required) Access Token for your project (needs `public-api:config:write` permission).
                          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.1.2/src/commands/project-config/plan.js)_
+_See code: [src/commands/project-config/plan.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.4.0/src/commands/project-config/plan.js)_
 
 ## `livingdocs-cli project-config:publish`
 
-Publish a ChannelConfig to your project
+Publish a project configuration to your project
 
 ```
 USAGE
   $ livingdocs-cli project-config:publish
 
 OPTIONS
-  -d, --dist=dist        (required) The folder or filename to the channelConfig.
+  -d, --dist=dist        The folder where the output will be written.
   -e, --env=env          If used configuration options are loaded from .livingdocs-cli file.
 
   -h, --host=host        (required) [default: http://localhost:9090] The livingdocs host.
@@ -172,9 +179,11 @@ OPTIONS
 
   -p, --project=project  If used configuration options are loaded from .livingdocs-cli file.
 
+  -s, --source=source    The folder or filename to the project config.
+
   -t, --token=token      (required) Access Token for your project (needs `public-api:config:write` permission).
                          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.1.2/src/commands/project-config/publish.js)_
+_See code: [src/commands/project-config/publish.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.4.0/src/commands/project-config/publish.js)_
 <!-- commandsstop -->

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.1.2","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"},"dist":{"name":"dist","type":"option","char":"d","description":"The folder or filename to the channelConfig.","required":true}},"args":[]},"project-config:publish":{"id":"project-config:publish","description":"Publish a ChannelConfig 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"},"dist":{"name":"dist","type":"option","char":"d","description":"The folder or filename to the channelConfig.","required":true}},"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"},"dist":{"name":"dist","type":"option","char":"d","description":"The folder or filename to the channelConfig.","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.4.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},"address":{"name":"address","type":"option","char":"a","description":"The address of the design-server."},"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.1.2",
+  "version": "2.4.0",
   "author": "Livingdocs AG",
   "repository": "livingdocsIO/livingdocs-cli",
   "homepage": "https://github.com/livingdocsIO/livingdocs-cli",
@@ -27,6 +27,7 @@
     "chalk": "^2.4.2",
     "cheerio": "^1.0.0-rc.3",
     "dedent": "^0.7.0",
+    "diff": "^5.0.0",
     "fastify": "^3.25.3",
     "fastify-cors": "^6.0.2",
     "fastify-static": "^4.5.0",
@@ -85,11 +86,11 @@
     "isCi": true,
     "name": "Drone",
     "service": "drone",
-    "commit": "5a1d56a52c578fc950d7bad0c488f627c92629a3",
-    "build": "87",
+    "commit": "073bb133c9abdc5cca5ab3f6e12648a010f595dd",
+    "build": "103",
     "branch": "master",
     "isPr": false,
     "slug": "livingdocsIO/livingdocs-cli",
-    "date": "2022-01-03T13:58:43.325Z"
+    "date": "2022-02-11T21:50:28.394Z"
   }
 }

package/src/commands/config/print.js

@@ -21,13 +21,15 @@ class ListConfigCommand extends Command {
 
     this.printVar(`LI_HOST`, 'host', sessionConfig)
     this.printVar(`LI_TOKEN`, 'token', sessionConfig)
+    this.printVar(`LI_SOURCE_FOLDER`, 'sourceFolder', sessionConfig)
     this.printVar(`LI_DIST_FOLDER`, 'distFolder', sessionConfig)
   }
 
   printVar (name, prop, sessionConfig) {
     const varObj = getVar(name, prop, sessionConfig)
 
-    this.log(chalk.green(`${name}`), chalk.gray(` (source: ${varObj.source})`))
+    if (varObj.source) this.log(chalk.green(`${name}`), chalk.gray(` (source: ${varObj.source})`))
+    else this.log(chalk.green(`${name}`))
     this.log(chalk.gray(`${varObj.value}\n`))
   }
 }
@@ -51,7 +53,7 @@ function getVar (key, prop, sessionConfig) {
   } else {
     return {
       value: '[undefined]',
-      source: 'not set'
+      source: undefined
     }
   }
 }

package/src/commands/design-server/start.js

@@ -13,6 +13,10 @@ class DesignServerCommand extends Command {
       description: 'The port of the design-server.',
       default: 9030
     }),
+    address: flags.string({
+      char: 'a',
+      description: 'The address of the design-server.'
+    }),
     dist: flags.string({
       char: 'd',
       description: 'The folder to load designs from.',
@@ -29,7 +33,8 @@ class DesignServerCommand extends Command {
 
   async run () {
     let host
-    const {port, verbose, dist, assets, basePath} = this.parse(DesignServerCommand).flags
+    const {port, address: customAddress, verbose, dist, assets, basePath} =
+      this.parse(DesignServerCommand).flags
 
     const fastify = require('fastify')({
       logger: verbose ? {prettyPrint: true} : undefined
@@ -108,7 +113,7 @@ class DesignServerCommand extends Command {
       reply.sendFile(filePath)
     })
 
-    fastify.listen(port, (err, address) => {
+    fastify.listen(port, customAddress, (err, address) => {
       if (err) throw err
       host = address
       if (!verbose) this.log(chalk.green(`server listening at ${address}`))

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 {
@@ -13,22 +13,21 @@ class PlanCommand extends Command {
     env: sharedFlags.env,
     token: {...sharedFlags.configWriteToken, required: true},
     host: {...sharedFlags.host, required: true},
-    dist: {
-      ...sharedFlags.dist,
-      required: true,
-      description: 'The folder or filename to the channelConfig.'
-    }
+    source: {...sharedFlags.source},
+    dist: {...sharedFlags.dist}
   }
 
   async run () {
-    const {token, host, dist} = this.parse(PlanCommand).flags
+    const {token, host, source, dist} = this.parse(PlanCommand).flags
     const reportError = errorReporter(this.log, host, {verbose: true})
 
-    const config = await readChannelConfig({source: dist})
+    if (!source && !dist) throw new Error('Missing a source param')
+
+    const config = await readChannelConfig({source: source || dist})
 
     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,54 +5,61 @@ 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')
 
 class PublishCommand extends Command {
-  static description = `Publish a ChannelConfig to your project`
+  static description = `Publish a project configuration to your project`
   static flags = {
     project: sharedFlags.project,
     env: sharedFlags.env,
     token: {...sharedFlags.configWriteToken, required: true},
     host: {...sharedFlags.host, required: true},
-    dist: {
-      ...sharedFlags.dist,
-      required: true,
-      description: 'The folder or filename to the channelConfig.'
-    }
+    source: {...sharedFlags.source},
+    dist: {...sharedFlags.dist}
   }
 
   async run () {
-    const {token, host, dist} = this.parse(PublishCommand).flags
+    const {token, host, source, dist, env} = this.parse(PublishCommand).flags
     const reportError = errorReporter(this.log, host, {verbose: true})
 
-    const config = await readChannelConfig({source: dist})
+    if (!source && !dist) throw new Error('Missing a source param')
+
+    const config = await readChannelConfig({source: source || dist})
       .catch((err) => {
         this.log(chalk.red('✕ Parsing Failed'))
         throw err
       })
 
+    let ok = false
     await liApi.plan({host, token, channelConfig: config})
       .then((result) => {
-        resultReporter(result, this.log)
+        ok = result.ok
+
+        // early return if there are no chagnes
+        if (!result.patches?.length) ok = false
+
+        resultReporter({result, log: this.log})
       })
       .catch(reportError)
 
+    if (!ok) return
+
     const answers = await inquirer.prompt([{
       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: dist,
+          source: source || dist,
           revisionNumberBefore: config.$baseRevision,
           revisionNumber: result.revisionNumber
         })

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 {
@@ -15,11 +15,10 @@ class UploadCommand extends Command {
     env: sharedFlags.env,
     token: {...sharedFlags.configWriteToken, required: true},
     host: {...sharedFlags.host, required: true},
-    dist: flags.string({
-      char: 'd',
-      required: true,
-      description: 'The folder or filename to the channelConfig.'
-    }),
+    source: {
+      ...sharedFlags.source,
+      required: true
+    },
     draftName: flags.string({
       description: 'The name of the draft the config will be saved under.',
       required: true
@@ -27,10 +26,10 @@ class UploadCommand extends Command {
   }
 
   async run () {
-    const {token, host, dist} = this.parse(UploadCommand).flags
+    const {token, host, source} = this.parse(UploadCommand).flags
     const reportError = errorReporter(this.log, host, {verbose: true})
 
-    const config = await readChannelConfig({source: dist})
+    const config = await readChannelConfig({source})
       .catch((err) => {
         this.log(chalk.red('✕ Parsing Failed'))
         throw err
@@ -39,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/project_config_result_reporter.js

@@ -0,0 +1,79 @@
+const chalk = require('chalk')
+const dedent = require('dedent')
+const diff = require('diff')
+
+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)) }
+  function print (obj) { return JSON.stringify(obj, null, 2) }
+
+  function colorUpdate (entry) {
+    if (entry.added) return chalk.green(entry.value)
+    if (entry.removed) return chalk.red(entry.value)
+    return entry.value
+  }
+
+  function calcDiff (patch) {
+
+    if (patch.action === 'update') {
+      const items = diff.diffJson(patch.valueBefore || '', patch.value)
+      return items.reduce((str, item) => {
+        return `${str}${colorUpdate(item)}`
+      }, '')
+    } else if (patch.action === 'remove') {
+      return patch.valueBefore
+        ? chalk.red(print(patch.valueBefore))
+        : ''
+    } else {
+      return chalk.green(print(patch.value))
+    }
+  }
+
+  if (result.ok) {
+    const count = result.patches?.length
+    if (!count) {
+      info(dedent`
+        ✓ No Changes.
+      `)
+    } 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.
+
+          Revision: ${result.revisionNumber}
+          DesignVersion: ${result.designVersion || '-'}
+      `)
+      info(`\nApplied Patches (${result.patches.length}):`)
+    }
+  }
+
+  if (result.schemaErrors) {
+    error(`\nInvalid JSON: there have been json schema errors`)
+
+    for (const err of result.schemaErrors) {
+      error(` • ${err.pointer}: ${err.message}`)
+    }
+  }
+
+  if (result.violations) {
+    error(`\nInvalid Config: there are invliad configuration properties`)
+
+    for (const err of result.violations) {
+      error(` • ${err.pointer}: ${err.message}`)
+    }
+  }
+}

package/src/lib/cli/shared_flags.js

@@ -66,6 +66,19 @@ module.exports = {
       }
     }
   }),
+  source: flags.string({
+    char: 's',
+    description: 'The folder or filename to the project config.',
+
+    default ({options, flags: givenFlags}) {
+      const sessionConfig = getCliConfig(givenFlags)
+      if (sessionConfig) {
+        return sessionConfig.sourceFolder
+      } else {
+        return process.env.LI_SOURCE_FOLDER
+      }
+    }
+  }),
   designUri: flags.string({
     char: 'u',
     description: 'URL of the design to import',

package/src/lib/api/channel_config_result_reporter.js

@@ -1,56 +0,0 @@
-const chalk = require('chalk')
-const dedent = require('dedent')
-
-module.exports = function (result, log) {
-  function info (msg) { log(msg) }
-  function success (msg) { log(chalk.green(msg)) }
-  function error (msg) { log(chalk.red(msg)) }
-
-  if (result.ok) {
-    if (!result.patches || result.patches.length === 0) {
-      info(dedent`
-        ✓ No Changes.
-      `)
-    } else {
-      if (result.plan) {
-        info(dedent`
-          Plan
-          ----
-          ✓ Everything looks ok.
-        `)
-        info(`\nThese patches will be applied (${result.patches.length}):`)
-      } else {
-        success(dedent`
-          ✓ Success. Channel Config Published.
-
-            Revision: ${result.revisionNumber}
-            DesignVersion: ${result.designVersion || '-'}
-        `)
-        info(`\nApplied Patches (${result.patches.length}):`)
-      }
-
-      for (const patch of result.patches) {
-        info(` • [${patch.action}] ${patch.pointer}`)
-      }
-      info(``)
-    }
-
-    return
-  }
-
-  if (result.schemaErrors) {
-    error(`\nInvalid JSON: there have been json schema errors`)
-
-    for (const err of result.schemaErrors) {
-      error(` • ${err.pointer}: ${err.message}`)
-    }
-  }
-
-  if (result.violations) {
-    error(`\nInvalid Config: there are invliad configuration properties`)
-
-    for (const err of result.violations) {
-      error(` • ${err.pointer}: ${err.message}`)
-    }
-  }
-}