|
1 | 1 | <!-- Plugin description --> |
| 2 | +English | [简体中文](./README-zh_CN.md) |
2 | 3 |
|
3 | 4 | <div align="center"> |
4 | 5 | <img src="https://github.com/maiqingqiang/go-orm-helper/raw/main/src/main/resources/icons/icon64x64.svg" alt="Go ORM Helper"/> |
5 | 6 | <h1 align="center">Go ORM Helper</h1> |
6 | 7 | </div> |
7 | 8 |
|
8 | | -<p align="center">一个为了让你在 Goland 上写 ORM 能自动补全数据库字段、Tag、生成Struct 的 Jetbrains 插件。支持:gorm、xorm、beego、database/sql...)</p> |
| 9 | +<p align="center">A JetBrains plugin for GoLand that automatically provides database field autocompletion, tags, and generates Structs for writing ORM code. Supports: gorm, xorm, beego, database/sql, etc.</p> |
9 | 10 |
|
10 | | -> 灵感来源 [Laravel Idea](https://plugins.jetbrains.com/plugin/13441-laravel-idea) & |
11 | | -> [PhpStorm metadata](https://www.jetbrains.com/help/phpstorm/ide-advanced-metadata.html)。 本人使用 golang 的 orm 包时, |
12 | | -> 一些 ORM 函数的参数是字符串,并且ide不支持代码补全,在字段贼多的情况下,记不清楚,写起来就会很不方便。以前本人写php的时候,就用到前面的插件, |
13 | | -> 感觉非常爽,所以就有了这个插件~~ |
| 11 | +> Inspired by [Laravel Idea](https://plugins.jetbrains.com/plugin/13441-laravel-idea) & |
| 12 | +> [PhpStorm metadata](https://www.jetbrains.com/help/phpstorm/ide-advanced-metadata.html). When using ORM packages in Golang, |
| 13 | +> I noticed that some ORM function parameters are strings and the IDE does not support code completion. It becomes inconvenient |
| 14 | +> to write code when dealing with numerous fields. Previously, when I was writing PHP, I used similar plugins and found them |
| 15 | +> extremely useful. Hence, this plugin was developed. |
14 | 16 |
|
15 | | -## 特性 |
16 | | - |
17 | | -- [x] ORM 代码补全 |
18 | | - - [x] @Model 注解辅助补全 |
19 | | - - [ ] @Table 注解辅助补全 🚧[WIP] |
20 | | - - [ ] 自定义 SQL 辅助不全 🚧[WIP] |
21 | | -- [x] SQL 转 Struct |
| 17 | +## Features |
| 18 | +- [x] ORM code autocompletion |
| 19 | + - [x] Assisted completion with @Model annotation |
| 20 | + - [ ] Assisted completion with @Table annotation 🚧[WIP] |
| 21 | + - [ ] Assisted completion for custom SQL 🚧[WIP] |
| 22 | +- [x] SQL to Struct conversion |
22 | 23 | - [x] Gorm |
23 | 24 | - [x] Xorm |
24 | | - - [x] 通用 Struct |
| 25 | + - [x] Generic Struct |
25 | 26 | - [ ] GoFrame |
26 | 27 | - [ ] Beego |
27 | 28 | - [ ] sqlx |
28 | | -- [ ] Tag 代码补全 🚧[WIP] |
29 | | -- 更多等你去发现与改进... |
30 | | - |
31 | | -## 支持的ORM |
| 29 | +- [ ] Tag code autocompletion 🚧[WIP] |
| 30 | +- More features waiting to be discovered and improved... |
32 | 31 |
|
| 32 | +## Supported ORM Packages |
33 | 33 | - [x] [Gorm](https://github.com/go-gorm/gorm) |
34 | 34 | - [x] [Xorm](https://gitea.com/xorm/xorm) |
35 | 35 | - [ ] [GoFrame](https://github.com/gogf/gf) 🚧[WIP] |
36 | 36 | - [ ] [Beego](https://github.com/beego/beego) 🚧[WIP] |
37 | 37 | - [ ] [sqlx](https://github.com/jmoiron/sqlx) 🚧[WIP] |
38 | | -- 更多等你去发现与改进... |
39 | | - |
40 | | -## 使用 |
| 38 | +- More packages waiting to be discovered and improved... |
41 | 39 |
|
| 40 | +## Usage |
42 | 41 |  |
43 | 42 |
|
44 | 43 | <!-- Plugin description end --> |
0 commit comments