chore(deps): use typescript 4+ (#254)

Author: RasPhilCo

.eslintrc

@@ -5,6 +5,17 @@
   ],
   "rules": {
     "unicorn/no-abusive-eslint-disable": "off",
-    "@typescript-eslint/no-empty-function": "off"
+    "unicorn/prefer-spread": "off",
+    "unicorn/prefer-module": "off",
+    "unicorn/prefer-node-protocol": "off",
+    "unicorn/import-style": "off",
+    "unicorn/consistent-function-scoping": "off",
+    "unicorn/no-array-reduce": "off",
+    "unicorn/prefer-array-some": "off",
+    "node/no-missing-import": "off",
+    "@typescript-eslint/no-empty-function": "off",
+    "@typescript-eslint/ban-ts-ignore": "off",
+    "@typescript-eslint/ban-ts-comment": "off",
+    "@typescript-eslint/explicit-module-boundary-types": "off"
   }
 }

package.json

@@ -50,8 +50,8 @@
     "chai-as-promised": "^7.1.1",
     "commitlint": "^12.1.1",
     "eslint": "^7.3.1",
-    "eslint-config-oclif": "^3.1.0",
-    "eslint-config-oclif-typescript": "^0.2.0",
+    "eslint-config-oclif": "^4.0.0",
+    "eslint-config-oclif-typescript": "^1.0.2",
     "fancy-test": "^1.4.3",
     "globby": "^11.0.1",
     "husky": "6",
@@ -62,7 +62,7 @@
     "shx": "^0.3.3",
     "sinon": "^11.1.1",
     "ts-node": "^9.0.0",
