fix: use ES2022

.github/workflows/automerge.yml

@@ -6,5 +6,5 @@ on:
 
 jobs:
   automerge:
-    uses: oclif/github-workflows/.github/workflows/automerge.yml@main
+    uses: salesforcecli/github-workflows/.github/workflows/automerge.yml@main
     secrets: inherit

.nycrc.json

@@ -0,0 +1,11 @@
+{
+  "check-coverage": true,
+  "lines": 80,
+  "statements": 70,
+  "functions": 70,
+  "branches": 60,
+  "reporter": ["lcov", "text"],
+  "extension": [".ts"],
+  "include": ["**/*.ts"],
+  "exclude": ["**/*.d.ts", "test/**"]
+}

.prettierrc.json

@@ -0,0 +1 @@
+"@oclif/prettier-config"

guides/PRE_CORE_MIGRATION.md

@@ -5,6 +5,7 @@ Migrating to `@oclif/core` from the deprecated oclif libraries (`@oclif/config`,
 
 - [Migrating to @oclif/core from deprecated libraries](#migrating-to-oclifcore-from-deprecated-libraries)
   - [Update Imports](#update-imports)
+  - [Update Command Args](#update-command-args)
   - [Update your bin scripts](#update-your-bin-scripts)
   - [Add `main` to your package.json](#add-main-to-your-packagejson)
   - [Restore `-h`, `-v`, and `version`](#restore--h--v-and-version)
@@ -30,6 +31,50 @@ With this import:
 import {Command, Flags, Topic, Help} from '@oclif/core';
 ```
 
+## Update Command Args
+
+We updated the `Command.args` to more closely resemble flags
+
+**Before**
+
+```typescript
+import { Command } from '@oclif/core'
+
+export default MyCommand extends Command {
+  static args = [{name: arg1, description: 'an argument', required: true}]
+
+  public async run(): Promise<void> {
+    const {args} = await this.parse(MyCommand) // args is useless {[name: string]: any}
+  }
+}
+```
+
+**After**
+
+```typescript
+import { Command, Args } from '@oclif/core'
+
+export default MyCommand extends Command {
+  static args = {
+    arg1: Args.string({description: 'an argument', required: true})
+  }
+
+  public async run(): Promise<void> {
+    const {args} = await this.parse(MyCommand) // args is { arg1: string }
+  }
+}
+```
+
+These are the available Args:
+- string
+- integer
+- boolean
+- url
+- file
+- directory
+- custom
+
+
 ## Update your bin scripts
 
 `@oclif/core` now supports separate bin scripts for production and development.

guides/V3_MIGRATION.md

@@ -5,16 +5,18 @@ Migrating to @oclif/core@V3
   - [BREAKING CHANGES ❗](#breaking-changes-)
     - [Dropping node 14 and node 16 support](#dropping-node-14-and-node-16-support)
     - [Bin Scripts for ESM/CJS Interoperability](#bin-scripts-for-esmcjs-interoperability)
+    - [Dropped `ts-node` as a dependency](#dropped-ts-node-as-a-dependency)
     - [`Config.plugins`](#configplugins)
     - [Readonly properties on `Config`](#readonly-properties-on-config)
     - [Private methods on `Plugin`](#private-methods-on-plugin)
     - [`global['cli-ux']` -\> `global.ux`](#globalcli-ux---globalux)
     - [`handle`](#handle)
     - [`noCacheDefault` flag property replaces `isWritingManifest`](#nocachedefault-flag-property-replaces-iswritingmanifest)
   - [Features 🎉](#features-)
-    - [Cache Flexible taxonomy Command Permutations](#cache-flexible-taxonomy-command-permutations)
+    - [Performance Improvements](#performance-improvements)
     - [charAliases Flag Property](#charaliases-flag-property)
     - [Flags.option](#flagsoption)
+    - [Set spinner styles](#set-spinner-styles)
 
 
 ## BREAKING CHANGES ❗
@@ -36,6 +38,10 @@ In order to support ESM and CommonJS plugin interoperability you will need to up
 
 If you'd like to migrate your plugin to ESM, please read our guide [here](https://oclif.io/docs/esm)
 
+### Dropped `ts-node` as a dependency
+
+We removed `ts-node` as a dependency to reduce the package size. By doing this, it means that linked plugin **must** have `ts-node` as a `devDependency` in order for auto-transpilation to work.
+
 ### `Config.plugins`
 `Config.plugins` is now a `Map` where the keys are the plugin names and the values are the loaded `Plugin` instances. Previously it was an array of loaded `Plugin` instances.
 
@@ -113,9 +119,12 @@ export const mySensitiveFlag = Flags.string({
 
 ## Features 🎉
 
-### Cache Flexible taxonomy Command Permutations
+### Performance Improvements
 
-The command permutations for flexible taxonomy are now cached in the oclif.manifest.json allowing for quicker startup times.
+- Cache command permutations for flexible taxonomy in the `oclif.manifest.json`
+- Cache additional command properties (`isESM`, `relativePath`) in the `oclif.manifest.json`
+- Improved accuracy in the `DEBUG=perf` output.
+- Remove `ts-node` from `dependencies` to reduce the package size.
 
 ### charAliases Flag Property
 
@@ -149,3 +158,15 @@ export default class MyCommand extends Command {
   }
 }
 ```
+
+### Set spinner styles
+
+You can now configure the style of the spinner when using `ux.action.start`. See [spinners](https://github.com/oclif/core/blob/main/src/cli-ux/action/spinners.ts) for all the different options.
+
+```typescript
+ux.action.start('starting spinner', 'spinning', {style: 'arc'})
+await ux.wait(2500)
+ux.action.status = 'still going'
+await ux.wait(2500)
+ux.action.stop()
+```

package.json

@@ -38,7 +38,8 @@
     "@commitlint/config-conventional": "^12.1.4",
     "@oclif/plugin-help": "^5.2.8",
     "@oclif/plugin-plugins": "^3.3.0",
-    "@oclif/test": "^2.4.7",
+    "@oclif/prettier-config": "^0.1.1",
+    "@oclif/test": "^3.0.0-beta.1",
     "@types/ansi-styles": "^3.2.1",
     "@types/benchmark": "^2.1.2",
     "@types/chai": "^4.3.4",
@@ -67,8 +68,10 @@
     "fancy-test": "^3.0.0-beta.2",
     "globby": "^11.1.0",
     "husky": "6",
+    "madge": "^6.1.0",
     "mocha": "^10.2.0",
     "nock": "^13.3.0",
+    "nyc": "^15.1.0",
     "shx": "^0.3.4",
     "sinon": "^11.1.2",
     "tsd": "^0.29.0",
@@ -105,13 +108,14 @@
     "commitlint": "commitlint",
     "compile": "tsc",
     "lint": "eslint . --ext .ts",
-    "posttest": "yarn lint",
+    "posttest": "yarn lint && yarn test:circular-deps",
     "prepack": "yarn run build",
-    "pretest": "yarn build --noEmit && tsc -p test --noEmit --skipLibCheck",
+    "pretest": "yarn build && tsc -p test --noEmit --skipLibCheck",
+    "test:circular-deps": "madge lib/ -c",
     "test:e2e": "mocha --forbid-only \"test/**/*.e2e.ts\" --parallel --timeout 1200000",
     "test:esm-cjs": "cross-env DEBUG=e2e:* ts-node test/integration/esm-cjs.ts",
     "test:perf": "ts-node test/perf/parser.perf.ts",
-    "test": "mocha --forbid-only \"test/**/*.test.ts\""
+    "test": "nyc mocha --forbid-only \"test/**/*.test.ts\""
   },
   "types": "lib/index.d.ts"
 }

src/cli-ux/action/spinner.ts

@@ -64,7 +64,7 @@ export default class SpinnerAction extends ActionBase {
   }
 
   private getFrames(opts?: Options) {
-    if (opts?.style) return spinners[process.platform === 'win32' ? 'line' : opts.style].frames
+    if (opts?.style) return spinners[opts.style].frames
 
     return spinners[process.platform === 'win32' ? 'line' : 'dots2'].frames
   }

src/cli-ux/flush.ts

@@ -1,4 +1,5 @@
-import {Errors, stdout} from '..'
+import {error} from '../errors'
+import {stdout} from './stream'
 
 function timeout(p: Promise<any>, ms: number) {
   function wait(ms: number, unref = false) {
@@ -8,7 +9,7 @@ function timeout(p: Promise<any>, ms: number) {
     })
   }
 
-  return Promise.race([p, wait(ms, true).then(() => Errors.error('timed out'))])
+  return Promise.race([p, wait(ms, true).then(() => error('timed out'))])
 }
 
 async function _flush() {

src/cli-ux/styled/json.ts

@@ -1,15 +1,17 @@
 import chalk from 'chalk'
+import {format} from 'node:util'
+import {stdout} from '../stream'
 
-import {ux} from '../../index'
+const info = (output: string) => stdout.write(format(output) + '\n')
 
 export default function styledJSON(obj: unknown): void {
   const json = JSON.stringify(obj, null, 2)
   if (!chalk.level) {
-    ux.info(json)
+    info(json)
     return
   }
 
   const cardinal = require('cardinal')
   const theme = require('cardinal/themes/jq')
-  ux.info(cardinal.highlight(json, {json: true, theme}))
+  info(cardinal.highlight(json, {json: true, theme}))
 }

src/command.ts

@@ -25,7 +25,7 @@ import {LoadOptions} from './interfaces/config'
 import {PJSON} from './interfaces'
 import {Plugin} from './interfaces/plugin'
 import {PrettyPrintableError} from './errors'
-import {boolean} from './flags'
+import {aggregateFlags} from './util/aggregate-flags'
 import chalk from 'chalk'
 import {fileURLToPath} from 'node:url'
 import {ux} from './cli-ux'
@@ -42,13 +42,6 @@ stdout.on('error', (err: any) => {
   throw err
 })
 
-const jsonFlag = {
-  json: boolean({
-    description: 'Format output as json.',
-    helpGroup: 'GLOBAL',
-  }),
-}
-
 /**
  * An abstract class which acts as the base for each command
  * in your project.
@@ -126,37 +119,7 @@ export abstract class Command {
 
   public static hasDynamicHelp = false
 
-  protected static '_--' = false
-
-  protected static _enableJsonFlag = false
-
-  public static get enableJsonFlag(): boolean {
-    return this._enableJsonFlag
-  }
-
-  public static set enableJsonFlag(value: boolean) {
-    this._enableJsonFlag = value
-    if (value === true) {
-      this.baseFlags = jsonFlag
-    } else {
-      delete this.baseFlags?.json
-      this.flags = {} // force the flags setter to run
-      delete this.flags?.json
-    }
-  }
-
-  public static get '--'(): boolean {
-    return Command['_--']
-  }
-
-  public static set '--'(value: boolean) {
-    Command['_--'] = value
-  }
-
-  public get passThroughEnabled(): boolean {
-    return Command['_--']
-  }
-
+  public static enableJsonFlag = false
   /**
    * instantiate and run the command
    *
@@ -184,29 +147,10 @@ export abstract class Command {
     return cmd._run<ReturnType<T['run']>>()
   }
 
-  protected static _baseFlags: FlagInput
-
-  static get baseFlags(): FlagInput {
-    return this._baseFlags
-  }
-
-  static set baseFlags(flags: FlagInput) {
-    // eslint-disable-next-line prefer-object-spread
-    this._baseFlags = Object.assign({}, this.baseFlags, flags)
-    this.flags = {} // force the flags setter to run
-  }
+  public static baseFlags: FlagInput
 
   /** A hash of flags for the command */
-  protected static _flags: FlagInput
-
-  public static get flags(): FlagInput {
-    return this._flags
-  }
-
-  public static set flags(flags: FlagInput) {
-    // eslint-disable-next-line prefer-object-spread
-    this._flags = Object.assign({}, this._flags ?? {}, this.baseFlags, flags)
-  }
+  public static flags: FlagInput
 
   public id: string | undefined
 
@@ -284,16 +228,19 @@ export abstract class Command {
    * @returns {boolean} true if the command supports json and the --json flag is present
    */
   public jsonEnabled(): boolean {
-    // if the command doesn't support json, return false
+    // If the command doesn't support json, return false
     if (!this.ctor.enableJsonFlag) return false
-    // if the command parameter pass through is enabled, return true if the --json flag is before the '--' separator
-    if (this.passThroughEnabled) {
-      const ptIndex = this.argv.indexOf('--')
-      const jsonIndex = this.argv.indexOf('--json')
-      return jsonIndex > -1 && (ptIndex === -1 || jsonIndex < ptIndex)
-    }
 
-    return this.argv.includes('--json') || this.config.scopedEnvVar?.('CONTENT_TYPE')?.toLowerCase() === 'json'
+    // If the CONTENT_TYPE env var is set to json, return true
+    if (this.config.scopedEnvVar?.('CONTENT_TYPE')?.toLowerCase() === 'json') return true
+
+    const passThroughIndex = this.argv.indexOf('--')
+    const jsonIndex = this.argv.indexOf('--json')
+    return passThroughIndex === -1
+      // If '--' is not present, then check for `--json` in this.argv
+      ? jsonIndex > -1
+      // If '--' is present, return true only the --json flag exists and is before the '--'
+      : jsonIndex > -1 && jsonIndex < passThroughIndex
   }
 
   /**
@@ -312,8 +259,13 @@ export abstract class Command {
   }
 
   protected warnIfFlagDeprecated(flags: Record<string, unknown>): void {
+    const allFlags = aggregateFlags(
+      this.ctor.flags,
+      this.ctor.baseFlags,
+      this.ctor.enableJsonFlag,
+    )
     for (const flag of Object.keys(flags)) {
-      const flagDef = this.ctor.flags[flag]
+      const flagDef = allFlags[flag]
       const deprecated = flagDef?.deprecated
       if (deprecated) {
         this.warn(formatFlagDeprecationWarning(flag, deprecated))
@@ -352,12 +304,22 @@ export abstract class Command {
     }
   }
 
-  protected async parse<F extends FlagOutput, B extends FlagOutput, A extends ArgOutput>(options?: Input<F, B, A>, argv = this.argv): Promise<ParserOutput<F, B, A>> {
+  protected async parse<F extends FlagOutput, B extends FlagOutput, A extends ArgOutput>(
+    options?: Input<F, B, A>,
+    argv = this.argv,
+  ): Promise<ParserOutput<F, B, A>> {
     if (!options) options = this.ctor as Input<F, B, A>
-    const opts = {context: this, ...options}
-    // the spread operator doesn't work with getters so we have to manually add it here
-    opts.flags = options?.flags
-    opts.args = options?.args
+
+    const opts = {
+      context: this,
+      ...options,
+      flags: aggregateFlags<F, B>(
+        options.flags,
+        options.baseFlags,
+        options.enableJsonFlag,
+      ),
+    }
+
     const results = await Parser.parse<F, B, A>(argv, opts)
     this.warnIfFlagDeprecated(results.flags ?? {})