formatters and temp pretty option (#241)

yaroslav-codefresh · web-flow · commit 69f8d14e5708 · 2018-12-06T16:42:54.000+02:00
* formatters and temp pretty option

* remove useless style

* missing pretty options + image style changed

* version updated
diff --git a/lib/interface/cli/commands/board/get.cmd.js b/lib/interface/cli/commands/board/get.cmd.js
@@ -29,7 +29,7 @@ const command = new Command({
         if (id) {
             try {
                 const board = await boardLogic.getBoardById(id);
-                specifyOutputForArray(output, [board]);
+                specifyOutputForArray(output, [board], argv.pretty);
             } catch (err) {
                 debug(err.toString());
                 const message = `Board '${id}' was not found`;
@@ -41,7 +41,7 @@ const command = new Command({
         } else if (name) {
             try {
                 const board = await boardLogic.getBoardByName(name);
-                specifyOutputForArray(output, [board]);
+                specifyOutputForArray(output, [board], argv.pretty);
             } catch (err) {
                 debug(err.toString());
                 const message = `Board '${name}' was not found`;
@@ -51,7 +51,7 @@ const command = new Command({
                 });
             }
         } else {
-            specifyOutputForArray(output, await boardLogic.getAll({ name }));
+            specifyOutputForArray(output, await boardLogic.getAll({ name }), argv.pretty);
         }
     },
 });
diff --git a/lib/interface/cli/commands/cluster/get.cmd.js b/lib/interface/cli/commands/cluster/get.cmd.js
@@ -21,7 +21,7 @@ const command = new Command({
     },
     handler: async (argv) => {
         const clusters = await cluster.getAllClusters();
-        specifyOutputForArray(argv.output, clusters);
+        specifyOutputForArray(argv.output, clusters, argv.pretty);
     },
 });
 
diff --git a/lib/interface/cli/commands/composition/get.cmd.js b/lib/interface/cli/commands/composition/get.cmd.js
@@ -38,7 +38,7 @@ const command = new Command({
         } else {
             compositions = await composition.getCompositions();
         }
-        specifyOutputForArray(argv.output, compositions);
+        specifyOutputForArray(argv.output, compositions, argv.pretty);
     },
 });
 
diff --git a/lib/interface/cli/commands/context/get.cmd.js b/lib/interface/cli/commands/context/get.cmd.js
@@ -54,7 +54,7 @@ const command = new Command({
         } else {
             contexts = await context.getContexts(data);
         }
-        specifyOutputForArray(argv.output, contexts);
+        specifyOutputForArray(argv.output, contexts, argv.pretty);
     },
 });
 
diff --git a/lib/interface/cli/commands/environment/get.cmd.js b/lib/interface/cli/commands/environment/get.cmd.js
@@ -39,7 +39,7 @@ const command = new Command({
         } else {
             environments = await environment.getEnvironments();
         }
-        specifyOutputForArray(argv.output, environments);
+        specifyOutputForArray(argv.output, environments, argv.pretty);
     },
 });
 
diff --git a/lib/interface/cli/commands/helm/repo/get.cmd.js b/lib/interface/cli/commands/helm/repo/get.cmd.js
@@ -38,7 +38,7 @@ const command = new Command({
                     repos.push(currRepo);
                 } catch (err) {
                     if (repos.length) {
-                        specifyOutputForArray(output, repos);
+                        specifyOutputForArray(output, repos, argv.pretty);
                     }
 
                     debug(err.toString());
@@ -49,9 +49,9 @@ const command = new Command({
                     });
                 }
             }
-            specifyOutputForArray(output, repos);
+            specifyOutputForArray(output, repos, argv.pretty);
         } else {
-            specifyOutputForArray(output, await helm.getAllRepos());
+            specifyOutputForArray(output, await helm.getAllRepos(), argv.pretty);
         }
     },
 });
diff --git a/lib/interface/cli/commands/image/get.cmd.js b/lib/interface/cli/commands/image/get.cmd.js
@@ -105,7 +105,7 @@ const command = new Command({
                 offset,
             });
         }
-        specifyOutputForArray(argv.output, images);
+        specifyOutputForArray(argv.output, images, argv.pretty);
     },
 });
 
