feat: copy oclif/core ux methods

.github/workflows/test.yml

@@ -17,6 +17,27 @@ jobs:
     needs: linux-unit-tests
     uses: salesforcecli/github-workflows/.github/workflows/unitTestsWindows.yml@main
 
+  integration:
+    needs: linux-unit-tests
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        node_version: [lts/*, latest]
+        exclude:
+          - os: windows-latest
+            node_version: lts/*
+      fail-fast: false
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node_version }}
+          cache: yarn
+      - uses: salesforcecli/github-workflows/.github/actions/yarnInstallWithRetries@main
+      - run: yarn build
+      - run: yarn test:integration
+
   external-nuts-deploy-retrieve:
     name: external-nuts-deploy-retrieve
     needs: linux-unit-tests

package.json

@@ -20,6 +20,7 @@
     "prepack": "sf-prepack",
     "prepare": "sf-install",
     "test": "wireit",
+    "test:integration": "mocha test/**/*.integration.ts --timeout 30000",
     "test:only": "wireit"
   },
   "exports": {
@@ -49,11 +50,21 @@
     "@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",
+    "cli-progress": "^3.12.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/cli-progress": "^3.11.5",
+    "@types/js-yaml": "^4.0.9",
     "eslint-plugin-sf-plugin": "^1.18.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.4.5"

src/ux/progress.ts

@@ -5,10 +5,14 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import * as util from 'node:util';
-import { ux } from '@oclif/core';
+import util from 'node:util';
+import { Options, SingleBar } from 'cli-progress';
 import { UxBase } from './base.js';
 
+function progress(options: Options = {}): Progress.Bar {
+  return new SingleBar({ noTTYOutput: Boolean(process.env.TERM === 'dumb' || !process.stdin.isTTY), ...options });
+}
+
 /**
  * Class for display a progress bar to the console. Will automatically be suppressed if the --json flag is present.
  */
@@ -50,10 +54,10 @@ export class Progress extends UxBase {
 
     this.maybeNoop(() => {
       const { title, ...rest } = { ...Progress.DEFAULT_OPTIONS, ...options };
-      this.bar = ux.progress({
+      this.bar = progress({
         ...rest,
         format: util.format(rest.format, title),
-      }) as Progress.Bar;
+      });
 
       this.bar.setTotal(total);
       this.bar.start(total, 0);

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,53 @@
+/*
+ * 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';
+import { AnyJson } from '@salesforce/ts-types';
+
+function prettyPrint(obj: AnyJson): string {
+  if (!obj) return inspect(obj);
+  if (typeof obj === 'string') return obj;
+  if (typeof obj === 'number') return obj.toString();
+  if (typeof obj === 'boolean') return obj.toString();
+  if (typeof obj === 'object') {
+    return Object.entries(obj)
+      .map(([key, value]) => `${key}: ${inspect(value)}`)
+      .join(', ');
+  }
+
+  return inspect(obj);
+}
+
+export default function styledObject(obj: AnyJson, keys?: string[]): string {
+  if (!obj) return inspect(obj);
+  if (typeof obj === 'string') return obj;
+  if (typeof obj === 'number') return obj.toString();
+  if (typeof obj === 'boolean') return obj.toString();
+
+  const output: string[] = [];
+  const keyLengths = Object.keys(obj).map((key) => key.toString().length);
+  const maxKeyLength = Math.max(...keyLengths) + 2;
+
+  const logKeyValue = (key: string, value: AnyJson): string =>
+    `${chalk.blue(key)}:` + ' '.repeat(maxKeyLength - key.length - 1) + prettyPrint(value);
+
+  for (const [key, value] of Object.entries(obj)) {
+    if (keys && !keys.includes(key)) continue;
+    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) + prettyPrint(e));
+        }
+      }
+    } else if (value !== null && value !== undefined) {
+      output.push(logKeyValue(key, value));
+    }
+  }
+
+  return output.join('\n');
+}