Merge pull request #365 from microsoft/conpty_stable

Remove experimental from conpty
microsoft · Oct 22, 2019 · ff1c57b · ff1c57b
2 parents b44c429 + 4deaa3a
commit ff1c57b
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/examples/fork/index.js b/examples/fork/index.js
@@ -10,7 +10,7 @@ var ptyProcess = pty.spawn(shell, [], {
   rows: 26,
   cwd: isWindows ? process.env.USERPROFILE : process.env.HOME,
   env: Object.assign({ TEST: "Environment vars work" }, process.env),
-  experimentalUseConpty: true
+  useConpty: true
 });
 
 ptyProcess.onData(data => process.stdout.write(data));

diff --git a/src/interfaces.ts b/src/interfaces.ts
@@ -125,7 +125,7 @@ export interface IPtyForkOptions extends IBasePtyForkOptions {
 }
 
 export interface IWindowsPtyForkOptions extends IBasePtyForkOptions {
-  experimentalUseConpty?: boolean;
+  useConpty?: boolean;
   conptyInheritCursor?: boolean;
 }
 

diff --git a/src/windowsTerminal.ts b/src/windowsTerminal.ts
@@ -46,7 +46,7 @@ export class WindowsTerminal extends Terminal {
     this._deferreds = [];
 
     // Create new termal.
-    this._agent = new WindowsPtyAgent(file, args, parsedEnv, cwd, this._cols, this._rows, false, opt.experimentalUseConpty, opt.conptyInheritCursor);
+    this._agent = new WindowsPtyAgent(file, args, parsedEnv, cwd, this._cols, this._rows, false, opt.useConpty, opt.conptyInheritCursor);
     this._socket = this._agent.outSocket;
 
     // Not available until `ready` event emitted.

diff --git a/typings/node-pty.d.ts b/typings/node-pty.d.ts
@@ -87,13 +87,13 @@ declare module 'node-pty' {
 
   export interface IWindowsPtyForkOptions extends IBasePtyForkOptions {
     /**
-     * Whether to use the experimental ConPTY system on Windows. When this is not set, ConPTY will
-     * be used when the Windows build number is >= 18309 (it's available in 17134 and 17692 but is
-     * too unstable to enable by default).
+     * Whether to use the ConPTY system on Windows. When this is not set, ConPTY will be used when
+     * the Windows build number is >= 18309 (instead of winpty). Note that ConPTY is available from
+     * build 17134 but is too unstable to enable by default.
      *
      * This setting does nothing on non-Windows.
      */
-    experimentalUseConpty?: boolean;
+    useConpty?: boolean;
 
     /**
      * Whether to use PSEUDOCONSOLE_INHERIT_CURSOR in conpty.