feat: copy oclif/core ux methods

Author: mdonnalley

package.json

@@ -49,11 +49,19 @@
     "@salesforce/core": "^7.2.0",
     "@salesforce/kit": "^3.1.0",
     "@salesforce/ts-types": "^2.0.9",
-    "chalk": "^5.3.0"
+    "cardinal": "^2.1.1",
+    "chalk": "^5.3.0",
+    "js-yaml": "^4.1.0",
+    "natural-orderby": "^3.0.2",
+    "slice-ansi": "^7.1.0",
+    "string-width": "^7.1.0",
+    "terminal-link": "^3.0.0"
   },
   "devDependencies": {
     "@inquirer/type": "^1.2.1",
     "@salesforce/dev-scripts": "^8.5.0",
+    "@types/cardinal": "^2.1.1",
+    "@types/js-yaml": "^4.0.9",
     "eslint-plugin-sf-plugin": "^1.18.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.4.5"

src/ux/styledJSON.ts

@@ -0,0 +1,22 @@
+/*
+ * Copyright (c) 2023, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { createRequire } from 'node:module';
+import { highlight, CardinalTheme } from 'cardinal';
+import chalk from 'chalk';
+
+// @oclif/core v4 will have native support for coloring JSON so we won't need this then.
+export default function styledJSON(obj: unknown): string {
+  const json = JSON.stringify(obj, null, 2);
+  if (!chalk.level) {
+    return json;
+  }
+
+  const require = createRequire(import.meta.url);
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  const theme = require('cardinal/themes/jq') as CardinalTheme;
+  return highlight(json, { theme });
+}

src/ux/styledObject.ts

@@ -0,0 +1,54 @@
+/*
+ * Copyright (c) 2023, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { inspect } from 'node:util';
+import chalk from 'chalk';
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+function pp(obj: any): any {
+  if (typeof obj === 'string' || typeof obj === 'number') return obj;
+  if (typeof obj === 'object') {
+    return (
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+      Object.keys(obj)
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+        .map((k) => k + ': ' + inspect(obj[k]))
+        .join(', ')
+    );
+  }
+
+  return inspect(obj);
+}
+
+// @oclif/core v4 will have native support for coloring JSON so we won't need this then.
+export default function styledObject(obj: any, keys?: string[]): string {
+  const output: string[] = [];
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+  const keyLengths = Object.keys(obj).map((key) => key.toString().length);
+  const maxKeyLength = Math.max(...keyLengths) + 2;
+
+  const logKeyValue = (key: string, value: any): string =>
+    `${chalk.blue(key)}:` + ' '.repeat(maxKeyLength - key.length - 1) + pp(value);
+
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+  for (const key of keys ?? Object.keys(obj).sort()) {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
+    const value = obj[key];
+    if (Array.isArray(value)) {
+      if (value.length > 0) {
+        output.push(logKeyValue(key, value[0]));
+        for (const e of value.slice(1)) {
+          output.push(' '.repeat(maxKeyLength) + pp(e));
+        }
+      }
+    } else if (value !== null && value !== undefined) {
+      output.push(logKeyValue(key, value));
+    }
+  }
+
+  return output.join('\n');
+}