Revert "feat: remove OCLIF_ALLOW_ESM env var (#1171)" (#1179)

This reverts commit 3100bc8.

bin/dev

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+const path = require('path')
+const project = path.join(__dirname, '..', 'tsconfig.json')
+
+// In dev mode -> use ts-node and dev plugins
+process.env.NODE_ENV = 'development'
+
+require('ts-node').register({project})
+
+// In dev mode, always show stack traces
+oclif.settings.debug = true;
+
+
+// Start the CLI
+oclif.run().then(oclif.flush).catch(oclif.Errors.handle)

bin/dev.cmd

@@ -1,3 +1,3 @@
 @echo off
 
-node "%~dp0\dev" %*
+node "%~dp0\dev" %*

bin/run

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+oclif.run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle'))

package.json

@@ -4,11 +4,11 @@
   "version": "3.13.0",
   "author": "Salesforce",
   "bin": {
-    "oclif": "bin/run.js"
+    "oclif": "bin/run"
   },
   "bugs": "https://github.com/oclif/oclif/issues",
   "dependencies": {
-    "@oclif/core": "^3.0.0-beta.4",
+    "@oclif/core": "^2.11.4",
     "@oclif/plugin-help": "^5.2.14",
     "@oclif/plugin-not-found": "^2.3.32",
     "@oclif/plugin-warn-if-update-available": "^2.0.44",
@@ -42,7 +42,7 @@
     "@types/yeoman-generator": "^5.2.11",
     "chai": "^4.3.7",
     "conventional-changelog-cli": "^2.2.2",
-    "eslint": "^8.47.0",
+    "eslint": "^7.32.0",
     "eslint-config-oclif": "^4.0.0",
     "eslint-config-oclif-typescript": "^1.0.2",
     "fancy-test": "^1.4.10",
@@ -124,11 +124,11 @@
     "lint": "nps lint",
     "postpack": "shx rm .oclif.manifest.json",
     "posttest": "yarn run lint",
-    "prepack": "shx rm -rf lib && tsc && bin/dev.js manifest .",
+    "prepack": "shx rm -rf lib && tsc && bin/dev manifest .",
     "test": "nps test && yarn test:unit && yarn test:integration",
     "test:integration": "mocha --forbid-only \"test/integration/*.test.ts\"",
     "test:unit": "mocha --forbid-only \"test/unit/*.test.ts\"",
-    "version": "bin/dev.js readme && git add README.md"
+    "version": "bin/dev readme && git add README.md"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org"

src/command-base.ts

@@ -0,0 +1,17 @@
+import {Command} from '@oclif/core'
+import {createEnv} from 'yeoman-environment'
+
+export default abstract class CommandBase extends Command {
+  protected async generate(type: string, generatorOptions: Record<string, unknown> = {}): Promise<void> {
+    const env = createEnv()
+
+    env.register(
+      require.resolve(`./generators/${type}`),
+      `oclif:${type}`,
+    )
+
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    await env.run(`oclif:${type}`, generatorOptions)
+  }
+}

src/commands/generate.ts

@@ -1,7 +1,7 @@
-import {Args, Command} from '@oclif/core'
-import {generate} from '../util'
+import {Args} from '@oclif/core'
+import CommandBase from './../command-base'
 
-export default class Generate extends Command {
+export default class Generate extends CommandBase {
   static description = `generate a new CLI
 This will clone the template repo 'oclif/hello-world' and update package properties`
 
@@ -14,7 +14,7 @@ This will clone the template repo 'oclif/hello-world' and update package propert
   async run(): Promise<void> {
     const {args} = await this.parse(Generate)
 
-    await generate('cli', {
+    await super.generate('cli', {
       name: args.name,
       force: true,
     })

src/commands/generate/command.ts

@@ -1,7 +1,7 @@
-import {Args, Command, Flags} from '@oclif/core'
-import {generate} from '../../util'
+import CommandBase from './../../command-base'
+import {Args, Flags} from '@oclif/core'
 
-export default class GenerateCommand extends Command {
+export default class GenerateCommand extends CommandBase {
   static description = 'add a command to an existing CLI or plugin'
 
   static flags = {
@@ -15,7 +15,7 @@ export default class GenerateCommand extends Command {
   async run(): Promise<void> {
     const {args, flags} = await this.parse(GenerateCommand)
 
-    await generate('command', {
+    await super.generate('command', {
       name: args.name,
       force: flags.force,
     })

src/commands/generate/hook.ts

@@ -1,7 +1,7 @@
-import {Args, Command, Flags} from '@oclif/core'
-import {generate} from '../../util'
+import CommandBase from './../../command-base'
+import {Args, Flags} from '@oclif/core'
 
-export default class GenerateHook extends Command {
+export default class GenerateHook extends CommandBase {
   static description = 'add a hook to an existing CLI or plugin'
 
   static flags = {
@@ -16,7 +16,7 @@ export default class GenerateHook extends Command {
   async run(): Promise<void> {
     const {args, flags} = await this.parse(GenerateHook)
 
-    await generate('hook', {
+    await super.generate('hook', {
       name: args.name,
       event: flags.event,
       force: flags.force,

src/commands/manifest.ts

@@ -73,15 +73,9 @@ export default class Manifest extends Command {
       ux.action.stop()
     }
 
-    let plugin = new Plugin({
-      root,
-      type: 'core',
-      ignoreManifest: true,
-      errorOnManifestCreate: true,
-      respectNoCacheDefault: true,
-    })
+    let plugin = new Plugin({root, type: 'core', ignoreManifest: true, errorOnManifestCreate: true})
     if (!plugin) throw new Error('plugin not found')
-    await plugin.load()
+    await plugin.load(true)
     if (!plugin.valid) {
       const p = require.resolve('@oclif/plugin-legacy', {paths: [process.cwd()]})
       const {PluginLegacy} = require(p)

src/commands/readme.ts

@@ -47,7 +47,7 @@ Customize the code URL prefix by setting oclif.repositoryPrefix in package.json.
       const p = require.resolve('@oclif/plugin-legacy', {paths: [cwd]})
       const plugin = new Plugin({root: p, type: 'core'})
       await plugin.load()
-      config.plugins.set(plugin.name, plugin)
+      config.plugins.push(plugin)
     } catch {}
 
     await (config as Config).runHook('init', {id: 'readme', argv: this.argv})
@@ -190,7 +190,7 @@ USAGE
   commandCode(config: Interfaces.Config, c: Command.Cached): string | undefined {
     const pluginName = c.pluginName
     if (!pluginName) return
-    const plugin = config.plugins.get(pluginName)
+    const plugin = config.plugins.find(p => p.name === c.pluginName)
     if (!plugin) return
     const repo = this.repo(plugin)
     if (!repo) return

src/generators/cli.ts

@@ -61,12 +61,13 @@ export default class CLI extends Generator {
     }
   }
 
+  // eslint-disable-next-line complexity
   async prompting(): Promise<void> {
     const msg = 'Time to build an oclif CLI!'
 
     this.log(`${msg} Version: ${version}`)
 
-    const {moduleType} = await this.prompt([
+    const {moduleType} = process.env.OCLIF_ALLOW_ESM ? await this.prompt([
       {
         type: 'list',
         name: 'moduleType',
@@ -77,7 +78,7 @@ export default class CLI extends Generator {
         ],
         default: 'cjs',
       },
-    ])
+    ]) : 'cjs'
 
     const repo = moduleType === 'esm' ? 'hello-world-esm' : 'hello-world'
     execSync(`git clone https://github.com/oclif/${repo}.git "${path.resolve(this.name)}" --depth=1`)

src/util.ts

@@ -3,18 +3,6 @@ import * as os from 'os'
 import * as crypto from 'node:crypto'
 import {log} from './log'
 import * as fs from 'fs-extra'
-import {createEnv} from 'yeoman-environment'
-
-export async function generate(type: string, generatorOptions: Record<string, unknown> = {}): Promise<void> {
-  const env = createEnv()
-
-  env.register(
-    require.resolve(`./generators/${type}`),
-    `oclif:${type}`,
-  )
-
-  return env.run(`oclif:${type}`, generatorOptions)
-}
 
 export function castArray<T>(input?: T | T[]): T[] {
   if (input === undefined) return []

tsconfig.json

@@ -13,7 +13,7 @@
     ],
     "strict": true,
     "lib": ["ES2019"],
-    "target": "es2019"
+    "target": "es2017"
   },
   "include": [
     "./src/**/*"