Skip to content

Commit

Permalink
Merge pull request #5 from maiqingqiang/v1.2.0
Browse files Browse the repository at this point in the history
V1.2.0
  • Loading branch information
johnmai-dev authored Jul 16, 2023
2 parents 0752b9d + 2cfc60e commit dca0d89
Show file tree
Hide file tree
Showing 58 changed files with 4,867 additions and 896 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
.idea
.qodana
build
.DS_Store
11 changes: 10 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@

## [Unreleased]

## [1.2.0] - 2023-07-15

### Added
- Support GoFrame ORM.
- Support Go ORM Tags Live Template.
- Refactor Code Completion. Better Performance!
- Refactor GoORMHelper Cache Manager.

## [1.1.0] - 2023-07-04

### Added
Expand Down Expand Up @@ -34,7 +42,8 @@
- ORM Code Completion
- SQL to Struct

[Unreleased]: https://github.com/maiqingqiang/go-orm-helper/compare/v1.1.0...HEAD
[Unreleased]: https://github.com/maiqingqiang/go-orm-helper/compare/v1.2.0...HEAD
[1.2.0]: https://github.com/maiqingqiang/go-orm-helper/compare/v1.1.0...v1.2.0
[1.1.0]: https://github.com/maiqingqiang/go-orm-helper/compare/v1.0.2...v1.1.0
[1.0.2]: https://github.com/maiqingqiang/go-orm-helper/compare/v1.0.1...v1.0.2
[1.0.1]: https://github.com/maiqingqiang/go-orm-helper/compare/v1.0.0...v1.0.1
Expand Down
38 changes: 29 additions & 9 deletions DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
<p><b>Go ORM Helper plugin for GoLand.</b></p>
<p> English | <a href="#zh_CN">简体中文</a> | <a href="#ja_JP">日本語</a> | <a href="#ko_KR">한국어</a> </p>

<p><b><a id="en_US">Go ORM Helper plugin for GoLand.</a></b></p>
<br/>
<p>
<b>
Expand Down Expand Up @@ -26,20 +28,25 @@
</ul>
</li>
<li>SQL to Struct conversion.</li>
<li>Go ORM Tags Live Template.</li>
<li>More packages waiting to be discovered and improved...</li>
</ul>

<h2>Supported Go ORM Packages</h2>
<h2>Supported ORM Code Completion.</h2>
<ul>
<li><a href="https://github.com/go-gorm/gorm">Gorm</a></li>
<li><a href="https://gitea.com/xorm/xorm">Xorm</a></li>
<li>More packages waiting to be discovered and improved...</li>
<li><a href="https://github.com/gogf/gf">GoFrame</a></li>
<li><a href="https://github.com/maiqingqiang/go-orm-helper/blob/main/SUPPORTED.md">More Supported</a></li>
</ul>

<br/>
<hr/>
<br/>

<p><b>基于 GoLand 的 Go ORM 助手插件。</b></p>
<p><a href="#en_US"> English </a>| 简体中文 | <a href="#ja_JP">日本語</a> | <a href="#ko_KR">한국어</a> </p>

<p><b><a id="zh_CN">基于 GoLand 的 Go ORM 助手插件。</a></b></p>
<br/>
<p>
<b>
Expand All @@ -66,20 +73,25 @@
</ul>
</li>
<li>SQL 转 Struct</li>
<li>Go ORM Tags Live Template</li>
<li>更多等你去发现与改进...</li>
</ul>

<h2>支持的 Go ORM</h2>
<ul>
<li><a href="https://github.com/go-gorm/gorm">Gorm</a></li>
<li><a href="https://gitea.com/xorm/xorm">Xorm</a></li>
<li>更多等你去发现与改进...</li>
<li><a href="https://github.com/gogf/gf">GoFrame</a></li>
<li><a href="https://github.com/maiqingqiang/go-orm-helper/blob/main/SUPPORTED.md">支持明细</a></li>
</ul>

<br/>
<hr/>
<br/>

<p><b>GoLand IDEベースのGo ORMアシスタントプラグイン。</b></p>
<p><a href="#en_US"> English </a>| <a href="#zh_CN">简体中文</a> | 日本語 | <a href="#ko_KR">한국어</a> </p>

<p><b><a id="ja_JP">GoLand IDEベースのGo ORMアシスタントプラグイン。</a></b></p>
<br/>
<p>
<b>
Expand Down Expand Up @@ -107,20 +119,25 @@
</ul>
</li>
<li>SQL 変換 Struct</li>
<li>Go ORM Tag リアルタイムテンプレート</li>
<li>発見と改善を待っています...</li>
</ul>

<h2>サポートされるGo ORM</h2>
<ul>
<li><a href="https://github.com/go-gorm/gorm">Gorm</a></li>
<li><a href="https://gitea.com/xorm/xorm">Xorm</a></li>
<li>発見と改善を待っています...</li>
<li><a href="https://github.com/gogf/gf">GoFrame</a></li>
<li><a href="https://github.com/maiqingqiang/go-orm-helper/blob/main/SUPPORTED.md">サポート詳細</a></li>
</ul>

<br/>
<hr/>
<br/>

<p><b>GoLand 기반 Go ORM 지원 플러그인.</b></p>
<p><a href="#en_US"> English </a>| <a href="#zh_CN">简体中文</a> | <a href="#ja_JP">日本語</a> | 한국어 </p>

<p><b><a id="ko_KR">GoLand 기반 Go ORM 지원 플러그인.</a></b></p>
<br/>
<p>
<b>
Expand All @@ -146,11 +163,14 @@
</ul>
</li>
<li>SQL 변환 Struct</li>
<li>Go ORM Tag 실시간 템플릿</li>
<li>더 많은 것을 발견하고 개선하기를 기다린다...</li>
</ul>

<h2>지원되는 Go ORM</h2>
<ul>
<li><a href="https://github.com/go-gorm/gorm">Gorm</a></li>
<li><a href="https://gitea.com/xorm/xorm">Xorm</a></li>
<li>더 많은 것을 발견하고 개선하기를 기다린다...</li>
<li><a href="https://github.com/gogf/gf">GoFrame</a></li>
<li><a href="https://github.com/maiqingqiang/go-orm-helper/blob/main/SUPPORTED.md">지원 내역</a></li>
</ul>
16 changes: 5 additions & 11 deletions README-ja_JP.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<h1 align="center">Go ORM アシスタント</h1>
</div>

<p align="center">GoLand にORMを書くためにデータベースフィールド、Tag、Struct を自動的に補完する Jetbrains プラグイン。サポート:Gorm、Xorm、Beego、GoFrame...)</p>
<p align="center">GoLand にORMを書くためにデータベースフィールド、Tag、Struct を自動的に補完する Jetbrains プラグイン。サポート:Gorm、Xorm、Beego、GoFrame...)<br>私たちの仕事をサポートするために ⭐️スター をください!</p>

