Skip to content

Commit 199e285

Browse files
sj817sj817
committed
fix: bun乱加的peerDependencies
1 parent 4f7cd64 commit 199e285

File tree

3 files changed

+172
-4
lines changed

3 files changed

+172
-4
lines changed

‎README.en.md‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# @karinjs/node-pty
2+
3+
A lightweight prebuilt node-pty package, optimized based on [@homebridge/node-pty-prebuilt-multiarch](https://github.com/homebridge/node-pty-prebuilt-multiarch).
4+
5+
English | [简体中文](./README.md)
6+
7+
## Features
8+
9+
- 🚀 Ultra-lightweight: Removed source code, keeping only necessary prebuilt binaries
10+
- 🇨🇳 China-friendly: Uses npmmirror.com mirror by default
11+
- 💪 Multi-arch support: Supports major operating systems and CPU architectures
12+
- 🔧 Ready to use: No compilation needed, supports multiple package managers
13+
14+
> [!WARNING]
15+
> Currently only tested in Windows Node.js environment. Compatibility with other environments (Linux, macOS, etc.) needs to be verified by users. Feedback is welcome if you encounter any issues.
16+
17+
## Installation
18+
19+
Using npm:
20+
21+
```bash
22+
npm install @karinjs/node-pty
23+
```
24+
25+
Using yarn:
26+
27+
```bash
28+
yarn add @karinjs/node-pty
29+
```
30+
31+
Using pnpm:
32+
33+
```bash
34+
pnpm add @karinjs/node-pty
35+
```
36+
37+
Using aliases:
38+
39+
```bash
40+
npm install node-ptym:@karinjs/node-pty
41+
# or
42+
npm install @homebridge/node-pty-prebuilt-multiarch:@karinjs/node-pty
43+
```
44+
45+
## Supported Environments
46+
47+
| OS | Architectures |
48+
| ------------- | ------------------------- |
49+
| macOS | x64, arm64 |
50+
| Linux (glibc) | ia32, x64, armv6, aarch64 |
51+
| Linux (musl) | x64, armv6, aarch64 |
52+
| Windows | ia32, x64 |
53+
54+
> Note: Only supports Node.js 16+ and Electron 16.0.0+ (excluding Electron 28)
55+
56+
## Notes
57+
58+
Since this package is distributed in prebuilt form, installation depends on network stability. If you encounter download issues, you can:
59+
60+
1. Use a proxy
61+
2. Switch to another package manager
62+
3. Retry installation multiple times
63+
64+
## Version Mapping
65+
66+
| @karinjs/node-pty | @homebridge/node-pty-prebuilt-multiarch |
67+
| ----------------- | --------------------------------------- |
68+
| 1.0.1 | 0.11.14 |
69+
70+
## Upstream Projects
71+
72+
This project is based on these excellent open source projects:
73+
74+
- [microsoft/node-pty](https://github.com/microsoft/node-pty) - Original node-pty project
75+
- [homebridge/node-pty-prebuilt-multiarch](https://github.com/homebridge/node-pty-prebuilt-multiarch) - Provides multi-architecture prebuilt support
76+
77+
## License
78+
79+
This project is open-sourced under the MIT License. Thanks to the contributions from:
80+
81+
- Copyright (c) 2012-2015, Christopher Jeffrey (MIT License)
82+
- Copyright (c) 2016, Daniel Imms (MIT License)
83+
- Copyright (c) 2018, Microsoft Corporation (MIT License)
84+
- Copyright (c) 2018, David Wilson (MIT License)
85+
- Copyright (c) 2018, oznu (MIT License)
86+
- Copyright (c) 2023, Homebridge (MIT License)

‎README.md‎

Lines changed: 86 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,87 @@
11
# @karinjs/node-pty
2-
2+
3+
一个轻量级的 node-pty 预编译包,基于 [@homebridge/node-pty-prebuilt-multiarch](https://github.com/homebridge/node-pty-prebuilt-multiarch) 优化。
4+
5+
[English](./README.en.md) | 简体中文
6+
7+
## 特点
8+
9+
- 🚀 极致轻量: 移除源代码,仅保留必要的预编译二进制文件
10+
- 🇨🇳 国内加速: 默认使用 npmmirror.com 镜像,无需额外配置
11+
- 💪 多架构支持: 支持主流操作系统和CPU架构
12+
- 🔧 开箱即用: 无需编译,支持多种包管理器
13+
14+
> [!WARNING]
15+
> 目前仅在 Windows Node.js 环境下完成测试。其他环境（Linux、macOS等）的兼容性需要用户自行验证。如遇到问题，欢迎反馈。
16+
17+
## 安装
18+
19+
使用 npm:
20+
21+
```bash
22+
npm install @karinjs/node-pty
23+
```
24+
25+
使用 yarn:
26+
27+
```bash
28+
yarn add @karinjs/node-pty
29+
```
30+
31+
使用 pnpm:
32+
33+
```bash
34+
pnpm add @karinjs/node-pty
35+
```
36+
37+
使用别名安装:
38+
39+
```bash
40+
npm install node-pty:@karinjs/node-pty
41+
# or
42+
npm install @homebridge/node-pty-prebuilt-multiarch:@karinjs/node-pty
43+
```
44+
45+
## 支持的环境
46+
47+
| 操作系统 | 架构 |
48+
| ------------- | ------------------------- |
49+
| macOS | x64, arm64 |
50+
| Linux (glibc) | ia32, x64, armv6, aarch64 |
51+
| Linux (musl) | x64, armv6, aarch64 |
52+
| Windows | ia32, x64 |
53+
54+
> 注意: 仅支持 Node.js 16+ 和 Electron 16.0.0+ 版本(不含 Electron 28)
55+
56+
## 注意事项
57+
58+
由于采用预编译的方式分发,包的安装依赖于网络环境的稳定性。如果遇到下载问题,可以:
59+
60+
1. 使用代理
61+
2. 切换到其他包管理器
62+
3. 多次重试安装
63+
64+
## 版本对照
65+
66+
| @karinjs/node-pty | @homebridge/node-pty-prebuilt-multiarch |
67+
| ----------------- | --------------------------------------- |
68+
| 1.0.1 | 0.11.14 |
69+
70+
## 上游项目
71+
72+
本项目基于以下优秀的开源项目:
73+
74+
- [microsoft/node-pty](https://github.com/microsoft/node-pty) - 原始的 node-pty 项目
75+
- [homebridge/node-pty-prebuilt-multiarch](https://github.com/homebridge/node-pty-prebuilt-multiarch) - 提供多架构预编译支持
76+
77+
## 开源许可
78+
79+
本项目基于 MIT 协议开源。感谢以下项目的贡献:
80+
81+
- Copyright (c) 2012-2015, Christopher Jeffrey (MIT License)
82+
- Copyright (c) 2016, Daniel Imms (MIT License)
83+
- Copyright (c) 2018, Microsoft Corporation (MIT License)
84+
- Copyright (c) 2018, David Wilson (MIT License)
85+
- Copyright (c) 2018, oznu (MIT License)
86+
- Copyright (c) 2023, Homebridge (MIT License)
87+

‎package.json‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,6 @@
4444
"tsx": "^4.19.3",
4545
"typescript": "^5.8.2"
4646
},
47-
"peerDependencies": {
48-
"typescript": "^5.0.0"
49-
},
5047
"engines": {
5148
"node": ">=16"
5249
},

0 commit comments

Comments
 (0)