refactor!: upgrade to oclif/core (#132)

* Upgrade to oclif/core

* Fix test, update packages

* Fix linting

* Fix bin/run

* Fix a bug in displaying diff need to await promise

* Fix bug by awaiting promise

* Update jsdiff

* Remove manifest testing file

Author: eablack

.eslintrc

@@ -11,10 +11,13 @@
     }
   },
   "rules": {
+    "@typescript-eslint/no-explicit-any": "off",
     "camelcase":"off",
+    "import/namespace": "off",
     "indent": ["error", 2, {"MemberExpression": 1}],
-    "node/no-deprecated-api": "warn",
     "node/no-missing-import": "off",
+    "n/shebang": "warn",
+    "perfectionist/sort-objects": "warn",
     "unicorn/no-array-for-each": "off",
     "unicorn/no-useless-undefined": "warn",
     "unicorn/prefer-node-protocol": "warn",

.tool-versions

@@ -1 +1 @@
-nodejs 16.20.2
+nodejs 20.18.1

bin/run

@@ -1,4 +1,7 @@
 #!/usr/bin/env node
 
-require('@oclif/command').run()
-.catch(require('@oclif/errors/handle'))
+const oclif = require('@oclif/core')
+
+oclif.run()
+  .then(require('@oclif/core/flush'))
+  .catch(async error => require('@oclif/core/handle')(error))

package.json

@@ -6,51 +6,43 @@
   "bugs": "https://github.com/heroku/heroku-cli-addons-admin/issues",
   "dependencies": {
     "@heroku-cli/color": "^2.0.4",
-    "@heroku-cli/command": "^8.5.0",
-    "@heroku-cli/schema": "^1.0.3",
-    "@oclif/command": "^1.8.36",
-    "@oclif/config": "^1.18.17",
-    "@oclif/plugin-help": "^3.3.1",
-    "cli-ux": "^6.0.9",
-    "diff": "^3.5.0",
+    "@heroku-cli/command": "^11.4.0",
+    "@heroku/http-call": "5.4.0",
+    "@heroku-cli/schema": "^1.0.25",
+    "@oclif/core": "^2.16.0",
+    "diff": "^5.2.0",
     "fs-extra": "^9.1.0",
-    "http-call": "5.3.0",
     "inquirer": "^8.2.6",
-    "jsdiff": "^1.1.1",
     "lodash": "^4.17.21",
-    "randomstring": "^1.3.0",
-    "tslib": "2.6.3"
+    "open": "^8.4.2",
+    "randomstring": "^1.3.1",
+    "tslib": "2.8.1"
   },
   "devDependencies": {
-    "@heroku-cli/dev-cli": "^1.26.13",
+    "@oclif/plugin-help": "^5",
     "@oclif/test": "^2.5.6",
     "@types/chai": "^4",
-    "@types/diff": "^3.5.1",
-    "@types/execa": "^0.9.0",
+    "@types/diff": "^5.2.1",
     "@types/fs-extra": "^9.0.13",
-    "@types/glob": "8.1.0",
     "@types/inquirer": "^8.2.10",
-    "@types/mocha": "^10.0.7",
-    "@types/nock": "^9.3.0",
+    "@types/mocha": "^10.0.10",
     "@types/node": "^22.8.7",
     "@types/randomstring": "^1.3.0",
-    "@types/supports-color": "^5.3.0",
-    "@types/write-json-file": "^2.2.1",
+    "@types/supports-color": "^8.1.3",
     "chai": "^4",
-    "eslint": "^7",
-    "eslint-config-oclif": "^4.0.0",
-    "eslint-config-oclif-typescript": "^1.0.2",
-    "globby": "^10",
+    "eslint": "^8.57.0",
+    "eslint-config-oclif": "^5.0.0",
+    "eslint-config-oclif-typescript": "^3.0.26",
     "mocha": "^10.7.3",
-    "nock": "^13.5.4",
+    "nock": "^13.5.6",
     "nyc": "^17.1.0",
     "sinon": "^18.0.0",
     "ts-node": "^10.9.2",
     "tsheredoc": "^1.0.1",
     "typescript": "4.9.5"
   },
   "engines": {
-    "node": ">= 16.0"
+    "node": ">= 20.0"
   },
   "files": [
     "/lib",
@@ -82,11 +74,13 @@
   },
   "repository": "heroku/heroku-cli-addons-admin",
   "scripts": {
+    "build": "rm -rf lib && tsc",
     "clean:branch": "./bin/clean-branch.sh",
     "lint": "eslint . --ext .ts --config .eslintrc",
     "postpack": "rm -f oclif.manifest.json",
     "posttest": "tsc -p test --noEmit",
-    "prepack": "rm -rf lib && tsc && oclif-dev manifest && oclif-dev readme",
+    "prepack": "yarn build && oclif-dev manifest && oclif-dev readme",
+    "pretest": "yarn build",
     "test": "nyc mocha --forbid-only \"test/**/*.test.ts\"",
     "version": "oclif-dev readme && git add README.md"
   }

src/addon-client.ts

@@ -1,24 +1,24 @@
+import {HTTPError} from '@heroku/http-call'
 import {APIClient} from '@heroku-cli/command'
-import cli from 'cli-ux'
-import * as url from 'url'
-import {HTTPError} from 'http-call'
+import {ux} from '@oclif/core'
+import {URL} from 'node:url'
 
 export default class AddonClient {
   private readonly client: APIClient
 
   private readonly options: any = {
     headers: {
+      Accept: 'application/json',
       'Content-Type': 'application/json',
       'User-Agent': 'kensa future',
-      Accept: 'application/json',
     },
   }
 
   constructor(config: any) {
     const client = new APIClient(config, {})
     const host = process.env.HEROKU_ADDONS_HOST
     const herokuHost = process.env.HEROKU_HOST || 'heroku.com'
-    client.defaults.host = host ? url.parse(host).host : `addons.${herokuHost}`
+    client.defaults.host = host ? new URL(host).host : `addons.${herokuHost}`
 
     this.client = client
   }
@@ -27,7 +27,7 @@ export default class AddonClient {
     const response = await this.client.get(path, this.options).catch((error: HTTPError) => {
       const errorBody = error?.body?.error
       if (errorBody) {
-        cli.error(errorBody)
+        ux.error(errorBody)
       }
 
       throw error
@@ -43,12 +43,12 @@ export default class AddonClient {
     const response = await this.client.post(path, opts).catch((error: HTTPError) => {
       const baseErrors = error?.body?.error?.base
       if (baseErrors) {
-        cli.error(baseErrors.join(', '))
+        ux.error(baseErrors.join(', '))
       }
 
       const errorBody = error?.body?.error
       if (errorBody) {
-        cli.error(errorBody)
+        ux.error(errorBody)
       }
 
       throw error

src/addon.ts

@@ -1,74 +1,73 @@
-import cli from 'cli-ux'
-
+import {HTTPError} from '@heroku/http-call'
 import color from '@heroku-cli/color'
-import {IConfig} from '@oclif/config'
-import {HTTPError} from 'http-call'
+import {ux} from '@oclif/core'
+import {Config} from '@oclif/core'
 
 import AddonClient from './addon-client'
 import {ManifestInterface, ManifestLocal, ManifestRemote} from './manifest'
 
 export default class Addon {
   readonly argsSlug?: string
+  private readonly _client: AddonClient
   private readonly _local: ManifestLocal
   private readonly _remote: ManifestRemote
-  private readonly _client: AddonClient
 
-  constructor(config: IConfig, argsSlug?: string) {
+  constructor(config: Config, argsSlug?: string) {
     this.argsSlug = argsSlug
     this._local = new ManifestLocal()
     this._remote = new ManifestRemote(this)
 
     this._client = new AddonClient(config)
   }
 
-  local(): ManifestLocal {
-    return this._local
+  client(): AddonClient {
+    return this._client
   }
 
-  remote(): ManifestRemote {
-    return this._remote
+  local(): ManifestLocal {
+    return this._local
   }
 
-  async slug(): Promise<string> {
-    // allows users to pull without declaring slug
-    if (this.argsSlug) {
-      return this.argsSlug
-    }
-
-    const manifest = await this.local().get()
-    if (!manifest.id) {
-      cli.error('No slug found in manifest')
-    }
+  async manifest(uuid: string): Promise<ManifestInterface> {
+    const slug = await this.slug()
+    ux.action.start(`Fetching add-on manifest for ${color.addon(slug)}`)
+    const body = await this._client.get(`/api/v3/addons/${encodeURIComponent(slug)}/manifests/${encodeURIComponent(uuid)}`)
+    ux.action.stop()
 
-    return manifest.id
+    return body.contents
   }
 
   async manifests(): Promise<ManifestInterface[]> {
     const slug = await this.slug()
-    cli.action.start(`Fetching add-on manifests for ${color.addon(slug)}`)
+    ux.action.start(`Fetching add-on manifests for ${color.addon(slug)}`)
     const body = await this._client.get(`/api/v3/addons/${encodeURIComponent(slug)}/manifests`).catch((error: HTTPError) => {
       const errorBody = error?.body?.error
       if (errorBody) {
-        cli.error(errorBody)
+        ux.error(errorBody)
       }
 
       throw error
     })
 
-    cli.action.stop()
+    ux.action.stop()
     return body
   }
 
-  async manifest(uuid: string): Promise<ManifestInterface> {
-    const slug = await this.slug()
-    cli.action.start(`Fetching add-on manifest for ${color.addon(slug)}`)
-    const body = await this._client.get(`/api/v3/addons/${encodeURIComponent(slug)}/manifests/${encodeURIComponent(uuid)}`)
-    cli.action.stop()
-
-    return body.contents
+  remote(): ManifestRemote {
+    return this._remote
   }
 
-  client(): AddonClient {
-    return this._client
+  async slug(): Promise<string> {
+    // allows users to pull without declaring slug
+    if (this.argsSlug) {
+      return this.argsSlug
+    }
+
+    const manifest = await this.local().get()
+    if (!manifest.id) {
+      ux.error('No slug found in manifest')
+    }
+
+    return manifest.id
   }
 }

src/commands/addons/admin/manifest/diff.ts

@@ -8,19 +8,17 @@ export default class Diff extends Command {
   static description = 'compares remote manifest to local manifest and finds differences'
 
   async run() {
-    this.parse(Diff)
-
     const addon = new Addon(this.config)
 
     // reading current manifest
     const body = await addon.remote().get()
 
     const fetchedManifest = JSON.stringify(body, null, 2)
-    const localManifest = JSON.stringify(addon.local().get(), null, 2)
-
-    const diff = diffLines(fetchedManifest, localManifest, {newlineIsToken: true, ignoreCase: true})
+    const localManifest = await addon.local().get()
+    const localManifestString = JSON.stringify(localManifest, null, 2)
+    const diff = diffLines(fetchedManifest, localManifestString, {ignoreCase: true, newlineIsToken: true})
     diff.forEach((substr: any) => {
-      let outputColor: 'white' | 'green' | 'red' = 'white'
+      let outputColor: 'green' | 'red' | 'white' = 'white'
       if (substr.added) {
         outputColor = 'green' // this is supposed to be a bold green (chalk.green.bold)
       } else if (substr.removed) {