> インスピレーション源の [Laravel Idea](https://plugins.jetbrains.com/plugin/13441-laravel-idea) &
> [PhpStorm metadata](https://www.jetbrains.com/help/phpstorm/ide-advanced-metadata.html).
Expand All @@ -19,24 +19,18 @@
- [x] @Model 注記補助補完
- [x] @Table 注記補助補完
- [ ] カスタムSQLアクセシビリティ不全 🚧[WIP]
- [x] SQL 変換 Struct
- [x] Gorm
- [x] Xorm
- [x] 共通 Struct
- [ ] GoFrame 🚧[WIP]
- [ ] Beego 🚧[WIP]
- [ ] sqlx 🚧[WIP]
- [ ] Tag コード補完 🚧[WIP]
- [x] SQL 変換 Struct [サポート詳細](./SUPPORTED.md#supported-sql-to-struct-conversion)
- [x] Go ORM Tag リアルタイムテンプレート [サポート詳細](./SUPPORTED.md#supported-orm-tags-live-template)
- 発見と改善を待っています...

## サポートされているORM

- [x] [Gorm](https://github.com/go-gorm/gorm)
- [x] [Xorm](https://gitea.com/xorm/xorm)
- [ ] [GoFrame](https://github.com/gogf/gf) 🚧[WIP]
- [x] [GoFrame](https://github.com/gogf/gf)
- [ ] [Beego](https://github.com/beego/beego) 🚧[WIP]
- [ ] [sqlx](https://github.com/jmoiron/sqlx) 🚧[WIP]
- 発見と改善を待っています...
- [サポート詳細](./SUPPORTED.md)

## 使用

Expand Down
17 changes: 6 additions & 11 deletions README-ko_KR.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
<h1 align="center">Go ORM 도우미</h1>
</div>

<p align="center">GoLand 에 ORM을 쓸 수 있도록 데이터베이스 필드, Tag, Struct를 자동으로 완성하는 플러그인지원: Gorm, Xorm, Beego, GoFrame...)</p>
<p align="center">GoLand 에 ORM을 쓸 수 있도록 데이터베이스 필드, Tag, Struct를 자동으로 완성하는 플러그인지원: Gorm, Xorm, Beego, GoFrame...)
<br>우리의 작업을 지원하기 위해 ⭐️스타를 부탁드립니다!</p>

> [Laravel Idea](https://plugins.jetbrains.com/plugin/13441-laravel-idea) &
> [PhpStorm metadata](https://www.jetbrains.com/help/phpstorm/ide-advanced-metadata.html) 에서영감을 받았습니다.본인이 Go의 ORM
Expand All @@ -18,24 +19,18 @@
- [x] @Model 메모 보조 완성
- [x] @Table 메모 보조 완성
- [ ] 사용자 정의 SQL 보조 불완전 🚧[WIP]
- [x] SQL 변환 Struct
- [x] Gorm
- [x] Xorm
- [x] 공통 Struct
- [ ] GoFrame 🚧[WIP]
- [ ] Beego 🚧[WIP]
- [ ] sqlx 🚧[WIP]
- [ ] Tag 코드 완성 🚧[WIP]
- [x] SQL 변환 Struct [지원 내역](./SUPPORTED.md#supported-sql-to-struct-conversion)
- [x] Go ORM Tag 실시간 템플릿 [지원 내역](./SUPPORTED.md#supported-orm-tags-live-template)
- 더 많은 것을 발견하고 개선하기를 기다린다...

## 지원되는 ORM

- [x] [Gorm](https://github.com/go-gorm/gorm)
- [x] [Xorm](https://gitea.com/xorm/xorm)
- [ ] [GoFrame](https://github.com/gogf/gf) 🚧[WIP]
- [x] [GoFrame](https://github.com/gogf/gf)
- [ ] [Beego](https://github.com/beego/beego) 🚧[WIP]
- [ ] [sqlx](https://github.com/jmoiron/sqlx) 🚧[WIP]
- 더 많은 것을 발견하고 개선하기를 기다린다...
- [지원 내역](./SUPPORTED.md)

## 사용

Expand Down
17 changes: 6 additions & 11 deletions README-zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
<h1 align="center">Go ORM 助手</h1>
</div>

<p align="center">一个为了让你在 GoLand 上写 ORM 能自动补全数据库字段、Tag、生成Struct 的插件。支持:Gorm、Xorm、Beego、GoFrame...)</p>
<p align="center">一个为了让你在 GoLand 上写 ORM 能自动补全数据库字段、Tag、生成Struct 的插件。支持:Gorm、Xorm、Beego、GoFrame...)
<br>给个 ⭐️Star 支持我们的工作吧!</p>

> 灵感来源 [Laravel Idea](https://plugins.jetbrains.com/plugin/13441-laravel-idea) &
> [PhpStorm metadata](https://www.jetbrains.com/help/phpstorm/ide-advanced-metadata.html)。 本人使用 Go 的 ORM 包时,
Expand All @@ -18,24 +19,18 @@
- [x] @Model 注解辅助补全
- [x] @Table 注解辅助补全
- [ ] 自定义 SQL 辅助不全 🚧[WIP]
- [x] SQL 转 Struct
- [x] Gorm
- [x] Xorm
- [x] 通用 Struct
- [ ] GoFrame 🚧[WIP]
- [ ] Beego 🚧[WIP]
- [ ] sqlx 🚧[WIP]
- [ ] Tag 代码补全 🚧[WIP]
- [x] SQL 转 Struct [支持明细](./SUPPORTED.md#supported-sql-to-struct-conversion)
- [x] Go ORM Tag 实时模版 [支持明细](./SUPPORTED.md#supported-orm-tags-live-template)
- 更多等你去发现与改进...

## 支持的 ORM

- [x] [Gorm](https://github.com/go-gorm/gorm)
- [x] [Xorm](https://gitea.com/xorm/xorm)
- [ ] [GoFrame](https://github.com/gogf/gf) 🚧[WIP]
- [x] [GoFrame](https://github.com/gogf/gf)
- [ ] [Beego](https://github.com/beego/beego) 🚧[WIP]
- [ ] [sqlx](https://github.com/jmoiron/sqlx) 🚧[WIP]
- 更多等你去发现与改进...
- [支持明细](./SUPPORTED.md)

## 使用

Expand Down
19 changes: 7 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ English | [简体中文](./README-zh_CN.md) | [日本語](./README-ja_JP.md) | [
<h1 align="center">Go ORM Helper</h1>
</div>

<p align="center">A GoLand plugin that automatically provides database field autocompletion, tags, and generates Structs for writing ORM code. Supports: Gorm、Xorm、Beego、GoFrame, etc.</p>
<p align="center">A GoLand plugin that automatically provides database field autocompletion, tags, and generates Structs
for writing ORM code. Supports: Gorm、Xorm、Beego、GoFrame, etc.<br/>⭐️ Star to support our work!</p>

> Inspired by [Laravel Idea](https://plugins.jetbrains.com/plugin/13441-laravel-idea) &
> [PhpStorm metadata](https://www.jetbrains.com/help/phpstorm/ide-advanced-metadata.html). When using ORM packages in Golang,
Expand All @@ -18,23 +19,17 @@ English | [简体中文](./README-zh_CN.md) | [日本語](./README-ja_JP.md) | [
- [x] Assisted code completion with @Model annotation.
- [x] Assisted code completion with @Table annotation.
- [ ] Assisted code completion for custom SQL. 🚧[WIP]
- [x] SQL to Struct conversion.
- [x] Gorm
- [x] Xorm
- [x] Generic Struct
- [ ] GoFrame
- [ ] Beego
- [ ] sqlx
- [ ] Tag Code Completion. 🚧[WIP]
- [x] SQL to Struct conversion. [Supported](./SUPPORTED.md#supported-sql-to-struct-conversion)
- [x] Go ORM Tags Live Template. [Supported](./SUPPORTED.md#supported-orm-tags-live-template)
- More features waiting to be discovered and improved...

## Supported ORM Packages
## Supported ORM Code Completion.
- [x] [Gorm](https://github.com/go-gorm/gorm)
- [x] [Xorm](https://gitea.com/xorm/xorm)
- [ ] [GoFrame](https://github.com/gogf/gf) 🚧[WIP]
- [x] [GoFrame](https://github.com/gogf/gf)
- [ ] [Beego](https://github.com/beego/beego) 🚧[WIP]
- [ ] [sqlx](https://github.com/jmoiron/sqlx) 🚧[WIP]
- More packages waiting to be discovered and improved...
- [More Supported](./SUPPORTED.md)

## Usage
![guide.gif](assets%2Fguide.gif)
Expand Down
37 changes: 37 additions & 0 deletions SUPPORTED.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Supported

## Supported SQL to Struct conversion

- [x] Generic Struct
- [x] [Gorm](https://github.com/go-gorm/gorm)
- [x] [Xorm](https://gitea.com/xorm/xorm)
- [x] [GoFrame](https://github.com/gogf/gf)
- [ ] [Beego](https://github.com/beego/beego) 🚧[WIP]
- [ ] [sqlx](https://github.com/jmoiron/sqlx) 🚧[WIP]

## Supported ORM Tags Live Template

[Go ORM Tags.xml](./src/main/resources/liveTemplates/Go%20ORM%20Tags.xml)

| Tag | ORM |
|--------------|-------------------------------------------------------------------------|
| `gorm:""` | [Gorm](https://github.com/go-gorm/gorm) |
| `xorm:""` | [Xorm](https://gitea.com/xorm/xorm) |
| `orm:"-"` | [GoFrame](https://github.com/gogf/gf) |
| `orm:"-"` | [Beego](https://github.com/beego/beego) |
| `gqlgen:"-"` | [ent.](https://entgo.io/) |
| `boil:"-"` | [SQLBoiler](https://github.com/volatiletech/sqlboiler) |
| `pg:"-"` | [pg](https://github.com/go-pg/pg) |
| `bun:"-"` | [Bun](https://github.com/uptrace/bun) |
| `reform:"-"` | [reform](https://github.com/go-reform/reform) |
| `aorm:"-"` | [aorm](https://github.com/tangpanqing/aorm) |
| `db:"-"` | [sqlx](https://github.com/jmoiron/sqlx) |
| `db:"-"` | [gorp](https://github.com/go-gorp/gorp) |
| `db:"-"` | [upper/db](https://github.com/upper/db) |
| `db:"-"` | [Buffalo Model](https://gobuffalo.io/pt/documentation/database/models/) |
| `db:"-"` | [go-sqlbuilder](https://github.com/huandu/go-sqlbuilder) |
| `db:"-"` | [rel](https://github.com/go-rel/rel) |
| `db:"-"` | [Bob](https://github.com/stephenafamo/bob) |
| `db:"-"` | [lore](https://github.com/abrahambotros/lore) |
| `db:"-"` | [GoBatis](https://github.com/mei-rune/GoBatis) |

Binary file modified assets/guide.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions example/goframe/go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
module goframe

go 1.20

require github.com/gogf/gf/v2 v2.4.4

require (
github.com/BurntSushi/toml v1.1.0 // indirect
github.com/clbanning/mxj/v2 v2.5.5 // indirect
github.com/fatih/color v1.13.0 // indirect
github.com/fsnotify/fsnotify v1.5.4 // indirect
github.com/go-logr/logr v1.2.3 // indirect
github.com/go-logr/stdr v1.2.2 // indirect
github.com/gorilla/websocket v1.5.0 // indirect
github.com/grokify/html-strip-tags-go v0.0.1 // indirect
github.com/magiconair/properties v1.8.6 // indirect
github.com/mattn/go-colorable v0.1.9 // indirect
github.com/mattn/go-isatty v0.0.14 // indirect
github.com/mattn/go-runewidth v0.0.9 // indirect
github.com/olekukonko/tablewriter v0.0.5 // indirect
go.opentelemetry.io/otel v1.7.0 // indirect
go.opentelemetry.io/otel/sdk v1.7.0 // indirect
go.opentelemetry.io/otel/trace v1.7.0 // indirect
golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2 // indirect
golang.org/x/sys v0.0.0-20220412211240-33da011f77ad // indirect
golang.org/x/text v0.3.8-0.20211105212822-18b340fc7af2 // indirect
gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
)
Loading

0 comments on commit dca0d89

Please sign in to comment.