livingdocs-cli 2.0.0 → 2.0.1

package/README.md

@@ -20,7 +20,7 @@ $ npm install -g livingdocs-cli
 $ livingdocs-cli COMMAND
 running command...
 $ livingdocs-cli (-v|--version|version)
-livingdocs-cli/0.0.0 darwin-x64 node-v12.10.0
+livingdocs-cli/2.0.1 linux-x64 node-v16.11.1
 $ livingdocs-cli --help [COMMAND]
 USAGE
   $ livingdocs-cli COMMAND
@@ -35,6 +35,7 @@ USAGE
 * [`livingdocs-cli help [COMMAND]`](#livingdocs-cli-help-command)
 * [`livingdocs-cli project-config:download`](#livingdocs-cli-project-configdownload)
 * [`livingdocs-cli project-config:drafts`](#livingdocs-cli-project-configdrafts)
+* [`livingdocs-cli project-config:import-design`](#livingdocs-cli-project-configimport-design)
 * [`livingdocs-cli project-config:plan`](#livingdocs-cli-project-configplan)
 * [`livingdocs-cli project-config:publish`](#livingdocs-cli-project-configpublish)
 * [`livingdocs-cli project-config:upload`](#livingdocs-cli-project-configupload)
@@ -49,7 +50,7 @@ USAGE
   $ livingdocs-cli cli-config:print
 ```
 
-_See code: [src/commands/cli-config/print.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v0.0.0/src/commands/cli-config/print.js)_
+_See code: [src/commands/cli-config/print.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.0.1/src/commands/cli-config/print.js)_
 
 ## `livingdocs-cli component-library:build`
 
@@ -64,7 +65,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/v0.0.0/src/commands/component-library/build.js)_
+_See code: [src/commands/component-library/build.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.0.1/src/commands/component-library/build.js)_
 
 ## `livingdocs-cli design-server:start`
 
@@ -75,13 +76,14 @@ 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.
+  -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/v0.0.0/src/commands/design-server/start.js)_
+_See code: [src/commands/design-server/start.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.0.1/src/commands/design-server/start.js)_
 
 ## `livingdocs-cli help [COMMAND]`
 
@@ -110,17 +112,20 @@ USAGE
 
 OPTIONS
   -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           [default: http://localhost:9090] The livingdocs host.
+  -h, --host=host           (required) [default: http://localhost:9090] The livingdocs host.
                             Can be set by the environment variable 'LI_HOST'.
 
-  -t, --token=token         (required) The Access Token to your project (needs write permission).
+  -p, --project=project     If used configuration options are loaded from .livingdocs-cli file.
+
+  -t, --token=token         (required) Access Token for your project (needs `public-api:config:read` permission).
                             Can be set by the environment variable 'LI_TOKEN'.
 
   --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/v0.0.0/src/commands/project-config/download.js)_
+_See code: [src/commands/project-config/download.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.0.1/src/commands/project-config/download.js)_
 
 ## `livingdocs-cli project-config:drafts`
 
@@ -134,11 +139,28 @@ OPTIONS
   -h, --host=host    [default: http://localhost:9090] The livingdocs host.
                      Can be set by the environment variable 'LI_HOST'.
 
-  -t, --token=token  (required) The Access Token to your project (needs write permission).
+  -t, --token=token  (required) Access Token for your project (needs `public-api:config:read` permission).
                      Can be set by the environment variable 'LI_TOKEN'.
 ```
 
-_See code: [src/commands/project-config/drafts.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v0.0.0/src/commands/project-config/drafts.js)_
+_See code: [src/commands/project-config/drafts.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.0.1/src/commands/project-config/drafts.js)_
+
+## `livingdocs-cli project-config:import-design`
+
+Import a design into a given project configuration
+
+```
+USAGE
+  $ livingdocs-cli project-config:import-design
+
+OPTIONS
+  -d, --dist=dist            (required) The folder where the output will be written.
+  -e, --env=env              If used configuration options are loaded from .livingdocs-cli file.
+  -p, --project=project      If used configuration options are loaded from .livingdocs-cli file.
+  -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.0.1/src/commands/project-config/import-design.js)_
 
 ## `livingdocs-cli project-config:plan`
 
@@ -149,16 +171,19 @@ USAGE
   $ livingdocs-cli project-config:plan
 
 OPTIONS
-  -d, --dist=dist    The folder or filename where to download to.
+  -d, --dist=dist        (required) The folder or filename to the channelConfig.
+  -e, --env=env          If used configuration options are loaded from .livingdocs-cli file.
 
-  -h, --host=host    [default: http://localhost:9090] The livingdocs host.
-                     Can be set by the environment variable 'LI_HOST'.
+  -h, --host=host        (required) [default: http://localhost:9090] The livingdocs host.
+                         Can be set by the environment variable 'LI_HOST'.
 
-  -t, --token=token  (required) The Access Token to your project (needs write permission).
-                     Can be set by the environment variable 'LI_TOKEN'.
+  -p, --project=project  If used configuration options are loaded from .livingdocs-cli file.
+
+  -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/v0.0.0/src/commands/project-config/plan.js)_
+_See code: [src/commands/project-config/plan.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.0.1/src/commands/project-config/plan.js)_
 
 ## `livingdocs-cli project-config:publish`
 
@@ -169,16 +194,19 @@ USAGE
   $ livingdocs-cli project-config:publish
 
 OPTIONS
-  -d, --dist=dist    The folder to publish from.
+  -d, --dist=dist        (required) The folder or filename to the channelConfig.
+  -e, --env=env          If used configuration options are loaded from .livingdocs-cli file.
 
-  -h, --host=host    [default: http://localhost:9090] The livingdocs host.
-                     Can be set by the environment variable 'LI_HOST'.
+  -h, --host=host        (required) [default: http://localhost:9090] The livingdocs host.
+                         Can be set by the environment variable 'LI_HOST'.
 
-  -t, --token=token  (required) The Access Token to your project (needs write permission).
-                     Can be set by the environment variable 'LI_TOKEN'.
+  -p, --project=project  If used configuration options are loaded from .livingdocs-cli file.
+
+  -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/v0.0.0/src/commands/project-config/publish.js)_
+_See code: [src/commands/project-config/publish.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.0.1/src/commands/project-config/publish.js)_
 
 ## `livingdocs-cli project-config:upload`
 
@@ -189,18 +217,21 @@ USAGE
   $ livingdocs-cli project-config:upload
 
 OPTIONS
-  -d, --dist=dist        The folder or filename where to download to.
+  -d, --dist=dist        (required) The folder or filename to the channelConfig.
+  -e, --env=env          If used configuration options are loaded from .livingdocs-cli file.
 
-  -h, --host=host        [default: http://localhost:9090] The livingdocs host.
+  -h, --host=host        (required) [default: http://localhost:9090] The livingdocs host.
                          Can be set by the environment variable 'LI_HOST'.
 
-  -t, --token=token      (required) The Access Token to your project (needs write permission).
+  -p, --project=project  If used configuration options are loaded from .livingdocs-cli file.
+
+  -t, --token=token      (required) Access Token for your project (needs `public-api:config:write` permission).
                          Can be set by the environment variable 'LI_TOKEN'.
 
   --draftName=draftName  (required) The name of the draft the config will be saved under.
 ```
 
-_See code: [src/commands/project-config/upload.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v0.0.0/src/commands/project-config/upload.js)_
+_See code: [src/commands/project-config/upload.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.0.1/src/commands/project-config/upload.js)_
 
 ## `livingdocs-cli project-config:upload_assets`
 
@@ -216,9 +247,9 @@ OPTIONS
   -h, --host=host      [default: http://localhost:9090] The livingdocs host.
                        Can be set by the environment variable 'LI_HOST'.
 
-  -t, --token=token    (required) The Access Token to your project (needs write permission).
+  -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/upload_assets.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v0.0.0/src/commands/project-config/upload_assets.js)_
+_See code: [src/commands/project-config/upload_assets.js](https://github.com/livingdocsIO/livingdocs-cli/blob/v2.0.1/src/commands/project-config/upload_assets.js)_
 <!-- commandsstop -->

package/oclif.manifest.json

@@ -0,0 +1 @@
+{"version":"2.0.1","commands":{"cli-config:print":{"id":"cli-config:print","description":"Print current CLI configuration","pluginName":"livingdocs-cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"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":[]},"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","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","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","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.0.0",
+  "version": "2.0.1",
   "author": "Livingdocs AG",
   "repository": "livingdocsIO/livingdocs-cli",
   "homepage": "https://github.com/livingdocsIO/livingdocs-cli",
@@ -15,8 +15,7 @@
     "test": "mocha --forbid-only \"test/**/*.test.js\"",
     "test:coverage": "nyc mocha --forbid-only \"test/**/*.test.js\"",
     "posttest": "eslint .",
-    "version": "oclif-dev readme && git add README.md",
-    "postversion": "/release/node_modules/.bin/set-ci"
+    "version": "oclif-dev readme && git add README.md"
   },
   "dependencies": {
     "@oclif/command": "^1.5.19",
@@ -24,7 +23,7 @@
     "@oclif/plugin-help": "^2.2.1",
     "@oclif/plugin-not-found": "^1.2.3",
     "@oclif/plugin-warn-if-update-available": "^1.7.0",
-    "axios": "^0.19.0",
+    "axios": "^0.21.2",
     "chalk": "^2.4.2",
     "cheerio": "^1.0.0-rc.3",
     "dedent": "^0.7.0",
@@ -85,11 +84,11 @@
     "isCi": true,
     "name": "Drone",
     "service": "drone",
-    "commit": "c336b1974fd30ebee4c7bfea493be9281b4bffad",
-    "build": "72",
+    "commit": "ffb53d4f5e402ac0f3b663811e1551ff04e29e5d",
+    "build": "80",
     "branch": "master",
     "isPr": false,
     "slug": "livingdocsIO/livingdocs-cli",
-    "date": "2021-10-19T14:13:12.332Z"
+    "date": "2021-12-10T15:16:18.151Z"
   }
 }

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

@@ -85,9 +85,20 @@ class DesignServerCommand extends Command {
         return
       }
 
-      designConfig.assets = designConfig.assets || {}
-      const defaultBasePath = `${host}/designs/${designName}/${version}`
-      designConfig.assets.basePath = basePath || defaultBasePath
+      const designBasePath = basePath || `${host}/designs/${designName}/${version}`
+      if (
+        typeof designConfig.assets === 'object' &&
+        !designConfig.assets.basePath
+      ) {
+        designConfig.assets.basePath = designBasePath
+      }
+
+      if (
+        typeof designConfig.designSettings?.assets === 'object' &&
+        !designConfig.designSettings.assets.basePath
+      ) {
+        designConfig.designSettings.assets.basePath = designBasePath
+      }
 
       reply.send(designConfig)
     })