diff --git a/lib/interface/cli/commands/pipeline/get.cmd.js b/lib/interface/cli/commands/pipeline/get.cmd.js
@@ -46,7 +46,7 @@ const command = new Command({
             });
     },
     handler: async (argv) => {
-        const { id: ids, name, output, d: decryptVariables } = argv;
+        const { id: ids, name, output, d: decryptVariables, pretty} = argv;
         const limit = argv.limit;
         const offset = (argv.page - 1) * limit;
         const labels = prepareKeyValueFromCLIEnvOption(argv.label);
@@ -60,7 +60,7 @@ const command = new Command({
                     pipelines.push(currPipeline);
                 } catch (err) {
                     if (pipelines.length) {
-                        specifyOutputForArray(output, pipelines);
+                        specifyOutputForArray(output, pipelines, pretty);
                     }
 
                     debug(err.toString());
@@ -71,14 +71,14 @@ const command = new Command({
                     });
                 }
             }
-            specifyOutputForArray(output, pipelines);
+            specifyOutputForArray(output, pipelines, pretty);
         } else {
             specifyOutputForArray(output, await pipeline.getAll({
                 limit,
                 offset,
                 name,
                 labels,
-            }));
+            }), pretty);
         }
     },
 });
diff --git a/lib/interface/cli/commands/root/get.cmd.js b/lib/interface/cli/commands/root/get.cmd.js
@@ -24,6 +24,10 @@ const get = new Command({
                 choices: ['json', 'yaml', 'wide', 'name', 'id'],
                 group: 'Output Options',
             })
+            .option('pretty', {
+                describe: 'Use colors and signs for output',
+                group: 'Output Options',
+            })
             .option('watch', {
                 describe: 'Watching updates to a particular resource',
                 alias: 'w',
diff --git a/lib/interface/cli/commands/runtimeEnvironments/get.cmd.js b/lib/interface/cli/commands/runtimeEnvironments/get.cmd.js
@@ -62,13 +62,13 @@ const command = new Command({
                 version,
                 extend,
             });
-            specifyOutputForSingle(argv.output, currruntimeEnvironments);
+            specifyOutputForSingle(argv.output, currruntimeEnvironments, argv.pretty);
         }
         else {
             specifyOutputForArray(output, await runtimeEnvironments.getAllRuntimeEnvironmentsForAccount({
                 limit,
                 offset,
-            }));
+            }), argv.pretty);
         }
     },
 });
diff --git a/lib/interface/cli/commands/section/get.cmd.js b/lib/interface/cli/commands/section/get.cmd.js
@@ -37,7 +37,7 @@ const command = new Command({
         if (id) {
             try {
                 const section = await sectionLogic.getSectionById(id);
-                specifyOutputForArray(output, [section]);
+                specifyOutputForArray(output, [section], argv.pretty);
             } catch (err) {
                 debug(err.toString());
                 const message = `Section '${id}' was not found`;
@@ -57,7 +57,7 @@ const command = new Command({
             if (name) {
                 try {
                     const section = await sectionLogic.getSectionByName({ boardId, name });
-                    specifyOutputForArray(output, [section]);
+                    specifyOutputForArray(output, [section], argv.pretty);
                 } catch (err) {
                     debug(err.toString());
                     const message = `Section '${name}' was not found`;
@@ -67,7 +67,7 @@ const command = new Command({
                     });
                 }
             } else {
-                specifyOutputForArray(output, await sectionLogic.getAll({ boardId }));
+                specifyOutputForArray(output, await sectionLogic.getAll({ boardId }), argv.pretty);
             }
         }
     },
diff --git a/lib/interface/cli/commands/systemRuntimeEnvironments/get.cmd.js b/lib/interface/cli/commands/systemRuntimeEnvironments/get.cmd.js
@@ -94,15 +94,15 @@ const command = new Command({
                 type,
                 plan,
             });
-            specifyOutputForSingle(argv.output, currruntimeEnvironments);
+            specifyOutputForSingle(argv.output, currruntimeEnvironments, argv.pretty);
         }
         else {
             specifyOutputForArray(output, await runtimeEnvironments.getAllRuntimeEnvironmentsForAdmin({
                 limit,
                 offset,
                 account,
                 accountIds,
-            }));
+            }), argv.pretty);
         }
     },
 });
diff --git a/lib/interface/cli/commands/team/get.cmd.js b/lib/interface/cli/commands/team/get.cmd.js
@@ -18,7 +18,8 @@ const command = new Command({
             .example('codefresh get teams', 'Get all teams for current account');
     },
     handler: async (argv) => {
-        specifyOutputForArray(argv.output, await team.getTeamsForCurrentUser());
+        const teams = await team.getTeamsForCurrentUser();
+        specifyOutputForArray(argv.output, teams, argv.pretty);
     },
 });
 
diff --git a/lib/interface/cli/commands/trigger/event/get.cmd.js b/lib/interface/cli/commands/trigger/event/get.cmd.js
@@ -49,9 +49,9 @@ const command = new Command({
         }
 
         if (_.isArray(events)) {
-            specifyOutputForArray(argv.output, events);
+            specifyOutputForArray(argv.output, events, argv.pretty);
         } else {
-            specifyOutputForSingle(argv.output, events);
+            specifyOutputForSingle(argv.output, events, argv.pretty);
         }
     },
 });
