node-pty 1.1.0-beta4 → 1.1.0-beta40

package/scripts/post-install.js

@@ -1,8 +1,11 @@
-var fs = require('fs');
-var path = require('path');
+//@ts-check
 
-var RELEASE_DIR = path.join(__dirname, '..', 'build', 'Release');
-var BUILD_FILES = [
+const fs = require('fs');
+const os = require('os');
+const path = require('path');
+
+const RELEASE_DIR = path.join(__dirname, '../build/Release');
+const BUILD_FILES = [
   path.join(RELEASE_DIR, 'conpty.node'),
   path.join(RELEASE_DIR, 'conpty.pdb'),
   path.join(RELEASE_DIR, 'conpty_console_list.node'),
@@ -15,14 +18,19 @@ var BUILD_FILES = [
   path.join(RELEASE_DIR, 'winpty.dll'),
   path.join(RELEASE_DIR, 'winpty.pdb')
 ];
+const CONPTY_DIR = path.join(__dirname, '../third_party/conpty');
+const CONPTY_SUPPORTED_ARCH = ['x64', 'arm64'];
+
+console.log('\x1b[32m> Cleaning release folder...\x1b[0m');
 
-cleanFolderRecursive = function(folder) {
+/** @param {string} folder  */
+function cleanFolderRecursive(folder) {
   var files = [];
-  if( fs.existsSync(folder) ) {
+  if (fs.existsSync(folder)) {
     files = fs.readdirSync(folder);
     files.forEach(function(file,index) {
       var curPath = path.join(folder, file);
-      if(fs.lstatSync(curPath).isDirectory()) { // recurse
+      if (fs.lstatSync(curPath).isDirectory()) { // recurse
         cleanFolderRecursive(curPath);
         fs.rmdirSync(curPath);
       } else if (BUILD_FILES.indexOf(curPath) < 0){ // delete file
@@ -36,7 +44,37 @@ try {
   cleanFolderRecursive(RELEASE_DIR);
 } catch(e) {
   console.log(e);
-  //process.exit(1);
-} finally {
-  process.exit(0);
+  process.exit(1);
+}
+
+console.log(`\x1b[32m> Moving conpty.dll...\x1b[0m`);
+if (os.platform() !== 'win32') {
+  console.log('  SKIPPED (not Windows)');
+} else {
+  let windowsArch;
+  if (process.env.npm_config_arch) {
+    windowsArch = process.env.npm_config_arch;
+    console.log(`  Using $npm_config_arch: ${windowsArch}`);
+  } else {
+    windowsArch = os.arch();
+    console.log(`  Using os.arch(): ${windowsArch}`);
+  }
+
+  if (!CONPTY_SUPPORTED_ARCH.includes(windowsArch)) {
+    console.log(`  SKIPPED (unsupported architecture ${windowsArch})`);
+  } else {
+    const versionFolder = fs.readdirSync(CONPTY_DIR)[0];
+    console.log(`  Found version ${versionFolder}`);
+    const sourceFolder = path.join(CONPTY_DIR, versionFolder, `win10-${windowsArch}`);
+    const destFolder = path.join(RELEASE_DIR, 'conpty');
+    fs.mkdirSync(destFolder, { recursive: true });
+    for (const file of ['conpty.dll', 'OpenConsole.exe']) {
+      const sourceFile = path.join(sourceFolder, file);
+      const destFile = path.join(destFolder, file);
+      console.log(`  Copying ${sourceFile} -> ${destFile}`);
+      fs.copyFileSync(sourceFile, destFile);
+    }
+  }
 }
+
+process.exit(0);

package/scripts/prebuild.js

@@ -0,0 +1,35 @@
+//@ts-check
+
+const fs = require('fs');
+const path = require('path');
+
+/**
+ * This script checks for the prebuilt binaries for the current platform and
+ * architecture. It exits with 0 if prebuilds are found and 1 if not.
+ *
+ * If npm_config_build_from_source is set then it removes the prebuilds for the
+ * current platform so they are not loaded at runtime.
+ *
+ * Usage:
+ *     node scripts/prebuild.js
+ */
+
+const PREBUILDS_ROOT = path.join(__dirname, '..', 'prebuilds');
+const PREBUILD_DIR = path.join(__dirname, '..', 'prebuilds', `${process.platform}-${process.arch}`);
+
+// Do not use prebuilds when npm_config_build_from_source is set
+if (process.env.npm_config_build_from_source === 'true') {
+  console.log('\x1b[33m> Removing prebuilds and rebuilding because npm_config_build_from_source is set\x1b[0m');
+  fs.rmSync(PREBUILDS_ROOT, { recursive: true, force: true });
+  process.exit(1);
+}
+
+// Check whether the correct prebuilt files exist
+console.log('\x1b[32m> Checking prebuilds...\x1b[0m');
+if (!fs.existsSync(PREBUILD_DIR)) {
+  console.log(`\x1b[33m> Removing prebuilds and rebuilding because directory ${PREBUILD_DIR} does not exist\x1b[0m`);
+  fs.rmSync(PREBUILDS_ROOT, { recursive: true, force: true });
+  process.exit(1);
+}
+
+process.exit(0);

package/src/conpty_console_list_agent.ts

@@ -6,13 +6,9 @@
  * single console attached to a process.
  */
 
-let getConsoleProcessList: any;
-try {
-  getConsoleProcessList = require('../build/Release/conpty_console_list.node').getConsoleProcessList;
-} catch (err) {
-  getConsoleProcessList = require('../build/Debug/conpty_console_list.node').getConsoleProcessList;
-}
+import { loadNativeModule } from './utils';
 
+const getConsoleProcessList = loadNativeModule('conpty_console_list').module.getConsoleProcessList;
 const shellPid = parseInt(process.argv[2], 10);
 const consoleProcessList = getConsoleProcessList(shellPid);
 process.send!({ consoleProcessList });

package/src/index.ts

@@ -6,6 +6,7 @@
 
 import { ITerminal, IPtyOpenOptions, IPtyForkOptions, IWindowsPtyForkOptions } from './interfaces';
 import { ArgvOrCommandLine } from './types';
+import { loadNativeModule } from './utils';
 
 let terminalCtor: any;
 if (process.platform === 'win32') {
@@ -48,4 +49,4 @@ export function open(options: IPtyOpenOptions): ITerminal {
  * Expose the native API when not Windows, note that this is not public API and
  * could be removed at any time.
  */
-export const native = (process.platform !== 'win32' ? require('../build/Release/pty.node') : null);
+export const native = (process.platform !== 'win32' ? loadNativeModule('pty').module : null);

package/src/interfaces.ts

@@ -22,7 +22,7 @@ export interface ITerminal {
    * Writes data to the socket.
    * @param data The data to write.
    */
-  write(data: string): void;
+  write(data: string | Buffer): void;
 
   /**
    * Resize the pty.
@@ -119,6 +119,7 @@ export interface IPtyForkOptions extends IBasePtyForkOptions {
 
 export interface IWindowsPtyForkOptions extends IBasePtyForkOptions {
   useConpty?: boolean;
+  useConptyDll?: boolean;
   conptyInheritCursor?: boolean;
 }
 

package/src/native.d.ts

@@ -3,11 +3,11 @@
  */
 
 interface IConptyNative {
-  startProcess(file: string, cols: number, rows: number, debug: boolean, pipeName: string, conptyInheritCursor: boolean): IConptyProcess;
-  connect(ptyId: number, commandLine: string, cwd: string, env: string[], onExitCallback: (exitCode: number) => void): { pid: number };
-  resize(ptyId: number, cols: number, rows: number): void;
-  clear(ptyId: number): void;
-  kill(ptyId: number): void;
+  startProcess(file: string, cols: number, rows: number, debug: boolean, pipeName: string, conptyInheritCursor: boolean, useConptyDll: boolean): IConptyProcess;
+  connect(ptyId: number, commandLine: string, cwd: string, env: string[], useConptyDll: boolean, onExitCallback: (exitCode: number) => void): { pid: number };
+  resize(ptyId: number, cols: number, rows: number, useConptyDll: boolean): void;
+  clear(ptyId: number, useConptyDll: boolean): void;
+  kill(ptyId: number, useConptyDll: boolean): void;
 }
 
 interface IWinptyNative {

package/src/terminal.test.ts

@@ -23,7 +23,7 @@ class TestTerminal extends Terminal {
   public checkType<T>(name: string, value: T, type: string, allowArray: boolean = false): void {
     this._checkType(name, value, type, allowArray);
   }
-  protected _write(data: string): void {
+  protected _write(data: string | Buffer): void {
     throw new Error('Method not implemented.');
   }
   public resize(cols: number, rows: number): void {

package/src/terminal.ts

@@ -74,9 +74,9 @@ export abstract class Terminal implements ITerminal {
     this._checkType('encoding', opt.encoding ? opt.encoding : undefined, 'string');
   }
 
-  protected abstract _write(data: string): void;
+  protected abstract _write(data: string | Buffer): void;
 
-  public write(data: string): void {
+  public write(data: string | Buffer): void {
     if (this.handleFlowControl) {
       // PAUSE/RESUME messages are not forwarded to the pty
       if (data === this._flowControlPause) {