Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/alpsmonaco/go-imports-alphabetical

an vscode extension sorts go imports in alphabetical
https://github.com/alpsmonaco/go-imports-alphabetical

Last synced: 7 days ago
JSON representation

an vscode extension sorts go imports in alphabetical

Awesome Lists containing this project

README 

        
# go-imports-alphabetical README



[中文](#Chinese)



This Visual Studio Code extension organizes your Go imports alphabetically.



![usage2 gif](assets/usage2.gif)



## NEW FEATURE!!!🎉🎉🎉

This extension can now be configured as a formatter!!!

add the following JSON settings to your `settings.json` file (either globally or in your workspace):  

```json

"[go]": {

    "editor.codeActionsOnSave": {

        "source.organizeImports": "never"

    },

    "editor.defaultFormatter": "alpsmonaco.go-imports-alphabetical",

    "editor.formatOnSave": true, //optional

}

```

By default, this extension will run `gofmt` to format your currently open Go file and then sort all imports in alphabetical order.  

The `gofmt` tool is included with your Go installation.

If you'd like to use a different formatting tool instead of gofmt, you can specify it in your settings:

```json

{

    "goImportsAlphabetical.preformatTool": "goimports"

}

```



as a formatter, you could use the following methods to format go files.

* use shortcut `Shift+Alt+F`

* use shortcut `Ctrl+Shift+P` and the choose `Format Document`



# Why Use This Extension?

The official Go Extension with gopls currently uses goimports to sort imports, and it doesn’t provide an option to change this behavior.  

This can be frustrating when your Go project is maintained by both Visual Studio Code and GoLand developers, as they may use different import sorting strategies.  

This difference can lead to unwanted changes, especially when you are about to submit your code.



# NOTICE

If this extension formats your Go file correctly, you’re all set!   

You don’t need to read any further—just start coding in Go.



# Prerequisite

You may need to define the following JSON settings in either user.json or workspace.json.  

Accroding to issue: https://github.com/microsoft/vscode-go/issues/3059#issuecomment-589072036.  

But when you import a new package,gopls will still sort you imports by `goimports`.That's why you might need this extension.    



```json

    "[go]": {

        "editor.codeActionsOnSave": {

            "source.organizeImports": "never"

        },

        "editor.formatOnSave": false,

    },

```



## Usage

* use shortcut `Ctrl+Shift+P`

* select/type `Sort Go Imports In Alphabetical`



![usage gif](assets/usage.gif)



## Extension Settings



`goImportsAlphabetical.keepEmptyLine`  

`default:false`



Whether to keep empty line or not.  

If enabled,all imports will be separated by empty lines,grouped into each group,  

then sorted within groups while keeping the empty lines.



`goImportsAlphabetical.ignoreImportAlias`  

`default:true`



Choose whether to sort by import package aliases.If enabled,ignore imports aliases and then sort.



`goImportsAlphabetical.moveToTopAfterSort`  

`default:true`



When the sort is successful,scroll to top of the document.  



## For more information



contact me at

[github.com/AlpsMonaco/go-imports-alphabetical](https://github.com/AlpsMonaco/go-imports-alphabetical)



**Enjoy!**






这个插件帮助你把 go 的导入包按字母顺序排序



![usage2 gif](assets/usage2.gif)



## 新功能!!!🎉🎉🎉



这个插件现在可以配置成格式化插件来使用



添加下面的json配置到 `settings.json` 中来生效（vscode的全局设置或者工作区设置都可以）

```json

"[go]": {

    "editor.codeActionsOnSave": {

        "source.organizeImports": "never"

    },

    "editor.defaultFormatter": "alpsmonaco.go-imports-alphabetical",

    "editor.formatOnSave": true, //optional

}

```

默认情况下这个插件会先用gofmt格式化你的Go代码，然后将导入的包按字母顺序来排序。  

一般安装Go的时候，gofmt也会自带。  

你也可以通过以下的设置来使用其他格式化工具来进行预格式化。  

```json

{

    "goImportsAlphabetical.preformatTool": "goimports"

}

```



你可以使用以下方法来进行格式化，排序Go的导入包。  

* 使用快捷键 `Shift+Alt+F`

* 使用快捷键 `Ctrl+Shift+P` 然后选择 `格式化文档`



## 注意

如果你能成功格式化，后面的内容就不用看了。  



# 先决配置



你可能需要先定义以下的json设置在你的 user.json 或者 workspace.json 中  

来源issue: https://github.com/microsoft/vscode-go/issues/3059#issuecomment-589072036.  

但是当你导入新的包的时候，gopls还是会用goimports来排序你的导入包，这就是为啥你可能需要这个插件    



```json

    "[go]": {

        "editor.codeActionsOnSave": {

            "source.organizeImports": "never"

        },

        "editor.formatOnSave": false,

    },

```



## 用法

* 使用快捷键 `Ctrl+Shift+P`

* 选择/输入 `Sort Go Imports In Alphabetical`



![usage gif](assets/usage.gif)



## 为什么要做这个插件



当前官方的go插件使用gopls语言服务器，只支持goimports，没办法修改。  

当你的go项目开发成员同时用`vscode` 和 `goland`的时候会很麻烦。  

尤其是提交代码的时候。。。  



## 插件设置



`goImportsAlphabetical.keepEmptyLine`  

`default:false`



是否保留空行



`goImportsAlphabetical.ignoreImportAlias`  

`default:true`



包的别名是否参与排序



## For more information



在github上联系我:  

[github.com/AlpsMonaco/go-imports-alphabetical](https://github.com/AlpsMonaco/go-imports-alphabetical)



**Enjoy!**