diff --git a/lib/interface/cli/commands/trigger/get.cmd.js b/lib/interface/cli/commands/trigger/get.cmd.js
@@ -39,9 +39,9 @@ const command = new Command({
         }
 
         if (_.isArray(triggers)) {
-            specifyOutputForArray(argv.output, triggers);
+            specifyOutputForArray(argv.output, triggers, argv.pretty);
         } else {
-            specifyOutputForSingle(argv.output, triggers);
+            specifyOutputForSingle(argv.output, triggers, argv.pretty);
         }
     },
 });
diff --git a/lib/interface/cli/commands/trigger/type/get.cmd.js b/lib/interface/cli/commands/trigger/type/get.cmd.js
@@ -50,9 +50,9 @@ const command = new Command({
         }
 
         if (_.isArray(types)) {
-            specifyOutputForArray(argv.output, types);
+            specifyOutputForArray(argv.output, types, argv.pretty);
         } else {
-            specifyOutputForSingle(argv.output, types);
+            specifyOutputForSingle(argv.output, types, argv.pretty);
         }
     },
 });
diff --git a/lib/interface/cli/commands/workflow/get.cmd.js b/lib/interface/cli/commands/workflow/get.cmd.js
@@ -49,10 +49,6 @@ const command = new Command({
                 type: Array,
                 default: [],
             })
-            .option('pretty', {
-                describe: 'Use colors and signs for output',
-                group: 'Output Options',
-            })
             .example('codefresh get build ID', 'Get build ID')
             .example('codefresh get builds', 'Get all builds')
             .example('codefresh get builds --pipeline-id ID', 'Get all builds that are executions of pipeline "ID"')
diff --git a/lib/interface/cli/helpers/get.js b/lib/interface/cli/helpers/get.js
@@ -1,17 +1,20 @@
 /* eslint-disable indent */
-const _                     = require('lodash');
-const columnify             = require('columnify');
-const chalk                 = require('chalk');
-const yaml                  = require('js-yaml');
-const draftlog              = require('draftlog');
-const { Formatter }         = require('../../../output');
+const _ = require('lodash');
+const columnify = require('columnify');
+const yaml = require('js-yaml');
+const draftlog = require('draftlog');
+const { Formatter } = require('../../../output');
 const { FormatterRegistry } = require('../../../output/formatters');
+const Style = require('../../../output/style');
 
+const NO_RESOURCES_MESSAGE = 'no available resources';
+const STYLED_NO_RESOURCES_MESSAGE = Style.yellow.prependedBy(Style.red('▸'))(NO_RESOURCES_MESSAGE);
 const NOOP_FORMATTER = new Formatter();
 
 const prettyOpts = {
-    headingTransform: chalk.bold,
+    headingTransform: Style.bold,
     columnSplitter: '  ',
+    preserveNewLines: true,
 };
 
 draftlog.into(console);
@@ -25,10 +28,11 @@ const print = (output) => {
     }
 };
 
