Skip to content

Latest commit

 

History

History
81 lines (54 loc) · 2.55 KB

README.md

File metadata and controls

81 lines (54 loc) · 2.55 KB
Raw

Goctl for Visual Studio Code

English | 简体中文

go-zero license Test

Install

This plugin can be installed on Visual Studio Code version 1.46.0+. First make sure your version of Visual Studio Code meets the requirements and that the goctl command line tool is installed. If Visual Studio Code is not installed, please install and open Visual Studio Code. Navigate to the Extensions pane, search for goctl and install this extension (publisher ID is "xiaoxin- technology.goctl").

Please refer to here for Visual Studio Code extension usage.

Note: If the shell you are using is fish, the $PATH environment variable is configured in fish, which may cause the $PATH in vscode to be inconsistent with the $PATH in Terminal, please refer to: PATH issues with Fish shell on macOS.

Functions

Implemented functions

  • Syntax highlighting
  • Jump to definition/reference
  • Code formatting
  • Code block hinting

No implemented:

  • Syntax error checking
  • Cross-file code jumping

Syntax Highlighting

Code Jump


(Jump to definition/reference)

Code Format

The code formatting function will invoke the goctl command line formatting tool. Make sure goctl is added to $PATH and has executable permissions before using it.

Code Block Hints

Info Code Block


(Generate info code block)

Type Code Block


(Generate type code block)

Service Code Block


(Generate service code block)

Handler Code Block


(Generate handler code block)

Feedback & Suggestions

If you encounter problems or have suggestions for improvement, please submit an issue by clicking here.