https://github.com/dext7r/pnpmturbo
基于pnpm Turbopack 构建高效流前端工作链~
https://github.com/dext7r/pnpmturbo
h7ml pnpm turbo turbopack
Last synced: 2 months ago
JSON representation
基于pnpm Turbopack 构建高效流前端工作链~
- Host: GitHub
- URL: https://github.com/dext7r/pnpmturbo
- Owner: dext7r
- License: mit
- Created: 2023-02-27T14:47:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-29T08:13:53.000Z (about 1 year ago)
- Last Synced: 2024-09-11T12:05:10.963Z (about 1 year ago)
- Topics: h7ml, pnpm, turbo, turbopack
- Language: JavaScript
- Homepage: https://pnpm-turbo-docs.vercel.app
- Size: 13.4 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Turbopack
Turbopack是一个基于pnpm的高效流前端工作链项目，旨在为前端开发者提供快速、高效的开发体验。本项目支持实时编译、自动化测试、代码压缩和自动部署等功能，可以帮助开发者更快地构建优质的前端应用。
## 安装
使用pnpm安装Turbopack：
```
pnpm install turbopack -g
```
## 使用
### 初始化项目
使用Turbopack初始化一个新的项目：
```
turbopack init myproject
```
这将创建一个名为myproject的新项目，并在其中包含一些示例文件和目录结构。
### 开始开发
进入项目目录，并运行以下命令来启动开发服务器：
```bash
cd myproject
turbopack start
```
这将启动一个开发服务器，监听在localhost:3000上，并在每次保存文件时自动重新编译。
### 运行测试
运行以下命令来执行测试：
```bash
turbopack test
```
这将运行项目中的所有测试。
### 构建项目
运行以下命令来构建项目：
```bash
turbopack build
```
这将生成一个优化后的、压缩后的版本的项目文件，可以直接用于生产环境部署。
### 自动部署
可以使用Turbopack自动部署项目到远程服务器。在项目根目录下创建一个名为deploy.config.js的文件，并在其中配置远程服务器信息。例如：
```js
module.exports = {
host: 'myserver.com',
username: 'myusername',
password: 'mypassword',
path: '/path/to/my/project',
}
```
然后运行以下命令来部署项目：
```bash
turbopack deploy
```
### 配置
Turbopack支持通过配置文件来定制项目的行为。在项目根目录下创建一个名为turbopack.config.js的文件，并在其中指定配置选项。例如：
#### turbopack.config.js
```javascript
module.exports = {
entry: './src/index.js',
output: {
path: './dist',
filename: 'bundle.js',
},
plugins: [
new MyPlugin(),
],
}
```
#### turbo.json
turbo.json是Turbopack工具的配置文件，用于指定一些工具的行为和选项。它是一个JSON格式的文件，应该位于项目的根目录下。
在turbo.json文件中，你可以指定如下选项：
1. entry：入口文件的路径，通常是项目的主要JavaScript文件。
2. output：输出文件的路径和文件名。
3. plugins：插件列表，用于对构建过程进行自定义的扩展。
4. externals：外部依赖列表，用于指定哪些模块应该被视为外部依赖而不被打包进构建文件中。
5. 此外，你还可以在turbo.json文件中指定许多其他选项，例如：
> mode：构建模式，可以是development或production。
> devServer：开发服务器的配置选项。
> resolve：模块解析选项，用于指定模块的搜索路径和别名。
> module：模块的加载和转换选项，用于处理各种类型的文件。
> optimization：优化选项，用于优化构建输出文件的大小和性能。
> performance：性能选项，用于控制构建过程中的性能警告和错误。
> Turbopack工具会读取项目中的turbo.json文件，并根据其中的选项进行构建和处理。
### 详细的配置选项请参考Turbopack文档。
### 贡献
欢迎为Turbopack做出贡献！请提交问题和拉取请求到GitHub存储库。
### 许可证
本项目基于MIT许可证发布，详情请参见LICENSE文件。