Skip to content

Commit e11bb55

Browse files
committed
docs: update
1 parent b1d6edf commit e11bb55

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/guide/package.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
本工具函数用于编写`nodejs`应用时使用,用来操作当前包工程。
44

5-
# getProjectRootPath
5+
## getProjectRootPath
66

77
返回当前包工程所在的根路径。
88

@@ -13,15 +13,15 @@ function getProjectRootPath(entryPath:string="./",exclueCurrent:boolean=false):s
1313
- `getProjectRootPath`会从指定的extryPath开始向上查找`package.json`文件
1414
- `entryPath`默认以当前路径为起点。
1515

16-
# getPackageJson
16+
## getPackageJson
1717

1818
返回当前工程的`package.json`文件内容
1919

2020
```typescript
2121
function getPackageJson()
2222
```
2323

24-
# getPackageTool
24+
## getPackageTool
2525

2626
返回当前项目所使用的包管理工具。
2727

@@ -31,7 +31,7 @@ function getPackageTool():('pnpm' | 'npm' | 'yarn')[]
3131

3232
- getPackageTool通过检查当前工程根目录下是否存在`pnpm-lock.yaml``yarn.lock`来判断当前工程所使用的包管理工具。
3333

34-
# installPackage
34+
## installPackage
3535

3636
安装指定的包。
3737

@@ -53,7 +53,7 @@ async function installPackage(packageName:string,options?:installPackageOptions)
5353
- 如果安装成功则返回`true`,否则返回`false`
5454
- `use`默认使用`pnpm`
5555

56-
# packageIsInstalled
56+
## packageIsInstalled
5757

5858
查询某个包是否已经安装。
5959

@@ -65,7 +65,7 @@ async function packageIsInstalled(packageName:string,checkGlobal:boolean=false):
6565
- `checkGlobal`参数用来指定是否在全局进行检查。
6666

6767

68-
# updatePackageJson
68+
## updatePackageJson
6969

7070
更新当前工程的`package.json`
7171

@@ -165,7 +165,7 @@ const args = process.argv.slice(2)
165165
})
166166
```
167167

168-
# getPackageEntry
168+
## getPackageEntry
169169

170170
读取包的入口文件,即`main`字段值
171171

0 commit comments

Comments
 (0)