@heroku/heroku-cli-util 9.0.0 → 9.0.1-beta.0

package/README.md

@@ -30,10 +30,24 @@ import { hux } from '@heroku/heroku-cli-util';
 hux.styledHeader('My CLI Header');
 
 // Styled JSON
-hux.styledJson({ foo: 'bar' });
+hux.styledJSON({ foo: 'bar' });
 
 // Styled object
 hux.styledObject({ foo: 'bar' });
+
+// Table output
+hux.table([
+  {name: 'Alice', age: 30},
+  {name: 'Bob', age: 25},
+], {
+  name: {header: 'Name'},
+  age: {header: 'Age'},
+});
+
+// Wait indicator
+const stop = hux.wait('Processing...');
+// ...do async work...
+stop();
 ```
 
 ### User Interaction

package/dist/index.d.ts

@@ -10,8 +10,10 @@ import { exec } from './utils/pg/psql';
 import { confirm } from './ux/confirm';
 import { prompt } from './ux/prompt';
 import { styledHeader } from './ux/styled-header';
-import { styledJson } from './ux/styled-json';
+import { styledJSON } from './ux/styled-json';
 import { styledObject } from './ux/styled-object';
+import { table } from './ux/table';
+import { wait } from './ux/wait';
 export declare const testHelpers: {
     expectOutput: (actual: string, expected: string) => Chai.Assertion;
     initCliTest: typeof initCliTest;
@@ -48,6 +50,8 @@ export declare const hux: {
     confirm: typeof confirm;
     prompt: typeof prompt;
     styledHeader: typeof styledHeader;
-    styledJson: typeof styledJson;
+    styledJSON: typeof styledJSON;
     styledObject: typeof styledObject;
+    table: typeof table;
+    wait: typeof wait;
 };

package/dist/index.js

@@ -15,6 +15,8 @@ const prompt_1 = require("./ux/prompt");
 const styled_header_1 = require("./ux/styled-header");
 const styled_json_1 = require("./ux/styled-json");
 const styled_object_1 = require("./ux/styled-object");
+const table_1 = require("./ux/table");
+const wait_1 = require("./ux/wait");
 exports.testHelpers = {
     expectOutput: expect_output_1.default,
     initCliTest: init_1.initCliTest,
@@ -51,6 +53,8 @@ exports.hux = {
     confirm: confirm_1.confirm,
     prompt: prompt_1.prompt,
     styledHeader: styled_header_1.styledHeader,
-    styledJson: styled_json_1.styledJson,
+    styledJSON: styled_json_1.styledJSON,
     styledObject: styled_object_1.styledObject,
+    table: table_1.table,
+    wait: wait_1.wait,
 };

package/dist/ux/styled-json.d.ts

@@ -1 +1 @@
-export declare function styledJson(obj: unknown): void;
+export declare function styledJSON(obj: unknown): void;

package/dist/ux/styled-json.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.styledJson = styledJson;
+exports.styledJSON = styledJSON;
 const core_1 = require("@oclif/core");
-function styledJson(obj) {
+function styledJSON(obj) {
     return core_1.ux.styledJSON(obj);
 }

package/dist/ux/table.d.ts

@@ -1,2 +1,2 @@
-import { ux } from '@oclif/core';
-export declare function table<T extends Record<string, unknown>>(data: T[], columns: Parameters<typeof ux.table>[1], options?: Parameters<typeof ux.table>[2]): void;
+import { table as cliTable } from '@oclif/core/lib/cli-ux';
+export declare function table<T extends Record<string, unknown>>(data: T[], columns: Parameters<typeof cliTable>[1], options?: Parameters<typeof cliTable>[2]): void;

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "commonjs",
   "name": "@heroku/heroku-cli-util",
-  "version": "9.0.0",
+  "version": "9.0.1-beta.0",
   "description": "Set of helpful CLI utilities",
   "author": "Heroku",
   "license": "ISC",