Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zeromicro/goctl-intellij

A intellij plugin of goctl
https://github.com/zeromicro/goctl-intellij

Last synced: 26 days ago
JSON representation

A intellij plugin of goctl

Host: GitHub
URL: https://github.com/zeromicro/goctl-intellij
Owner: zeromicro
License: mit
Created: 2020-12-13T07:09:45.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2023-10-31T07:47:42.000Z (about 1 year ago)
Last Synced: 2024-08-04T12:01:57.172Z (4 months ago)
Language: Java
Homepage:
Size: 5.68 MB
Stars: 25
Watchers: 5
Forks: 5
Open Issues: 10
Metadata Files:
- Readme: README.md
- Changelog: CHANGE_LOG.md
- License: LICENSE

Awesome Lists containing this project

awesome-zero - goctl-intellij - goctl intellij plugin (Tools and plugins for [go-zero](https://github.com/tal-tech/go-zero))

README

        # goctl intellij  Plugin

中文简体 | [English](README_EN.md)

[![go-zero](https://img.shields.io/badge/Github-go--zero-brightgreen?logo=github)](https://github.com/tal-tech/go-zero)

[![license](https://img.shields.io/badge/License-MIT-blue)](https://github.com/zeromicro/goctl-intellij/blob/main/LICENSE)

[![license](https://img.shields.io/badge/Release-1.1.0-red)](https://github.com/zeromicro/goctl-intellij/releases)

# 介绍

一款支持go-zero api语言结构语法高亮、检测以及api、rpc、model快捷生成的插件工具。

# idea版本要求

不低于193.0(2019.3)

# 版本特性

* api语法高亮

* api语法、语义检测

* struct、route、handler重复定义检测

* type跳转到类型声明位置

* 上下文菜单中支持api、rpc、mode相关menu选项

* 代码格式化(option+command+L)

* 代码提示

# 安装方式

## 方式一

在github的release中找到最新的zip包，下载本地安装即可。（无需解压）

## 方式二

在plugin商店中，搜索`Goctl`安装即可（目前商店中已通过的版本比较低。）

# 预览

![preview](./src/main/resources/static/api_colorful.png)

# 新建 Api file

在工程区域目标文件夹`右键 -> New -> New Api File -> Empty File/Api Template`,如图：

![preview](./src/main/resources/static/api_new.png)

![preview](./src/main/resources/static/new.png)

# 新建 Proto File

在工程区目标文件夹`右键 -> New -> New Proto File -> Empty File/Proto Template`,如图：

![preview](./src/main/resources/static/new_proto.png)

![preview](./src/main/resources/static/proto.png)

# 快速生成api/rpc服务

在目标文件夹`右键 -> New -> Go Zero -> Api Greet Service/Rpc Greet Service`

![preview](./src/main/resources/static/service.png)

# Api 代码生成

## 1. api 文件右键生成

![preview](./src/main/resources/static/project_api_code_gen.png)

## 2. api 文件编辑区右键生成

![preview](./src/main/resources/static/editor_api_code_gen.png)

## Api 代码生成说明

`API Code Generation` 和 `API Quick Code Generation` 的区别是：

- `API Quick Code Generation` 中 `goctl` 的相关指令参数均使用指定值，其代码生成指令内容如下：

  

    ```shell

    $ goctl api go --api=${API 文件路径} --style=gozero --home="~/.goctl" --dir=${API 文件所在文件夹}

    ```

- `API Code Generation` 会打开弹窗让使用者填写 `--style`，`-- dir`，`--home` 等信息

  ![preview](./src/main/resources/static/api_code_gen_dialog.png)

# zRPC 代码生成

## 1. proto 文件右键生成

![preview](./src/main/resources/static/project_zrpc_code_gen.png)

## 2. proto 文件编辑区右键生成

![preview](./src/main/resources/static/editor_zrpc_code_gen.png)

## zRPC 代码生成说明

`ZRPC Code Generation` 和 `ZRPC Quick Code Generation` 的区别是：

- `ZRPC Quick Code Generation` 中 `goctl` 的相关指令参数均使用指定值，其代码生成指令内容如下：

    

    ```shell

    $ goctl rpc protoc ${proto 文件路径} --style=gozero --home="~/.goctl" --go_out=${API 文件所在文件夹} --grpc-go_out=${API 文件所在文件夹} --zrpc_out=${API 文件所在文件夹}

    ```

- `ZRPC Code Generation` 会打开弹窗让使用者填写 `--style`，`-- dir`，`--home`,`proto_path`(如果有 import 其他 proto 文件) 等信息

  

  - 无 import 情况

    ![preview](./src/main/resources/static/api_code_gen_dialog.png)

  - 有 import 情况，proto_path 目前只支持但文件选择，因此 **不支持 import 自不同文件夹的 proto**。

    ![preview](./src/main/resources/static/rpc_code_gen_dialog.png)

# Model 代码生成

## 1. sql 文件右键生成

![preview](./src/main/resources/static/project_model_code_gen.png)

## 2. sql 文件编辑区右键生成

![preview](./src/main/resources/static/editor_model_code_gen.png)

## Model 代码生成说明

**Model 代码生成默认都是带缓存的。**

`Model Code Generation` 和 `Model Quick Code Generation` 的区别是：

- `Model Quick Code Generation` 中 `goctl` 的相关指令参数均使用指定值，其代码生成指令内容如下：

    

    ```shell

    $ goctl model mysql ddl --src=${sql 文件路径} --dir=${sql 文件所在文件夹} --style=gozero -c --home="~/.goctl"

    ```

- `Model Code Generation` 会打开弹窗让使用者填写 `--style`，`-- dir`，`--home`，`--cache` 等信息

  ![preview](./src/main/resources/static/api_code_gen_dialog.png)

- 

# 错误提示

![context menu](./src/main/resources/static/alert.png)

# Live Template

Live Template可以加快我们对api文件的编写，比如我们在go文件中输入`main`关键字根据tip回车后会插入一段模板代码

```golang

func main(){

}

```

或者说看到下图你会更加熟悉，曾几何时你还在这里定义过template

![context menu](./src/main/resources/static/go_live_template.png)

下面就进入今天api语法中的模板使用说明吧，我们先来看看service模板的效果

![context menu](./src/main/resources/static/live_preview.gif)

#### 预设模板及生效区域

|  模板关键字   | psiTree生效区域 |描述 

|  ----  | ----  | ----  | 

| @doc  | ApiService |doc注释模板|

| doc  | ApiService |doc注释模板|

| struct  | Struct |struct声明模板|

| info  | ApiFile |info block模板|

| type  | ApiFile |type group模板|

| handler  | ApiService |handler文件名模板|

| get  | ApiService |get方法路由模板|

| head  | ApiService |head方法路由模板|

| post  | ApiService |post方法路由模板|

| put  | ApiService |put方法路由模板|

| delete  | ApiService |delete方法路由模板|

| connect  | ApiService |connect方法路由模板|

| options  | ApiService |options方法路由模板|

| trace  | ApiService |trace方法路由模板|

| service  | ApiFile |service服务block模板|

| json  | Tag|Tag literal |tag模板|

| xml  | Tag|Tag literal |tag模板|

| path  | Tag|Tag literal |tag模板|

| form  | Tag|Tag literal |tag模板|