@oclif/core 3.19.6 → 3.20.0

package/lib/config/config.js

@@ -44,7 +44,7 @@ const fs_1 = require("../util/fs");
 const os_1 = require("../util/os");
 const util_2 = require("../util/util");
 const plugin_loader_1 = __importDefault(require("./plugin-loader"));
-const ts_node_1 = require("./ts-node");
+const ts_path_1 = require("./ts-path");
 const util_3 = require("./util");
 // eslint-disable-next-line new-cap
 const debug = (0, util_3.Debug)();
@@ -485,7 +485,7 @@ class Config {
                 const marker = performance_1.Performance.mark(performance_1.OCLIF_MARKER_OWNER, `config.runHook#${p.name}(${hook})`);
                 try {
                     /* eslint-disable no-await-in-loop */
-                    const { filePath, isESM, module } = await (0, module_loader_1.loadWithData)(p, await (0, ts_node_1.tsPath)(p.root, hook, p));
+                    const { filePath, isESM, module } = await (0, module_loader_1.loadWithData)(p, await (0, ts_path_1.tsPath)(p.root, hook, p));
                     debug('start', isESM ? '(import)' : '(require)', filePath);
                     const result = timeout
                         ? await withTimeout(timeout, search(module).call(context, { ...opts, config: this, context }))

package/lib/config/index.d.ts

@@ -1,3 +1,3 @@
 export { Config } from './config';
 export { Plugin } from './plugin';
-export { tsPath } from './ts-node';
+export { tsPath } from './ts-path';

package/lib/config/index.js

@@ -5,5 +5,5 @@ var config_1 = require("./config");
 Object.defineProperty(exports, "Config", { enumerable: true, get: function () { return config_1.Config; } });
 var plugin_1 = require("./plugin");
 Object.defineProperty(exports, "Plugin", { enumerable: true, get: function () { return plugin_1.Plugin; } });
-var ts_node_1 = require("./ts-node");
-Object.defineProperty(exports, "tsPath", { enumerable: true, get: function () { return ts_node_1.tsPath; } });
+var ts_path_1 = require("./ts-path");
+Object.defineProperty(exports, "tsPath", { enumerable: true, get: function () { return ts_path_1.tsPath; } });

package/lib/config/plugin.js

@@ -14,7 +14,7 @@ const cache_command_1 = require("../util/cache-command");
 const find_root_1 = require("../util/find-root");
 const fs_1 = require("../util/fs");
 const util_1 = require("../util/util");
-const ts_node_1 = require("./ts-node");
+const ts_path_1 = require("./ts-path");
 const util_2 = require("./util");
 const _pjson = (0, fs_1.requireJson)(__dirname, '..', '..', 'package.json');
 function topicsToArray(input, base) {
@@ -261,7 +261,7 @@ class Plugin {
     async getCommandsDir() {
         if (this.commandsDir)
             return this.commandsDir;
-        this.commandsDir = await (0, ts_node_1.tsPath)(this.root, this.pjson.oclif.commands, this);
+        this.commandsDir = await (0, ts_path_1.tsPath)(this.root, this.pjson.oclif.commands, this);
         return this.commandsDir;
     }
     warn(err, scope) {

package/lib/config/{ts-node.js → ts-path.js}

@@ -13,9 +13,50 @@ const read_tsconfig_1 = require("../util/read-tsconfig");
 const util_1 = require("../util/util");
 const util_2 = require("./util");
 // eslint-disable-next-line new-cap
-const debug = (0, util_2.Debug)('ts-node');
+const debug = (0, util_2.Debug)('ts-path');
 exports.TS_CONFIGS = {};
 const REGISTERED = new Set();
+function determineRuntime() {
+    /**
+     * Examples:
+     * #!/usr/bin/env bun
+     * bun bin/run.js
+     * bun bin/dev.js
+     */
+    if (process.execPath.split(node_path_1.sep).includes('bun'))
+        return 'bun';
+    /**
+     * Examples:
+     * #!/usr/bin/env node
+     * #!/usr/bin/env node --loader ts-node/esm --experimental-specifier-resolution=node --no-warnings
+     * node bin/run.js
+     * node bin/dev.js
+     */
+    if (process.execArgv.length === 0)
+        return 'node';
+    /**
+     * Examples:
+     * #!/usr/bin/env ts-node
+     * #!/usr/bin/env node_modules/.bin/ts-node
+     * ts-node bin/run.js
+     * ts-node bin/dev.js
+     */
+    if (process.execArgv[0] === '--require' && process.execArgv[1].split(node_path_1.sep).includes('ts-node'))
+        return 'ts-node';
+    if (process.execArgv[0].split(node_path_1.sep).includes('ts-node'))
+        return 'ts-node';
+    /**
+     * Examples:
+     * #!/usr/bin/env tsx
+     * #!/usr/bin/env node_modules/.bin/tsx
+     * tsx bin/run.js
+     * tsx bin/dev.js
+     */
+    if (process.execArgv[0] === '--require' && process.execArgv[1].split(node_path_1.sep).includes('tsx'))
+        return 'tsx';
+    return 'node';
+}
+const RUN_TIME = determineRuntime();
 function isErrno(error) {
     return 'code' in error && error.code === 'ENOENT';
 }
@@ -23,22 +64,23 @@ async function loadTSConfig(root) {
     try {
         if (exports.TS_CONFIGS[root])
             return exports.TS_CONFIGS[root];
-        exports.TS_CONFIGS[root] = await (0, read_tsconfig_1.readTSConfig)(root);
+        const tsconfig = await (0, read_tsconfig_1.readTSConfig)(root);
+        if (!tsconfig)
+            return;
+        debug('tsconfig: %O', tsconfig);
+        exports.TS_CONFIGS[root] = tsconfig;
         return exports.TS_CONFIGS[root];
     }
     catch (error) {
         if (isErrno(error))
             return;
-        debug(`Could not parse tsconfig.json. Skipping ts-node registration for ${root}.`);
+        debug(`Could not parse tsconfig.json. Skipping typescript path lookup for ${root}.`);
         (0, errors_1.memoizedWarn)(`Could not parse tsconfig.json for ${root}. Falling back to compiled source.`);
     }
 }
-async function registerTSNode(root) {
-    const tsconfig = await loadTSConfig(root);
-    if (!tsconfig)
-        return;
+async function registerTSNode(root, tsconfig) {
     if (REGISTERED.has(root))
-        return tsconfig;
+        return;
     debug('registering ts-node at', root);
     const tsNodePath = require.resolve('ts-node', { paths: [root, __dirname] });
     debug('ts-node path:', tsNodePath);
@@ -87,11 +129,9 @@ async function registerTSNode(root) {
         skipProject: true,
         transpileOnly: true,
     };
+    debug('ts-node options: %O', conf);
     tsNode.register(conf);
     REGISTERED.add(root);
-    debug('tsconfig: %O', tsconfig);
-    debug('ts-node options: %O', conf);
-    return tsconfig;
 }
 /**
  * Skip ts-node registration for ESM plugins in production.
@@ -121,17 +161,22 @@ function cannotUseTsNode(root, plugin, isProduction) {
     if (plugin?.moduleType !== 'module' || isProduction)
         return false;
     const nodeMajor = Number.parseInt(process.version.replace('v', '').split('.')[0], 10);
-    const tsNodeExecIsUsed = process.execArgv[0] === '--require' && process.execArgv[1].split(node_path_1.sep).includes(`ts-node`);
-    return tsNodeExecIsUsed && nodeMajor >= 20;
+    return RUN_TIME === 'ts-node' && nodeMajor >= 20;
 }
 /**
  * Determine the path to the source file from the compiled ./lib files
  */
 async function determinePath(root, orig) {
-    const tsconfig = await registerTSNode(root);
+    const tsconfig = await loadTSConfig(root);
     if (!tsconfig)
         return orig;
-    debug(`determining path for ${orig}`);
+    debug(`Determining path for ${orig}`);
+    if (RUN_TIME === 'tsx' || RUN_TIME === 'bun') {
+        debug(`Skipping ts-node registration for ${root} because the runtime is: ${RUN_TIME}`);
+    }
+    else {
+        await registerTSNode(root, tsconfig);
+    }
     const { baseUrl, outDir, rootDir, rootDirs } = tsconfig.compilerOptions;
     const rootDirPath = rootDir ?? (rootDirs ?? [])[0] ?? baseUrl;
     if (!rootDirPath) {
@@ -171,24 +216,25 @@ async function tsPath(root, orig, plugin) {
         return orig;
     orig = orig.startsWith(root) ? orig : (0, node_path_1.join)(root, orig);
     // NOTE: The order of these checks matter!
-    if (settings_1.settings.tsnodeEnabled === false) {
-        debug(`Skipping ts-node registration for ${root} because tsNodeEnabled is explicitly set to false`);
+    const enableAutoTranspile = settings_1.settings.enableAutoTranspile ?? settings_1.settings.tsnodeEnabled;
+    if (enableAutoTranspile === false) {
+        debug(`Skipping typescript path lookup for ${root} because enableAutoTranspile is explicitly set to false`);
         return orig;
     }
     const isProduction = (0, util_1.isProd)();
     // Do not skip ts-node registration if the plugin is linked
-    if (settings_1.settings.tsnodeEnabled === undefined && isProduction && plugin?.type !== 'link') {
-        debug(`Skipping ts-node registration for ${root} because NODE_ENV is NOT "test" or "development"`);
+    if (enableAutoTranspile === undefined && isProduction && plugin?.type !== 'link') {
+        debug(`Skipping typescript path lookup for ${root} because NODE_ENV is NOT "test" or "development"`);
         return orig;
     }
     if (cannotTranspileEsm(rootPlugin, plugin, isProduction)) {
-        debug(`Skipping ts-node registration for ${root} because it's an ESM module (NODE_ENV: ${process.env.NODE_ENV}, root plugin module type: ${rootPlugin?.moduleType})`);
+        debug(`Skipping typescript path lookup for ${root} because it's an ESM module (NODE_ENV: ${process.env.NODE_ENV}, root plugin module type: ${rootPlugin?.moduleType})`);
         if (plugin?.type === 'link')
             (0, errors_1.memoizedWarn)(`${plugin?.name} is a linked ESM module and cannot be auto-transpiled. Existing compiled source will be used instead.`);
         return orig;
     }
     if (cannotUseTsNode(root, plugin, isProduction)) {
-        debug(`Skipping ts-node registration for ${root} because ts-node is run in node version ${process.version}"`);
+        debug(`Skipping typescript path lookup for ${root} because ts-node is run in node version ${process.version}"`);
         (0, errors_1.memoizedWarn)(`ts-node executable cannot transpile ESM in Node 20. Existing compiled source will be used instead. See https://github.com/oclif/core/issues/817.`);
         return orig;
     }

package/lib/main.js

@@ -38,6 +38,11 @@ async function run(argv, options) {
         await performance_1.Performance.collect();
         performance_1.Performance.debug();
     };
+    const showHelp = async (argv) => {
+        const Help = await (0, help_1.loadHelpClass)(config);
+        const help = new Help(config, config.pjson.oclif.helpOptions ?? config.pjson.helpOptions);
+        await help.showHelp(argv);
+    };
     debug(`process.execPath: ${process.execPath}`);
     debug(`process.execArgv: ${process.execArgv}`);
     debug('process.argv: %O', process.argv);
@@ -58,9 +63,7 @@ async function run(argv, options) {
     }
     // display help version if applicable
     if ((0, exports.helpAddition)(argv, config)) {
-        const Help = await (0, help_1.loadHelpClass)(config);
-        const help = new Help(config, config.pjson.oclif.helpOptions ?? config.pjson.helpOptions);
-        await help.showHelp(argv);
+        await showHelp(argv);
         await collectPerf();
         return;
     }
@@ -68,8 +71,11 @@ async function run(argv, options) {
     const cmd = config.findCommand(id);
     if (!cmd) {
         const topic = config.flexibleTaxonomy ? null : config.findTopic(id);
-        if (topic)
-            return config.runCommand('help', [id]);
+        if (topic) {
+            await showHelp([id]);
+            await collectPerf();
+            return;
+        }
         if (config.pjson.oclif.default) {
             id = config.pjson.oclif.default;
             argvSlice = argv;

package/lib/module-loader.js

@@ -4,7 +4,7 @@ exports.isPathModule = exports.loadWithDataFromManifest = exports.loadWithData =
 const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
 const node_url_1 = require("node:url");
-const ts_node_1 = require("./config/ts-node");
+const ts_path_1 = require("./config/ts-path");
 const errors_1 = require("./errors");
 const fs_1 = require("./util/fs");
 const getPackageType = require('get-package-type');
@@ -164,7 +164,7 @@ async function resolvePath(config, modulePath) {
     }
     catch {
         filePath =
-            (isPlugin(config) ? await (0, ts_node_1.tsPath)(config.root, modulePath, config) : await (0, ts_node_1.tsPath)(config.root, modulePath)) ??
+            (isPlugin(config) ? await (0, ts_path_1.tsPath)(config.root, modulePath, config) : await (0, ts_path_1.tsPath)(config.root, modulePath)) ??
                 modulePath;
         let fileExists = false;
         let isDirectory = false;

package/lib/settings.d.ts

@@ -9,7 +9,7 @@ export type Settings = {
     /**
      * Show additional debug output without DEBUG. Mainly shows stackstraces.
      *
-     * Useful to set in the ./bin/dev script.
+     * Useful to set in the ./bin/dev.js script.
      * oclif.settings.debug = true;
      */
     debug?: boolean;
@@ -25,15 +25,18 @@ export type Settings = {
      */
     performanceEnabled?: boolean;
     /**
-     * Try to use ts-node to load typescript source files instead of
-     * javascript files.
+     * Try to use ts-node to load typescript source files instead of javascript files.
+     * Defaults to true in development and test environments (e.g. using bin/dev.js or
+     * NODE_ENV=development or NODE_ENV=test).
      *
-     * NOTE: This requires registering ts-node first.
-     * require('ts-node').register();
-     *
-     * Environment Variable:
-     *   NODE_ENV=development
+     * @deprecated use enableAutoTranspile instead.
      */
     tsnodeEnabled?: boolean;
+    /**
+     * Enable automatic transpilation of TypeScript files to JavaScript.
+     *
+     * Defaults to true in development and test environments (e.g. using bin/dev.js or NODE_ENV=development or NODE_ENV=test).
+     */
+    enableAutoTranspile?: boolean;
 };
 export declare const settings: Settings;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "3.19.6",
+  "version": "3.20.0",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {
@@ -64,10 +64,10 @@
     "commitlint": "^17.8.1",
     "cross-env": "^7.0.3",
     "eslint": "^8.56.0",
-    "eslint-config-oclif": "^5.0.0",
-    "eslint-config-oclif-typescript": "^3.0.47",
+    "eslint-config-oclif": "^5.0.2",
+    "eslint-config-oclif-typescript": "^3.0.48",
     "eslint-config-prettier": "^9.1.0",
-    "fancy-test": "^3.0.1",
+    "fancy-test": "^3.0.11",
     "globby": "^11.1.0",
     "husky": "^8",
     "lint-staged": "^14.0.1",
@@ -78,7 +78,7 @@
     "shx": "^0.3.4",
     "sinon": "^16.1.3",
     "ts-node": "^10.9.2",
-    "tsd": "^0.30.4",
+    "tsd": "^0.30.6",
     "typescript": "^5"
   },
   "engines": {
@@ -127,7 +127,7 @@
     "test:circular-deps": "madge lib/ -c",
     "test:debug": "nyc mocha --debug-brk --inspect \"test/**/*.test.ts\"",
     "test:integration": "mocha --forbid-only \"test/**/*.integration.ts\" --parallel --timeout 1200000",
-    "test:esm-cjs": "cross-env DEBUG=integration:* ts-node test/integration/esm-cjs.ts",
+    "test:interoperability": "cross-env DEBUG=integration:* ts-node test/integration/interop.ts",
     "test:perf": "ts-node test/perf/parser.perf.ts",
     "test:dev": "nyc mocha \"test/**/*.test.ts\"",
     "test": "nyc mocha --forbid-only \"test/**/*.test.ts\""