-//i tried that this function will be dynamic (with the keys). it is also possible to add an array with all the fields if you think it better
+// i tried that this function will be dynamic (with the keys). it is also possible to add an array with all the fields if you think it better
 const _printArrayTable = (data, pretty = false) => {
     if (data.length === 0) {
-        console.log('no available resources');
+        const message = pretty ? STYLED_NO_RESOURCES_MESSAGE : NO_RESOURCES_MESSAGE;
+        console.log(message);
     } else {
         const keys = Object.keys(data[0]);
         const res  = [];
@@ -104,7 +108,7 @@ const specifyOutputForArray = (type, entities, pretty = false) => {
 
             break;
         case 'yaml':
-            let yamlArray = {
+            const yamlArray = {
                 items: [],
             };
             _.forEach(entities, (entity) => {
@@ -130,14 +134,18 @@ const specifyOutputForArray = (type, entities, pretty = false) => {
         case 'wide':
             const wideArray = [];
             _.forEach(entities, (entity) => {
-                wideArray.push(formatter.apply(entity.toWide()));
+                let item = entity.toWide();
+                item = _.mapValues(item, (val) => val instanceof Array ? val.join('\n') : val);
+                wideArray.push(formatter.apply(item));
             });
             _printArrayTable(wideArray, pretty);
             break;
         default:
             const defaultArray = [];
             _.forEach(entities, (entity) => {
-                defaultArray.push(formatter.apply(entity.toDefault()));
+                let item = entity.toDefault();
+                item = _.mapValues(item, (val) => (val instanceof Array) ? val.join('\n') : val);
+                defaultArray.push(formatter.apply(item));
             });
             _printArrayTable(defaultArray, pretty);
     }
diff --git a/lib/logic/entities/HelmRepo.js b/lib/logic/entities/HelmRepo.js
@@ -1,7 +1,7 @@
 const moment = require('moment');
 const Entity = require('./Entity');
 
-class Pipeline extends Entity {
+class HelmRepo extends Entity {
     constructor(data) {
         super();
         this.entityType = 'helm-repo';
@@ -15,4 +15,4 @@ class Pipeline extends Entity {
     }
 }
 
-module.exports = Pipeline;
+module.exports = HelmRepo;
diff --git a/lib/logic/entities/Team.js b/lib/logic/entities/Team.js
@@ -8,6 +8,18 @@ class Team extends Entity {
         this.defaultColumns = ['id', 'name', 'type', 'account', 'tags', 'users'];
         this.wideColumns = this.defaultColumns.concat([]);
     }
+
+    toDefault() {
+        const data = super.toDefault();
+        data.users = data.users.map(user => user.userName);
+        return data;
+    }
+
+    toWide() {
+        const data = super.toWide();
+        data.users = data.users.map(user => user.userName);
+        return data;
+    }
 }
 
 module.exports = Team;
diff --git a/lib/output/formatters/Composition.formatter.js b/lib/output/formatters/Composition.formatter.js
@@ -0,0 +1,14 @@
+const { Formatter, Style } = require('../../output');
+
+const CHECK_SIGN = '✓';
+const CROSS_SIGN = '✗';
+
+const TYPE = {
+    false: Style.red.appendedBy(CROSS_SIGN),
+    true: Style.green.appendedBy(CHECK_SIGN),
+};
+
+const FORMATTER = Formatter.build()
+    .style('isAdvanced', input => (TYPE[input] || Style).bold(input));
+
+module.exports = FORMATTER;
diff --git a/lib/output/formatters/Environment.formatter.js b/lib/output/formatters/Environment.formatter.js
@@ -0,0 +1,17 @@
+const { Formatter, Style } = require('../../output');
+
+const CHECK_SIGN = '✓';
+const CROSS_SIGN = '✗';
+const PROGRESS_SIGN = '«';
+
+
+const STATUS = {
+    done: Style.green.appendedBy(CHECK_SIGN),
+    inProgress: Style.yellow.appendedBy(PROGRESS_SIGN),
+    terminating: Style.red.appendedBy(CROSS_SIGN),
+};
+
+const FORMATTER = Formatter.build()
+    .style('status', input => (STATUS[input] || Style).bold.uppercase(input));
+
+module.exports = FORMATTER;
diff --git a/lib/output/formatters/HelmRepo.formatter.js b/lib/output/formatters/HelmRepo.formatter.js
diff --git a/lib/output/formatters/Image.formatter.js b/lib/output/formatters/Image.formatter.js
diff --git a/lib/output/formatters/Section.formatter.js b/lib/output/formatters/Section.formatter.js
diff --git a/lib/output/formatters/Team.formatter.js b/lib/output/formatters/Team.formatter.js
diff --git a/lib/output/formatters/TriggerEvent.formatter.js b/lib/output/formatters/TriggerEvent.formatter.js
diff --git a/lib/output/formatters/TriggerType.formatter.js b/lib/output/formatters/TriggerType.formatter.js
diff --git a/lib/output/formatters/Workflow.formatter.js b/lib/output/formatters/Workflow.formatter.js
diff --git a/lib/output/formatters/index.js b/lib/output/formatters/index.js
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ const command = new Command({`
`38`	`38`	`} else {`
`39`	`39`	`compositions = await composition.getCompositions();`
`40`	`40`	`}`
`41`		`- specifyOutputForArray(argv.output, compositions);`
	`41`	`+ specifyOutputForArray(argv.output, compositions, argv.pretty);`
`42`	`42`	`},`
`43`	`43`	`});`
`44`	`44`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ const command = new Command({`
`54`	`54`	`} else {`
`55`	`55`	`contexts = await context.getContexts(data);`
`56`	`56`	`}`
`57`		`- specifyOutputForArray(argv.output, contexts);`
	`57`	`+ specifyOutputForArray(argv.output, contexts, argv.pretty);`
`58`	`58`	`},`
`59`	`59`	`});`
`60`	`60`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ const command = new Command({`
`39`	`39`	`} else {`
`40`	`40`	`environments = await environment.getEnvironments();`
`41`	`41`	`}`
`42`		`- specifyOutputForArray(argv.output, environments);`
	`42`	`+ specifyOutputForArray(argv.output, environments, argv.pretty);`
`43`	`43`	`},`
`44`	`44`	`});`
`45`	`45`
Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,7 @@ const command = new Command({`
`105`	`105`	`offset,`
`106`	`106`	`});`
`107`	`107`	`}`
`108`		`- specifyOutputForArray(argv.output, images);`
	`108`	`+ specifyOutputForArray(argv.output, images, argv.pretty);`
`109`	`109`	`},`
`110`	`110`	`});`
`111`	`111`