@oclif/core 3.13.2 → 3.14.0

package/lib/interfaces/parser.d.ts

@@ -213,6 +213,11 @@ export type OptionFlagProps = FlagProps & {
      * separate on spaces.
      */
     delimiter?: ',';
+    /**
+     * Allow input value to be read from stdin.
+     * Should only be used on one flag at a time.
+     */
+    allowStdin?: boolean;
 };
 export type FlagParserContext = Command & {
     token: FlagToken;

package/lib/parser/parse.d.ts

@@ -1,4 +1,5 @@
 import { OutputArgs, OutputFlags, ParserInput, ParserOutput } from '../interfaces/parser';
+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;
     private readonly argv;

package/lib/parser/parse.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Parser = void 0;
+exports.Parser = exports.readStdin = void 0;
 /* eslint-disable no-await-in-loop */
 const node_readline_1 = require("node:readline");
 const util_1 = require("../util/util");
@@ -54,6 +54,7 @@ const readStdin = async () => {
         }, { once: true });
     });
 };
+exports.readStdin = readStdin;
 function isNegativeNumber(input) {
     return /^-\d/g.test(input);
 }
@@ -80,14 +81,14 @@ class Parser {
     }
     async parse() {
         this._debugInput();
-        const parseFlag = (arg) => {
+        const parseFlag = async (arg) => {
             const { isLong, name } = this.findFlag(arg);
             if (!name) {
                 const i = arg.indexOf('=');
                 if (i !== -1) {
                     const sliced = arg.slice(i + 1);
                     this.argv.unshift(sliced);
-                    const equalsParsed = parseFlag(arg.slice(0, i));
+                    const equalsParsed = await parseFlag(arg.slice(0, i));
                     if (!equalsParsed) {
                         this.argv.shift();
                     }
@@ -101,11 +102,17 @@ class Parser {
                     throw new errors_1.CLIError(`Flag --${name} can only be specified once`);
                 }
                 this.currentFlag = flag;
-                const input = isLong || arg.length < 3 ? this.argv.shift() : arg.slice(arg[2] === '=' ? 3 : 2);
+                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 && input === '-') {
+                    const stdin = await (0, exports.readStdin)();
+                    if (stdin) {
+                        input = stdin.trim();
+                    }
+                }
                 this.raw.push({ flag: flag.name, input, type: 'flag' });
             }
             else {
@@ -129,7 +136,7 @@ class Parser {
                     parsingFlags = false;
                     continue;
                 }
-                if (parseFlag(input)) {
+                if (await parseFlag(input)) {
                     continue;
                 }
                 if (input === '--') {
@@ -183,7 +190,7 @@ class Parser {
                 args[token.arg] = parsed;
             }
             else if (!arg.ignoreStdin && !stdinRead) {
-                let stdin = await readStdin();
+                let stdin = await (0, exports.readStdin)();
                 if (stdin) {
                     stdin = stdin.trim();
                     const parsed = await arg.parse(stdin, ctx, arg);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "3.13.2",
+  "version": "3.14.0",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {