chore: config gofumpt

This commit is contained in:
Fu Diwei 2024-10-15 21:14:33 +08:00
parent 7ef885319e
commit cf3de10eff
3 changed files with 27 additions and 4 deletions

12
.vscode/settings.json vendored
View File

@ -6,5 +6,15 @@
"source.fixAll.eslint": "explicit"
},
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true
"editor.formatOnSave": true,
"go.useLanguageServer": true,
"gopls": {
"formatting.gofumpt": true,
},
"[go]": {
"editor.defaultFormatter": "golang.go"
},
"[typescript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
}
}

View File

@ -28,6 +28,7 @@ git clone https://github.com/your_username/certimate.git
1. 进入根目录
2. 运行以下命令启动服务:
```bash
go run main.go serve
```
@ -36,11 +37,12 @@ git clone https://github.com/your_username/certimate.git
**在向主仓库提交 PR 之前,建议你:**
- 使用 [gofumpt](https://github.com/mvdan/gofumpt) 对你的代码进行格式化。
- 为你的改动添加单元测试或集成测试Certimate 使用 Go 的标准 `testing` 包)。你可以通过以下命令运行测试(在项目根目录下):
```bash
go test ./...
```
## 修改管理页面 (Admin UI)
@ -49,9 +51,12 @@ Certimate 的管理页面是一个基于 React 和 Vite 构建的单页应用(
要启动 Admin UI
1. 进入 `ui` 项目目录
2. 运行 `npm install` 安装依赖
1. 进入 `ui` 项目目录。
2. 运行 `npm install` 安装依赖。
3. 启动 Vite 开发服务器:
```bash
npm run dev
```

View File

@ -27,7 +27,9 @@ git clone https://github.com/your_username/certimate.git
Once you have made changes to the Go code in Certimate, follow these steps to run the project:
1. Navigate to the root directory.
2. Start the service by running:
```bash
go run main.go serve
```
@ -36,6 +38,8 @@ This will start a web server at `http://localhost:8090` using the prebuilt Admin
**Before submitting a PR to the main repository, consider:**
- Format your source code by using [gofumpt](https://github.com/mvdan/gofumpt).
- Adding unit or integration tests for your changes. Certimate uses Gos standard `testing` package. You can run tests using the following command (while in the root project directory):
```bash
@ -49,11 +53,15 @@ Certimates Admin UI is a single-page application (SPA) built using React and
To start the Admin UI:
1. Navigate to the `ui` project directory.
2. Install the necessary dependencies by running:
```bash
npm install
```
3. Start the Vite development server:
```bash
npm run dev
```