readline: add autoCommit option

PR-URL: #37947Fixes: #37287
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>

Author: aduh95

doc/api/readline.md

@@ -599,12 +599,14 @@ setTimeout(() => ac.abort(), 10000);
 added: REPLACEME
 -->
 
-#### `new readlinePromises.Readline(stream)`
+#### `new readlinePromises.Readline(stream[, options])`
 <!-- YAML
 added: REPLACEME
 -->
 
 *`stream` {stream.Writable} A [TTY][] stream.
+*`options` {Object}
+*`autoCommit` {boolean} If `true`, no need to call `rl.commit()`.
 
 #### `rl.clearLine(dir)`
 <!-- YAML
@@ -620,7 +622,8 @@ added: REPLACEME
 The `rl.clearLine()` method adds to the internal list of pending action an
 action that clears current line of the associated `stream` in a specified
 direction identified by `dir`.
-You need to call `rl.commit()` to see the effect of this method.
+Call `rl.commit()` to see the effect of this method, unless `autoCommit: true`
+was passed to the constructor.
 
 #### `rl.clearScreenDown()`
 <!-- YAML
@@ -632,7 +635,8 @@ added: REPLACEME
 The `rl.clearScreenDown()` method adds to the internal list of pending action an
 action that clears the associated stream from the current position of the
 cursor down.
-You need to call `rl.commit()` to see the effect of this method.
+Call `rl.commit()` to see the effect of this method, unless `autoCommit: true`
+was passed to the constructor.
 
 #### `rl.commit()`
 <!-- YAML
@@ -655,7 +659,8 @@ added: REPLACEME
 
 The `rl.cursorTo()` method adds to the internal list of pending action an action
 that moves cursor to the specified position in the associated `stream`.
-You need to call `rl.commit()` to see the effect of this method.
+Call `rl.commit()` to see the effect of this method, unless `autoCommit: true`
+was passed to the constructor.
 
 #### `rl.moveCursor(dx, dy)`
 <!-- YAML
@@ -669,7 +674,8 @@ added: REPLACEME
 The `rl.moveCursor()` method adds to the internal list of pending action an
 action that moves the cursor *relative* to its current position in the
 associated `stream`.
-You need to call `rl.commit()` to see the effect of this method.
+Call `rl.commit()` to see the effect of this method, unless `autoCommit: true`
+was passed to the constructor.
 
 #### `rl.rollback()`
 <!-- YAML

lib/internal/readline/promises.js

@@ -7,7 +7,7 @@ const {
 }=primordials;
 
 const{CSI}=require('internal/readline/utils');
-const{ validateInteger }=require('internal/validators');
+const{validateBoolean,validateInteger }=require('internal/validators');
 const{ isWritable }=require('internal/streams/utils');
 const{codes: {ERR_INVALID_ARG_TYPE}}=require('internal/errors');
 
@@ -19,13 +19,18 @@ const {
 }=CSI;
 
 classReadline{
+ #autoCommit =false;
  #stream;
  #todo =[];
 
-constructor(stream){
+constructor(stream,options=undefined){
 if(!isWritable(stream))
 thrownewERR_INVALID_ARG_TYPE('stream','Writable',stream);
 this.#stream =stream;
+if(options?.autoCommit!=null){
+validateBoolean(options.autoCommit,'options.autoCommit');
+this.#autoCommit =options.autoCommit;
+}
 }
 
 /**
@@ -38,10 +43,9 @@ class Readline {
 validateInteger(x,'x');
 if(y!=null)validateInteger(y,'y');
 
-ArrayPrototypePush(
-this.#todo,
-y==null ? CSI`${x+1}G` : CSI`${y+1};${x+1}H`
-);
+constdata=y==null ? CSI`${x+1}G` : CSI`${y+1};${x+1}H`;
+if(this.#autoCommit)process.nextTick(()=>this.#stream.write(data));
+elseArrayPrototypePush(this.#todo,data);
 
 returnthis;
 }
@@ -70,7 +74,8 @@ class Readline {
 }elseif(dy>0){
 data+=CSI`${dy}B`;
 }
-ArrayPrototypePush(this.#todo,data);
+if(this.#autoCommit)process.nextTick(()=>this.#stream.write(data));
+elseArrayPrototypePush(this.#todo,data);
 }
 returnthis;
 }
@@ -86,10 +91,12 @@ class Readline {
 clearLine(dir){
 validateInteger(dir,'dir',-1,1);
 
-ArrayPrototypePush(
-this.#todo,
-dir<0 ? kClearToLineBeginning : dir>0 ? kClearToLineEnd : kClearLine
-);
+constdata=
+dir<0 ? kClearToLineBeginning :
+dir>0 ? kClearToLineEnd :
+kClearLine;
+if(this.#autoCommit)process.nextTick(()=>this.#stream.write(data));
+elseArrayPrototypePush(this.#todo,data);
 returnthis;
 }
 
@@ -98,7 +105,11 @@ class Readline {
  * @returns {Readline} this
  */
 clearScreenDown(){
-ArrayPrototypePush(this.#todo,kClearScreenDown);
+if(this.#autoCommit){
+process.nextTick(()=>this.#stream.write(kClearScreenDown));
+}else{
+ArrayPrototypePush(this.#todo,kClearScreenDown);
+}
 returnthis;
 }