fix: fix lint issues

package.json

@@ -47,6 +47,9 @@
     "@types/wordwrap": "^1.0.3",
     "@typescript-eslint/eslint-plugin": "^7.18.0",
     "eslint": "^8.57.0",
+    "eslint-config-oclif": "^5.2.1",
+    "eslint-config-oclif-typescript": "^3.1.9",
+    "eslint-config-prettier": "^9.1.0",
     "jest": "^29.7.0",
     "oclif": "^4.14.22",
     "semantic-release": "^24.1.0",

src/action/base.ts

@@ -1,7 +1,10 @@
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
+/* eslint-disable @typescript-eslint/non-nullable-type-assertion-style */
+/* eslint-disable @typescript-eslint/unbound-method */
 import { inspect } from 'node:util'
 
 import { castArray } from '../util'
-import { Options } from './types'
+import type { Options } from './types'
 
 export interface ITask {
   action: string
@@ -15,7 +18,7 @@ export type ActionType = 'debug' | 'simple' | 'spinner'
 export class ActionBase {
   std: 'stderr' | 'stdout' = 'stderr'
 
-  protected stdmocks?: ['stderr' | 'stdout', string[]][]
+  protected stdmocks?: Array<['stderr' | 'stdout', string[]]>
 
   type!: ActionType
 
@@ -62,9 +65,9 @@ export class ActionBase {
     this.globals.action.task = task
   }
 
-  public pause(fn: () => any, icon?: string): Promise<any> {
+  public async pause(fn: () => any, icon?: string): Promise<any> {
     const { task } = this
-    const active = task && task.active
+    const active = task?.active
     if (task && active) {
       this._pause(icon)
       this._stdout(false)
@@ -81,7 +84,7 @@ export class ActionBase {
 
   public async pauseAsync<T>(fn: () => Promise<T>, icon?: string): Promise<T> {
     const { task } = this
-    const active = task && task.active
+    const active = task?.active
     if (task && active) {
       this._pause(icon)
       this._stdout(false)
@@ -98,7 +101,7 @@ export class ActionBase {
 
   public start(action: string, status?: string, opts: Options = {}): void {
     this.std = opts.stdout ? 'stdout' : 'stderr'
-    const task = { action, active: Boolean(this.task && this.task.active), status }
+    const task = { action, active: Boolean(this.task?.active), status }
     this.task = task
 
     this._start(opts)

src/action/simple.ts

@@ -1,9 +1,9 @@
-import { ActionBase, ActionType } from './base'
+import { ActionBase, type ActionType } from './base'
 
 export default class SimpleAction extends ActionBase {
   public type: ActionType = 'simple'
 
-  private _flush() {
+  private _flush(): void {
     this._write(this.std, '\n')
     this._flushStdout()
   }
@@ -13,7 +13,7 @@ export default class SimpleAction extends ActionBase {
     else this._flush()
   }
 
-  private _render(action: string, status?: string) {
+  private _render(action: string, status?: string): void {
     if (!this.task) return
     if (this.task.active) this._flush()
     this._write(this.std, status ? `${action}... ${status}` : `${action}...`)

src/action/spinner.ts

@@ -1,12 +1,13 @@
+/* eslint-disable @typescript-eslint/no-unsafe-argument */
 import ansiStyles from 'ansi-styles'
 import chalk from 'chalk'
 import stripAnsi from 'strip-ansi'
 import * as supportsColor from 'supports-color'
 
 import { errtermwidth } from '../screen'
-import { ActionBase, ActionType } from './base'
+import { ActionBase, type ActionType } from './base'
 import spinners from './spinners'
-import { Options } from './types'
+import type { Options } from './types'
 
 const ansiEscapes = require('ansi-escapes')
 
@@ -48,7 +49,7 @@ export default class SpinnerAction extends ActionBase {
     this.output = undefined
   }
 
-  private _render(icon?: string) {
+  private _render(icon?: string): void {
     if (!this.task) return
     this._reset()
     this._flushStdout()
@@ -59,7 +60,7 @@ export default class SpinnerAction extends ActionBase {
     this._write(this.std, this.output)
   }
 
-  private _reset() {
+  private _reset(): void {
     if (!this.output) return
     const lines = this._lines(this.output)
     this._write(this.std, ansiEscapes.cursorLeft + ansiEscapes.cursorUp(lines) + ansiEscapes.eraseDown)
@@ -73,7 +74,7 @@ export default class SpinnerAction extends ActionBase {
     if (this.spinner) clearInterval(this.spinner)
     this._render()
     this.spinner = setInterval(
-      (icon) => this._render.bind(this)(icon),
+      (icon) => { this._render.bind(this)(icon); },
       process.platform === 'win32' ? 500 : 100,
       'spinner',
     )
@@ -88,7 +89,7 @@ export default class SpinnerAction extends ActionBase {
     this.output = undefined
   }
 
-  private getFrames(opts?: Options) {
+  private getFrames(opts?: Options): string[] {
     if (opts?.style) return spinners[opts.style].frames
 
     return spinners[process.platform === 'win32' ? 'line' : 'dots2'].frames

src/action/types.ts

@@ -1,4 +1,4 @@
-import spinners from './spinners'
+import type spinners from './spinners'
 
 export type Options = {
   stdout?: boolean

src/config.ts

@@ -1,5 +1,5 @@
 import Cache from '@oclif/core/lib/cache'
-import { ActionBase } from './action/base'
+import type { ActionBase } from './action/base'
 import simple from './action/simple'
 import spinner from './action/spinner'
 
@@ -17,6 +17,7 @@ const globals = g.ux || (g.ux = {})
 const actionType =
   (Boolean(process.stderr.isTTY) &&
     !process.env.CI &&
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
     !['dumb', 'emacs-color'].includes(process.env.TERM!) &&
     'spinner') ||
   'simple'
@@ -50,7 +51,7 @@ export class Config {
   }
 }
 
-function fetch() {
+function fetch(): any {
   const core = Cache.getInstance().get('@oclif/core')
   const major = core?.version.split('.')[0] || 'unknown'
   if (globals[major]) return globals[major]

src/flush.ts

@@ -1,20 +1,20 @@
 import { error } from "@oclif/core/lib/errors"
 
 
-function timeout(p: Promise<any>, ms: number) {
-  function wait(ms: number, unref = false) {
+async function timeout(p: Promise<any>, ms: number): Promise<any> {
+  async function wait(ms: number, unref = false): Promise<any> {
     return new Promise((resolve) => {
-      const t: any = setTimeout(() => resolve(null), ms)
+      const t: any = setTimeout(() => { resolve(null); }, ms)
       if (unref) t.unref()
     })
   }
 
   return Promise.race([p, wait(ms, true).then(() => error('timed out'))])
 }
 
-async function _flush() {
+async function _flush(): Promise<any> {
   const p = new Promise((resolve) => {
-    process.stdout.once('drain', () => resolve(null))
+    process.stdout.once('drain', () => { resolve(null); })
   })
   const flushed = process.stdout.write('')
 

src/index.ts

@@ -1,7 +1,9 @@
+/* eslint-disable @typescript-eslint/unbound-method */
+/* eslint-disable @typescript-eslint/no-unsafe-argument */
 import chalk from 'chalk'
 import { format as utilFormat } from 'node:util'
 
-import { ActionBase } from './action/base'
+import type { ActionBase } from './action/base'
 import { config } from './config'
 import { flush as _flush } from './flush'
 import * as uxPrompt from './prompt'
@@ -11,6 +13,7 @@ import write from './write'
 import { Errors } from '@oclif/core'
 const hyperlinker = require('hyperlinker')
 
+// eslint-disable-next-line @typescript-eslint/no-extraneous-class
 export class ux {
   public static config = config
 
@@ -172,7 +175,7 @@ export {
   warn
 }
 
-const uxProcessExitHandler = async () => {
+const uxProcessExitHandler = async (): Promise<void> => {
   try {
     await ux.done()
   } catch (error) {
@@ -185,13 +188,14 @@ const uxProcessExitHandler = async () => {
 // only attach named listener once
 const uxListener = process.listeners('exit').find((fn) => fn.name === uxProcessExitHandler.name)
 if (!uxListener) {
+  // eslint-disable-next-line @typescript-eslint/no-misused-promises
   process.once('exit', uxProcessExitHandler)
 }
 
 export { ActionBase } from './action/base'
 export { Config, config } from './config'
 export { ExitError } from './exit'
-export { IPromptOptions } from './prompt'
+export type { IPromptOptions } from './prompt'
 export { Table } from './styled'
 
 export { colorize } from './theme'

src/prompt.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/unbound-method */
 import chalk from 'chalk'
 
 import { config } from './config'
@@ -25,7 +26,7 @@ interface IPromptConfig {
   type: 'hide' | 'mask' | 'normal' | 'single'
 }
 
-function normal(options: IPromptConfig, retries = 100): Promise<string> {
+async function normal(options: IPromptConfig, retries = 100): Promise<string> {
   if (retries < 0) throw new Error('no input')
   return new Promise((resolve, reject) => {
     let timer: NodeJS.Timeout
@@ -47,13 +48,14 @@ function normal(options: IPromptConfig, retries = 100): Promise<string> {
       if (!options.default && options.required && data === '') {
         resolve(normal(options, retries - 1))
       } else {
+        // eslint-disable-next-line @typescript-eslint/non-nullable-type-assertion-style
         resolve(data || (options.default as string))
       }
     })
   })
 }
 
-function getPrompt(name: string, type?: string, defaultValue?: string) {
+function getPrompt(name: string, type?: string, defaultValue?: string): string {
   let prompt = '> '
 
   if (defaultValue && type === 'hide') {
@@ -75,7 +77,7 @@ async function single(options: IPromptConfig): Promise<string> {
   return response
 }
 
-function replacePrompt(prompt: string) {
+function replacePrompt(prompt: string): void {
   const ansiEscapes = require('ansi-escapes')
   process.stderr.write(
     ansiEscapes.cursorHide +
@@ -142,15 +144,15 @@ async function _prompt(name: string, inputOptions: Partial<IPromptOptions> = {})
  * @returns Promise<string>
  */
 export async function prompt(name: string, options: IPromptOptions = {}): Promise<string> {
-  return config.action.pauseAsync(() => _prompt(name, options), chalk.cyan('?'))
+  return config.action.pauseAsync(async () => _prompt(name, options), chalk.cyan('?'))
 }
 
 /**
  * confirmation prompt (yes/no)
  * @param message - confirmation text
  * @returns Promise<boolean>
  */
-export function confirm(message: string): Promise<boolean> {
+export async function confirm(message: string): Promise<boolean> {
   return config.action.pauseAsync(async () => {
     const confirm = async (): Promise<boolean> => {
       const raw = await _prompt(message)

src/screen.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
 
 function termwidth(stream: any): number {
   if (!stream.isTTY) {

src/stream.ts

@@ -9,19 +9,20 @@ class Stream {
   }
 
   public emit(event: string, ...args: any[]): boolean {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
     return process[this.channel].emit(event, ...args)
   }
 
   public getWindowSize(): number[] {
     return process[this.channel].getWindowSize()
   }
 
-  public on(event: string, listener: (...args: any[]) => void): Stream {
+  public on(event: string, listener: (...args: any[]) => void): this {
     process[this.channel].on(event, listener)
     return this
   }
 
-  public once(event: string, listener: (...args: any[]) => void): Stream {
+  public once(event: string, listener: (...args: any[]) => void): this {
     process[this.channel].once(event, listener)
     return this
   }

src/styled/object.ts

@@ -4,12 +4,12 @@ import { inspect } from 'node:util'
 
 export default function styledObject(obj: any, keys?: string[]): string {
   const output: string[] = []
-  const keyLengths = Object.keys(obj).map((key) => key.toString().length)
+  const keyLengths = Object.keys(obj as object).map((key) => key.toString().length)
   const maxKeyLength = Math.max(...keyLengths) + 2
-  function pp(obj: any) {
+  function pp(obj: any): any {
     if (typeof obj === 'string' || typeof obj === 'number') return obj
     if (typeof obj === 'object') {
-      return Object.keys(obj)
+      return Object.keys(obj as object)
         .map((k) => k + ': ' + inspect(obj[k]))
         .join(', ')
     }
@@ -20,7 +20,7 @@ export default function styledObject(obj: any, keys?: string[]): string {
   const logKeyValue = (key: string, value: any): string =>
     `${chalk.blue(key)}:` + ' '.repeat(maxKeyLength - key.length - 1) + pp(value)
 
-  for (const key of keys || Object.keys(obj).sort()) {
+  for (const key of keys || Object.keys(obj as object).sort()) {
     const value = obj[key]
     if (Array.isArray(value)) {
       if (value.length > 0) {

src/styled/progress.ts

@@ -1,5 +1,5 @@
 // 3pp
-import { Options, SingleBar } from 'cli-progress'
+import { type Options, SingleBar } from 'cli-progress'
 
 
 export default function progress(options: Options = {}): SingleBar {