@oclif/core 3.19.0 → 3.19.2

package/lib/cli-ux/prompt.js

@@ -28,28 +28,22 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.anykey = exports.confirm = exports.prompt = void 0;
 const chalk_1 = __importDefault(require("chalk"));
+const node_readline_1 = __importDefault(require("node:readline"));
 const Errors = __importStar(require("../errors"));
 const config_1 = require("./config");
 function normal(options, retries = 100) {
     if (retries < 0)
         throw new Error('no input');
+    const ac = new AbortController();
+    const { signal } = ac;
     return new Promise((resolve, reject) => {
-        let timer;
-        if (options.timeout) {
-            timer = setTimeout(() => {
-                process.stdin.pause();
-                reject(new Error('Prompt timeout'));
-            }, options.timeout);
-            timer.unref();
-        }
-        process.stdin.setEncoding('utf8');
-        process.stderr.write(options.prompt);
-        process.stdin.resume();
-        process.stdin.once('data', (b) => {
-            if (timer)
-                clearTimeout(timer);
-            process.stdin.pause();
-            const data = (typeof b === 'string' ? b : b.toString()).trim();
+        const rl = node_readline_1.default.createInterface({
+            input: process.stdin,
+            output: process.stdout,
+        });
+        rl.question(options.prompt, { signal }, (answer) => {
+            rl.close();
+            const data = answer.trim();
             if (!options.default && options.required && data === '') {
                 resolve(normal(options, retries - 1));
             }
@@ -57,6 +51,12 @@ function normal(options, retries = 100) {
                 resolve(data || options.default);
             }
         });
+        if (options.timeout) {
+            signal.addEventListener('abort', () => {
+                reject(new Error('Prompt timeout'));
+            }, { once: true });
+            setTimeout(() => ac.abort(), options.timeout);
+        }
     });
 }
 function getPrompt(name, type, defaultValue) {

package/lib/execute.d.ts

@@ -8,23 +8,17 @@ import { LoadOptions } from './interfaces';
  * @example For ESM dev.js
  * ```
  * #!/usr/bin/env -S node --loader ts-node/esm --no-warnings=ExperimentalWarning
- * async function main() {
- *   const oclif = await import('@oclif/core')
- *   await oclif.execute({development: true, dir: import.meta.url})
- * }
+ * import { execute } from '@oclif/core'
  *
- * await main()
+ * await execute({development: true, dir: import.meta.url})
  * ```
  *
  * @example For ESM run.js
  * ```
  * #!/usr/bin/env node
- * async function main() {
- *   const oclif = await import('@oclif/core')
- *   await oclif.execute({dir: import.meta.url})
- * }
+ * import { execute } from '@oclif/core'
  *
- * await main()
+ * await execute({dir: import.meta.url})
  * ```
  *
  * @example For CJS dev.js

package/lib/execute.js

@@ -14,23 +14,17 @@ const settings_1 = require("./settings");
  * @example For ESM dev.js
  * ```
  * #!/usr/bin/env -S node --loader ts-node/esm --no-warnings=ExperimentalWarning
- * async function main() {
- *   const oclif = await import('@oclif/core')
- *   await oclif.execute({development: true, dir: import.meta.url})
- * }
+ * import { execute } from '@oclif/core'
  *
- * await main()
+ * await execute({development: true, dir: import.meta.url})
  * ```
  *
  * @example For ESM run.js
  * ```
  * #!/usr/bin/env node
- * async function main() {
- *   const oclif = await import('@oclif/core')
- *   await oclif.execute({dir: import.meta.url})
- * }
+ * import { execute } from '@oclif/core'
  *
- * await main()
+ * await execute({dir: import.meta.url})
  * ```
  *
  * @example For CJS dev.js

package/lib/parser/parse.d.ts

@@ -1,4 +1,18 @@
 import { OutputArgs, OutputFlags, ParserInput, ParserOutput } from '../interfaces/parser';
+declare global {
+    /**
+     * Cache the stdin so that it can be read multiple times.
+     *
+     * This fixes a bug where the stdin would be read multiple times (because Parser.parse() was called more than once)
+     * but only the first read would be successful - all other reads would return null.
+     *
+     * Storing in global is necessary because we want the cache to be shared across all versions of @oclif/core in
+     * in the dependency tree. Storing in a variable would only share the cache within the same version of @oclif/core.
+     */
+    var oclif: {
+        stdinCache?: string;
+    };
+}
 export declare const readStdin: () => Promise<null | string>;
 export declare class Parser<T extends ParserInput, TFlags extends OutputFlags<T['flags']>, BFlags extends OutputFlags<T['flags']>, TArgs extends OutputArgs<T['args']>> {
     private readonly input;

package/lib/parser/parse.js

@@ -32,11 +32,15 @@ const readStdin = async () => {
     // Because of this, we have to set a timeout to prevent the process from hanging.
     if (stdin.isTTY)
         return null;
+    if (global.oclif?.stdinCache) {
+        debug('resolved stdin from global cache', global.oclif.stdinCache);
+        return global.oclif.stdinCache;
+    }
     return new Promise((resolve) => {
         let result = '';
         const ac = new AbortController();
         const { signal } = ac;
-        const timeout = setTimeout(() => ac.abort(), 100);
+        const timeout = setTimeout(() => ac.abort(), 10);
         const rl = (0, node_readline_1.createInterface)({
             input: stdin,
             output: stdout,
@@ -48,6 +52,7 @@ const readStdin = async () => {
         rl.once('close', () => {
             clearTimeout(timeout);
             debug('resolved from stdin', result);
+            global.oclif = { ...global.oclif, stdinCache: result };
             resolve(result);
         });
         signal.addEventListener('abort', () => {
@@ -85,6 +90,7 @@ class Parser {
     }
     async parse() {
         this._debugInput();
+        // eslint-disable-next-line complexity
         const parseFlag = async (arg) => {
             const { isLong, name } = this.findFlag(arg);
             if (!name) {
@@ -107,19 +113,19 @@ class Parser {
                 }
                 this.currentFlag = flag;
                 let input = isLong || arg.length < 3 ? this.argv.shift() : arg.slice(arg[2] === '=' ? 3 : 2);
-                // if the value ends up being one of the command's flags, the user didn't provide an input
-                if (typeof input !== 'string' || this.findFlag(input).name) {
-                    throw new errors_1.CLIError(`Flag --${name} expects a value`);
-                }
-                if (flag.allowStdin === 'only' && input !== '-') {
-                    throw new errors_1.CLIError(`Flag --${name} can only be read from stdin. The value must be "-".`);
+                if (flag.allowStdin === 'only' && input !== '-' && input !== undefined) {
+                    throw new errors_1.CLIError(`Flag --${name} can only be read from stdin. The value must be "-" or not provided at all.`);
                 }
-                if (flag.allowStdin && input === '-') {
+                if ((flag.allowStdin && input === '-') || flag.allowStdin === 'only') {
                     const stdin = await (0, exports.readStdin)();
                     if (stdin) {
                         input = stdin.trim();
                     }
                 }
+                // if the value ends up being one of the command's flags, the user didn't provide an input
+                if (typeof input !== 'string' || this.findFlag(input).name) {
+                    throw new errors_1.CLIError(`Flag --${name} expects a value`);
+                }
                 this.raw.push({ flag: flag.name, input, type: 'flag' });
             }
             else {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "3.19.0",
+  "version": "3.19.2",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {
@@ -38,7 +38,7 @@
     "@oclif/plugin-help": "^6",
     "@oclif/plugin-plugins": "^4",
     "@oclif/prettier-config": "^0.2.1",
-    "@oclif/test": "^3.1.12",
+    "@oclif/test": "^3.1.14",
     "@types/ansi-styles": "^3.2.1",
     "@types/benchmark": "^2.1.5",
     "@types/chai": "^4.3.11",
@@ -72,9 +72,9 @@
     "husky": "^8",
     "lint-staged": "^14.0.1",
     "madge": "^6.1.0",
-    "mocha": "^10.2.0",
+    "mocha": "^10.3.0",
     "nyc": "^15.1.0",
-    "prettier": "^3.1.1",
+    "prettier": "^3.2.5",
     "shx": "^0.3.4",
     "sinon": "^16.1.3",
     "ts-node": "^10.9.2",