forked from datawhale/whale-town-end
chore:切换包管理器为pnpm(替换yarn)
This commit is contained in:
7
.gitignore
vendored
7
.gitignore
vendored
@@ -1,7 +1,6 @@
|
|||||||
# 依赖
|
# 依赖
|
||||||
node_modules/
|
node_modules/
|
||||||
yarn.lock
|
pnpm-lock.yaml
|
||||||
package-lock.json
|
|
||||||
|
|
||||||
# 构建输出
|
# 构建输出
|
||||||
dist/
|
dist/
|
||||||
@@ -15,9 +14,7 @@ build/
|
|||||||
|
|
||||||
# 日志
|
# 日志
|
||||||
*.log
|
*.log
|
||||||
npm-debug.log*
|
pnpm-debug.log*
|
||||||
yarn-debug.log*
|
|
||||||
yarn-error.log*
|
|
||||||
|
|
||||||
# 操作系统
|
# 操作系统
|
||||||
.DS_Store
|
.DS_Store
|
||||||
|
|||||||
33
README.md
33
README.md
@@ -91,33 +91,50 @@ git commit -m "api:添加玩家信息查询接口"
|
|||||||
## 前置要求
|
## 前置要求
|
||||||
|
|
||||||
- **Node.js** >= 18.0.0
|
- **Node.js** >= 18.0.0
|
||||||
- **Yarn** >= 1.22.0(推荐)或 npm >= 9.0.0
|
- **pnpm** >= 8.0.0(推荐)
|
||||||
|
|
||||||
如果还没有安装 Yarn,请先安装:
|
如果还没有安装 pnpm,请先安装:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install -g yarn
|
npm install -g pnpm
|
||||||
```
|
```
|
||||||
|
|
||||||
检查版本:
|
检查版本:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
node --version
|
node --version
|
||||||
yarn --version
|
pnpm --version
|
||||||
```
|
```
|
||||||
|
|
||||||
## 安装依赖
|
## 安装依赖
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
yarn install
|
pnpm install
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**注意**:首次安装时,pnpm 可能会提示需要批准构建脚本。这是 pnpm 的安全特性,用于防止恶意脚本执行。
|
||||||
|
|
||||||
|
如果看到以下警告:
|
||||||
|
|
||||||
|
```
|
||||||
|
Warning: Ignored build scripts: @nestjs/core.
|
||||||
|
Run "pnpm approve-builds" to pick which dependencies should be allowed to run scripts.
|
||||||
|
```
|
||||||
|
|
||||||
|
请运行以下命令批准 NestJS 的构建脚本:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pnpm approve-builds
|
||||||
|
```
|
||||||
|
|
||||||
|
然后选择批准 `@nestjs/core` 和其他 NestJS 相关包的构建脚本。
|
||||||
|
|
||||||
## 开发
|
## 开发
|
||||||
|
|
||||||
启动开发服务器(支持热重载):
|
启动开发服务器(支持热重载):
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
yarn dev
|
pnpm dev
|
||||||
```
|
```
|
||||||
|
|
||||||
服务器将运行在 `http://localhost:3000`
|
服务器将运行在 `http://localhost:3000`
|
||||||
@@ -125,13 +142,13 @@ yarn dev
|
|||||||
## 构建
|
## 构建
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
yarn build
|
pnpm build
|
||||||
```
|
```
|
||||||
|
|
||||||
## 生产环境运行
|
## 生产环境运行
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
yarn start:prod
|
pnpm start:prod
|
||||||
```
|
```
|
||||||
|
|
||||||
## 项目结构
|
## 项目结构
|
||||||
|
|||||||
@@ -158,7 +158,7 @@ export class PlayerService {
|
|||||||
### 安装依赖
|
### 安装依赖
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
yarn add @nestjs/websockets @nestjs/platform-socket.io socket.io
|
pnpm add @nestjs/websockets @nestjs/platform-socket.io socket.io
|
||||||
```
|
```
|
||||||
|
|
||||||
### Gateway 示例
|
### Gateway 示例
|
||||||
@@ -243,7 +243,7 @@ export class GameModule {}
|
|||||||
### 安装依赖
|
### 安装依赖
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
yarn add class-validator class-transformer
|
pnpm add class-validator class-transformer
|
||||||
```
|
```
|
||||||
|
|
||||||
### DTO 示例
|
### DTO 示例
|
||||||
|
|||||||
2
pnpm-workspace.yaml
Normal file
2
pnpm-workspace.yaml
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
ignoredBuiltDependencies:
|
||||||
|
- '@nestjs/core'
|
||||||
Reference in New Issue
Block a user