fix: add init

Author: sj817

.github/workflows/release.yml

@@ -40,7 +40,7 @@ jobs:
       - run: npm run build
         if: ${{ steps.release.outputs.release_created }}
       # 增加install script
-      - run: npm pkg set "scripts.install"="node lib/scripts/index.js"
+      - run: npm pkg set "scripts.install"="node lib/scripts/main.js"
         if: ${{ steps.release.outputs.release_created }}
       # 删除开发依赖
       - run: npm pkg delete devDependencies

.gitignore

@@ -177,3 +177,4 @@ lib
 dist
 pnpm-lock.yaml
 package-lock.json
+build

README.en.md

@@ -83,4 +83,54 @@ This project is open-sourced under the MIT License. Thanks to the contributions
 - Copyright (c) 2018, Microsoft Corporation (MIT License)
 - Copyright (c) 2018, David Wilson (MIT License)
 - Copyright (c) 2018, oznu (MIT License)
-- Copyright (c) 2023, Homebridge (MIT License) 
+- Copyright (c) 2023, Homebridge (MIT License)
+
+## Usage Example
+
+```typescript
+import * as os from 'node:os'
+import * as pty from '@karinjs/node-pty'
+
+async function run () {
+  // Optional: Check and ensure binary compatibility with current environment
+  await pty.init()
+  
+  const shell = os.platform() === 'win32' ? 'powershell.exe' : 'bash'
+  const ptyProcess = pty.spawn(shell, [], {
+    name: 'xterm-color',
+    cols: 80,
+    rows: 30,
+    cwd: process.env.HOME,
+    env: process.env
+  })
+
+  ptyProcess.onData((data) => {
+    process.stdout.write(data)
+  })
+
+  ptyProcess.write('ls\r')
+  ptyProcess.resize(100, 40)
+  ptyProcess.write('ls\r')
+}
+
+run()
+```
+
+## API
+
+### Base API
+
+This package supports all original APIs from [@homebridge/node-pty-prebuilt-multiarch](https://github.com/homebridge/node-pty-prebuilt-multiarch).
+
+### Extended API
+
+We've added the following new API on top of the original ones:
+
+#### init()
+
+The `init()` method checks if the prebuilt binary is compatible with the current Node.js/Electron environment. This method is optional and is mainly useful in the following scenarios:
+
+- After switching Node.js or Electron versions, to verify compatibility
+- When you need to reinstall binaries compatible with the current environment
+
+> Tip: If you don't want to call the init() method, you can also directly run `npx pty` to reinstall binaries compatible with the current environment. 

README.md

@@ -85,3 +85,53 @@ npm install @homebridge/node-pty-prebuilt-multiarch:@karinjs/node-pty
 - Copyright (c) 2018, oznu (MIT License)
 - Copyright (c) 2023, Homebridge (MIT License)
 
+## 使用示例
+
+```typescript
+import * as os from 'node:os'
+import * as pty from '@karinjs/node-pty'
+
+async function run () {
+  // 可选: 检查并确保二进制文件与当前环境兼容
+  await pty.init()
+  
+  const shell = os.platform() === 'win32' ? 'powershell.exe' : 'bash'
+  const ptyProcess = pty.spawn(shell, [], {
+    name: 'xterm-color',
+    cols: 80,
+    rows: 30,
+    cwd: process.env.HOME,
+    env: process.env
+  })
+
+  ptyProcess.onData((data) => {
+    process.stdout.write(data)
+  })
+
+  ptyProcess.write('ls\r')
+  ptyProcess.resize(100, 40)
+  ptyProcess.write('ls\r')
+}
+
+run()
+```
+
+## API
+
+### 基础 API
+
+本包支持 [@homebridge/node-pty-prebuilt-multiarch](https://github.com/homebridge/node-pty-prebuilt-multiarch) 的所有原有 API。
+
+### 扩展 API
+
+在原有基础上，我们新增了以下 API：
+
+#### init()
+
+`init()` 方法用于检查预编译二进制文件是否与当前 Node.js/Electron 环境兼容。该方法是可选的，主要用于以下场景：
+
+- 更换 Node.js 或 Electron 版本后，需要验证兼容性
+- 需要重新安装适配当前环境的二进制文件
+
+> 提示：如果不想调用 init() 方法，也可以直接运行 `npx pty` 来重新安装适配当前环境的二进制文件。
+

index.js

@@ -0,0 +1,12 @@
+'use strict'
+Object.defineProperty(exports, '__esModule', { value: true })
+
+const pty = require('./lib/index.js')
+const main = require('./lib/scripts/index.js')
+
+exports.init = main.main
+exports.spawn = pty.spawn
+exports.fork = pty.fork
+exports.createTerminal = pty.createTerminal
+exports.open = pty.open
+exports.native = pty.native

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@karinjs/node-pty",
-  "main": "lib/index.js",
+  "main": "index.js",
   "types": "lib/index.d.ts",
   "version": "1.0.2",
   "description": "node-pty without compilation",
@@ -23,10 +23,15 @@
   },
   "license": "MIT",
   "author": "shijin",
+  "bin": {
+    "pty": "./lib/scripts/main.js"
+  },
   "scripts": {
-    "build": "tsup --tsconfig tsconfig.json --config tsup.config.ts",
+    "build": "tsc  && tsup --tsconfig tsconfig.json --config tsup.config.ts",
     "download": "tsx src/index.ts",
-    "pub": "npm publish --access public"
+    "test:install": "tsx src/install/index.ts",
+    "pub": "npm publish --access public",
+    "test": "node test.mjs"
   },
   "files": [
     "lib",

src/index.ts

@@ -27,8 +27,14 @@ const main = async () => {
   const data = fs.readFileSync(dts, 'utf-8')
   fs.writeFileSync(
     path.resolve(lib, 'index.d.ts'),
-    data.replace('@homebridge/node-pty-prebuilt-multiarch', _PKG_NAME)
-  )
+    data
+      .replace('@homebridge/node-pty-prebuilt-multiarch', _PKG_NAME)
+      .replace(new RegExp(`${_PKG_NAME}.*{.*`, 'g'), `${_PKG_NAME}' {
+  /**
+   * Initializes the pty module.
+   */
+  export function init (): Promise<void>
+`))
 
   /**
    * 递归删除lib文件夹下 后缀.map、 test.js后缀的

src/install/index.ts

@@ -5,6 +5,7 @@ import { logger } from '../common/log'
 import { getUrl } from './url'
 import { getFileName } from './filename'
 import { download, probe } from './download'
+import { VERSION_JSON_NAME } from '@/version'
 
 /**
  * 递归创建目录
@@ -20,47 +21,78 @@ const mkdir = (dir: string) => {
  * 获取基本路径
  */
 const getPath = () => {
+  /** 根目录 */
   const dir = path.resolve(__dirname, '../..')
+  /** 二进制根目录 */
   const build = path.resolve(dir, 'build')
+  /** package.json路径 */
   const pkg = path.resolve(dir, 'package.json')
-
-  const release = path.resolve(build, 'Release')
-  mkdir(release)
+  /** 保存当前二进制文件的json路径 */
+  const versionData = path.resolve(build, VERSION_JSON_NAME)
   return {
     dir,
     build,
     pkg,
-    release
+    versionData
+  }
+}
+
+/**
+ * 当前版本缓存
+ */
+const version = {
+  set: (name: string) => {
+    const dir = getPath().versionData
+    fs.writeFileSync(dir, JSON.stringify({ name }))
+  },
+  get: (): { name: string } | null => {
+    const dir = getPath().versionData
+    if (!fs.existsSync(dir)) {
+      return null
+    }
+    return JSON.parse(fs.readFileSync(dir, 'utf-8'))
   }
 }
 
 /**
  * 下载成功之后解压
  * @param data 下载的压缩包数据
  * @param destPath 目标路径
+ * @param fileName 缓存文件名称
  */
-const downloadAndUnzip = async (data: Buffer, destPath: string) => {
+const downloadAndUnzip = async (data: Buffer, destPath: string, fileName: string) => {
+  mkdir(destPath)
   await decompress(data, destPath)
   logger.info('unzip Success:', destPath)
+
+  version.set(fileName)
 }
 
 /**
- * 判断
+ * 主函数
+ * @param isForce 是否强制下载
+ * @param isExit 执行完成后是否退出
  */
-const main = async () => {
+export const main = async (isForce = false) => {
   try {
     const fileName = getFileName()
-    logger.info('name:', fileName)
 
+    /** 判断已下载版本是否一致 */
+    if (!isForce && version.get()?.name === fileName) {
+      return
+    }
+
+    logger.info('name:', fileName)
     const dir = getPath()
+
     const url = getUrl(fileName)
 
     if (url.custom) {
       logger.info('download URL:', url.custom)
 
       try {
         const customResult = await download(url.custom)
-        return await downloadAndUnzip(customResult, dir.dir)
+        return await downloadAndUnzip(customResult, dir.dir, fileName)
       } catch {
         logger.error('failed to download custom binary, fallback to default')
       }
@@ -71,13 +103,9 @@ const main = async () => {
     logger.info('download URL:', target)
 
     const data = await download(target)
-    await downloadAndUnzip(data, dir.dir)
+    await downloadAndUnzip(data, dir.dir, fileName)
   } catch (error) {
     logger.error('failed to download node-pty binary:')
     logger.error(error)
-  } finally {
-    process.exit(0)
   }
 }
-
-main()

src/install/main.ts

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+
+import { main } from '.'
+
+async function run () {
+  await main(true)
+  process.exit(0)
+}
+
+run()

src/install/url.ts

@@ -22,7 +22,7 @@ const getHostMirrorUrl = (pkgName: string) => {
  * @param fileName 文件名
  */
 const getGithubUrl = (fileName: string) => {
-  return `https://github.com/homebridge/${PKG_NAME}/releases/download/${VERSION}/${fileName}`
+  return `https://github.com/homebridge/${PKG_NAME}/releases/download/v${VERSION}/${fileName}`
 }
 
 /**