-    "typescript": "3.8.3"
+    "typescript": "4.4.3"
   },
   "engines": {
     "node": ">=12.0.0"

src/command.ts

@@ -107,6 +107,7 @@ export default abstract class Command {
       opts = fileURLToPath(opts)
     }
 
+    // to-do: update in node-14 to module.main
     const config = await Config.load(opts || (module.parent && module.parent.parent && module.parent.parent.filename) || __dirname)
     const cmd = new this(argv, config)
     return cmd._run(argv)
@@ -134,7 +135,7 @@ export default abstract class Command {
 
   protected debug: (...args: any[]) => void
 
-  constructor(public argv: string[], public config: Interfaces.Config) {
+  constructor(public argv: string[], public config: Config) {
     this.id = this.ctor.id
     try {
       this.debug = require('debug')(this.id ? `${this.config.bin}:${this.id}` : this.config.bin)
@@ -155,7 +156,7 @@ export default abstract class Command {
       delete process.env[this.config.scopedEnvVarKey('REDIRECTED')]
       await this.init()
       result = await this.run()
-    } catch (error) {
+    } catch (error: any) {
       err = error
       await this.catch(error)
     } finally {
@@ -165,26 +166,27 @@ export default abstract class Command {
     if (result && this.jsonEnabled()) {
       cli.styledJSON(this.toSuccessJson(result))
     }
+
     return result
   }
 
-  exit(code = 0) {
+  exit(code = 0): void {
     return Errors.exit(code)
   }
 
-  warn(input: string | Error) {
+  warn(input: string | Error): void {
     Errors.warn(input)
   }
 
   error(input: string | Error, options: {code?: string; exit: false} & PrettyPrintableError): void
 
   error(input: string | Error, options?: {code?: string; exit?: number} & PrettyPrintableError): never
 
-  error(input: string | Error, options: {code?: string; exit?: number | false} & PrettyPrintableError = {}) {
+  error(input: string | Error, options: {code?: string; exit?: number | false} & PrettyPrintableError = {}): void {
     return Errors.error(input, options as any)
   }
 
-  log(message = '', ...args: any[]) {
+  log(message = '', ...args: any[]): void {
     if (!this.jsonEnabled()) {
       // tslint:disable-next-line strict-type-predicates
       message = typeof message === 'string' ? message : inspect(message)
@@ -222,17 +224,18 @@ export default abstract class Command {
     return Parser.parse(argv, opts)
   }
 
-  protected async catch(err: any): Promise<any> {
+  protected async catch(err: Record<string, any>): Promise<any> {
     process.exitCode = process.exitCode ?? err.exitCode ?? 1
     if (this.jsonEnabled()) {
       cli.styledJSON(this.toErrorJson(err))
     } else {
       if (!err.message) throw err
       try {
         const {cli} = require('cli-ux')
-        const chalk = require('chalk') // eslint-disable-line node/no-extraneous-require
+        const chalk = require('chalk')
         cli.action.stop(chalk.bold.red('!'))
       } catch {}
+
       throw err
     }
   }
@@ -242,16 +245,16 @@ export default abstract class Command {
       const config = Errors.config
       if (config.errorLogger) await config.errorLogger.flush()
       // tslint:disable-next-line no-console
-    } catch (error) {
+    } catch (error: any) {
       console.error(error)
     }
   }
 
-  protected toSuccessJson(result: any): any {
+  protected toSuccessJson(result: unknown): any {
     return result
   }
 
-  protected toErrorJson(err: any): any {
+  protected toErrorJson(err: unknown): any {
     return {error: err}
   }
 }

src/config/config.ts

@@ -90,8 +90,7 @@ export class Config implements IConfig {
   private _topics?: Topic[]
 
   // eslint-disable-next-line no-useless-constructor
-  constructor(public options: Options) {
-  }
+  constructor(public options: Options) {}
 
   static async load(opts: LoadOptions = (module.parent && module.parent.parent && module.parent.parent.filename) || __dirname) {
     // Handle the case when a file URL string is passed in such as 'import.meta.url'; covert to file path.
@@ -181,7 +180,7 @@ export class Config implements IConfig {
     try {
       const devPlugins = this.pjson.oclif.devPlugins
       if (devPlugins) await this.loadPlugins(this.root, 'dev', devPlugins)
-    } catch (error) {
+    } catch (error: any) {
       process.emitWarning(error)
     }
   }
@@ -197,7 +196,7 @@ export class Config implements IConfig {
         if (!pjson.oclif.plugins) pjson.oclif.plugins = []
         await this.loadPlugins(userPJSONPath, 'user', pjson.oclif.plugins.filter((p: any) => p.type === 'user'))
         await this.loadPlugins(userPJSONPath, 'link', pjson.oclif.plugins.filter((p: any) => p.type === 'link'))
-      } catch (error) {
+      } catch (error: any) {
         if (error.code !== 'ENOENT') process.emitWarning(error)
       }
     }
@@ -263,7 +262,7 @@ export class Config implements IConfig {
           final.successes.push({plugin: p, result})
 
           debug('done')
-        } catch (error) {
+        } catch (error: any) {
           final.failures.push({plugin: p, error: error as Error})
           debug(error)
         }
@@ -277,13 +276,15 @@ export class Config implements IConfig {
     return final
   }
 
+  // eslint-disable-next-line default-param-last
   async runCommand<T = unknown>(id: string, argv: string[] = [], cachedCommand?: Command.Plugin): Promise<T> {
     debug('runCommand %s %o', id, argv)
     const c = cachedCommand || this.findCommand(id)
     if (!c) {
       await this.runHook('command_not_found', {id, argv})
       throw new CLIError(`command ${id} not found`)
     }
+
     const command = await c.load()
     await this.runHook('prerun', {Command: command, argv})
     const result = (await command.run(argv, this)) as T
@@ -302,8 +303,7 @@ export class Config implements IConfig {
 
   scopedEnvVarKey(k: string) {
     return [this.bin, k]
-    // eslint-disable-next-line no-useless-escape
-    .map(p => p.replace(/@/g, '').replace(/[-\/]/g, '_'))
+    .map(p => p.replace(/@/g, '').replace(/[/-]/g, '_'))
     .join('_')
     .toUpperCase()
   }
@@ -348,14 +348,17 @@ export class Config implements IConfig {
         // If b appears first in the pjson.plugins sort it first
         return aIndex - bIndex
       }
+
       // if b is a core plugin and a is not sort b first
       if (b.pluginType === 'core' && a.pluginType !== 'core') {
         return 1
       }
+
       // if a is a core plugin and b is not sort a first
       if (a.pluginType === 'core' && b.pluginType !== 'core') {
         return -1
       }
+
       // neither plugin is core, so do not change the order
       return 0
     })
@@ -397,17 +400,20 @@ export class Config implements IConfig {
         } else topics.push(topic)
       }
     }
+
     // add missing topics
     for (const c of this.commands.filter(c => !c.hidden)) {
       const parts = c.id.split(':')
-      while (parts.length) {
+      while (parts.length > 0) {
         const name = parts.join(':')
         if (name && !topics.find(t => t.name === name)) {
           topics.push({name, description: c.summary || c.description})
         }
+
         parts.pop()
       }
     }
+
     this._topics = topics
     return this._topics
   }
@@ -460,6 +466,7 @@ export class Config implements IConfig {
     } else {
       shellPath = ['unknown']
     }
+
     return shellPath[shellPath.length - 1]
   }
 
@@ -468,8 +475,8 @@ export class Config implements IConfig {
     try {
       const {enabled} = require('debug')(this.bin)
       if (enabled) return 1
-    } catch {
-    }
+    } catch {}
+
     return 0
   }
 
@@ -486,18 +493,19 @@ export class Config implements IConfig {
           opts.tag = plugin.tag || opts.tag
           opts.root = plugin.root || opts.root
         }
+
         const instance = new Plugin.Plugin(opts)
         await instance.load()
         if (this.plugins.find(p => p.name === instance.name)) return
         this.plugins.push(instance)
         if (parent) {
-          // eslint-disable-next-line require-atomic-updates
           instance.parent = parent
           if (!parent.children) parent.children = []
           parent.children.push(instance)
         }
+
         await this.loadPlugins(instance.root, type, instance.pjson.oclif.plugins || [], instance)
-      } catch (error) {
+      } catch (error: any) {
         this.warn(error, 'loadPlugins')
       }
     }))
@@ -581,7 +589,6 @@ export async function toCached(c: Command.Class, plugin?: IPlugin): Promise<Comm
         options: flag.options,
         dependsOn: flag.dependsOn,
         exclusive: flag.exclusive,
-        // eslint-disable-next-line no-await-in-loop
         default: typeof flag.default === 'function' ? await flag.default({options: {}, flags: {}}) : flag.default,
       }
     }
@@ -620,9 +627,9 @@ export async function toCached(c: Command.Class, plugin?: IPlugin): Promise<Comm
   const stdKeys = Object.keys(stdProperties)
   const keysToAdd = Object.keys(c).filter(property => ![...stdKeys, ...ignoreCommandProperties].includes(property))
   const additionalProperties: any = {}
-  keysToAdd.forEach(key => {
+  for (const key of keysToAdd) {
     additionalProperties[key] = (c as any)[key]
-  })
+  }
 
   return {...stdProperties, ...additionalProperties}
 }

src/config/plugin.ts

@@ -23,6 +23,7 @@ function topicsToArray(input: any, base?: string): Topic[] {
   if (Array.isArray(input)) {
     return input.concat(flatMap(input, t => topicsToArray(t.subtopics, `${base}${t.name}`)))
   }
+
   return flatMap(Object.keys(input), k => {
     input[k].name = k
     return [{...input[k], name: `${base}${k}`}].concat(topicsToArray(input[k].subtopics, `${base}${input[k].name}`))
@@ -44,8 +45,10 @@ async function findRoot(name: string | undefined, root: string) {
       yield from
       from = path.dirname(from)
     }
+
     yield from
   }
+
   for (const next of up(root)) {
     let cur
     if (name) {
@@ -56,7 +59,7 @@ async function findRoot(name: string | undefined, root: string) {
         // eslint-disable-next-line no-await-in-loop
         const pkg = await loadJSON(path.join(next, 'package.json'))
         if (pkg.name === name) return next
-      } catch { }
+      } catch {}
     } else {
       cur = path.join(next, 'package.json')
       // eslint-disable-next-line no-await-in-loop
@@ -153,10 +156,11 @@ export class Plugin implements IPlugin {
     try {
       const globbyPath = require.resolve('globby', {paths: [this.root, __dirname]})
       globby = require(globbyPath)
-    } catch (error) {
+    } catch (error: any) {
       this.warn(error, 'not loading commands, globby not found')
       return []
     }
+
     this._debug(`loading IDs from ${this.commandsDir}`)
     const patterns = [
       '**/*.+(js|cjs|mjs|ts|tsx)',
@@ -185,22 +189,25 @@ export class Plugin implements IPlugin {
         if (cmd.default && cmd.default.run) return cmd.default
         return Object.values(cmd).find((cmd: any) => typeof cmd.run === 'function')
       }
+
       let m
       try {
         const p = path.join(this.pjson.oclif.commands as string, ...id.split(':'))
         const {isESM, module, filePath} = await ModuleLoader.loadWithData(this, p)
         this._debug(isESM ? '(import)' : '(require)', filePath)
         m = module
-      } catch (error) {
+      } catch (error: any) {
         if (!opts.must && error.code === 'MODULE_NOT_FOUND') return
         throw error
       }
+
       const cmd = search(m)
       if (!cmd) return
       cmd.id = id
       cmd.plugin = this
       return cmd
     }
+
     const cmd = await fetch()
     if (!cmd && opts.must) error(`command ${id} not found`)
     return cmd
@@ -217,26 +224,26 @@ export class Plugin implements IPlugin {
           this._debug('using manifest from', p)
           return manifest
         }
-      } catch (error) {
+      } catch (error: any) {
         if (error.code === 'ENOENT') {
           if (!dotfile) return readManifest(true)
         } else {
           this.warn(error, 'readManifest')
         }
       }
     }
+
     if (!ignoreManifest) {
       const manifest = await readManifest()
       if (manifest) return manifest
     }
 
     return {
       version: this.version,
-      // eslint-disable-next-line array-callback-return
       commands: (await Promise.all(this.commandIDs.map(async id => {
         try {
           return [id, await toCached(await this.findCommand(id, {must: true}), this)]
-        } catch (error) {
+        } catch (error: any) {
           const scope = 'toCached'
           if (Boolean(errorOnManifestCreate) === false) this.warn(error, scope)
           else throw this.addErrorScope(error, scope)