Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fjc0k/tbify
使用淘宝镜像运行命令: tbify [nvm|npm|npx|yarn|pnpm|...]
https://github.com/fjc0k/tbify
cnpm npm package-manager pnpm taobao taobao-mirror taobao-registry yarn
Last synced: 5 days ago
JSON representation
使用淘宝镜像运行命令: tbify [nvm|npm|npx|yarn|pnpm|...]
- Host: GitHub
- URL: https://github.com/fjc0k/tbify
- Owner: fjc0k
- License: mit
- Created: 2020-04-29T12:04:41.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-15T12:31:13.000Z (about 1 year ago)
- Last Synced: 2025-01-10T02:05:59.987Z (12 days ago)
- Topics: cnpm, npm, package-manager, pnpm, taobao, taobao-mirror, taobao-registry, yarn
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/tbify
- Size: 244 KB
- Stars: 209
- Watchers: 3
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# tbify
使用 [淘宝 NPM 镜像](https://developer.aliyun.com/mirror/NPM) 加速包管理工具安装依赖的速度。
---
- [原理](#原理)
- [安装](#安装)
- [使用](#使用)
- [手动同步 NPM 包到淘宝镜像](#手动同步-npm-包到淘宝镜像)
- [鸣谢](#鸣谢)
- [许可](#许可)
## 原理
基于环境变量对国内请求速度欠佳的资源地址进行了替换，具体分为两点：
- 通过环境变量令包管理工具（`npm`、`npx`、`yarn`、`pnpm`、`pnpx`）使用淘宝源安装依赖；
- 通过环境变量令诸如 `nvm`、`fnm`、`node-sass`、`Electron`、`Puppeteer`、`Cypress`、`Sharp`、`Prisma` 等工具或包使用淘宝镜像安装其自身所需资源。
以上，本工具对包管理工具本身零侵入，同时，对环境变量的设置也是一次性的，并不会产生任何的副作用，请放心使用。
## 安装
```bash
# npm
npm install tbify --global
# yarn
yarn global add tbify
# pnpm
pnpm add --global tbify
```
## 使用
对于常用的包管理命令，`tbify` 提供了使用淘宝 NPM 镜像的等价命令，除了发布包到 npm 时必须使用 `npm publish` 外，都可以使用等价命令进行相关操作：
| 原命令 | 使用淘宝 NPM 镜像的命令 | 示例 |
| ------ | ----------------------------------------------------------------------------- | --------------------- |
| `nvm` | `tnvm` / `tbify nvm` | `tnvm install 8.0.0` |
| `fnm` | `tfnm` / `tbify fnm` | `tfnm install 20` |
| `npm` | `tnpm` / `tbify npm` | `tnpm install react` |
| `npx` | `tnpx` / `tbify npx` | `tnpx kill-port 3000` |
| `yarn` | `tyn` / `tyarn` / `tbify yarn` | `tyn add react` |
| `pnpm` | `tpm` (Windows 下该命令被系统占用，请使用后面的替代) / `tpnpm` / `tbify pnpm` | `tpm add react` |
| `pnpx` | `tpx` / `tpnpx` / `tbify pnpx` | `tpx kill-port 3000` |
对于其他命令，在使用时加上 `tbify` 前缀即可，比如：
```bash
tbify printenv npm_config_registry
# -> https://registry.npmmirror.com
```
若想覆盖内部的环境变量值，可在使用 `tbify` 前设置：
```bash
npm_config_registry=https://my.npm.mirror tbify printenv npm_config_registry
# -> https://my.npm.mirror
```
## 手动同步 NPM 包到淘宝镜像
可以通过 `tsync` 或 `tbify sync` 命令手动同步一个或多个 NPM 包到淘宝镜像。
```bash
# 一个
tsync vue
# 多个
tsync vue react
```
## 鸣谢
正所谓前人栽树后人乘凉，感谢 [@fengmk2](https://github.com/fengmk2) 大佬及 [cnpm 团队](https://github.com/cnpm) 为提供一个优质国内镜像所作出的努力！👍
同时本工具从 [@yiminghe](https://github.com/yiminghe) 大佬的 [tyarn](https://github.com/yiminghe/tyarn) 项目借鉴了很多思路，一并表示感谢！💐
## 许可
Jay Fong (c) MIT