Skip to content

Commit 42ffc7f

Browse files
committed
remove requirement to enforce yarn
1 parent e6a369d commit 42ffc7f

4 files changed

Lines changed: 27 additions & 29 deletions

File tree

.github/workflows/build_release.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ jobs:
3939
- name: Build Linux
4040
if: matrix.os == 'ubuntu-latest'
4141
run: |
42-
yarn run build:linux
42+
npm run build:linux
4343
cp dist/linux-unpacked/resources/app.asar dist/app.asar
4444
4545
# prepare for amd64 deb
@@ -99,13 +99,13 @@ jobs:
9999
- name: Build Windows
100100
if: matrix.os == 'windows-latest'
101101
run: |
102-
yarn run build:win
102+
npm run build:win
103103
rm -r dist/win-unpacked
104104
rm -r dist/win-arm64-unpacked
105105
- name: Build macOS
106106
if: matrix.os == 'macos-latest'
107107
run: |
108-
yarn run build:mac
108+
npm run build:mac
109109
rm -rf dist/mac
110110
rm -rf dist/mac-arm64
111111
- name: Show build files

docs/en/developer-guide/CONTRIBUTING.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ First make sure you have installed these below on your computer:
66

77
- Git
88
- Node.js >= 18
9-
- Yarn (our recommended version is 1.22.19, and it can be installed with `npm install -g yarn`)
109

1110
Then get the source code.
1211

@@ -25,27 +24,27 @@ git clone --recursive --depth=1 https://github.com/[your username]/bbg.git
2524
Then go to the project root directory and execute command below to install dependencies:
2625

2726
```sh
28-
yarn install
27+
npm install
2928
```
3029

3130
## Commonly used commands
3231

3332
### Start a BBG instance (with debugging tools)
3433

3534
```sh
36-
yarn run dev
35+
npm run dev
3736
```
3837

3938
### Start a BBG instance (with debugging tools and hot reload)
4039

4140
```sh
42-
yarn run dev_with_hot_reload
41+
npm run dev_with_hot_reload
4342
```
4443

4544
### Start a BBG instance (without debugging tools, the same as the production environment)
4645

4746
```sh
48-
yarn run start
47+
npm run start
4948
```
5049

5150
### Build packages
@@ -55,9 +54,9 @@ yarn run start
5554
> If you are building a package for Windows on the Linux platform, you need to install Wine.
5655
5756
```sh
58-
yarn run build:win
59-
yarn run build:linux
60-
yarn run build:mac
57+
npm run build:win
58+
npm run build:linux
59+
npm run build:mac
6160
```
6261

6362
### View documents locally
@@ -67,7 +66,7 @@ This project uses Docsify to manage documentation.
6766
You can use the following command to open the documentation.
6867

6968
```sh
70-
yarn run read_doc
69+
npm run read_doc
7170
```
7271

7372
You can also visit <http://localhost:23941>.
@@ -77,9 +76,9 @@ You can also visit <http://localhost:23941>.
7776
You can use ESLint in the project:
7877

7978
```sh
80-
yarn run lint
81-
yarn run lint:fix
82-
yarn run lint:html
79+
npm run lint
80+
npm run lint:fix
81+
npm run lint:html
8382
```
8483

8584
## What do these files mean? / I want to modify a function, where should I start?

docs/zh-cn/developer-guide/CONTRIBUTING.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66

77
- Git
88
- Node.js >= 18
9-
- Yarn(我们推荐使用 1.22.19 版本,可以在安装 Node.js 和 NPM 之后使用`npm install -g yarn`安装)
109

1110
然后使用 Git 获取源代码。
1211

@@ -25,7 +24,7 @@ git clone --recursive --depth=1 https://github.com/[your username]/bbg.git
2524
然后转到项目根目录下执行以下命令安装依赖:
2625

2726
```sh
28-
yarn install
27+
npm install
2928
```
3029

3130
如果遇到 Electron 不能正常下载的问题,请尝试使用 `ELECTRON_MIRROR="https://npmmirror.com/mirrors/electron/"` 环境变量。
@@ -35,19 +34,19 @@ yarn install
3534
### 启动一个 BBG 实例(带有调试工具)
3635

3736
```sh
38-
yarn run dev
37+
npm run dev
3938
```
4039

4140
### 启动一个 BBG 实例(带有调试工具和热重载)
4241

4342
```sh
44-
yarn run dev_with_hot_reload
43+
npm run dev_with_hot_reload
4544
```
4645

4746
### 启动一个 BBG 实例(不带有调试工具,同生产环境一致)
4847

4948
```sh
50-
yarn run start
49+
npm run start
5150
```
5251

5352
### 生成软件包
@@ -57,9 +56,9 @@ yarn run start
5756
> 如果你在 Linux 平台生成适用于 Windows 的软件包,需要提前安装 Wine。
5857
5958
```sh
60-
yarn run build:win
61-
yarn run build:linux
62-
yarn run build:mac
59+
npm run build:win
60+
npm run build:linux
61+
npm run build:mac
6362
```
6463

6564
由于 global-agent 的一个问题,部分系统配置下打包时可能会遇到 `Unsupported 'GLOBAL_AGENT.HTTP_PROXY' configuration`的错误,解决方法是执行以下命令来重新指定正确的 Proxy 配置:
@@ -76,7 +75,7 @@ export GLOBAL_AGENT_HTTP_PROXY=http://host:port
7675
本项目使用 Docsify 来管理项目文档。你可以使用如下命令打开文档。
7776

7877
```
79-
yarn run read_doc
78+
npm run read_doc
8079
```
8180

8281
然后访问 <http://localhost:23941>
@@ -86,9 +85,9 @@ yarn run read_doc
8685
你可以在本项目中使用 ESLint:
8786

8887
```sh
89-
yarn run lint
90-
yarn run lint:fix
91-
yarn run lint:html
88+
npm run lint
89+
npm run lint:fix
90+
npm run lint:html
9291
```
9392

9493
## 这些文件都是什么意思?/我想修改 XXX 功能,应该从哪里开始?

docs/zh-cn/developer-guide/publish_new_version.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ BBG 生成博客的数据文件中记录了上次被打开编辑时使用的是
2626
然后先在 BBG 代码仓库根目录下执行如下命令更新`package.json``App.json`中的版本号。
2727

2828
```
29-
yarn run modify_version_number
29+
npm run modify_version_number
3030
```
3131

3232
然后执行如下命令:
@@ -37,4 +37,4 @@ git commit -m "bump to version <新的版本号>"
3737
git push
3838
git tag -a <新的版本号> -m "bump to version <新的版本号>"
3939
git push origin --tags
40-
```
40+
```

0 commit comments

Comments
 (0)