Compare commits
64 commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 6a3924cee5 | |||
| 4a2384ade8 | |||
| 7764f6e37f | |||
| f599e75963 | |||
| 906e340b4f | |||
| fabdcc5fb3 | |||
| 03de1f5ffc | |||
| 7a18d9f7bd | |||
| 0de1892ca9 | |||
| 399845fee2 | |||
| ef4a3a1c7a | |||
| e8d53840d4 | |||
| f4809cd2ec | |||
| 0b2c26ebbb | |||
| d1eaebab6b | |||
| 7c198a1b36 | |||
| 440a7cc432 | |||
| 1e7af1b212 | |||
| 295e21e637 | |||
|
|
7e8c6f41aa | ||
| b7ce5d1f35 | |||
|
|
9bf72afc63 | ||
| c0951c4769 | |||
| d6b41494f1 | |||
|
|
b6d3815f9b | ||
| 8c87952964 | |||
| 92b0ebb6a7 | |||
| e90f766ea3 | |||
| 53ab4274c2 | |||
| 09696900a5 | |||
| 6f9648805e | |||
|
|
de585144eb | ||
|
|
9db5931af1 | ||
|
|
9d28cdebf1 | ||
|
|
ea28fc4e6f | ||
|
|
847c79ab76 | ||
| 7725689d1d | |||
|
|
77754fe362 | ||
|
|
c0b2834652 | ||
| 592fe82760 | |||
|
|
3dcf708d34 | ||
|
|
7ebe190c96 | ||
|
|
ab68a58b34 | ||
|
|
acd4e6fc30 | ||
|
|
969db908f8 | ||
|
|
a993ece59f | ||
| 6ee261cfa6 | |||
|
|
7af08c9780 | ||
|
|
9aa0038125 | ||
|
|
c5cc5080fa | ||
|
|
55bc5787d1 | ||
|
|
e9f2eef5e7 | ||
|
|
f171953e43 | ||
|
|
d1a21bffab | ||
|
|
bb31271311 | ||
|
|
57b5dbf62e | ||
|
|
c2f64db4a8 | ||
|
|
6016ca57d4 | ||
|
|
837897a79d | ||
|
|
cd8a5efc88 | ||
|
|
da960189c1 | ||
|
|
0ed14a40d9 | ||
|
|
f55c15ada8 | ||
|
|
a995af3415 |
143 changed files with 3674 additions and 1170 deletions
16
.editorconfig
Normal file
16
.editorconfig
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
root = true
|
||||
|
||||
[*]
|
||||
indent_style = space
|
||||
indent_size = 4
|
||||
end_of_line = lf
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = true
|
||||
charset = utf-8
|
||||
|
||||
[*.{md,yml,yaml,toml,lua,vim}]
|
||||
indent_size = 2
|
||||
|
||||
[*.go]
|
||||
indent_style = tab
|
||||
indent_size = 4
|
||||
4
.envrc
Normal file
4
.envrc
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
dotenv
|
||||
|
||||
# GOPHER_DIR - needed only for tests, to find the root of the project
|
||||
env_vars_required GOPHER_DIR
|
||||
24
.github/workflows/ci.yml
vendored
24
.github/workflows/ci.yml
vendored
|
|
@ -1,24 +0,0 @@
|
|||
name: Format and lint
|
||||
on: [push, pull_request]
|
||||
|
||||
jobs:
|
||||
format:
|
||||
name: stylua
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: JohnnyMorganz/stylua-action@1.0.0
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
version: 0.14.0
|
||||
args: --check .
|
||||
|
||||
lint:
|
||||
name: selene
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: NTBBloodbath/selene-action@v1.0.0
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
args: --display-style=quiet .
|
||||
58
.github/workflows/linters.yml
vendored
Normal file
58
.github/workflows/linters.yml
vendored
Normal file
|
|
@ -0,0 +1,58 @@
|
|||
name: linters
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- develop
|
||||
pull_request:
|
||||
|
||||
jobs:
|
||||
linters:
|
||||
name: Lua
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: JohnnyMorganz/stylua-action@v3
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
version: latest
|
||||
args: --check .
|
||||
|
||||
- uses: NTBBloodbath/selene-action@v1.0.0
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
args: .
|
||||
|
||||
docs:
|
||||
name: Docs
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Install Task
|
||||
uses: arduino/setup-task@v1
|
||||
with:
|
||||
version: 3.x
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Install NeoVim
|
||||
uses: rhysd/action-setup-vim@v1
|
||||
with:
|
||||
neovim: true
|
||||
version: stable
|
||||
|
||||
- name: Cache .tests
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: |
|
||||
${{ github.workspace }}/.tests
|
||||
key: ${{ runner.os }}-tests-${{ hashFiles('${{ github.workspace }}/.tests') }}
|
||||
|
||||
- name: Generate docs
|
||||
run: task docgen
|
||||
|
||||
- name: Diff
|
||||
run: |
|
||||
git diff doc
|
||||
exit $(git status --porcelain doc | wc -l | tr -d " ")
|
||||
62
.github/workflows/tests.yml
vendored
Normal file
62
.github/workflows/tests.yml
vendored
Normal file
|
|
@ -0,0 +1,62 @@
|
|||
name: tests
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- develop
|
||||
pull_request:
|
||||
|
||||
jobs:
|
||||
tests:
|
||||
strategy:
|
||||
matrix:
|
||||
os: [ubuntu-latest]
|
||||
version:
|
||||
- stable
|
||||
- nightly
|
||||
- v0.10.0
|
||||
- v0.10.4
|
||||
- v0.11.0
|
||||
- v0.11.1
|
||||
- v0.11.2
|
||||
- v0.11.3
|
||||
- v0.11.4
|
||||
runs-on: ${{ matrix.os }}
|
||||
steps:
|
||||
- name: Install Task
|
||||
uses: arduino/setup-task@v1
|
||||
with:
|
||||
version: 3.x
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Install Go
|
||||
uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: "1.24.0"
|
||||
check-latest: false
|
||||
|
||||
- name: Install NeoVim
|
||||
uses: rhysd/action-setup-vim@v1
|
||||
with:
|
||||
neovim: true
|
||||
version: ${{ matrix.version }}
|
||||
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Cache .tests
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: |
|
||||
${{ github.workspace }}/.tests
|
||||
~/.cache/go-build
|
||||
~/go/pkg/mod
|
||||
key: ${{ runner.os }}-tests-${{ hashFiles('${{ github.workspace }}/.tests') }}
|
||||
|
||||
- name: Install Go bins
|
||||
run: task install-deps
|
||||
|
||||
- name: Run Tests
|
||||
run: |
|
||||
nvim --version
|
||||
task test
|
||||
4
.gitignore
vendored
4
.gitignore
vendored
|
|
@ -1 +1,3 @@
|
|||
playground/
|
||||
/playground/
|
||||
/.tests/
|
||||
/.env
|
||||
|
|
|
|||
|
|
@ -1,15 +0,0 @@
|
|||
repos:
|
||||
- repo: local
|
||||
hooks:
|
||||
- id: stylua
|
||||
name: StyLua
|
||||
language: rust
|
||||
entry: stylua
|
||||
types: [lua]
|
||||
args: ["--check", "-"]
|
||||
- id: selene
|
||||
name: Selene
|
||||
language: rust
|
||||
entry: selene
|
||||
types: [lua]
|
||||
args: ["-"]
|
||||
|
|
@ -1,13 +1,49 @@
|
|||
# Contributing to `gopher.nvim`
|
||||
Thank you for taking the time to submit some code to gopher.nvim. It means a lot!
|
||||
|
||||
Thank you for looking to contributing
|
||||
|
||||
### Styling and formatting
|
||||
### Task running
|
||||
In this codebase for running tasks is used [Taskfile](https://taskfile.dev).
|
||||
You can install it with:
|
||||
```bash
|
||||
go install github.com/go-task/task/v3/cmd/task@latest
|
||||
```
|
||||
|
||||
### Formatting and linting
|
||||
Code is formatted by [stylua](https://github.com/JohnnyMorganz/StyLua) and linted using [selene](https://github.com/Kampfkarren/selene).
|
||||
You can install these with:
|
||||
|
||||
```bash
|
||||
cargo install stylua
|
||||
cargo install selene
|
||||
sudo pacman -S selene stylua
|
||||
# or whatever is your package manager
|
||||
```
|
||||
|
||||
For formatting use this following commands, or setup your editor to integrate with selene/stylua:
|
||||
```bash
|
||||
task format
|
||||
task lint
|
||||
```
|
||||
|
||||
### Documentation
|
||||
Here we're using [mini.doc](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-doc.md)
|
||||
for generating vimhelp files based on [LuaCats](https://luals.github.io/wiki/annotations/) annotations in comments.
|
||||
|
||||
For demo gifs in [readme](./README.md) we're using [vhs](https://github.com/charmbracelet/vhs).
|
||||
All files related to demos live in [/vhs](./vhs) dir.
|
||||
|
||||
You can generate docs with:
|
||||
```bash
|
||||
task docgen # generates vimhelp
|
||||
task vhs:generate # generates demo gifs
|
||||
```
|
||||
|
||||
### Commit messages
|
||||
We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), please follow it.
|
||||
|
||||
### Testing
|
||||
For testing this plugins uses [mini.test](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-test.md).
|
||||
All tests live in [/spec](./spec) dir.
|
||||
|
||||
You can run tests with:
|
||||
```bash
|
||||
task test
|
||||
```
|
||||
|
|
|
|||
21
LICENSE
Normal file
21
LICENSE
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) 2025 Oleksandr Smirnov
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
11
Makefile
11
Makefile
|
|
@ -1,11 +0,0 @@
|
|||
.PHONY:
|
||||
.SILENT:
|
||||
|
||||
format:
|
||||
stylua **/*.lua
|
||||
|
||||
lint:
|
||||
selene **/*.lua
|
||||
|
||||
test:
|
||||
nvim --headless -u ./spec/minimal_init.vim -c "PlenaryBustedDirectory spec {minimal_init='./spec/minimal_init.vim'}"
|
||||
344
README.md
344
README.md
|
|
@ -4,163 +4,293 @@
|
|||
|
||||
Minimalistic plugin for Go development in Neovim written in Lua.
|
||||
|
||||
It's not an LSP tool, the main goal of this plugin is add go tooling support in Neovim.
|
||||
It's **NOT** an LSP tool, the goal of this plugin is to add go tooling support in Neovim.
|
||||
|
||||
## Install
|
||||
> All development of new and maybe undocumented, and unstable features is happening on [develop](https://github.com/olexsmir/gopher.nvim/tree/develop) branch.
|
||||
|
||||
Pre-dependency: [go](https://github.com/golang/go) (tested on 1.17 and 1.18)
|
||||
## Table of content
|
||||
* [How to install](#install-using-lazynvim)
|
||||
* [Features](#features)
|
||||
* [Configuration](#configuration)
|
||||
* [Troubleshooting](#troubleshooting)
|
||||
* [Contributing](#contributing)
|
||||
|
||||
## Install (using [lazy.nvim](https://github.com/folke/lazy.nvim))
|
||||
|
||||
Requirements:
|
||||
|
||||
- **Neovim 0.10** or later
|
||||
- Treesitter parser for `go`(`:TSInstall go` if you use [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter))
|
||||
- [Go](https://github.com/golang/go) installed
|
||||
|
||||
> [!IMPORTANT]
|
||||
> If you prefer using other forges, this repository is also mirrored at:
|
||||
> - [tangled.org](https://tangled.org): [`https://tangled.org/olexsmir.xyz/gopher.nvim`](https://tangled.org/olexsmir.xyz/gopher.nvim)
|
||||
> - [codeberg.org](https://codeberg.org): [`https://codeberg.org/olexsmir/gopher.nvim`](https://codeberg.org/olexsmir/gopher.nvim)
|
||||
|
||||
```lua
|
||||
use {
|
||||
-- NOTE: this plugin is already lazy-loaded and adds only about 1ms
|
||||
-- of load time to your config
|
||||
{
|
||||
"olexsmir/gopher.nvim",
|
||||
requires = { -- dependencies
|
||||
"nvim-lua/plenary.nvim",
|
||||
"nvim-treesitter/nvim-treesitter",
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
Also, run `TSInstall go` if `go` parser if isn't installed yet.
|
||||
|
||||
## Config
|
||||
|
||||
By `.setup` function you can configure the plugin.
|
||||
|
||||
Note:
|
||||
|
||||
- `installer` does not install the tool in user set path
|
||||
|
||||
```lua
|
||||
require("gopher").setup {
|
||||
commands = {
|
||||
go = "go",
|
||||
gomodifytags = "gomodifytags",
|
||||
gotests = "~/go/bin/gotests", -- also you can set custom command path
|
||||
impl = "impl",
|
||||
iferr = "iferr",
|
||||
},
|
||||
ft = "go",
|
||||
-- branch = "develop"
|
||||
-- (optional) updates the plugin's dependencies on each update
|
||||
build = function()
|
||||
vim.cmd.GoInstallDeps()
|
||||
end,
|
||||
---@module "gopher"
|
||||
---@type gopher.Config
|
||||
opts = {},
|
||||
}
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
1. Installation requires this go tool:
|
||||
<details>
|
||||
<summary>
|
||||
<b>Install plugin's go deps</b>
|
||||
</summary>
|
||||
|
||||
```vim
|
||||
:GoInstallDeps
|
||||
```
|
||||
```vim
|
||||
:GoInstallDeps
|
||||
```
|
||||
|
||||
It will install next tools:
|
||||
This will install the following tools:
|
||||
|
||||
- [gomodifytags](https://github.com/fatih/gomodifytags)
|
||||
- [impl](https://github.com/josharian/impl)
|
||||
- [gotests](https://github.com/cweill/gotests)
|
||||
- [iferr](https://github.com/koron/iferr)
|
||||
- [gomodifytags](https://github.com/fatih/gomodifytags)
|
||||
- [impl](https://github.com/josharian/impl)
|
||||
- [gotests](https://github.com/cweill/gotests)
|
||||
- [iferr](https://github.com/koron/iferr)
|
||||
- [json2go](https://github.com/olexsmir/json2go)
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
<b>Add and remove tags for structs via <a href="https://github.com/fatih/gomodifytags">gomodifytags</a></b>
|
||||
</summary>
|
||||
|
||||

|
||||
|
||||
2. Modify struct tags:
|
||||
By default `json` tag will be added/removed, if not set:
|
||||
|
||||
```vim
|
||||
:GoTagAdd json " For add json tag
|
||||
:GoTagRm yaml " For remove yaml tag
|
||||
```
|
||||
```vim
|
||||
" add json tag
|
||||
:GoTagAdd json
|
||||
|
||||
3. Run `go mod` command:
|
||||
" add json tag with omitempty option
|
||||
:GoTagAdd json=omitempty
|
||||
|
||||
```vim
|
||||
:GoMod tidy " Runs `go mod tidy`
|
||||
:GoMod init asdf " Runs `go mod init asdf`
|
||||
```
|
||||
" remove yaml tag
|
||||
:GoTagRm yaml
|
||||
```
|
||||
|
||||
4. Run `go get` command
|
||||
```lua
|
||||
-- or you can use lua api
|
||||
require("gopher").tags.add "xml"
|
||||
require("gopher").tags.rm "proto"
|
||||
```
|
||||
</details>
|
||||
|
||||
Link can have a `http` or `https` prefix.
|
||||
<details>
|
||||
<summary>
|
||||
<b>Generating tests via <a href="https://github.com/cweill/gotests">gotests</a></b>
|
||||
</summary>
|
||||
|
||||
You can provide more than one package url:
|
||||
```vim
|
||||
" Generate one test for a specific function/method(one under cursor)
|
||||
:GoTestAdd
|
||||
|
||||
```vim
|
||||
:GoGet github.com/gorilla/mux
|
||||
```
|
||||
" Generate all tests for all functions/methods in the current file
|
||||
:GoTestsAll
|
||||
|
||||
5. Interface implementation
|
||||
" Generate tests for only exported functions/methods in the current file
|
||||
:GoTestsExp
|
||||
```
|
||||
|
||||
Command syntax:
|
||||
```lua
|
||||
-- or you can use lua api
|
||||
require("gopher").test.add()
|
||||
require("gopher").test.exported()
|
||||
require("gopher").test.all()
|
||||
```
|
||||
|
||||
```vim
|
||||
:GoImpl [receiver] [interface]
|
||||
For named tests see `:h gopher.nvim-gotests-named`
|
||||
</details>
|
||||
|
||||
" Also you can put cursor on the struct and run:
|
||||
:GoImpl [interface]
|
||||
```
|
||||
<details>
|
||||
<summary>
|
||||
<b>Run commands like <code>go mod/get/etc</code> inside of nvim</b>
|
||||
</summary>
|
||||
|
||||
Example of usage:
|
||||
```vim
|
||||
:GoGet github.com/gorilla/mux
|
||||
|
||||
```vim
|
||||
" Example
|
||||
:GoImpl r Read io.Reader
|
||||
" or simply put your cursor in the struct and run:
|
||||
:GoImpl io.Reader
|
||||
```
|
||||
" Link can have an `http` or `https` prefix.
|
||||
:GoGet https://github.com/lib/pq
|
||||
|
||||
6. Generate tests with [gotests](https://github.com/cweill/gotests)
|
||||
" You can provide more than one package url
|
||||
:GoGet github.com/jackc/pgx/v5 github.com/google/uuid/
|
||||
|
||||
Generate one test for a specific function/method:
|
||||
" go mod commands
|
||||
:GoMod tidy
|
||||
:GoMod init new-shiny-project
|
||||
|
||||
```vim
|
||||
:GoTestAdd
|
||||
```
|
||||
" go work commands
|
||||
:GoWork sync
|
||||
|
||||
Generate all tests for all functions/methods in current file:
|
||||
" run go generate in cwd
|
||||
:GoGenerate
|
||||
|
||||
```vim
|
||||
:GoTestsAll
|
||||
```
|
||||
" run go generate for the current file
|
||||
:GoGenerate %
|
||||
```
|
||||
</details>
|
||||
|
||||
Generate tests only for exported functions/methods in current file:
|
||||
<details>
|
||||
<summary>
|
||||
<b>Interface implementation via <a href="https://github.com/josharian/impl">impl<a></b>
|
||||
</summary>
|
||||
|
||||
```vim
|
||||
:GoTestsExp
|
||||
```
|
||||

|
||||
|
||||
7. Run `go generate` command;
|
||||
Syntax of the command:
|
||||
```vim
|
||||
:GoImpl [receiver] [interface]
|
||||
|
||||
```vim
|
||||
" Run `go generate` in cwd path
|
||||
:GoGenerate
|
||||
" also you can put a cursor on the struct and run
|
||||
:GoImpl [interface]
|
||||
```
|
||||
|
||||
" Run `go generate` for current file
|
||||
:GoGenerate %
|
||||
```
|
||||
Usage examples:
|
||||
```vim
|
||||
:GoImpl r Read io.Reader
|
||||
:GoImpl Write io.Writer
|
||||
|
||||
8. Generate doc comment
|
||||
" or you can simply put a cursor on the struct and run
|
||||
:GoImpl io.Reader
|
||||
```
|
||||
</details>
|
||||
|
||||
First set a cursor on **public** package/function/interface/struct and execute:
|
||||
<details>
|
||||
<summary>
|
||||
<b>Generate boilerplate for doc comments</b>
|
||||
</summary>
|
||||
|
||||
```vim
|
||||
:GoCmt
|
||||
```
|
||||

|
||||
|
||||
9. Generate `if err`
|
||||
First set a cursor on **public** package/function/interface/struct and execute:
|
||||
|
||||
Set cursor on the line with **err** and execute:
|
||||
```vim
|
||||
:GoCmt
|
||||
```
|
||||
</details>
|
||||
|
||||
```vim
|
||||
:GoIfErr
|
||||
```
|
||||
<details>
|
||||
<summary>
|
||||
<b>Convert json to Go types</b>
|
||||
</summary>
|
||||
|
||||
10. Setup nvim-dap for go in one line.
|
||||

|
||||
|
||||
Notice: [nvim-dap](https://github.com/mfussenegger/nvim-dap) is required
|
||||
`:GoJson` opens a temporary buffer where you can paste or write JSON.
|
||||
Saving the buffer (`:w` or `:wq`) automatically closes it and inserts the generated Go struct into the original buffer at the cursor position.
|
||||
|
||||
Alternatively, you can pass JSON directly as an argument:
|
||||
```vim
|
||||
:GoJson {"name": "Alice", "age": 30}
|
||||
```
|
||||
|
||||
Additionally, `gopher.json2go` provides lua api, see `:h gopher.nvim-json2go` for details.
|
||||
</details>
|
||||
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
<b>Generate <code>if err != nil {</code> via <a href="https://github.com/koron/iferr">iferr</a></b>
|
||||
</summary>
|
||||
|
||||

|
||||
|
||||
Set the cursor on the line with `err` and execute
|
||||
|
||||
```vim
|
||||
:GoIfErr
|
||||
```
|
||||
</details>
|
||||
|
||||
## Configuration
|
||||
|
||||
> [!IMPORTANT]
|
||||
>
|
||||
> If you need more info look `:h gopher.nvim`
|
||||
|
||||
**Take a look at default options (might be a bit outdated, look `:h gopher.nvim-config`)**
|
||||
|
||||
```lua
|
||||
require"gopher.dap".setup()
|
||||
require("gopher").setup {
|
||||
-- log level, you might consider using DEBUG or TRACE for debugging the plugin
|
||||
log_level = vim.log.levels.INFO,
|
||||
|
||||
-- timeout for running internal commands
|
||||
timeout = 2000,
|
||||
|
||||
-- timeout for running installer commands(e.g :GoDepsInstall, :GoDepsInstallSync)
|
||||
installer_timeout = 999999,
|
||||
|
||||
-- user specified paths to binaries
|
||||
commands = {
|
||||
go = "go",
|
||||
gomodifytags = "gomodifytags",
|
||||
gotests = "gotests",
|
||||
impl = "impl",
|
||||
iferr = "iferr",
|
||||
},
|
||||
gotests = {
|
||||
-- a default template that gotess will use.
|
||||
-- gotets doesn't have template named `default`, we use it to represent absence of the provided template.
|
||||
template = "default",
|
||||
|
||||
-- path to a directory containing custom test code templates
|
||||
template_dir = nil,
|
||||
|
||||
-- use named tests(map with test name as key) in table tests(slice of structs by default)
|
||||
named = false,
|
||||
},
|
||||
gotag = {
|
||||
transform = "snakecase",
|
||||
|
||||
-- default tags to add to struct fields
|
||||
default_tag = "json",
|
||||
|
||||
-- default tag option added struct fields, set to nil to disable
|
||||
-- e.g: `option = "json=omitempty,xml=omitempty`
|
||||
option = nil,
|
||||
},
|
||||
iferr = {
|
||||
-- choose a custom error message, nil to use default
|
||||
-- e.g: `message = 'fmt.Errorf("failed to %w", err)'`
|
||||
message = nil,
|
||||
},
|
||||
json2go = {
|
||||
-- command used to open interactive input.
|
||||
-- e.g: `split`, `botright split`, `tabnew`
|
||||
interactive_cmd = "vsplit",
|
||||
|
||||
-- name of autogenerated struct
|
||||
-- e.g: "MySuperCoolName"
|
||||
type_name = nil,
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
The most common issue with the plugin is missing dependencies.
|
||||
Run `:checkhealth gopher` to verify that the plugin is installed correctly.
|
||||
If any binaries are missing, install them using `:GoInstallDeps`.
|
||||
|
||||
If the issue persists, feel free to [open a new issue](https://github.com/olexsmir/gopher.nvim/issues/new).
|
||||
|
||||
## Contributing
|
||||
|
||||
PRs are always welcome. See [CONTRIBUTING.md](./CONTRIBUTING.md)
|
||||
|
||||
## Thanks
|
||||
|
||||
- [go.nvim](https://github.com/ray-x/go.nvim)
|
||||
- [nvim-dap-go](https://github.com/leoluz/nvim-dap-go)
|
||||
|
|
|
|||
42
Taskfile.yml
Normal file
42
Taskfile.yml
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
version: "3"
|
||||
|
||||
includes:
|
||||
vhs:
|
||||
taskfile: ./vhs/Taskfile.yml
|
||||
dir: ./vhs
|
||||
|
||||
tasks:
|
||||
lint:
|
||||
cmds:
|
||||
- selene .
|
||||
- stylua --check .
|
||||
|
||||
format:
|
||||
cmd: stylua .
|
||||
|
||||
test:
|
||||
cmds:
|
||||
- |
|
||||
nvim --clean --headless \
|
||||
-u ./scripts/minimal_init.lua \
|
||||
-c "lua MiniTest.run()" \
|
||||
-c ":qa!"
|
||||
nvim:
|
||||
cmd: nvim --clean -u "./scripts/minimal_init.lua" {{ .CLI_ARGS }}
|
||||
|
||||
docgen:
|
||||
desc: generate vimhelp
|
||||
cmds:
|
||||
- |
|
||||
nvim --clean --headless \
|
||||
-u "./scripts/minimal_init.lua" \
|
||||
-c "luafile ./scripts/docgen.lua" \
|
||||
-c ":qa!"
|
||||
|
||||
install-deps:
|
||||
desc: installs go bin (used in CI)
|
||||
cmds:
|
||||
- |
|
||||
nvim --clean --headless \
|
||||
-u "./scripts/minimal_init.lua" \
|
||||
+GoInstallDepsSync +qa
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
function! health#gopher#check()
|
||||
lua require"gopher.health".check()
|
||||
endfunction
|
||||
1
doc/.gitignore
vendored
Normal file
1
doc/.gitignore
vendored
Normal file
|
|
@ -0,0 +1 @@
|
|||
/tags
|
||||
294
doc/gopher.nvim.txt
Normal file
294
doc/gopher.nvim.txt
Normal file
|
|
@ -0,0 +1,294 @@
|
|||
*gopher.nvim* Enhance your golang experience
|
||||
|
||||
MIT License Copyright (c) 2025 Oleksandr Smirnov
|
||||
|
||||
==============================================================================
|
||||
|
||||
gopher.nvim is a minimalistic plugin for Go development in Neovim written in Lua.
|
||||
It's not an LSP tool, the main goal of this plugin is add go tooling support in Neovim.
|
||||
|
||||
Table of Contents
|
||||
Setup ................................................ |gopher.nvim-setup()|
|
||||
Install dependencies ............................ |gopher.nvim-dependencies|
|
||||
Config ................................................ |gopher.nvim-config|
|
||||
Commands ............................................ |gopher.nvim-commands|
|
||||
Modify struct tags ............................... |gopher.nvim-struct-tags|
|
||||
json2go .............................................. |gopher.nvim-json2go|
|
||||
Auto implementation of interface methods ................ |gopher.nvim-impl|
|
||||
Generating unit tests boilerplate .................... |gopher.nvim-gotests|
|
||||
Iferr .................................................. |gopher.nvim-iferr|
|
||||
Generate comments ................................... |gopher.nvim-comments|
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
*gopher.nvim-setup()*
|
||||
`gopher.setup`({user_config})
|
||||
Setup function. This method simply merges default config with opts table.
|
||||
You can read more about configuration at |gopher.nvim-config|
|
||||
Calling this function is optional, if you ok with default settings.
|
||||
See |gopher.nvim.config|
|
||||
|
||||
Usage ~
|
||||
>lua
|
||||
require("gopher").setup {} -- use default config or replace {} with your own
|
||||
<
|
||||
Parameters ~
|
||||
{user_config} `(gopher.Config)` See |gopher.nvim-config|
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
*gopher.nvim-dependencies*
|
||||
`gopher.install_deps`
|
||||
|
||||
Gopher.nvim implements most of its features using third-party tools. To
|
||||
install plugin's dependencies, you can run:
|
||||
`:GoInstallDeps` or `:GoInstallDepsSync`
|
||||
or use `require("gopher").install_deps()` if you prefer lua api.
|
||||
|
||||
|
||||
==============================================================================
|
||||
------------------------------------------------------------------------------
|
||||
*gopher.nvim-config*
|
||||
`default_config`
|
||||
>lua
|
||||
local default_config = {
|
||||
-- log level, you might consider using DEBUG or TRACE for debugging the plugin
|
||||
---@type number
|
||||
log_level = vim.log.levels.INFO,
|
||||
|
||||
-- timeout for running internal commands
|
||||
---@type number
|
||||
timeout = 2000,
|
||||
|
||||
-- timeout for running installer commands(e.g :GoDepsInstall, :GoDepsInstallSync)
|
||||
---@type number
|
||||
installer_timeout = 999999,
|
||||
|
||||
-- user specified paths to binaries
|
||||
---@class gopher.ConfigCommand
|
||||
commands = {
|
||||
go = "go",
|
||||
gomodifytags = "gomodifytags",
|
||||
gotests = "gotests",
|
||||
impl = "impl",
|
||||
iferr = "iferr",
|
||||
json2go = "json2go",
|
||||
},
|
||||
---@class gopher.ConfigGotests
|
||||
gotests = {
|
||||
-- a default template that gotess will use.
|
||||
-- gotets doesn't have template named `default`, we use it to represent absence of the provided template.
|
||||
template = "default",
|
||||
|
||||
-- path to a directory containing custom test code templates
|
||||
---@type string|nil
|
||||
template_dir = nil,
|
||||
|
||||
-- use named tests(map with test name as key) in table tests(slice of structs by default)
|
||||
named = false,
|
||||
},
|
||||
---@class gopher.ConfigGoTag
|
||||
gotag = {
|
||||
---@type gopher.ConfigGoTagTransform
|
||||
transform = "snakecase",
|
||||
|
||||
-- default tags to add to struct fields
|
||||
default_tag = "json",
|
||||
|
||||
-- default tag option added struct fields, set to nil to disable
|
||||
-- e.g: `option = "json=omitempty,xml=omitempty`
|
||||
---@type string|nil
|
||||
option = nil,
|
||||
},
|
||||
---@class gopher.ConfigIfErr
|
||||
iferr = {
|
||||
-- choose a custom error message, nil to use default
|
||||
-- e.g: `message = 'fmt.Errorf("failed to %w", err)'`
|
||||
---@type string|nil
|
||||
message = nil,
|
||||
},
|
||||
---@class gopher.ConfigJson2Go
|
||||
json2go = {
|
||||
-- command used to open interactive input.
|
||||
-- e.g: `split`, `botright split`, `tabnew`
|
||||
interactive_cmd = "vsplit",
|
||||
|
||||
-- name of autogenerated struct, if nil none, will the default one of json2go.
|
||||
-- e.g: "MySuperCoolName"
|
||||
---@type string|nil
|
||||
type_name = nil,
|
||||
},
|
||||
}
|
||||
<
|
||||
Class ~
|
||||
{gopher.Config}
|
||||
Fields ~
|
||||
{setup} `(fun(user_config?: gopher.Config))`
|
||||
|
||||
|
||||
==============================================================================
|
||||
------------------------------------------------------------------------------
|
||||
*gopher.nvim-commands*
|
||||
|
||||
If don't want to automatically register plugins' commands,
|
||||
you can set `vim.g.gopher_register_commands` to `false`, before loading the plugin.
|
||||
|
||||
|
||||
==============================================================================
|
||||
------------------------------------------------------------------------------
|
||||
*gopher.nvim-struct-tags*
|
||||
|
||||
`struct_tags` is utilizing the `gomodifytags` tool to add or remove tags to
|
||||
struct fields.
|
||||
|
||||
Usage ~
|
||||
|
||||
How to add/remove/clear tags to struct fields:
|
||||
1. Place cursor on the struct
|
||||
2. Run `:GoTagAdd json` to add json tags to struct fields
|
||||
3. Run `:GoTagRm json` to remove json tags to struct fields
|
||||
4. Run `:GoTagClear` to clear all tags from struct fields
|
||||
|
||||
If you want to add/remove tag with options, you can use `json=omitempty`
|
||||
(where json is tag, and omitempty is its option).
|
||||
Example: `:GoTagAdd xml json=omitempty`
|
||||
|
||||
|
||||
NOTE: if you dont specify the tag it will use `json` as default
|
||||
|
||||
Example:
|
||||
>go
|
||||
// before
|
||||
type User struct {
|
||||
// ^ put your cursor here
|
||||
// run `:GoTagAdd yaml`
|
||||
ID int
|
||||
Name string
|
||||
}
|
||||
|
||||
// after
|
||||
type User struct {
|
||||
ID int `yaml:id`
|
||||
Name string `yaml:name`
|
||||
}
|
||||
<
|
||||
|
||||
==============================================================================
|
||||
------------------------------------------------------------------------------
|
||||
*gopher.nvim-json2go*
|
||||
|
||||
Convert json to go type annotations.
|
||||
|
||||
Usage ~
|
||||
|
||||
`:GoJson` opens a temporary buffer where you can paste or write JSON.
|
||||
Saving the buffer (`:w` or `:wq`) automatically closes it and inserts the
|
||||
generated Go struct into the original buffer at the cursor position.
|
||||
|
||||
Alternatively, you can pass JSON directly as an argument:
|
||||
>vim
|
||||
:GoJson {"name": "Alice", "age": 30}
|
||||
<
|
||||
------------------------------------------------------------------------------
|
||||
*json2go.transform()*
|
||||
`json2go.transform`({json_str})
|
||||
|
||||
Parameters ~
|
||||
{json_str} `(string)` Json string that is going to be converted to go type.
|
||||
Return ~
|
||||
`(string)` `(optional)` Go type, or nil if failed.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
*json2go.json2go()*
|
||||
`json2go.json2go`({json_str})
|
||||
Converts json string to go type, and puts result under the cursor. If
|
||||
[json_str] is nil, will open an interactive prompt (with cmd set in
|
||||
config).
|
||||
|
||||
Parameters ~
|
||||
{json_str} `(optional)` `(string)`
|
||||
|
||||
|
||||
==============================================================================
|
||||
------------------------------------------------------------------------------
|
||||
*gopher.nvim-impl*
|
||||
|
||||
Integration of `impl` tool to generate method stubs for interfaces.
|
||||
|
||||
Usage ~
|
||||
|
||||
1. Automatically implement an interface for a struct:
|
||||
- Place your cursor on the struct where you want to implement the interface.
|
||||
- Run `:GoImpl io.Reader`
|
||||
- This will automatically determine the receiver and implement the `io.Reader` interface.
|
||||
|
||||
2. Specify a custom receiver:
|
||||
- Place your cursor on the struct
|
||||
- Run `:GoImpl w io.Writer`, where:
|
||||
- `w` is the receiver.
|
||||
- `io.Writer` is the interface to implement.
|
||||
|
||||
3. Explicitly specify the receiver, struct, and interface:
|
||||
- No need to place the cursor on the struct if all arguments are provided.
|
||||
- Run `:GoImpl r RequestReader io.Reader`, where:
|
||||
- `r` is the receiver.
|
||||
- `RequestReader` is the struct.
|
||||
- `io.Reader` is the interface to implement.
|
||||
|
||||
Example:
|
||||
>go
|
||||
type BytesReader struct{}
|
||||
// ^ put your cursor here
|
||||
// run `:GoImpl b io.Reader`
|
||||
|
||||
// this is what you will get
|
||||
func (b *BytesReader) Read(p []byte) (n int, err error) {
|
||||
panic("not implemented") // TODO: Implement
|
||||
}
|
||||
<
|
||||
|
||||
==============================================================================
|
||||
------------------------------------------------------------------------------
|
||||
*gopher.nvim-gotests*
|
||||
gotests is utilizing the `gotests` tool to generate unit tests boilerplate.
|
||||
Usage ~
|
||||
|
||||
- Generate unit test for specific function/method:
|
||||
1. Place your cursor on the desired function/method.
|
||||
2. Run `:GoTestAdd`
|
||||
|
||||
- Generate unit tests for *all* functions/methods in current file:
|
||||
- run `:GoTestsAll`
|
||||
|
||||
- Generate unit tests *only* for *exported(public)* functions/methods:
|
||||
- run `:GoTestsExp`
|
||||
|
||||
You can also specify the template to use for generating the tests.
|
||||
See |gopher.nvim-config|.
|
||||
More details about templates: https://github.com/cweill/gotests
|
||||
|
||||
If you prefer named tests, you can enable them in |gopher.nvim-config|.
|
||||
|
||||
|
||||
==============================================================================
|
||||
------------------------------------------------------------------------------
|
||||
*gopher.nvim-iferr*
|
||||
|
||||
`iferr` provides a way to way to automatically insert `if err != nil` check.
|
||||
If you want to change `-message` option of `iferr` tool, see |gopher.nvim-config|
|
||||
|
||||
Usage ~
|
||||
Execute `:GoIfErr` near any `err` variable to insert the check
|
||||
|
||||
|
||||
==============================================================================
|
||||
------------------------------------------------------------------------------
|
||||
*gopher.nvim-comments*
|
||||
|
||||
This module provides a way to generate comments for Go code.
|
||||
|
||||
Usage ~
|
||||
|
||||
Set cursor on line with function/method/struct/etc and
|
||||
run `:GoCmt` to generate a comment.
|
||||
|
||||
|
||||
vim:tw=78:ts=8:noet:ft=help:norl:
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
return {
|
||||
---@param lib string
|
||||
---@return boolean
|
||||
lualib_is_found = function(lib)
|
||||
local is_found, _ = pcall(require, lib)
|
||||
return is_found
|
||||
end,
|
||||
|
||||
---@param bin string
|
||||
---@return boolean
|
||||
binary_is_found = function(bin)
|
||||
if vim.fn.executable(bin) == 1 then
|
||||
return true
|
||||
end
|
||||
return false
|
||||
end,
|
||||
}
|
||||
|
|
@ -1,40 +0,0 @@
|
|||
---Run any go commands like `go generate`, `go get`, `go mod`
|
||||
---@param cmd string
|
||||
---@param ... string|string[]
|
||||
return function(cmd, ...)
|
||||
local Job = require "plenary.job"
|
||||
local c = require("gopher.config").config.commands
|
||||
local u = require "gopher._utils"
|
||||
|
||||
local args = { ... }
|
||||
if #args == 0 then
|
||||
u.notify("please provice any arguments", "error")
|
||||
return
|
||||
end
|
||||
|
||||
if cmd == "generate" and #args == 1 and args[1] == "%" then
|
||||
args[1] = vim.fn.expand "%" ---@diagnostic disable-line: missing-parameter
|
||||
elseif cmd == "get" then
|
||||
for i, arg in ipairs(args) do
|
||||
---@diagnostic disable-next-line: param-type-mismatch
|
||||
local m = string.match(arg, "^https://(.*)$") or string.match(arg, "^http://(.*)$") or arg
|
||||
table.remove(args, i)
|
||||
table.insert(args, i, m)
|
||||
end
|
||||
end
|
||||
|
||||
local cmd_args = vim.list_extend({ cmd }, args) ---@diagnostic disable-line: missing-parameter
|
||||
Job:new({
|
||||
command = c.go,
|
||||
args = cmd_args,
|
||||
on_exit = function(_, retval)
|
||||
if retval ~= 0 then
|
||||
u.notify("command 'go " .. unpack(cmd_args) .. "' exited with code " .. retval, "error")
|
||||
u.notify(cmd .. " " .. unpack(cmd_args), "debug")
|
||||
return
|
||||
end
|
||||
|
||||
u.notify("go " .. cmd .. " was success runned", "info")
|
||||
end,
|
||||
}):start()
|
||||
end
|
||||
|
|
@ -1,48 +1,72 @@
|
|||
---@diagnostic disable: param-type-mismatch
|
||||
return {
|
||||
---@param t table
|
||||
---@return boolean
|
||||
empty = function(t)
|
||||
if t == nil then
|
||||
return true
|
||||
local c = require "gopher.config"
|
||||
local log = require "gopher._utils.log"
|
||||
local utils = {}
|
||||
|
||||
---@param msg string
|
||||
---@param lvl? integer by default `vim.log.levels.INFO`
|
||||
function utils.notify(msg, lvl)
|
||||
lvl = lvl or vim.log.levels.INFO
|
||||
vim.notify(msg, lvl, {
|
||||
---@diagnostic disable-next-line:undefined-field
|
||||
title = c.___plugin_name,
|
||||
})
|
||||
log.debug(msg)
|
||||
end
|
||||
|
||||
---@param path string
|
||||
---@return string
|
||||
function utils.readfile_joined(path)
|
||||
return table.concat(vim.fn.readfile(path), "\n")
|
||||
end
|
||||
|
||||
---@param t string[]
|
||||
---@return string[]
|
||||
function utils.remove_empty_lines(t)
|
||||
local res = {}
|
||||
for _, line in ipairs(t) do
|
||||
if line ~= "" then
|
||||
table.insert(res, line)
|
||||
end
|
||||
end
|
||||
return res
|
||||
end
|
||||
|
||||
---@param s string
|
||||
---@return string
|
||||
function utils.trimend(s)
|
||||
local r, _ = string.gsub(s, "%s+$", "")
|
||||
return r
|
||||
end
|
||||
|
||||
-- Since indentation can be spaces or tabs, that's my hack around it
|
||||
---@param line string
|
||||
---@param indent integer
|
||||
---@return string
|
||||
function utils.indent(line, indent)
|
||||
local char = string.sub(line, 1, 1)
|
||||
if char ~= " " and char ~= "\t" then
|
||||
char = " "
|
||||
end
|
||||
return string.rep(char, indent)
|
||||
end
|
||||
|
||||
---@generic T
|
||||
---@param tbl T[]
|
||||
---@return T[]
|
||||
function utils.list_unique(tbl)
|
||||
if vim.fn.has "nvim-0.12" == 1 then
|
||||
return vim.list.unique(tbl)
|
||||
end
|
||||
|
||||
return next(t) == nil
|
||||
end,
|
||||
|
||||
---@param s string
|
||||
---@return string
|
||||
rtrim = function(s)
|
||||
local n = #s
|
||||
while n > 0 and s:find("^%s", n) do
|
||||
n = n - 1
|
||||
for i = #tbl, 1, -1 do
|
||||
for j = 1, i - 1 do
|
||||
if tbl[i] == tbl[j] then
|
||||
table.remove(tbl, i)
|
||||
break
|
||||
end
|
||||
|
||||
return s:sub(1, n)
|
||||
end,
|
||||
|
||||
---@param msg string
|
||||
---@param lvl string|integer
|
||||
notify = function(msg, lvl)
|
||||
local l
|
||||
if lvl == "error" or lvl == 4 then
|
||||
l = vim.log.levels.ERROR
|
||||
elseif lvl == "info" or lvl == 2 then
|
||||
l = vim.log.levels.INFO
|
||||
elseif lvl == "debug" or lvl == 1 then
|
||||
l = vim.log.levels.DEBUG
|
||||
end
|
||||
end
|
||||
return tbl
|
||||
end
|
||||
|
||||
vim.defer_fn(function()
|
||||
vim.notify(msg, l)
|
||||
end, 0)
|
||||
end,
|
||||
|
||||
---safe require
|
||||
---@param name string module name
|
||||
sreq = function(name)
|
||||
local ok, m = pcall(require, name)
|
||||
assert(ok, string.format("gopher.nvim dependency error: %s not installed", name))
|
||||
return m
|
||||
end,
|
||||
}
|
||||
return utils
|
||||
|
|
|
|||
171
lua/gopher/_utils/log.lua
Normal file
171
lua/gopher/_utils/log.lua
Normal file
|
|
@ -0,0 +1,171 @@
|
|||
-- thanks https://github.com/tjdevries/vlog.nvim
|
||||
-- and https://github.com/williamboman/mason.nvim
|
||||
-- for the code i have stolen(or have inspected by idk)
|
||||
local c = require "gopher.config"
|
||||
|
||||
---@class gopher.Logger
|
||||
---@field get_outfile fun():string
|
||||
---@field trace fun(...)
|
||||
---@field fmt_trace fun(...)
|
||||
---@field debug fun(...)
|
||||
---@field fmt_debug fun(...)
|
||||
---@field info fun(...)
|
||||
---@field fmt_info fun(...)
|
||||
---@field warn fun(...)
|
||||
---@field fmt_warn fun(...)
|
||||
---@field error fun(...)
|
||||
---@field fmt_error fun(...)
|
||||
|
||||
local config = {
|
||||
-- Name of the plugin. Prepended to log messages
|
||||
---@diagnostic disable-next-line:undefined-field
|
||||
name = c.___plugin_name,
|
||||
|
||||
-- Should print the output to neovim while running
|
||||
-- values: 'sync','async',false
|
||||
use_console = vim.env.GOPHER_VERBOSE_LOGS == "1",
|
||||
|
||||
-- Should highlighting be used in console (using echohl)
|
||||
highlights = true,
|
||||
|
||||
-- Should write to a file
|
||||
use_file = true,
|
||||
|
||||
-- Level configuration
|
||||
modes = {
|
||||
{ name = "trace", hl = "Comment", level = vim.log.levels.TRACE },
|
||||
{ name = "debug", hl = "Comment", level = vim.log.levels.DEBUG },
|
||||
{ name = "info", hl = "None", level = vim.log.levels.INFO },
|
||||
{ name = "warn", hl = "WarningMsg", level = vim.log.levels.WARN },
|
||||
{ name = "error", hl = "ErrorMsg", level = vim.log.levels.ERROR },
|
||||
},
|
||||
|
||||
-- Can limit the number of decimals displayed for floats
|
||||
float_precision = 0.01,
|
||||
}
|
||||
|
||||
---@type gopher.Logger
|
||||
---@diagnostic disable-next-line: missing-fields
|
||||
local log = {}
|
||||
|
||||
---@return string
|
||||
function log.get_outfile()
|
||||
return table.concat {
|
||||
(vim.fn.has "nvim-0.8.0" == 1) and vim.fn.stdpath "log" or vim.fn.stdpath "cache",
|
||||
("/%s.log"):format(config.name),
|
||||
}
|
||||
end
|
||||
|
||||
-- selene: allow(incorrect_standard_library_use)
|
||||
local unpack = unpack or table.unpack
|
||||
|
||||
do
|
||||
local round = function(x, increment)
|
||||
increment = increment or 1
|
||||
x = x / increment
|
||||
return (x > 0 and math.floor(x + 0.5) or math.ceil(x - 0.5)) * increment
|
||||
end
|
||||
|
||||
local tbl_has_tostring = function(tbl)
|
||||
local mt = getmetatable(tbl)
|
||||
return mt and mt.__tostring ~= nil
|
||||
end
|
||||
|
||||
local make_string = function(...)
|
||||
local t = {}
|
||||
for i = 1, select("#", ...) do
|
||||
local x = select(i, ...)
|
||||
|
||||
if type(x) == "number" and config.float_precision then
|
||||
x = tostring(round(x, config.float_precision))
|
||||
elseif type(x) == "table" and not tbl_has_tostring(x) then
|
||||
x = vim.inspect(x)
|
||||
else
|
||||
x = tostring(x)
|
||||
end
|
||||
|
||||
t[#t + 1] = x
|
||||
end
|
||||
return table.concat(t, " ")
|
||||
end
|
||||
|
||||
local log_at_level = function(level_config, message_maker, ...)
|
||||
-- Return early if we're below the current_log_level
|
||||
--
|
||||
-- the log level source get from config directly because otherwise it doesn't work
|
||||
if level_config.level < c.log_level then
|
||||
return
|
||||
end
|
||||
local nameupper = level_config.name:upper()
|
||||
|
||||
local msg = message_maker(...)
|
||||
local info = debug.getinfo(2, "Sl")
|
||||
local lineinfo = info.short_src .. ":" .. info.currentline
|
||||
|
||||
-- Output to console
|
||||
if config.use_console then
|
||||
local log_to_console = function()
|
||||
local console_string =
|
||||
string.format("[%-6s%s] %s: %s", nameupper, os.date "%H:%M:%S", lineinfo, msg)
|
||||
|
||||
if config.highlights and level_config.hl then
|
||||
vim.cmd(string.format("echohl %s", level_config.hl))
|
||||
end
|
||||
|
||||
local split_console = vim.split(console_string, "\n")
|
||||
for _, v in ipairs(split_console) do
|
||||
local formatted_msg = string.format("[%s] %s", config.name, vim.fn.escape(v, [["\]]))
|
||||
|
||||
---@diagnostic disable-next-line: param-type-mismatch
|
||||
local ok = pcall(vim.cmd, string.format([[echom "%s"]], formatted_msg))
|
||||
if not ok then
|
||||
vim.api.nvim_out_write(msg .. "\n")
|
||||
end
|
||||
end
|
||||
|
||||
if config.highlights and level_config.hl then
|
||||
vim.cmd "echohl NONE"
|
||||
end
|
||||
end
|
||||
if config.use_console == "sync" and not vim.in_fast_event() then
|
||||
log_to_console()
|
||||
else
|
||||
vim.schedule(log_to_console)
|
||||
end
|
||||
end
|
||||
|
||||
-- Output to log file
|
||||
if config.use_file then
|
||||
local fp = assert(io.open(log.get_outfile(), "a"))
|
||||
local str = string.format("[%-6s%s] %s: %s\n", nameupper, os.date(), lineinfo, msg)
|
||||
fp:write(str)
|
||||
fp:close()
|
||||
end
|
||||
end
|
||||
|
||||
for _, x in ipairs(config.modes) do
|
||||
-- log.info("these", "are", "separated")
|
||||
log[x.name] = function(...) ---@diagnostic disable-line: assign-type-mismatch
|
||||
return log_at_level(x, make_string, ...)
|
||||
end
|
||||
|
||||
-- log.fmt_info("These are %s strings", "formatted")
|
||||
log[("fmt_%s"):format(x.name)] = function(...) ---@diagnostic disable-line: assign-type-mismatch
|
||||
return log_at_level(x, function(...)
|
||||
local passed = { ... }
|
||||
local fmt = table.remove(passed, 1)
|
||||
local inspected = {}
|
||||
for _, v in ipairs(passed) do
|
||||
if type(v) == "table" and tbl_has_tostring(v) then
|
||||
table.insert(inspected, v)
|
||||
else
|
||||
table.insert(inspected, vim.inspect(v))
|
||||
end
|
||||
end
|
||||
return string.format(fmt, unpack(inspected))
|
||||
end, ...)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
return log
|
||||
39
lua/gopher/_utils/runner.lua
Normal file
39
lua/gopher/_utils/runner.lua
Normal file
|
|
@ -0,0 +1,39 @@
|
|||
local c = require "gopher.config"
|
||||
local runner = {}
|
||||
|
||||
---@class gopher.RunnerOpts
|
||||
---@field cwd? string
|
||||
---@field timeout? number
|
||||
---@field stdin? boolean|string|string[]
|
||||
---@field text? boolean
|
||||
|
||||
---@param cmd (string|number)[]
|
||||
---@param on_exit fun(out:vim.SystemCompleted)
|
||||
---@param opts? gopher.RunnerOpts
|
||||
---@return vim.SystemObj
|
||||
function runner.async(cmd, on_exit, opts)
|
||||
opts = opts or {}
|
||||
return vim.system(cmd, {
|
||||
cwd = opts.cwd or nil,
|
||||
timeout = opts.timeout or c.timeout,
|
||||
stdin = opts.stdin or nil,
|
||||
text = opts.text or true,
|
||||
}, on_exit)
|
||||
end
|
||||
|
||||
---@param cmd (string|number)[]
|
||||
---@param opts? gopher.RunnerOpts
|
||||
---@return vim.SystemCompleted
|
||||
function runner.sync(cmd, opts)
|
||||
opts = opts or {}
|
||||
return vim
|
||||
.system(cmd, {
|
||||
cwd = opts.cwd or nil,
|
||||
timeout = opts.timeout or c.timeout,
|
||||
stdin = opts.stdin or nil,
|
||||
text = opts.text or true,
|
||||
})
|
||||
:wait()
|
||||
end
|
||||
|
||||
return runner
|
||||
160
lua/gopher/_utils/ts.lua
Normal file
160
lua/gopher/_utils/ts.lua
Normal file
|
|
@ -0,0 +1,160 @@
|
|||
local ts = {}
|
||||
local queries = {
|
||||
struct = [[
|
||||
[(type_spec name: (type_identifier) @_name
|
||||
type: (struct_type))
|
||||
(var_declaration (var_spec
|
||||
name: (identifier) @_name @_var
|
||||
type: (struct_type)))
|
||||
(short_var_declaration
|
||||
left: (expression_list (identifier) @_name @_var)
|
||||
right: (expression_list (composite_literal
|
||||
type: (struct_type))))]
|
||||
]],
|
||||
struct_field = [[
|
||||
(field_declaration name: (field_identifier) @_name)
|
||||
]],
|
||||
func = [[
|
||||
[(function_declaration name: (identifier) @_name)
|
||||
(method_declaration name: (field_identifier) @_name)
|
||||
(method_elem name: (field_identifier) @_name)]
|
||||
]],
|
||||
package = [[
|
||||
(package_identifier) @_name
|
||||
]],
|
||||
interface = [[
|
||||
(type_spec
|
||||
name: (type_identifier) @_name
|
||||
type: (interface_type))
|
||||
]],
|
||||
var = [[
|
||||
[(var_declaration (var_spec name: (identifier) @_name))
|
||||
(short_var_declaration
|
||||
left: (expression_list (identifier) @_name @_var))]
|
||||
]],
|
||||
}
|
||||
|
||||
---@param parent_type string[]
|
||||
---@param node TSNode
|
||||
---@return TSNode?
|
||||
local function get_parent_node(parent_type, node)
|
||||
---@type TSNode?
|
||||
local current = node
|
||||
while current do
|
||||
if vim.tbl_contains(parent_type, current:type()) then
|
||||
break
|
||||
end
|
||||
|
||||
current = current:parent()
|
||||
if current == nil then
|
||||
return nil
|
||||
end
|
||||
end
|
||||
return current
|
||||
end
|
||||
|
||||
---@param query vim.treesitter.Query
|
||||
---@param node TSNode
|
||||
---@param bufnr integer
|
||||
---@return {name:string, is_varstruct:boolean}
|
||||
local function get_captures(query, node, bufnr)
|
||||
local res = {}
|
||||
for id, _node in query:iter_captures(node, bufnr) do
|
||||
if query.captures[id] == "_name" then
|
||||
res["name"] = vim.treesitter.get_node_text(_node, bufnr)
|
||||
end
|
||||
|
||||
if query.captures[id] == "_var" then
|
||||
res["is_varstruct"] = true
|
||||
end
|
||||
end
|
||||
|
||||
return res
|
||||
end
|
||||
|
||||
---@class gopher.TsResult
|
||||
---@field name string Name of the struct, function, etc
|
||||
---@field start integer Line number where the declaration starts
|
||||
---@field end_ integer Line number where the declaration ends
|
||||
---@field indent integer Number of spaces/tabs in the current cursor line
|
||||
---@field is_varstruct boolean Is struct declared as `var S struct{}` or `s := struct{}{}`
|
||||
|
||||
---@param bufnr integer
|
||||
---@param parent_type string[]
|
||||
---@param query string
|
||||
---@return gopher.TsResult
|
||||
local function do_stuff(bufnr, parent_type, query)
|
||||
if not vim.treesitter.get_parser(bufnr, "go") then
|
||||
error "No treesitter parser found for go"
|
||||
end
|
||||
|
||||
local node = vim.treesitter.get_node { bufnr = bufnr }
|
||||
if not node then
|
||||
error "No nodes found under the cursor"
|
||||
end
|
||||
|
||||
local parent_node = get_parent_node(parent_type, node)
|
||||
if not parent_node then
|
||||
error "No parent node found under the cursor"
|
||||
end
|
||||
|
||||
local q = vim.treesitter.query.parse("go", query)
|
||||
local res = get_captures(q, parent_node, bufnr)
|
||||
assert(res.name ~= nil, "No capture name found")
|
||||
|
||||
local start_row, start_col, end_row, _ = parent_node:range()
|
||||
res["indent"] = start_col
|
||||
res["start"] = start_row + 1
|
||||
res["end_"] = end_row + 1
|
||||
|
||||
return res
|
||||
end
|
||||
|
||||
---@param bufnr integer
|
||||
function ts.get_struct_under_cursor(bufnr)
|
||||
--- should be both type_spec and type_declaration
|
||||
--- because in cases like `type ( T struct{}, U struct{} )`
|
||||
---
|
||||
--- var_declaration is for cases like `var x struct{}`
|
||||
--- short_var_declaration is for cases like `x := struct{}{}`
|
||||
---
|
||||
--- it always chooses last struct type in the list
|
||||
return do_stuff(bufnr, {
|
||||
"type_spec",
|
||||
"type_declaration",
|
||||
"var_declaration",
|
||||
"short_var_declaration",
|
||||
}, queries.struct)
|
||||
end
|
||||
|
||||
---@param bufnr integer
|
||||
function ts.get_struct_field_under_cursor(bufnr)
|
||||
return do_stuff(bufnr, { "field_declaration" }, queries.struct_field)
|
||||
end
|
||||
|
||||
---@param bufnr integer
|
||||
function ts.get_func_under_cursor(bufnr)
|
||||
--- since this handles both and funcs and methods we should check for both parent nodes
|
||||
return do_stuff(bufnr, {
|
||||
"method_elem",
|
||||
"function_declaration",
|
||||
"method_declaration",
|
||||
}, queries.func)
|
||||
end
|
||||
|
||||
---@param bufnr integer
|
||||
function ts.get_package_under_cursor(bufnr)
|
||||
return do_stuff(bufnr, { "package_clause" }, queries.package)
|
||||
end
|
||||
|
||||
---@param bufnr integer
|
||||
function ts.get_interface_under_cursor(bufnr)
|
||||
return do_stuff(bufnr, { "type_declaration" }, queries.interface)
|
||||
end
|
||||
|
||||
---@param bufnr integer
|
||||
function ts.get_variable_under_cursor(bufnr)
|
||||
return do_stuff(bufnr, { "var_declaration", "short_var_declaration" }, queries.var)
|
||||
end
|
||||
|
||||
return ts
|
||||
|
|
@ -1,104 +0,0 @@
|
|||
---@diagnostic disable: param-type-mismatch
|
||||
local nodes = require "gopher._utils.ts.nodes"
|
||||
local u = require "gopher._utils"
|
||||
local M = {
|
||||
querys = {
|
||||
struct_block = [[((type_declaration (type_spec name:(type_identifier) @struct.name type: (struct_type)))@struct.declaration)]],
|
||||
em_struct_block = [[(field_declaration name:(field_identifier)@struct.name type: (struct_type)) @struct.declaration]],
|
||||
package = [[(package_clause (package_identifier)@package.name)@package.clause]],
|
||||
interface = [[((type_declaration (type_spec name:(type_identifier) @interface.name type:(interface_type)))@interface.declaration)]],
|
||||
method_name = [[((method_declaration receiver: (parameter_list)@method.receiver name: (field_identifier)@method.name body:(block))@method.declaration)]],
|
||||
func = [[((function_declaration name: (identifier)@function.name) @function.declaration)]],
|
||||
},
|
||||
}
|
||||
|
||||
---@return table
|
||||
local function get_name_defaults()
|
||||
return {
|
||||
["func"] = "function",
|
||||
["if"] = "if",
|
||||
["else"] = "else",
|
||||
["for"] = "for",
|
||||
}
|
||||
end
|
||||
|
||||
---@param row string
|
||||
---@param col string
|
||||
---@param bufnr string|nil
|
||||
---@param do_notify boolean|nil
|
||||
---@return table|nil
|
||||
function M.get_struct_node_at_pos(row, col, bufnr, do_notify)
|
||||
local notify = do_notify or true
|
||||
local query = M.querys.struct_block .. " " .. M.querys.em_struct_block
|
||||
local bufn = bufnr or vim.api.nvim_get_current_buf()
|
||||
local ns = nodes.nodes_at_cursor(query, get_name_defaults(), bufn, row, col)
|
||||
if ns == nil then
|
||||
if notify then
|
||||
u.notify("struct not found", "warn")
|
||||
end
|
||||
else
|
||||
return ns[#ns]
|
||||
end
|
||||
end
|
||||
|
||||
---@param row string
|
||||
---@param col string
|
||||
---@param bufnr string|nil
|
||||
---@param do_notify boolean|nil
|
||||
---@return table|nil
|
||||
function M.get_func_method_node_at_pos(row, col, bufnr, do_notify)
|
||||
local notify = do_notify or true
|
||||
local query = M.querys.func .. " " .. M.querys.method_name
|
||||
local bufn = bufnr or vim.api.nvim_get_current_buf()
|
||||
local ns = nodes.nodes_at_cursor(query, get_name_defaults(), bufn, row, col)
|
||||
if ns == nil then
|
||||
if notify then
|
||||
u.notify("function not found", "warn")
|
||||
end
|
||||
else
|
||||
return ns[#ns]
|
||||
end
|
||||
end
|
||||
|
||||
---@param row string
|
||||
---@param col string
|
||||
---@param bufnr string|nil
|
||||
---@param do_notify boolean|nil
|
||||
---@return table|nil
|
||||
function M.get_package_node_at_pos(row, col, bufnr, do_notify)
|
||||
local notify = do_notify or true
|
||||
-- stylua: ignore
|
||||
if row > 10 then return end
|
||||
local query = M.querys.package
|
||||
local bufn = bufnr or vim.api.nvim_get_current_buf()
|
||||
local ns = nodes.nodes_at_cursor(query, get_name_defaults(), bufn, row, col)
|
||||
if ns == nil then
|
||||
if notify then
|
||||
u.notify("package not found", "warn")
|
||||
return nil
|
||||
end
|
||||
else
|
||||
return ns[#ns]
|
||||
end
|
||||
end
|
||||
|
||||
---@param row string
|
||||
---@param col string
|
||||
---@param bufnr string|nil
|
||||
---@param do_notify boolean|nil
|
||||
---@return table|nil
|
||||
function M.get_interface_node_at_pos(row, col, bufnr, do_notify)
|
||||
local notify = do_notify or true
|
||||
local query = M.querys.interface
|
||||
local bufn = bufnr or vim.api.nvim_get_current_buf()
|
||||
local ns = nodes.nodes_at_cursor(query, get_name_defaults(), bufn, row, col)
|
||||
if ns == nil then
|
||||
if notify then
|
||||
u.notify("interface not found", "warn")
|
||||
end
|
||||
else
|
||||
return ns[#ns]
|
||||
end
|
||||
end
|
||||
|
||||
return M
|
||||
|
|
@ -1,139 +0,0 @@
|
|||
local M = {}
|
||||
|
||||
local function intersects(row, col, sRow, sCol, eRow, eCol)
|
||||
if sRow > row or eRow < row then
|
||||
return false
|
||||
end
|
||||
|
||||
if sRow == row and sCol > col then
|
||||
return false
|
||||
end
|
||||
|
||||
if eRow == row and eCol < col then
|
||||
return false
|
||||
end
|
||||
|
||||
return true
|
||||
end
|
||||
|
||||
---@param nodes table
|
||||
---@param row string
|
||||
---@param col string
|
||||
---@return table
|
||||
function M.intersect_nodes(nodes, row, col)
|
||||
local found = {}
|
||||
for idx = 1, #nodes do
|
||||
local node = nodes[idx]
|
||||
local sRow = node.dim.s.r
|
||||
local sCol = node.dim.s.c
|
||||
local eRow = node.dim.e.r
|
||||
local eCol = node.dim.e.c
|
||||
|
||||
if intersects(row, col, sRow, sCol, eRow, eCol) then
|
||||
table.insert(found, node)
|
||||
end
|
||||
end
|
||||
|
||||
return found
|
||||
end
|
||||
|
||||
---@param nodes table
|
||||
---@return table
|
||||
function M.sort_nodes(nodes)
|
||||
table.sort(nodes, function(a, b)
|
||||
return M.count_parents(a) < M.count_parents(b)
|
||||
end)
|
||||
|
||||
return nodes
|
||||
end
|
||||
|
||||
---@param query string
|
||||
---@param lang string
|
||||
---@param bufnr integer
|
||||
---@param pos_row string
|
||||
---@return string
|
||||
function M.get_all_nodes(query, lang, _, bufnr, pos_row, _)
|
||||
local ts_query = require "nvim-treesitter.query"
|
||||
local parsers = require "nvim-treesitter.parsers"
|
||||
local locals = require "nvim-treesitter.locals"
|
||||
|
||||
bufnr = bufnr or 0
|
||||
pos_row = pos_row or 30000
|
||||
|
||||
local ok, parsed_query = pcall(function()
|
||||
return vim.treesitter.query.parse(lang, query)
|
||||
end)
|
||||
if not ok then
|
||||
return nil
|
||||
end
|
||||
|
||||
local parser = parsers.get_parser(bufnr, lang)
|
||||
local root = parser:parse()[1]:root()
|
||||
local start_row, _, end_row, _ = root:range()
|
||||
local results = {}
|
||||
|
||||
for match in ts_query.iter_prepared_matches(parsed_query, root, bufnr, start_row, end_row) do
|
||||
local sRow, sCol, eRow, eCol, declaration_node
|
||||
local type, name, op = "", "", ""
|
||||
locals.recurse_local_nodes(match, function(_, node, path)
|
||||
local idx = string.find(path, ".[^.]*$")
|
||||
op = string.sub(path, idx + 1, #path)
|
||||
type = string.sub(path, 1, idx - 1)
|
||||
|
||||
if op == "name" then
|
||||
name = vim.treesitter.get_node_text(node, bufnr)
|
||||
elseif op == "declaration" or op == "clause" then
|
||||
declaration_node = node
|
||||
sRow, sCol, eRow, eCol = node:range()
|
||||
sRow = sRow + 1
|
||||
eRow = eRow + 1
|
||||
sCol = sCol + 1
|
||||
eCol = eCol + 1
|
||||
end
|
||||
end)
|
||||
|
||||
if declaration_node ~= nil then
|
||||
table.insert(results, {
|
||||
declaring_node = declaration_node,
|
||||
dim = { s = { r = sRow, c = sCol }, e = { r = eRow, c = eCol } },
|
||||
name = name,
|
||||
operator = op,
|
||||
type = type,
|
||||
})
|
||||
end
|
||||
end
|
||||
|
||||
return results
|
||||
end
|
||||
|
||||
---@param query string
|
||||
---@param default string
|
||||
---@param bufnr string
|
||||
---@param row string
|
||||
---@param col string
|
||||
---@return table
|
||||
function M.nodes_at_cursor(query, default, bufnr, row, col)
|
||||
local u = require "gopher._utils"
|
||||
|
||||
bufnr = bufnr or vim.api.nvim_get_current_buf()
|
||||
local ft = vim.api.nvim_buf_get_option(bufnr, "ft")
|
||||
if row == nil or col == nil then
|
||||
row, col = unpack(vim.api.nvim_win_get_cursor(0))
|
||||
end
|
||||
|
||||
local nodes = M.get_all_nodes(query, ft, default, bufnr, row, col)
|
||||
if nodes == nil then
|
||||
u.notify("Unable to find any nodes. Place your cursor on a go symbol and try again", "debug")
|
||||
return nil
|
||||
end
|
||||
|
||||
nodes = M.sort_nodes(M.intersect_nodes(nodes, row, col))
|
||||
if nodes == nil or #nodes == 0 then
|
||||
u.notify("Unable to find any nodes at pos. " .. tostring(row) .. ":" .. tostring(col), "debug")
|
||||
return nil
|
||||
end
|
||||
|
||||
return nodes
|
||||
end
|
||||
|
||||
return M
|
||||
|
|
@ -1,29 +0,0 @@
|
|||
local API = {}
|
||||
local tags = require "gopher.struct_tags"
|
||||
local tests = require "gopher.gotests"
|
||||
local cmd = require "gopher._utils.commands"
|
||||
|
||||
API.install_deps = require "gopher.installer"
|
||||
API.tags_add = tags.add
|
||||
API.tags_rm = tags.remove
|
||||
API.impl = require "gopher.impl"
|
||||
API.iferr = require "gopher.iferr"
|
||||
API.comment = require "gopher.comment"
|
||||
API.test_add = tests.func_test
|
||||
API.test_exported = tests.all_exported_tests
|
||||
API.tests_all = tests.all_tests
|
||||
|
||||
API.get = function(...)
|
||||
cmd("get", ...)
|
||||
end
|
||||
API.mod = function(...)
|
||||
cmd("mod", ...)
|
||||
end
|
||||
API.generate = function(...)
|
||||
cmd("generate", ...)
|
||||
end
|
||||
API.work = function(...)
|
||||
cmd("work", ...)
|
||||
end
|
||||
|
||||
return API
|
||||
|
|
@ -1,50 +1,71 @@
|
|||
local function generate(row, col)
|
||||
local ts_utils = require "gopher._utils.ts"
|
||||
local comment, ns = nil, nil
|
||||
---@toc_entry Generate comments
|
||||
---@tag gopher.nvim-comments
|
||||
---@text
|
||||
--- This module provides a way to generate comments for Go code.
|
||||
---
|
||||
---@usage
|
||||
--- Set cursor on line with function/method/struct/etc and
|
||||
--- run `:GoCmt` to generate a comment.
|
||||
|
||||
ns = ts_utils.get_package_node_at_pos(row, col, nil, false)
|
||||
if ns ~= nil then
|
||||
comment = "// Package " .. ns.name .. " provides " .. ns.name
|
||||
return comment, ns
|
||||
local ts = require "gopher._utils.ts"
|
||||
local log = require "gopher._utils.log"
|
||||
local u = require "gopher._utils"
|
||||
local comment = {}
|
||||
|
||||
--- NOTE: The order of functions executed inside this function is IMPORTANT.
|
||||
--- This function is extremely fragile; run tests after making any changes.
|
||||
---
|
||||
---@param bufnr integer
|
||||
---@param line string
|
||||
---@return string
|
||||
---@dochide
|
||||
local function generate(bufnr, line)
|
||||
local sf_ok, sf_res = pcall(ts.get_struct_field_under_cursor, bufnr)
|
||||
if sf_ok then
|
||||
return u.indent(line, sf_res.indent) .. "// " .. sf_res.name .. " "
|
||||
end
|
||||
|
||||
ns = ts_utils.get_struct_node_at_pos(row, col, nil, false)
|
||||
if ns ~= nil then
|
||||
comment = "// " .. ns.name .. " " .. ns.type .. " "
|
||||
return comment, ns
|
||||
local s_ok, s_res = pcall(ts.get_struct_under_cursor, bufnr)
|
||||
if s_ok then
|
||||
return u.indent(line, s_res.indent) .. "// " .. s_res.name .. " "
|
||||
end
|
||||
|
||||
ns = ts_utils.get_func_method_node_at_pos(row, col, nil, false)
|
||||
if ns ~= nil then
|
||||
comment = "// " .. ns.name .. " " .. ns.type .. " "
|
||||
return comment, ns
|
||||
local v_ok, v_res = pcall(ts.get_variable_under_cursor, bufnr)
|
||||
if v_ok then
|
||||
return u.indent(line, v_res.indent) .. "// " .. v_res.name .. " "
|
||||
end
|
||||
|
||||
ns = ts_utils.get_interface_node_at_pos(row, col, nil, false)
|
||||
if ns ~= nil then
|
||||
comment = "// " .. ns.name .. " " .. ns.type .. " "
|
||||
return comment, ns
|
||||
local f_ok, f_res = pcall(ts.get_func_under_cursor, bufnr)
|
||||
if f_ok then
|
||||
return u.indent(line, f_res.indent) .. "// " .. f_res.name .. " "
|
||||
end
|
||||
|
||||
return "// ", {}
|
||||
local i_ok, i_res = pcall(ts.get_interface_under_cursor, bufnr)
|
||||
if i_ok then
|
||||
return u.indent(line, i_res.indent) .. "// " .. i_res.name .. " "
|
||||
end
|
||||
|
||||
local p_ok, p_res = pcall(ts.get_package_under_cursor, bufnr)
|
||||
if p_ok then
|
||||
return "// Package " .. p_res.name .. " provides "
|
||||
end
|
||||
|
||||
return "// "
|
||||
end
|
||||
|
||||
return function()
|
||||
local row, col = unpack(vim.api.nvim_win_get_cursor(0))
|
||||
local comment, ns = generate(row + 1, col + 1)
|
||||
|
||||
vim.api.nvim_win_set_cursor(0, {
|
||||
ns.dim.s.r,
|
||||
ns.dim.s.c,
|
||||
function comment.comment()
|
||||
local bufnr = vim.api.nvim_get_current_buf()
|
||||
local lnum = vim.fn.getcurpos()[2]
|
||||
local line = vim.fn.getline(lnum)
|
||||
local cmt = generate(bufnr, line)
|
||||
log.debug("generated comment:", {
|
||||
comment = cmt,
|
||||
line = line,
|
||||
})
|
||||
|
||||
---@diagnostic disable-next-line: param-type-mismatch
|
||||
vim.fn.append(row - 1, comment)
|
||||
|
||||
vim.api.nvim_win_set_cursor(0, {
|
||||
ns.dim.s.r,
|
||||
#comment + 1,
|
||||
})
|
||||
|
||||
vim.cmd [[startinsert!]]
|
||||
vim.fn.append(lnum - 1, cmt)
|
||||
vim.fn.setpos(".", { bufnr, lnum, #cmt })
|
||||
vim.cmd "startinsert!"
|
||||
end
|
||||
|
||||
return comment
|
||||
|
|
|
|||
|
|
@ -1,33 +1,142 @@
|
|||
---@class Config
|
||||
---@field commands ConfigCommands
|
||||
---@type gopher.Config
|
||||
---@dochide
|
||||
---@diagnostic disable-next-line: missing-fields .setup() gets injected later
|
||||
local config = {}
|
||||
|
||||
---@class ConfigCommands
|
||||
---@field go string
|
||||
---@field gomodifytags string
|
||||
---@field gotests string
|
||||
---@field impl string
|
||||
---@field iferr string
|
||||
---@field dlv string
|
||||
---@tag gopher.nvim-config.ConfigGoTagTransform
|
||||
---@text Possible values for |gopher.Config|.gotag.transform:
|
||||
---
|
||||
---@dochide
|
||||
---@alias gopher.ConfigGoTagTransform
|
||||
---| "snakecase" "GopherUser" -> "gopher_user"
|
||||
---| "camelcase" "GopherUser" -> "gopherUser"
|
||||
---| "lispcase" "GopherUser" -> "gopher-user"
|
||||
---| "pascalcase" "GopherUser" -> "GopherUser"
|
||||
---| "titlecase" "GopherUser" -> "Gopher User"
|
||||
---| "keep" keeps the original field name
|
||||
|
||||
local M = {
|
||||
---@type Config
|
||||
config = {
|
||||
---set custom commands for tools
|
||||
---@toc_entry Config
|
||||
---@tag gopher.nvim-config
|
||||
---@eval return MiniDoc.afterlines_to_code(MiniDoc.current.eval_section)
|
||||
---@class gopher.Config
|
||||
---@field setup fun(user_config?: gopher.Config)
|
||||
local default_config = {
|
||||
-- log level, you might consider using DEBUG or TRACE for debugging the plugin
|
||||
---@type number
|
||||
log_level = vim.log.levels.INFO,
|
||||
|
||||
-- timeout for running internal commands
|
||||
---@type number
|
||||
timeout = 2000,
|
||||
|
||||
-- timeout for running installer commands(e.g :GoDepsInstall, :GoDepsInstallSync)
|
||||
---@type number
|
||||
installer_timeout = 999999,
|
||||
|
||||
-- user specified paths to binaries
|
||||
---@class gopher.ConfigCommand
|
||||
commands = {
|
||||
go = "go",
|
||||
gomodifytags = "gomodifytags",
|
||||
gotests = "gotests",
|
||||
impl = "impl",
|
||||
iferr = "iferr",
|
||||
dlv = "dlv",
|
||||
json2go = "json2go",
|
||||
},
|
||||
---@class gopher.ConfigGotests
|
||||
gotests = {
|
||||
-- a default template that gotess will use.
|
||||
-- gotets doesn't have template named `default`, we use it to represent absence of the provided template.
|
||||
template = "default",
|
||||
|
||||
-- path to a directory containing custom test code templates
|
||||
---@type string|nil
|
||||
template_dir = nil,
|
||||
|
||||
-- use named tests(map with test name as key) in table tests(slice of structs by default)
|
||||
named = false,
|
||||
},
|
||||
---@class gopher.ConfigGoTag
|
||||
gotag = {
|
||||
---@type gopher.ConfigGoTagTransform
|
||||
transform = "snakecase",
|
||||
|
||||
-- default tags to add to struct fields
|
||||
default_tag = "json",
|
||||
|
||||
-- default tag option added struct fields, set to nil to disable
|
||||
-- e.g: `option = "json=omitempty,xml=omitempty`
|
||||
---@type string|nil
|
||||
option = nil,
|
||||
},
|
||||
---@class gopher.ConfigIfErr
|
||||
iferr = {
|
||||
-- choose a custom error message, nil to use default
|
||||
-- e.g: `message = 'fmt.Errorf("failed to %w", err)'`
|
||||
---@type string|nil
|
||||
message = nil,
|
||||
},
|
||||
---@class gopher.ConfigJson2Go
|
||||
json2go = {
|
||||
-- command used to open interactive input.
|
||||
-- e.g: `split`, `botright split`, `tabnew`
|
||||
interactive_cmd = "vsplit",
|
||||
|
||||
-- name of autogenerated struct, if nil none, will the default one of json2go.
|
||||
-- e.g: "MySuperCoolName"
|
||||
---@type string|nil
|
||||
type_name = nil,
|
||||
},
|
||||
}
|
||||
--minidoc_afterlines_end
|
||||
|
||||
---Plugin setup function
|
||||
---@param opts Config user config
|
||||
function M.setup(opts)
|
||||
M.config = vim.tbl_deep_extend("force", M.config, opts or {})
|
||||
---@type gopher.Config
|
||||
---@dochide
|
||||
local _config = default_config
|
||||
|
||||
-- I am kinda secret so don't tell anyone about me even dont use me
|
||||
--
|
||||
-- if you don't believe me that i am secret see
|
||||
-- the line below it says @private
|
||||
---@private
|
||||
_config.___plugin_name = "gopher.nvim" ---@diagnostic disable-line: inject-field
|
||||
|
||||
---@param user_config? gopher.Config
|
||||
---@dochide
|
||||
function config.setup(user_config)
|
||||
vim.validate("user_config", user_config, "table", true)
|
||||
|
||||
_config = vim.tbl_deep_extend("force", vim.deepcopy(default_config), user_config or {})
|
||||
|
||||
vim.validate("log_level", _config.log_level, "number")
|
||||
vim.validate("timeout", _config.timeout, "number")
|
||||
vim.validate("installer_timeout", _config.timeout, "number")
|
||||
vim.validate("commands", _config.commands, "table")
|
||||
vim.validate("commands.go", _config.commands.go, "string")
|
||||
vim.validate("commands.gomodifytags", _config.commands.gomodifytags, "string")
|
||||
vim.validate("commands.gotests", _config.commands.gotests, "string")
|
||||
vim.validate("commands.impl", _config.commands.impl, "string")
|
||||
vim.validate("commands.iferr", _config.commands.iferr, "string")
|
||||
vim.validate("commands.json2go", _config.commands.json2go, "string")
|
||||
vim.validate("gotests", _config.gotests, "table")
|
||||
vim.validate("gotests.template", _config.gotests.template, "string")
|
||||
vim.validate("gotests.template_dir", _config.gotests.template_dir, { "string", "nil" })
|
||||
vim.validate("gotests.named", _config.gotests.named, "boolean")
|
||||
vim.validate("gotag", _config.gotag, "table")
|
||||
vim.validate("gotag.transform", _config.gotag.transform, "string")
|
||||
vim.validate("gotag.default_tag", _config.gotag.default_tag, "string")
|
||||
vim.validate("gotag.option", _config.gotag.option, { "string", "nil" })
|
||||
vim.validate("iferr", _config.iferr, "table")
|
||||
vim.validate("iferr.message", _config.iferr.message, { "string", "nil" })
|
||||
vim.validate("json2go.installer_timeout", _config.json2go.interactive_cmd, "string")
|
||||
vim.validate("json2go.type_name", _config.json2go.type_name, { "string", "nil" })
|
||||
end
|
||||
|
||||
return M
|
||||
setmetatable(config, {
|
||||
__index = function(_, key)
|
||||
return _config[key]
|
||||
end,
|
||||
})
|
||||
|
||||
---@dochide
|
||||
return config
|
||||
|
|
|
|||
|
|
@ -1,98 +0,0 @@
|
|||
---@diagnostic disable: param-type-mismatch
|
||||
local function get_arguments()
|
||||
local function get()
|
||||
vim.ui.input({ prompt = "Args: " }, function(input)
|
||||
return vim.split(input or "", " ") ---@diagnostic disable-line: missing-parameter
|
||||
end)
|
||||
end
|
||||
|
||||
local co = coroutine.running()
|
||||
if co then
|
||||
return coroutine.create(function()
|
||||
local args = get()
|
||||
coroutine.resume(co, args)
|
||||
end)
|
||||
else
|
||||
return get()
|
||||
end
|
||||
end
|
||||
|
||||
return {
|
||||
adapter = function(callback, config)
|
||||
local handle, pid_or_err
|
||||
local stdout = vim.loop.new_pipe(false)
|
||||
local host = config.host or "127.0.0.1"
|
||||
local port = config.port or "38697"
|
||||
local addr = string.format("%s:%s", host, port)
|
||||
local opts = {
|
||||
stdio = { nil, stdout },
|
||||
args = { "dap", "-l", addr },
|
||||
detached = true,
|
||||
}
|
||||
|
||||
handle, pid_or_err = vim.loop.spawn("dlv", opts, function(code)
|
||||
stdout:close()
|
||||
handle:close()
|
||||
if code ~= 0 then
|
||||
print("dlv exited with code", code)
|
||||
end
|
||||
end)
|
||||
|
||||
assert(handle, "Error running dlv: " .. tostring(pid_or_err))
|
||||
stdout:read_start(function(err, chunk)
|
||||
assert(not err, err)
|
||||
if chunk then
|
||||
vim.schedule(function()
|
||||
require("dap.repl").append(chunk)
|
||||
end)
|
||||
end
|
||||
end)
|
||||
|
||||
-- Wait for delve to start
|
||||
vim.defer_fn(function()
|
||||
callback { type = "server", host = "127.0.0.1", port = port }
|
||||
end, 100)
|
||||
end,
|
||||
configuration = {
|
||||
{
|
||||
type = "go",
|
||||
name = "Debug",
|
||||
request = "launch",
|
||||
program = "${file}",
|
||||
},
|
||||
{
|
||||
type = "go",
|
||||
name = "Debug (Arguments)",
|
||||
request = "launch",
|
||||
program = "${file}",
|
||||
args = get_arguments,
|
||||
},
|
||||
{
|
||||
type = "go",
|
||||
name = "Debug Package",
|
||||
request = "launch",
|
||||
program = "${fileDirname}",
|
||||
},
|
||||
{
|
||||
type = "go",
|
||||
name = "Attach",
|
||||
mode = "local",
|
||||
request = "attach",
|
||||
processId = require("dap.utils").pick_process,
|
||||
},
|
||||
{
|
||||
type = "go",
|
||||
name = "Debug test",
|
||||
request = "launch",
|
||||
mode = "test",
|
||||
program = "${file}",
|
||||
},
|
||||
{
|
||||
type = "go",
|
||||
name = "Debug test (go.mod)",
|
||||
request = "launch",
|
||||
mode = "test",
|
||||
program = "./${relativeFileDirname}",
|
||||
},
|
||||
},
|
||||
}
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
local M = {}
|
||||
|
||||
---setup nvim-dap for golang using
|
||||
function M.setup()
|
||||
local cfg = require "gopher.dap.config"
|
||||
local u = require "gopher._utils"
|
||||
|
||||
local dap = u.sreq "dap"
|
||||
dap.adapters.go = cfg.adapter
|
||||
dap.configurations.go = cfg.configuration
|
||||
end
|
||||
|
||||
return M
|
||||
56
lua/gopher/go.lua
Normal file
56
lua/gopher/go.lua
Normal file
|
|
@ -0,0 +1,56 @@
|
|||
local c = require "gopher.config"
|
||||
local u = require "gopher._utils"
|
||||
local r = require "gopher._utils.runner"
|
||||
local go = {}
|
||||
|
||||
local function run(subcmd, args)
|
||||
local rs = r.sync { c.commands.go, subcmd, unpack(args) }
|
||||
if rs.code ~= 0 then
|
||||
error("go " .. subcmd .. " failed: " .. rs.stderr)
|
||||
end
|
||||
|
||||
u.notify(c.commands.go .. " " .. subcmd .. " ran successful")
|
||||
return rs.stdout
|
||||
end
|
||||
|
||||
---@param args string[]
|
||||
function go.get(args)
|
||||
for i, arg in ipairs(args) do
|
||||
local m = string.match(arg, "^https://(.*)$") or string.match(arg, "^http://(.*)$") or arg
|
||||
table.remove(args, i)
|
||||
table.insert(args, i, m)
|
||||
end
|
||||
|
||||
run("get", args)
|
||||
end
|
||||
|
||||
---@param args string[]
|
||||
function go.mod(args)
|
||||
run("mod", args)
|
||||
end
|
||||
|
||||
---@param args string[]
|
||||
function go.work(args)
|
||||
-- TODO: use `gopls.tidy`
|
||||
|
||||
run("work", args)
|
||||
end
|
||||
|
||||
---Executes `go generate`
|
||||
---If only argument is `%` it's going to be equivalent to `go generate <path to current file>`
|
||||
---@param args string[]
|
||||
function go.generate(args)
|
||||
-- TODO: use `gopls.generate`
|
||||
|
||||
if #args == 0 then
|
||||
error "please provide arguments"
|
||||
end
|
||||
|
||||
if #args == 1 and args[1] == "%" then
|
||||
args[1] = vim.fn.expand "%"
|
||||
end
|
||||
|
||||
run("generate", args)
|
||||
end
|
||||
|
||||
return go
|
||||
|
|
@ -1,73 +1,76 @@
|
|||
---@toc_entry Generating unit tests boilerplate
|
||||
---@tag gopher.nvim-gotests
|
||||
---@text gotests is utilizing the `gotests` tool to generate unit tests boilerplate.
|
||||
---@usage
|
||||
--- - Generate unit test for specific function/method:
|
||||
--- 1. Place your cursor on the desired function/method.
|
||||
--- 2. Run `:GoTestAdd`
|
||||
---
|
||||
--- - Generate unit tests for *all* functions/methods in current file:
|
||||
--- - run `:GoTestsAll`
|
||||
---
|
||||
--- - Generate unit tests *only* for *exported(public)* functions/methods:
|
||||
--- - run `:GoTestsExp`
|
||||
---
|
||||
--- You can also specify the template to use for generating the tests.
|
||||
--- See |gopher.nvim-config|.
|
||||
--- More details about templates: https://github.com/cweill/gotests
|
||||
---
|
||||
--- If you prefer named tests, you can enable them in |gopher.nvim-config|.
|
||||
|
||||
local c = require "gopher.config"
|
||||
local ts_utils = require "gopher._utils.ts"
|
||||
local r = require "gopher._utils.runner"
|
||||
local u = require "gopher._utils"
|
||||
local M = {}
|
||||
|
||||
---@param cmd_args table
|
||||
local function run(cmd_args)
|
||||
local Job = require "plenary.job"
|
||||
local c = require("gopher.config").config.commands
|
||||
|
||||
Job:new({
|
||||
command = c.gotests,
|
||||
args = cmd_args,
|
||||
on_exit = function(_, retval)
|
||||
if retval ~= 0 then
|
||||
u.notify("command 'go " .. unpack(cmd_args) .. "' exited with code " .. retval, "error")
|
||||
return
|
||||
end
|
||||
|
||||
u.notify("unit test(s) generated", "info")
|
||||
end,
|
||||
}):start()
|
||||
end
|
||||
local log = require "gopher._utils.log"
|
||||
local gotests = {}
|
||||
|
||||
---@param args table
|
||||
---@dochide
|
||||
local function add_test(args)
|
||||
local fpath = vim.fn.expand "%" ---@diagnostic disable-line: missing-parameter
|
||||
if c.gotests.named then
|
||||
table.insert(args, "-named")
|
||||
end
|
||||
|
||||
if c.gotests.template_dir then
|
||||
table.insert(args, "-template_dir")
|
||||
table.insert(args, c.gotests.template_dir)
|
||||
end
|
||||
|
||||
if c.gotests.template ~= "default" then
|
||||
table.insert(args, "-template")
|
||||
table.insert(args, c.gotests.template)
|
||||
end
|
||||
|
||||
table.insert(args, "-w")
|
||||
table.insert(args, fpath)
|
||||
run(args)
|
||||
end
|
||||
table.insert(args, vim.fn.expand "%")
|
||||
|
||||
---generate unit test for one function
|
||||
---@param parallel boolean
|
||||
function M.func_test(parallel)
|
||||
local ts_utils = require "gopher._utils.ts"
|
||||
log.debug("generating tests with args: ", args)
|
||||
|
||||
local ns = ts_utils.get_func_method_node_at_pos(unpack(vim.api.nvim_win_get_cursor(0)))
|
||||
if ns == nil or ns.name == nil then
|
||||
u.notify("cursor on func/method and execute the command again", "info")
|
||||
return
|
||||
local rs = r.sync { c.commands.gotests, unpack(args) }
|
||||
if rs.code ~= 0 then
|
||||
error("gotests failed: " .. rs.stderr)
|
||||
end
|
||||
|
||||
local cmd_args = { "-only", ns.name }
|
||||
if parallel then
|
||||
table.insert(cmd_args, "-parallel")
|
||||
end
|
||||
|
||||
add_test(cmd_args)
|
||||
u.notify "unit test(s) generated"
|
||||
end
|
||||
|
||||
---generate unit tests for all functions in current file
|
||||
---@param parallel boolean
|
||||
function M.all_tests(parallel)
|
||||
local cmd_args = { "-all" }
|
||||
if parallel then
|
||||
table.insert(cmd_args, "-parallel")
|
||||
end
|
||||
-- generate unit test for one function
|
||||
function gotests.func_test()
|
||||
local bufnr = vim.api.nvim_get_current_buf()
|
||||
local func = ts_utils.get_func_under_cursor(bufnr)
|
||||
|
||||
add_test(cmd_args)
|
||||
add_test { "-only", func.name }
|
||||
end
|
||||
|
||||
---generate unit tests for all exported functions
|
||||
---@param parallel boolean
|
||||
function M.all_exported_tests(parallel)
|
||||
local cmd_args = {}
|
||||
if parallel then
|
||||
table.insert(cmd_args, "-parallel")
|
||||
end
|
||||
|
||||
table.insert(cmd_args, "-exported")
|
||||
add_test(cmd_args)
|
||||
-- generate unit tests for all functions in current file
|
||||
function gotests.all_tests()
|
||||
add_test { "-all" }
|
||||
end
|
||||
|
||||
return M
|
||||
-- generate unit tests for all exported functions
|
||||
function gotests.all_exported_tests()
|
||||
add_test { "-exported" }
|
||||
end
|
||||
|
||||
return gotests
|
||||
|
|
|
|||
|
|
@ -1,44 +1,59 @@
|
|||
local c = require("gopher.config").config.commands
|
||||
local c = require("gopher.config").commands
|
||||
local health = {}
|
||||
|
||||
local requried_for_work_msg = "Gopher.nvim will not work without it!"
|
||||
local M = {
|
||||
_required = {
|
||||
plugins = {
|
||||
{ lib = "plenary", help = requried_for_work_msg },
|
||||
{ lib = "nvim-treesitter", help = requried_for_work_msg },
|
||||
{ lib = "dap", help = "Required for set upping debugger" },
|
||||
local deps = {
|
||||
vim_version = "nvim-0.10",
|
||||
bin = {
|
||||
{
|
||||
bin = c.go,
|
||||
msg = "required for `:GoGet`, `:GoMod`, `:GoGenerate`, `:GoWork`, `:GoInstallDeps`, `:GoInstallDepsSync`",
|
||||
},
|
||||
binarys = {
|
||||
{ bin = c.go, help = "required for GoMod, GoGet, GoGenerate command" },
|
||||
{ bin = c.gomodifytags, help = "required for modify struct tags" },
|
||||
{ bin = c.impl, help = "required for interface implementing" },
|
||||
{ bin = c.gotests, help = "required for test(s) generation" },
|
||||
{ bin = c.dlv, help = "required for debugger(nvim-dap)" },
|
||||
{ bin = c.gomodifytags, msg = "required for `:GoTagAdd`, `:GoTagRm`" },
|
||||
{ bin = c.impl, msg = "required for `:GoImpl`" },
|
||||
{ bin = c.iferr, msg = "required for `:GoIfErr`" },
|
||||
{ bin = c.gotests, msg = "required for `:GoTestAdd`, `:GoTestsAll`, `:GoTestsExp`" },
|
||||
},
|
||||
treesitter = {
|
||||
{ parser = "go", msg = "required for most of the parts of `gopher.nvim`" },
|
||||
},
|
||||
}
|
||||
|
||||
function M.check()
|
||||
local health = vim.health or require "health"
|
||||
local u = require "gopher._utils._health"
|
||||
|
||||
health.report_start "Required plugins"
|
||||
for _, plugin in ipairs(M._required.plugins) do
|
||||
if u.lualib_is_found(plugin.lib) then
|
||||
health.report_ok(plugin.lib .. " installed.")
|
||||
---@param bin {bin:string, msg:string, optional:boolean}
|
||||
local function check_binary(bin)
|
||||
if vim.fn.executable(bin.bin) == 1 then
|
||||
vim.health.ok(bin.bin .. " is found oh PATH: `" .. vim.fn.exepath(bin.bin) .. "`")
|
||||
else
|
||||
health.report_error(plugin.lib .. " not found. " .. plugin.help)
|
||||
end
|
||||
end
|
||||
|
||||
health.report_start "Required go tools"
|
||||
for _, binary in ipairs(M._required.binarys) do
|
||||
if u.binary_is_found(binary.bin) then
|
||||
health.report_ok(binary.bin .. " installed")
|
||||
else
|
||||
health.report_warn(binary.bin .. " is not installed but " .. binary.help)
|
||||
end
|
||||
vim.health.error(bin.bin .. " not found on PATH, " .. bin.msg)
|
||||
end
|
||||
end
|
||||
|
||||
return M
|
||||
---@param ts {parser:string, msg:string}
|
||||
local function check_treesitter(ts)
|
||||
local ok, parser = pcall(vim.treesitter.get_parser, 0, ts.parser)
|
||||
if ok and parser ~= nil then
|
||||
vim.health.ok("`" .. ts.parser .. "` parser is installed")
|
||||
else
|
||||
vim.health.error("`" .. ts.parser .. "` parser not found")
|
||||
end
|
||||
end
|
||||
|
||||
function health.check()
|
||||
vim.health.start "Neovim version"
|
||||
if vim.fn.has(deps.vim_version) == 1 then
|
||||
vim.health.ok "Neovim version is compatible"
|
||||
else
|
||||
vim.health.error(deps.vim_version .. " or newer is required")
|
||||
end
|
||||
|
||||
vim.health.start "Required binaries (those can be installed with `:GoInstallDeps`)"
|
||||
for _, bin in ipairs(deps.bin) do
|
||||
check_binary(bin)
|
||||
end
|
||||
|
||||
vim.health.start "Treesitter"
|
||||
for _, parser in ipairs(deps.treesitter) do
|
||||
check_treesitter(parser)
|
||||
end
|
||||
end
|
||||
|
||||
return health
|
||||
|
|
|
|||
|
|
@ -1,21 +1,48 @@
|
|||
---Add iferr declaration
|
||||
---That's Lua of vimscript implementation of:
|
||||
---github.com/koron/iferr
|
||||
return function()
|
||||
local c = require("gopher.config").config.commands
|
||||
local u = require "gopher._utils"
|
||||
-- Thanks https://github.com/koron/iferr for vim implementation
|
||||
|
||||
local boff = vim.fn.wordcount().cursor_bytes
|
||||
local cmd = (c.iferr .. " -pos " .. boff)
|
||||
local data = vim.fn.systemlist(cmd, vim.fn.bufnr "%")
|
||||
---@toc_entry Iferr
|
||||
---@tag gopher.nvim-iferr
|
||||
---@text
|
||||
--- `iferr` provides a way to way to automatically insert `if err != nil` check.
|
||||
--- If you want to change `-message` option of `iferr` tool, see |gopher.nvim-config|
|
||||
---
|
||||
---@usage Execute `:GoIfErr` near any `err` variable to insert the check
|
||||
|
||||
if vim.v.shell_error ~= 0 then
|
||||
u.notify("command " .. cmd .. " exited with code " .. vim.v.shell_error, "error")
|
||||
local c = require "gopher.config"
|
||||
local u = require "gopher._utils"
|
||||
local r = require "gopher._utils.runner"
|
||||
local log = require "gopher._utils.log"
|
||||
local iferr = {}
|
||||
|
||||
function iferr.iferr()
|
||||
local curb = vim.fn.wordcount().cursor_bytes
|
||||
local pos = vim.fn.getcurpos()[2]
|
||||
local fpath = vim.fn.expand "%"
|
||||
|
||||
local cmd = { c.commands.iferr, "-pos", curb }
|
||||
if c.iferr.message ~= nil and type(c.iferr.message) == "string" then
|
||||
table.insert(cmd, "-message")
|
||||
table.insert(cmd, c.iferr.message)
|
||||
end
|
||||
|
||||
local rs = r.sync(cmd, {
|
||||
stdin = u.readfile_joined(fpath),
|
||||
})
|
||||
|
||||
if rs.code ~= 0 then
|
||||
if string.find(rs.stderr, "no functions at") then
|
||||
u.notify("iferr: no function at " .. curb, vim.log.levels.ERROR)
|
||||
log.warn("iferr: no function at " .. curb)
|
||||
return
|
||||
end
|
||||
|
||||
local pos = vim.fn.getcurpos()[2]
|
||||
vim.fn.append(pos, data)
|
||||
log.error("ferr: failed. output: " .. rs.stderr)
|
||||
error("iferr failed: " .. rs.stderr)
|
||||
end
|
||||
|
||||
vim.fn.append(pos, u.remove_empty_lines(vim.split(rs.stdout, "\n")))
|
||||
vim.cmd [[silent normal! j=2j]]
|
||||
vim.fn.setpos(".", pos)
|
||||
vim.fn.setpos(".", pos --[[@as integer[] ]])
|
||||
end
|
||||
|
||||
return iferr
|
||||
|
|
|
|||
|
|
@ -1,75 +1,80 @@
|
|||
---@toc_entry Auto implementation of interface methods
|
||||
---@tag gopher.nvim-impl
|
||||
---@text
|
||||
--- Integration of `impl` tool to generate method stubs for interfaces.
|
||||
---
|
||||
---@usage
|
||||
--- 1. Automatically implement an interface for a struct:
|
||||
--- - Place your cursor on the struct where you want to implement the interface.
|
||||
--- - Run `:GoImpl io.Reader`
|
||||
--- - This will automatically determine the receiver and implement the `io.Reader` interface.
|
||||
---
|
||||
--- 2. Specify a custom receiver:
|
||||
--- - Place your cursor on the struct
|
||||
--- - Run `:GoImpl w io.Writer`, where:
|
||||
--- - `w` is the receiver.
|
||||
--- - `io.Writer` is the interface to implement.
|
||||
---
|
||||
--- 3. Explicitly specify the receiver, struct, and interface:
|
||||
--- - No need to place the cursor on the struct if all arguments are provided.
|
||||
--- - Run `:GoImpl r RequestReader io.Reader`, where:
|
||||
--- - `r` is the receiver.
|
||||
--- - `RequestReader` is the struct.
|
||||
--- - `io.Reader` is the interface to implement.
|
||||
---
|
||||
--- Example:
|
||||
--- >go
|
||||
--- type BytesReader struct{}
|
||||
--- // ^ put your cursor here
|
||||
--- // run `:GoImpl b io.Reader`
|
||||
---
|
||||
--- // this is what you will get
|
||||
--- func (b *BytesReader) Read(p []byte) (n int, err error) {
|
||||
--- panic("not implemented") // TODO: Implement
|
||||
--- }
|
||||
--- <
|
||||
|
||||
local c = require("gopher.config").commands
|
||||
local r = require "gopher._utils.runner"
|
||||
local ts_utils = require "gopher._utils.ts"
|
||||
local u = require "gopher._utils"
|
||||
local impl = {}
|
||||
|
||||
---@return string
|
||||
local function get_struct()
|
||||
local ts_utils = require "gopher._utils.ts"
|
||||
|
||||
local ns = ts_utils.get_struct_node_at_pos(unpack(vim.api.nvim_win_get_cursor(0)))
|
||||
if ns == nil then
|
||||
u.notify("put cursor on a struct or specify a receiver", "info")
|
||||
return ""
|
||||
end
|
||||
|
||||
vim.api.nvim_win_set_cursor(0, {
|
||||
ns.dim.e.r,
|
||||
ns.dim.e.c,
|
||||
})
|
||||
|
||||
return ns.name
|
||||
end
|
||||
|
||||
return function(...)
|
||||
local c = require("gopher.config").config.commands
|
||||
local Job = require "plenary.job"
|
||||
|
||||
function impl.impl(...)
|
||||
local args = { ... }
|
||||
local iface, recv_name = "", ""
|
||||
local recv = get_struct()
|
||||
local iface, recv = "", ""
|
||||
local bufnr = vim.api.nvim_get_current_buf()
|
||||
|
||||
if #args == 0 then
|
||||
iface = vim.fn.input "impl: generating method stubs for interface: "
|
||||
vim.cmd "redraw!"
|
||||
if iface == "" then
|
||||
u.notify("usage: GoImpl f *File io.Reader", "info")
|
||||
u.notify("arguments not provided. usage: :GoImpl f *File io.Reader", vim.log.levels.ERROR)
|
||||
return
|
||||
end
|
||||
elseif #args == 1 then -- :GoImpl io.Reader
|
||||
recv = string.lower(recv) .. " *" .. recv
|
||||
vim.cmd "redraw!"
|
||||
iface = select(1, ...)
|
||||
local st = ts_utils.get_struct_under_cursor(bufnr)
|
||||
iface = args[1]
|
||||
recv = string.lower(st.name) .. " *" .. st.name
|
||||
elseif #args == 2 then -- :GoImpl w io.Writer
|
||||
recv_name = select(1, ...)
|
||||
recv = string.format("%s *%s", recv_name, recv)
|
||||
iface = select(#args, ...)
|
||||
elseif #args > 2 then
|
||||
iface = select(#args, ...)
|
||||
recv = select(#args - 1, ...)
|
||||
recv_name = select(#args - 2, ...)
|
||||
recv = string.format("%s %s", recv_name, recv)
|
||||
local st = ts_utils.get_struct_under_cursor(bufnr)
|
||||
iface = args[2]
|
||||
recv = args[1] .. " *" .. st.name
|
||||
elseif #args == 3 then -- :GoImpl r Struct io.Reader
|
||||
recv = args[1] .. " *" .. args[2]
|
||||
iface = args[3]
|
||||
end
|
||||
|
||||
-- stylua: ignore
|
||||
local cmd_args = {
|
||||
"-dir", vim.fn.fnameescape(vim.fn.expand "%:p:h"), ---@diagnostic disable-line: missing-parameter
|
||||
recv,
|
||||
iface
|
||||
}
|
||||
assert(iface ~= "", "interface not provided")
|
||||
assert(recv ~= "", "receiver not provided")
|
||||
|
||||
local res_data
|
||||
Job:new({
|
||||
command = c.impl,
|
||||
args = cmd_args,
|
||||
on_exit = function(data, retval)
|
||||
if retval ~= 0 then
|
||||
u.notify("command 'impl " .. unpack(cmd_args) .. "' exited with code " .. retval, "error")
|
||||
return
|
||||
local dir = vim.fn.fnameescape(vim.fn.expand "%:p:h")
|
||||
local rs = r.sync { c.impl, "-dir", dir, recv, iface }
|
||||
if rs.code ~= 0 then
|
||||
error("failed to implement interface: " .. rs.stderr)
|
||||
end
|
||||
|
||||
res_data = data:result()
|
||||
end,
|
||||
}):sync()
|
||||
|
||||
local pos = vim.fn.getcurpos()[2]
|
||||
table.insert(res_data, 1, "")
|
||||
vim.fn.append(pos, res_data)
|
||||
local output = u.remove_empty_lines(vim.split(rs.stdout, "\n"))
|
||||
|
||||
table.insert(output, 1, "")
|
||||
vim.fn.append(pos, output)
|
||||
end
|
||||
|
||||
return impl
|
||||
|
|
|
|||
|
|
@ -1,5 +1,66 @@
|
|||
local GOPHER = {}
|
||||
--- *gopher.nvim* Enhance your golang experience
|
||||
---
|
||||
--- MIT License Copyright (c) 2025 Oleksandr Smirnov
|
||||
---
|
||||
--- ==============================================================================
|
||||
---
|
||||
--- gopher.nvim is a minimalistic plugin for Go development in Neovim written in Lua.
|
||||
--- It's not an LSP tool, the main goal of this plugin is add go tooling support in Neovim.
|
||||
---
|
||||
--- Table of Contents
|
||||
---@toc
|
||||
|
||||
GOPHER.setup = require("gopher.config").setup
|
||||
local log = require "gopher._utils.log"
|
||||
local tags = require "gopher.struct_tags"
|
||||
local tests = require "gopher.gotests"
|
||||
local go = require "gopher.go"
|
||||
local gopher = {}
|
||||
|
||||
return GOPHER
|
||||
---@toc_entry Setup
|
||||
---@tag gopher.nvim-setup()
|
||||
---@text Setup function. This method simply merges default config with opts table.
|
||||
--- You can read more about configuration at |gopher.nvim-config|
|
||||
--- Calling this function is optional, if you ok with default settings.
|
||||
--- See |gopher.nvim.config|
|
||||
---
|
||||
---@usage >lua
|
||||
--- require("gopher").setup {} -- use default config or replace {} with your own
|
||||
--- <
|
||||
---@param user_config gopher.Config See |gopher.nvim-config|
|
||||
gopher.setup = function(user_config)
|
||||
log.debug "setting up config"
|
||||
require("gopher.config").setup(user_config)
|
||||
log.debug(vim.inspect(user_config))
|
||||
end
|
||||
|
||||
---@toc_entry Install dependencies
|
||||
---@tag gopher.nvim-dependencies
|
||||
---@text
|
||||
--- Gopher.nvim implements most of its features using third-party tools. To
|
||||
--- install plugin's dependencies, you can run:
|
||||
--- `:GoInstallDeps` or `:GoInstallDepsSync`
|
||||
--- or use `require("gopher").install_deps()` if you prefer lua api.
|
||||
gopher.install_deps = require("gopher.installer").install_deps
|
||||
|
||||
gopher.impl = require("gopher.impl").impl
|
||||
gopher.iferr = require("gopher.iferr").iferr
|
||||
gopher.comment = require("gopher.comment").comment
|
||||
|
||||
gopher.tags = {
|
||||
add = tags.add,
|
||||
rm = tags.remove,
|
||||
clear = tags.clear,
|
||||
}
|
||||
|
||||
gopher.test = {
|
||||
add = tests.func_test,
|
||||
exported = tests.all_exported_tests,
|
||||
all = tests.all_tests,
|
||||
}
|
||||
|
||||
gopher.get = go.get
|
||||
gopher.mod = go.mod
|
||||
gopher.work = go.work
|
||||
gopher.generate = go.generate
|
||||
|
||||
return gopher
|
||||
|
|
|
|||
|
|
@ -1,35 +1,66 @@
|
|||
local c = require "gopher.config"
|
||||
local r = require "gopher._utils.runner"
|
||||
local u = require "gopher._utils"
|
||||
local log = require "gopher._utils.log"
|
||||
local installer = {}
|
||||
|
||||
local urls = {
|
||||
gomodifytags = "github.com/fatih/gomodifytags",
|
||||
impl = "github.com/josharian/impl",
|
||||
gotests = "github.com/cweill/gotests/...",
|
||||
iferr = "github.com/koron/iferr",
|
||||
dlv = "github.com/go-delve/delve/cmd/dlv",
|
||||
gomodifytags = "github.com/fatih/gomodifytags@latest",
|
||||
impl = "github.com/josharian/impl@latest",
|
||||
gotests = "github.com/cweill/gotests/...@develop",
|
||||
iferr = "github.com/koron/iferr@latest",
|
||||
json2go = "olexsmir.xyz/json2go/cmd/json2go@latest",
|
||||
}
|
||||
|
||||
---@param pkg string
|
||||
local function install(pkg)
|
||||
local Job = require "plenary.job"
|
||||
local u = require "gopher._utils"
|
||||
---@param opt vim.SystemCompleted
|
||||
---@param url string
|
||||
local function handle_intall_exit(opt, url)
|
||||
if opt.code ~= 0 then
|
||||
vim.schedule(function()
|
||||
u.notify("go install failed: " .. url)
|
||||
end)
|
||||
|
||||
local url = urls[pkg] .. "@latest"
|
||||
|
||||
Job:new({
|
||||
command = "go",
|
||||
args = { "install", url },
|
||||
on_exit = function(_, retval)
|
||||
if retval ~= 0 then
|
||||
u.notify("command 'go install " .. url .. "' exited with code " .. retval, "error")
|
||||
log.error("go install failed:", "url", url, "opt", vim.inspect(opt))
|
||||
return
|
||||
end
|
||||
|
||||
u.notify("install " .. url .. " finished", "info ")
|
||||
end,
|
||||
}):start()
|
||||
vim.schedule(function()
|
||||
u.notify("go install-ed: " .. url)
|
||||
end)
|
||||
end
|
||||
|
||||
---@param url string
|
||||
local function install(url)
|
||||
vim.schedule(function()
|
||||
u.notify("go install-ing: " .. url)
|
||||
end)
|
||||
|
||||
r.async({ c.commands.go, "install", url }, function(opt)
|
||||
handle_intall_exit(opt, url)
|
||||
end, { timeout = c.installer_timeout })
|
||||
end
|
||||
|
||||
---@param url string
|
||||
local function install_sync(url)
|
||||
vim.schedule(function()
|
||||
u.notify("go install-ing: " .. url)
|
||||
end)
|
||||
|
||||
local rs = r.sync({ c.commands.go, "install", url }, { timeout = c.installer_timeout })
|
||||
handle_intall_exit(rs, url)
|
||||
end
|
||||
|
||||
---Install required go deps
|
||||
return function()
|
||||
for pkg, _ in pairs(urls) do
|
||||
install(pkg)
|
||||
---@param opts? {sync:boolean}
|
||||
function installer.install_deps(opts)
|
||||
opts = opts or {}
|
||||
for _, url in pairs(urls) do
|
||||
if opts.sync then
|
||||
install_sync(url)
|
||||
else
|
||||
install(url)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
return installer
|
||||
|
|
|
|||
137
lua/gopher/json2go.lua
Normal file
137
lua/gopher/json2go.lua
Normal file
|
|
@ -0,0 +1,137 @@
|
|||
---@toc_entry json2go
|
||||
---@tag gopher.nvim-json2go
|
||||
---@text
|
||||
--- Convert json to go type annotations.
|
||||
---
|
||||
---@usage
|
||||
--- `:GoJson` opens a temporary buffer where you can paste or write JSON.
|
||||
--- Saving the buffer (`:w` or `:wq`) automatically closes it and inserts the
|
||||
--- generated Go struct into the original buffer at the cursor position.
|
||||
---
|
||||
--- Alternatively, you can pass JSON directly as an argument:
|
||||
--- >vim
|
||||
--- :GoJson {"name": "Alice", "age": 30}
|
||||
--- <
|
||||
|
||||
local c = require "gopher.config"
|
||||
local log = require "gopher._utils.log"
|
||||
local u = require "gopher._utils"
|
||||
local r = require "gopher._utils.runner"
|
||||
local json2go = {}
|
||||
|
||||
---@dochide
|
||||
---@param bufnr integer
|
||||
---@param cpos integer
|
||||
---@param type_ string
|
||||
local function apply(bufnr, cpos, type_)
|
||||
local lines = vim.api.nvim_buf_get_lines(bufnr, 0, -1, false)
|
||||
local input_lines = u.remove_empty_lines(vim.split(type_, "\n"))
|
||||
for i, line in pairs(input_lines) do
|
||||
table.insert(lines, cpos + i, line)
|
||||
end
|
||||
vim.api.nvim_buf_set_lines(bufnr, 0, -1, true, lines)
|
||||
end
|
||||
|
||||
-- Convert json string to go type.
|
||||
---
|
||||
---@param json_str string Json string that is going to be converted to go type.
|
||||
---@return string? Go type, or nil if failed.
|
||||
function json2go.transform(json_str)
|
||||
local cmd = { c.commands.json2go }
|
||||
if c.json2go.type_name then
|
||||
table.insert(cmd, "-type", c.json2go.type_name)
|
||||
end
|
||||
|
||||
local rs = r.sync(cmd, { stdin = json_str })
|
||||
if rs.code ~= 0 then
|
||||
u.notify("json2go: got this error: " .. rs.stdout, vim.log.levels.ERROR)
|
||||
log.error("json2go: got this error: " .. rs.stdout)
|
||||
return
|
||||
end
|
||||
return rs.stdout
|
||||
end
|
||||
|
||||
---@dochide
|
||||
---@param ocpos integer
|
||||
local function interactive(ocpos)
|
||||
local obuf = vim.api.nvim_get_current_buf()
|
||||
local owin = vim.api.nvim_get_current_win()
|
||||
|
||||
-- setup the input window
|
||||
local buf = vim.api.nvim_create_buf(false, true)
|
||||
vim.cmd(c.json2go.interactive_cmd)
|
||||
|
||||
local win = vim.api.nvim_get_current_win()
|
||||
vim.api.nvim_win_set_buf(win, buf)
|
||||
vim.api.nvim_buf_set_name(buf, "[GoJson input]")
|
||||
vim.api.nvim_set_option_value("filetype", "jsonc", { buf = buf })
|
||||
vim.api.nvim_set_option_value("buftype", "acwrite", { buf = buf })
|
||||
vim.api.nvim_set_option_value("swapfile", false, { buf = buf })
|
||||
vim.api.nvim_set_option_value("bufhidden", "delete", { buf = buf })
|
||||
vim.api.nvim_buf_set_lines(buf, 0, -1, false, {
|
||||
"// Write your json here.",
|
||||
"// Writing and quitting (:wq), will generate go struct under the cursor.",
|
||||
"",
|
||||
"",
|
||||
})
|
||||
|
||||
vim.api.nvim_create_autocmd("BufLeave", { buffer = buf, command = "stopinsert" })
|
||||
vim.api.nvim_create_autocmd("BufWriteCmd", {
|
||||
buffer = buf,
|
||||
once = true,
|
||||
callback = function()
|
||||
local input = vim.api.nvim_buf_get_lines(buf, 0, -1, true)
|
||||
local inp = table.concat(
|
||||
vim
|
||||
.iter(input)
|
||||
:filter(function(line)
|
||||
local found = string.find(line, "^//.*")
|
||||
return (not found) or (line == "")
|
||||
end)
|
||||
:totable(),
|
||||
"\n"
|
||||
)
|
||||
|
||||
local go_type = json2go.transform(inp)
|
||||
if not go_type then
|
||||
error "cound't convert json to go type"
|
||||
end
|
||||
|
||||
vim.api.nvim_set_option_value("modified", false, { buf = buf })
|
||||
apply(obuf, ocpos, go_type)
|
||||
|
||||
vim.api.nvim_set_current_win(owin)
|
||||
vim.api.nvim_win_set_cursor(owin, { ocpos + 1, 0 })
|
||||
|
||||
vim.schedule(function()
|
||||
pcall(vim.api.nvim_win_close, win, true)
|
||||
pcall(vim.api.nvim_buf_delete, buf, {})
|
||||
end)
|
||||
end,
|
||||
})
|
||||
|
||||
vim.cmd "normal! G"
|
||||
vim.cmd "startinsert"
|
||||
end
|
||||
|
||||
--- Converts json string to go type, and puts result under the cursor. If
|
||||
--- [json_str] is nil, will open an interactive prompt (with cmd set in
|
||||
--- config).
|
||||
---
|
||||
---@param json_str? string
|
||||
function json2go.json2go(json_str)
|
||||
local cur_line = vim.api.nvim_win_get_cursor(0)[1]
|
||||
if not json_str then
|
||||
interactive(cur_line)
|
||||
return
|
||||
end
|
||||
|
||||
local go_type = json2go.transform(json_str)
|
||||
if not go_type then
|
||||
error "cound't convert json to go type"
|
||||
end
|
||||
|
||||
apply(0, cur_line, go_type)
|
||||
end
|
||||
|
||||
return json2go
|
||||
|
|
@ -1,119 +1,200 @@
|
|||
local M = {}
|
||||
---@toc_entry Modify struct tags
|
||||
---@tag gopher.nvim-struct-tags
|
||||
---@text
|
||||
--- `struct_tags` is utilizing the `gomodifytags` tool to add or remove tags to
|
||||
--- struct fields.
|
||||
---
|
||||
---@usage
|
||||
--- How to add/remove/clear tags to struct fields:
|
||||
--- 1. Place cursor on the struct
|
||||
--- 2. Run `:GoTagAdd json` to add json tags to struct fields
|
||||
--- 3. Run `:GoTagRm json` to remove json tags to struct fields
|
||||
--- 4. Run `:GoTagClear` to clear all tags from struct fields
|
||||
---
|
||||
--- If you want to add/remove tag with options, you can use `json=omitempty`
|
||||
--- (where json is tag, and omitempty is its option).
|
||||
--- Example: `:GoTagAdd xml json=omitempty`
|
||||
---
|
||||
---
|
||||
--- NOTE: if you dont specify the tag it will use `json` as default
|
||||
---
|
||||
--- Example:
|
||||
--- >go
|
||||
--- // before
|
||||
--- type User struct {
|
||||
--- // ^ put your cursor here
|
||||
--- // run `:GoTagAdd yaml`
|
||||
--- ID int
|
||||
--- Name string
|
||||
--- }
|
||||
---
|
||||
--- // after
|
||||
--- type User struct {
|
||||
--- ID int `yaml:id`
|
||||
--- Name string `yaml:name`
|
||||
--- }
|
||||
--- <
|
||||
|
||||
local function modify(...)
|
||||
local ts_utils = require "gopher._utils.ts"
|
||||
local Job = require "plenary.job"
|
||||
local c = require("gopher.config").config.commands
|
||||
local u = require "gopher._utils"
|
||||
local ts = require "gopher._utils.ts"
|
||||
local r = require "gopher._utils.runner"
|
||||
local c = require "gopher.config"
|
||||
local u = require "gopher._utils"
|
||||
local log = require "gopher._utils.log"
|
||||
local struct_tags = {}
|
||||
|
||||
local fpath = vim.fn.expand "%" ---@diagnostic disable-line: missing-parameter
|
||||
local ns = ts_utils.get_struct_node_at_pos(unpack(vim.api.nvim_win_get_cursor(0)))
|
||||
if ns == nil then
|
||||
return
|
||||
end
|
||||
---@dochide
|
||||
---@class gopher.StructTagInput
|
||||
---@field input string[] User provided tags
|
||||
---@field range? gopher.StructTagRange (optional)
|
||||
|
||||
---@dochide
|
||||
---@class gopher.StructTagRange
|
||||
---@field start number
|
||||
---@field end_ number
|
||||
|
||||
---@param fpath string
|
||||
---@param bufnr integer
|
||||
---@param range? gopher.StructTagRange
|
||||
---@param user_args string[]
|
||||
---@dochide
|
||||
local function handle_tags(fpath, bufnr, range, user_args)
|
||||
local st = ts.get_struct_under_cursor(bufnr)
|
||||
|
||||
-- stylua: ignore
|
||||
local cmd_args = {
|
||||
local cmd = {
|
||||
c.commands.gomodifytags,
|
||||
"-transform", c.gotag.transform,
|
||||
"-format", "json",
|
||||
"-file", fpath,
|
||||
"-w"
|
||||
"-w",
|
||||
}
|
||||
|
||||
-- by struct name of line pos
|
||||
if ns.name == nil then
|
||||
local _, csrow, _, _ = unpack(vim.fn.getpos ".")
|
||||
table.insert(cmd_args, "-line")
|
||||
table.insert(cmd_args, csrow)
|
||||
-- `-struct` and `-line` cannot be combined, setting them separately
|
||||
if range or st.is_varstruct then
|
||||
table.insert(cmd, "-line")
|
||||
table.insert(cmd, string.format("%d,%d", (range or st).start, (range or st).end_))
|
||||
else
|
||||
table.insert(cmd_args, "-struct")
|
||||
table.insert(cmd_args, ns.name)
|
||||
table.insert(cmd, "-struct")
|
||||
table.insert(cmd, st.name)
|
||||
end
|
||||
|
||||
-- set user args for cmd
|
||||
local arg = { ... }
|
||||
for _, v in ipairs(arg) do
|
||||
table.insert(cmd_args, v)
|
||||
for _, v in ipairs(user_args) do
|
||||
table.insert(cmd, v)
|
||||
end
|
||||
|
||||
-- set default tag for "clear tags"
|
||||
if #arg == 1 and arg[1] ~= "-clear-tags" then
|
||||
table.insert(cmd_args, "json")
|
||||
local rs = r.sync(cmd)
|
||||
if rs.code ~= 0 then
|
||||
log.error("tags: failed to set tags " .. rs.stderr)
|
||||
error("failed to set tags " .. rs.stderr)
|
||||
end
|
||||
|
||||
-- get result of "gomodifytags" works
|
||||
local res_data
|
||||
Job:new({
|
||||
command = c.gomodifytags,
|
||||
args = cmd_args,
|
||||
on_exit = function(data, retval)
|
||||
if retval ~= 0 then
|
||||
u.notify(
|
||||
"command 'gomodifytags " .. unpack(cmd_args) .. "' exited with code " .. retval,
|
||||
"error"
|
||||
)
|
||||
return
|
||||
local res = vim.json.decode(rs.stdout)
|
||||
if res["errors"] then
|
||||
log.error("tags: got an error " .. vim.inspect(res))
|
||||
error("failed to set tags " .. vim.inspect(res["errors"]))
|
||||
end
|
||||
|
||||
res_data = data:result()
|
||||
end,
|
||||
}):sync()
|
||||
|
||||
-- decode goted value
|
||||
local tagged = vim.json.decode(table.concat(res_data))
|
||||
if
|
||||
tagged.errors ~= nil
|
||||
or tagged.lines == nil
|
||||
or tagged["start"] == nil
|
||||
or tagged["start"] == 0
|
||||
then
|
||||
u.notify("failed to set tags " .. vim.inspect(tagged), "error")
|
||||
for i, v in ipairs(res["lines"]) do
|
||||
res["lines"][i] = u.trimend(v)
|
||||
end
|
||||
|
||||
for i, v in ipairs(tagged.lines) do
|
||||
tagged.lines[i] = u.rtrim(v)
|
||||
end
|
||||
|
||||
-- write goted tags
|
||||
vim.api.nvim_buf_set_lines(
|
||||
0,
|
||||
tagged.start - 1,
|
||||
tagged.start - 1 + #tagged.lines,
|
||||
false,
|
||||
tagged.lines
|
||||
bufnr,
|
||||
res["start"] - 1,
|
||||
res["start"] - 1 + #res["lines"],
|
||||
true,
|
||||
res["lines"]
|
||||
)
|
||||
vim.cmd "write"
|
||||
end
|
||||
|
||||
---add tags to struct under cursor
|
||||
---@param ... unknown
|
||||
function M.add(...)
|
||||
local arg = { ... }
|
||||
if #arg == nil or arg == "" then
|
||||
arg = { "json" }
|
||||
end
|
||||
|
||||
local cmd_args = { "-add-tags" }
|
||||
for _, v in ipairs(arg) do
|
||||
table.insert(cmd_args, v)
|
||||
end
|
||||
|
||||
modify(unpack(cmd_args))
|
||||
---@dochide
|
||||
---@param option string
|
||||
local function option_to_tag(option)
|
||||
return option:match "^(.-)="
|
||||
end
|
||||
|
||||
---remove tags to struct under cursor
|
||||
---@param ... unknown
|
||||
function M.remove(...)
|
||||
local arg = { ... }
|
||||
if #arg == nil or arg == "" then
|
||||
arg = { "json" }
|
||||
---@dochide
|
||||
---@param args string[]
|
||||
local function unwrap_if_needed(args)
|
||||
local out = {}
|
||||
for _, v in pairs(args) do
|
||||
for _, p in pairs(vim.split(v, ",")) do
|
||||
table.insert(out, p)
|
||||
end
|
||||
|
||||
local cmd_args = { "-remove-tags" }
|
||||
for _, v in ipairs(arg) do
|
||||
table.insert(cmd_args, v)
|
||||
end
|
||||
|
||||
modify(unpack(cmd_args))
|
||||
return out
|
||||
end
|
||||
|
||||
return M
|
||||
---@dochide
|
||||
---@class gopher.StructTagsArgs
|
||||
---@field tags string
|
||||
---@field options string
|
||||
|
||||
---@dochide
|
||||
---@param args string[]
|
||||
---@return gopher.StructTagsArgs
|
||||
function struct_tags.parse_args(args)
|
||||
args = unwrap_if_needed(args)
|
||||
|
||||
local tags, options = {}, {}
|
||||
for _, v in pairs(args) do
|
||||
if string.find(v, "=") then
|
||||
table.insert(options, v)
|
||||
table.insert(tags, option_to_tag(v))
|
||||
else
|
||||
table.insert(tags, v)
|
||||
end
|
||||
end
|
||||
|
||||
return {
|
||||
tags = table.concat(u.list_unique(tags), ","),
|
||||
options = table.concat(u.list_unique(options), ","),
|
||||
}
|
||||
end
|
||||
|
||||
-- Adds tags to a struct under the cursor. See `:h gopher.nvim-struct-tags`.
|
||||
---@param opts gopher.StructTagInput
|
||||
---@dochide
|
||||
function struct_tags.add(opts)
|
||||
log.debug("adding tags", opts)
|
||||
|
||||
local fpath = vim.fn.expand "%"
|
||||
local bufnr = vim.api.nvim_get_current_buf()
|
||||
|
||||
local user_args = struct_tags.parse_args(opts.input)
|
||||
handle_tags(fpath, bufnr, opts.range, {
|
||||
"-add-tags",
|
||||
(user_args.tags ~= "") and user_args.tags or c.gotag.default_tag,
|
||||
(user_args.options ~= "" or c.gotag.option) and "-add-options" or nil,
|
||||
(user_args.options ~= "") and user_args.options or c.gotag.option,
|
||||
})
|
||||
end
|
||||
|
||||
-- Removes tags from a struct under the cursor. See `:h gopher.nvim-struct-tags`.
|
||||
---@dochide
|
||||
---@param opts gopher.StructTagInput
|
||||
function struct_tags.remove(opts)
|
||||
log.debug("removing tags", opts)
|
||||
|
||||
local fpath = vim.fn.expand "%"
|
||||
local bufnr = vim.api.nvim_get_current_buf()
|
||||
|
||||
local user_args = struct_tags.parse_args(opts.input)
|
||||
handle_tags(fpath, bufnr, opts.range, {
|
||||
"-remove-tags",
|
||||
(user_args.tags ~= "") and user_args.tags or c.gotag.default_tag,
|
||||
(user_args.options ~= "" or c.gotag.option ~= nil) and "-remove-options" or nil,
|
||||
(user_args.options ~= "") and user_args.options or c.gotag.option,
|
||||
})
|
||||
end
|
||||
|
||||
-- Removes all tags from a struct under the cursor.
|
||||
-- See `:h gopher.nvim-struct-tags`.
|
||||
---@dochide
|
||||
function struct_tags.clear()
|
||||
local fpath = vim.fn.expand "%"
|
||||
local bufnr = vim.api.nvim_get_current_buf()
|
||||
handle_tags(fpath, bufnr, nil, { "-clear-tags" })
|
||||
end
|
||||
|
||||
return struct_tags
|
||||
|
|
|
|||
39
nvim.toml
39
nvim.toml
|
|
@ -1,42 +1,5 @@
|
|||
[vim]
|
||||
any = true
|
||||
|
||||
[describe]
|
||||
[MiniTest]
|
||||
any = true
|
||||
[[describe.args]]
|
||||
type = "string"
|
||||
[[describe.args]]
|
||||
type = "function"
|
||||
|
||||
[it]
|
||||
any = true
|
||||
[[it.args]]
|
||||
type = "string"
|
||||
[[it.args]]
|
||||
type = "function"
|
||||
|
||||
[before_each]
|
||||
any = true
|
||||
[[before_each.args]]
|
||||
type = "function"
|
||||
[[after_each.args]]
|
||||
type = "function"
|
||||
|
||||
[assert]
|
||||
any = true
|
||||
|
||||
[assert.is_not]
|
||||
any = true
|
||||
|
||||
[[assert.equals.args]]
|
||||
type = "any"
|
||||
[[assert.equals.args]]
|
||||
type = "any"
|
||||
[[assert.equals.args]]
|
||||
type = "any"
|
||||
required = false
|
||||
|
||||
[[assert.same.args]]
|
||||
type = "any"
|
||||
[[assert.same.args]]
|
||||
type = "any"
|
||||
|
|
|
|||
10
pkg.json
Normal file
10
pkg.json
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
{
|
||||
"name": "gopher.nvim",
|
||||
"engines": {
|
||||
"nvim": "^0.10.0"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/olexsmir/gopher.nvim"
|
||||
}
|
||||
}
|
||||
107
plugin/gopher.lua
Normal file
107
plugin/gopher.lua
Normal file
|
|
@ -0,0 +1,107 @@
|
|||
---@toc_entry Commands
|
||||
---@tag gopher.nvim-commands
|
||||
---@text
|
||||
--- If don't want to automatically register plugins' commands,
|
||||
--- you can set `vim.g.gopher_register_commands` to `false`, before loading the plugin.
|
||||
|
||||
if vim.g.gopher_register_commands == false then
|
||||
return
|
||||
end
|
||||
|
||||
---@param name string
|
||||
---@param fn fun(args: table)
|
||||
---@param nargs? number|"*"|"?"
|
||||
---@param range? boolean
|
||||
---@private
|
||||
local function cmd(name, fn, nargs, range)
|
||||
vim.api.nvim_create_user_command(name, fn, {
|
||||
nargs = nargs or 0,
|
||||
range = range or false,
|
||||
})
|
||||
end
|
||||
|
||||
cmd("GopherLog", function()
|
||||
vim.cmd("tabnew " .. require("gopher._utils.log").get_outfile())
|
||||
end)
|
||||
|
||||
cmd("GoIfErr", function()
|
||||
require("gopher").iferr()
|
||||
end)
|
||||
|
||||
cmd("GoCmt", function()
|
||||
require("gopher").comment()
|
||||
end)
|
||||
|
||||
cmd("GoImpl", function(args)
|
||||
require("gopher").impl(unpack(args.fargs))
|
||||
end, "*")
|
||||
|
||||
-- :GoInstall
|
||||
cmd("GoInstallDeps", function()
|
||||
require("gopher").install_deps()
|
||||
end)
|
||||
|
||||
cmd("GoInstallDepsSync", function()
|
||||
require("gopher").install_deps { sync = true }
|
||||
end)
|
||||
|
||||
-- :GoTag
|
||||
cmd("GoTagAdd", function(opts)
|
||||
require("gopher").tags.add {
|
||||
input = opts.fargs,
|
||||
range = (opts.count ~= -1) and {
|
||||
start = opts.line1,
|
||||
end_ = opts.line2,
|
||||
} or nil,
|
||||
}
|
||||
end, "*", true)
|
||||
|
||||
cmd("GoTagRm", function(opts)
|
||||
require("gopher").tags.rm {
|
||||
input = opts.fargs,
|
||||
range = (opts.count ~= -1) and {
|
||||
start = opts.line1,
|
||||
end_ = opts.line2,
|
||||
} or nil,
|
||||
}
|
||||
end, "*", true)
|
||||
|
||||
cmd("GoTagClear", function()
|
||||
require("gopher").tags.clear()
|
||||
end)
|
||||
|
||||
-- :GoJson
|
||||
cmd("GoJson", function(opts)
|
||||
local inp = ((opts.args ~= "" and opts.args) or nil)
|
||||
require("gopher.json2go").json2go(inp)
|
||||
end, "*")
|
||||
|
||||
-- :GoTest
|
||||
cmd("GoTestAdd", function()
|
||||
require("gopher").test.add()
|
||||
end)
|
||||
|
||||
cmd("GoTestsAll", function()
|
||||
require("gopher").test.all()
|
||||
end)
|
||||
|
||||
cmd("GoTestsExp", function()
|
||||
require("gopher").test.exported()
|
||||
end)
|
||||
|
||||
-- :Go
|
||||
cmd("GoMod", function(opts)
|
||||
require("gopher").mod(opts.fargs)
|
||||
end, "*")
|
||||
|
||||
cmd("GoGet", function(opts)
|
||||
require("gopher").get(opts.fargs)
|
||||
end, "*")
|
||||
|
||||
cmd("GoWork", function(opts)
|
||||
require("gopher").get(opts.fargs)
|
||||
end, "*")
|
||||
|
||||
cmd("GoGenerate", function(opts)
|
||||
require("gopher").generate(opts.fargs or { "" })
|
||||
end, "?")
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
command! -nargs=* GoTagAdd :lua require"gopher.api".tags_add(<f-args>)
|
||||
command! -nargs=* GoTagRm :lua require"gopher.api".tags_rm(<f-args>)
|
||||
command! -nargs=* GoTestAdd :lua require"gopher.api".test_add(<f-args>)
|
||||
command! -nargs=* GoTestsAll :lua require"gopher.api".tests_all(<f-args>)
|
||||
command! -nargs=* GoTestsExp :lua require"gopher.api".test_exported(<f-args>)
|
||||
command! -nargs=* GoMod :lua require"gopher.api".mod(<f-args>)
|
||||
command! -nargs=* GoGet :lua require"gopher.api".get(<f-args>)
|
||||
command! -nargs=* GoWork :lua require"gopher.api".work(<f-args>)
|
||||
command! -nargs=* GoImpl :lua require"gopher.api".impl(<f-args>)
|
||||
command! -nargs=* GoGenerate :lua require"gopher.api".generate(<f-args>)
|
||||
command! GoCmt :lua require"gopher.api".comment()
|
||||
command! GoIfErr :lua require"gopher.api".iferr()
|
||||
command! GoInstallDeps :lua require"gopher.api".install_deps()
|
||||
38
scripts/docgen.lua
Normal file
38
scripts/docgen.lua
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
---@diagnostic disable: undefined-global
|
||||
--# selene: allow(undefined_variable)
|
||||
|
||||
local okay, minidoc = pcall(require, "mini.doc")
|
||||
if not okay then
|
||||
error "mini.doc not found, please install it. https://github.com/echasnovski/mini.doc"
|
||||
return
|
||||
end
|
||||
|
||||
local files = {
|
||||
"lua/gopher/init.lua",
|
||||
"lua/gopher/config.lua",
|
||||
"plugin/gopher.lua",
|
||||
"lua/gopher/struct_tags.lua",
|
||||
"lua/gopher/json2go.lua",
|
||||
"lua/gopher/impl.lua",
|
||||
"lua/gopher/gotests.lua",
|
||||
"lua/gopher/iferr.lua",
|
||||
"lua/gopher/comment.lua",
|
||||
}
|
||||
|
||||
minidoc.setup()
|
||||
|
||||
local hooks = vim.deepcopy(minidoc.default_hooks)
|
||||
hooks.write_pre = function(lines)
|
||||
-- Remove first two lines with `======` and `------` delimiters to comply
|
||||
-- with `:h local-additions` template
|
||||
table.remove(lines, 1)
|
||||
table.remove(lines, 1)
|
||||
|
||||
return lines
|
||||
end
|
||||
|
||||
hooks.sections["@dochide"] = function(s)
|
||||
s.parent:clear_lines()
|
||||
end
|
||||
|
||||
MiniDoc.generate(files, "doc/gopher.nvim.txt", { hooks = hooks })
|
||||
72
scripts/minimal_init.lua
Normal file
72
scripts/minimal_init.lua
Normal file
|
|
@ -0,0 +1,72 @@
|
|||
local function root(p)
|
||||
local f = debug.getinfo(1, "S").source:sub(2)
|
||||
return vim.fn.fnamemodify(f, ":p:h:h") .. "/" .. (p or "")
|
||||
end
|
||||
|
||||
local function install_plug(plugin)
|
||||
local name = plugin:match ".*/(.*)"
|
||||
local package_root = root ".tests/site/pack/deps/start/"
|
||||
if not vim.uv.fs_stat(package_root .. name) then
|
||||
print("Installing " .. plugin)
|
||||
vim
|
||||
.system({
|
||||
"git",
|
||||
"clone",
|
||||
"--depth=1",
|
||||
"https://github.com/" .. plugin .. ".git",
|
||||
package_root .. "/" .. name,
|
||||
})
|
||||
:wait()
|
||||
end
|
||||
end
|
||||
|
||||
install_plug "nvim-treesitter/nvim-treesitter"
|
||||
install_plug "echasnovski/mini.doc" -- used for docs generation
|
||||
install_plug "folke/tokyonight.nvim" -- theme for generating demos
|
||||
install_plug "echasnovski/mini.test"
|
||||
|
||||
vim.env.XDG_CONFIG_HOME = root ".tests/config"
|
||||
vim.env.XDG_DATA_HOME = root ".tests/data"
|
||||
vim.env.XDG_STATE_HOME = root ".tests/state"
|
||||
vim.env.XDG_CACHE_HOME = root ".tests/cache"
|
||||
|
||||
vim.opt.runtimepath:append(root())
|
||||
vim.opt.packpath:append(root ".tests/site")
|
||||
vim.o.swapfile = false
|
||||
vim.o.writebackup = false
|
||||
vim.notify = vim.print
|
||||
|
||||
-- install go treesitter parse
|
||||
require("nvim-treesitter.install").ensure_installed_sync "go"
|
||||
|
||||
require("gopher").setup {
|
||||
log_level = vim.log.levels.OFF,
|
||||
timeout = 4000,
|
||||
}
|
||||
|
||||
-- setup mini.test only when running headless nvim
|
||||
if #vim.api.nvim_list_uis() == 0 then
|
||||
require("mini.test").setup {
|
||||
collect = {
|
||||
find_files = function()
|
||||
return vim.fn.globpath("spec", "**/*_test.lua", true, true)
|
||||
end,
|
||||
},
|
||||
}
|
||||
end
|
||||
|
||||
-- set colorscheme only when running ui
|
||||
if #vim.api.nvim_list_uis() == 1 then
|
||||
vim.cmd.colorscheme "tokyonight-night"
|
||||
vim.o.cursorline = true
|
||||
vim.o.number = true
|
||||
end
|
||||
|
||||
-- needed for tests, i dont know the reason why, but on start
|
||||
-- vim is not able to use treesitter for go by default
|
||||
vim.api.nvim_create_autocmd("FileType", {
|
||||
pattern = "go",
|
||||
callback = function(args)
|
||||
vim.treesitter.start(args.buf, "go")
|
||||
end,
|
||||
})
|
||||
|
|
@ -1 +1,2 @@
|
|||
std="nvim+lua51"
|
||||
std = "nvim+lua52"
|
||||
exclude = [".tests/*"]
|
||||
|
|
|
|||
0
spec/fixtures/comment/empty_input.go
vendored
Normal file
0
spec/fixtures/comment/empty_input.go
vendored
Normal file
2
spec/fixtures/comment/empty_output.go
vendored
Normal file
2
spec/fixtures/comment/empty_output.go
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
//
|
||||
|
||||
5
spec/fixtures/comment/func_input.go
vendored
Normal file
5
spec/fixtures/comment/func_input.go
vendored
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
package main
|
||||
|
||||
func Test(a int) bool {
|
||||
return false
|
||||
}
|
||||
6
spec/fixtures/comment/func_output.go
vendored
Normal file
6
spec/fixtures/comment/func_output.go
vendored
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
package main
|
||||
|
||||
// Test
|
||||
func Test(a int) bool {
|
||||
return false
|
||||
}
|
||||
3
spec/fixtures/comment/interface_input.go
vendored
Normal file
3
spec/fixtures/comment/interface_input.go
vendored
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
package main
|
||||
|
||||
type Testinger interface{}
|
||||
6
spec/fixtures/comment/interface_many_method_input.go
vendored
Normal file
6
spec/fixtures/comment/interface_many_method_input.go
vendored
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
package main
|
||||
|
||||
type Testinger interface {
|
||||
Get(id string) int
|
||||
Set(id string, val int)
|
||||
}
|
||||
7
spec/fixtures/comment/interface_many_method_output.go
vendored
Normal file
7
spec/fixtures/comment/interface_many_method_output.go
vendored
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
package main
|
||||
|
||||
type Testinger interface {
|
||||
Get(id string) int
|
||||
// Set
|
||||
Set(id string, val int)
|
||||
}
|
||||
5
spec/fixtures/comment/interface_method_input.go
vendored
Normal file
5
spec/fixtures/comment/interface_method_input.go
vendored
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
package main
|
||||
|
||||
type Testinger interface {
|
||||
Method(input string) error
|
||||
}
|
||||
6
spec/fixtures/comment/interface_method_output.go
vendored
Normal file
6
spec/fixtures/comment/interface_method_output.go
vendored
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
package main
|
||||
|
||||
type Testinger interface {
|
||||
// Method
|
||||
Method(input string) error
|
||||
}
|
||||
4
spec/fixtures/comment/interface_output.go
vendored
Normal file
4
spec/fixtures/comment/interface_output.go
vendored
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
package main
|
||||
|
||||
// Testinger
|
||||
type Testinger interface{}
|
||||
18
spec/fixtures/comment/many_structs_fields_input.go
vendored
Normal file
18
spec/fixtures/comment/many_structs_fields_input.go
vendored
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
package main
|
||||
|
||||
type (
|
||||
TestOne struct {
|
||||
Asdf string
|
||||
ID int
|
||||
}
|
||||
|
||||
TestTwo struct {
|
||||
Fesa int
|
||||
A bool
|
||||
}
|
||||
|
||||
TestThree struct {
|
||||
Asufj int
|
||||
Fs string
|
||||
}
|
||||
)
|
||||
19
spec/fixtures/comment/many_structs_fields_output.go
vendored
Normal file
19
spec/fixtures/comment/many_structs_fields_output.go
vendored
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
package main
|
||||
|
||||
type (
|
||||
TestOne struct {
|
||||
Asdf string
|
||||
ID int
|
||||
}
|
||||
|
||||
TestTwo struct {
|
||||
// Fesa
|
||||
Fesa int
|
||||
A bool
|
||||
}
|
||||
|
||||
TestThree struct {
|
||||
Asufj int
|
||||
Fs string
|
||||
}
|
||||
)
|
||||
7
spec/fixtures/comment/method_input.go
vendored
Normal file
7
spec/fixtures/comment/method_input.go
vendored
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
package main
|
||||
|
||||
type Method struct{}
|
||||
|
||||
func (Method) Run() error {
|
||||
return nil
|
||||
}
|
||||
8
spec/fixtures/comment/method_output.go
vendored
Normal file
8
spec/fixtures/comment/method_output.go
vendored
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
package main
|
||||
|
||||
type Method struct{}
|
||||
|
||||
// Run
|
||||
func (Method) Run() error {
|
||||
return nil
|
||||
}
|
||||
1
spec/fixtures/comment/package_input.go
vendored
Normal file
1
spec/fixtures/comment/package_input.go
vendored
Normal file
|
|
@ -0,0 +1 @@
|
|||
package main
|
||||
2
spec/fixtures/comment/package_output.go
vendored
Normal file
2
spec/fixtures/comment/package_output.go
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
// Package main provides
|
||||
package main
|
||||
7
spec/fixtures/comment/struct_fields_input.go
vendored
Normal file
7
spec/fixtures/comment/struct_fields_input.go
vendored
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
package main
|
||||
|
||||
type CommentStruct struct {
|
||||
Name string
|
||||
Address string
|
||||
Aliases []string
|
||||
}
|
||||
8
spec/fixtures/comment/struct_fields_output.go
vendored
Normal file
8
spec/fixtures/comment/struct_fields_output.go
vendored
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
package main
|
||||
|
||||
type CommentStruct struct {
|
||||
Name string
|
||||
// Address
|
||||
Address string
|
||||
Aliases []string
|
||||
}
|
||||
3
spec/fixtures/comment/struct_input.go
vendored
Normal file
3
spec/fixtures/comment/struct_input.go
vendored
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
package main
|
||||
|
||||
type CommentStruct struct{}
|
||||
4
spec/fixtures/comment/struct_output.go
vendored
Normal file
4
spec/fixtures/comment/struct_output.go
vendored
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
package main
|
||||
|
||||
// CommentStruct
|
||||
type CommentStruct struct{}
|
||||
5
spec/fixtures/comment/svar_input.go
vendored
Normal file
5
spec/fixtures/comment/svar_input.go
vendored
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
package main
|
||||
|
||||
func varTest() {
|
||||
s := "something"
|
||||
}
|
||||
6
spec/fixtures/comment/svar_output.go
vendored
Normal file
6
spec/fixtures/comment/svar_output.go
vendored
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
package main
|
||||
|
||||
func varTest() {
|
||||
// s
|
||||
s := "something"
|
||||
}
|
||||
5
spec/fixtures/comment/var_input.go
vendored
Normal file
5
spec/fixtures/comment/var_input.go
vendored
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
package main
|
||||
|
||||
func test() {
|
||||
var imAVar string
|
||||
}
|
||||
6
spec/fixtures/comment/var_output.go
vendored
Normal file
6
spec/fixtures/comment/var_output.go
vendored
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
package main
|
||||
|
||||
func test() {
|
||||
// imAVar
|
||||
var imAVar string
|
||||
}
|
||||
8
spec/fixtures/comment/var_struct_fields_input.go
vendored
Normal file
8
spec/fixtures/comment/var_struct_fields_input.go
vendored
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
package main
|
||||
|
||||
func main() {
|
||||
var s struct {
|
||||
API string
|
||||
Key string
|
||||
}
|
||||
}
|
||||
9
spec/fixtures/comment/var_struct_fields_output.go
vendored
Normal file
9
spec/fixtures/comment/var_struct_fields_output.go
vendored
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
package main
|
||||
|
||||
func main() {
|
||||
var s struct {
|
||||
API string
|
||||
// Key
|
||||
Key string
|
||||
}
|
||||
}
|
||||
9
spec/fixtures/iferr/iferr_input.go
vendored
Normal file
9
spec/fixtures/iferr/iferr_input.go
vendored
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
package main
|
||||
|
||||
func test() error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func main() {
|
||||
err := test()
|
||||
}
|
||||
12
spec/fixtures/iferr/iferr_output.go
vendored
Normal file
12
spec/fixtures/iferr/iferr_output.go
vendored
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
package main
|
||||
|
||||
func test() error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func main() {
|
||||
err := test()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
7
spec/fixtures/iferr/message_input.go
vendored
Normal file
7
spec/fixtures/iferr/message_input.go
vendored
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
package main
|
||||
|
||||
func getErr() error { return nil }
|
||||
|
||||
func test() error {
|
||||
err := getErr()
|
||||
}
|
||||
10
spec/fixtures/iferr/message_output.go
vendored
Normal file
10
spec/fixtures/iferr/message_output.go
vendored
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
package main
|
||||
|
||||
func getErr() error { return nil }
|
||||
|
||||
func test() error {
|
||||
err := getErr()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to %w", err)
|
||||
}
|
||||
}
|
||||
3
spec/fixtures/impl/closer_input.go
vendored
Normal file
3
spec/fixtures/impl/closer_input.go
vendored
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
package main
|
||||
|
||||
type CloserTest struct{}
|
||||
7
spec/fixtures/impl/closer_output.go
vendored
Normal file
7
spec/fixtures/impl/closer_output.go
vendored
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
package main
|
||||
|
||||
type CloserTest2 struct{}
|
||||
|
||||
func (closertest *CloserTest2) Close() error {
|
||||
panic("not implemented") // TODO: Implement
|
||||
}
|
||||
3
spec/fixtures/impl/reader_input.go
vendored
Normal file
3
spec/fixtures/impl/reader_input.go
vendored
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
package main
|
||||
|
||||
type Read struct{}
|
||||
7
spec/fixtures/impl/reader_output.go
vendored
Normal file
7
spec/fixtures/impl/reader_output.go
vendored
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
package main
|
||||
|
||||
func (r *Read2) Read(p []byte) (n int, err error) {
|
||||
panic("not implemented") // TODO: Implement
|
||||
}
|
||||
|
||||
type Read2 struct{}
|
||||
3
spec/fixtures/impl/writer_input.go
vendored
Normal file
3
spec/fixtures/impl/writer_input.go
vendored
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
package main
|
||||
|
||||
type WriterTest struct{}
|
||||
7
spec/fixtures/impl/writer_output.go
vendored
Normal file
7
spec/fixtures/impl/writer_output.go
vendored
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
package main
|
||||
|
||||
type WriterTest2 struct{}
|
||||
|
||||
func (w *WriterTest2) Write(p []byte) (n int, err error) {
|
||||
panic("not implemented") // TODO: Implement
|
||||
}
|
||||
2
spec/fixtures/json2go/interativly_input.go
vendored
Normal file
2
spec/fixtures/json2go/interativly_input.go
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
package main
|
||||
|
||||
5
spec/fixtures/json2go/interativly_output.go
vendored
Normal file
5
spec/fixtures/json2go/interativly_output.go
vendored
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
package main
|
||||
|
||||
type AutoGenerated struct {
|
||||
Json bool `json:"json"`
|
||||
}
|
||||
2
spec/fixtures/json2go/manual_input.go
vendored
Normal file
2
spec/fixtures/json2go/manual_input.go
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
package main
|
||||
|
||||
7
spec/fixtures/json2go/manual_output.go
vendored
Normal file
7
spec/fixtures/json2go/manual_output.go
vendored
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
package main
|
||||
|
||||
type AutoGenerated struct {
|
||||
User struct {
|
||||
Name string `json:"name"`
|
||||
} `json:"user"`
|
||||
}
|
||||
11
spec/fixtures/tags/add_many_input.go
vendored
Normal file
11
spec/fixtures/tags/add_many_input.go
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
package main
|
||||
|
||||
type Test struct {
|
||||
ID int
|
||||
Name string
|
||||
Num int64
|
||||
Another struct {
|
||||
First int
|
||||
Second string
|
||||
}
|
||||
}
|
||||
11
spec/fixtures/tags/add_many_output.go
vendored
Normal file
11
spec/fixtures/tags/add_many_output.go
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
package main
|
||||
|
||||
type Test struct {
|
||||
ID int `test4:"id" test5:"id" test1:"id" test2:"id"`
|
||||
Name string `test4:"name" test5:"name" test1:"name" test2:"name"`
|
||||
Num int64 `test4:"num" test5:"num" test1:"num" test2:"num"`
|
||||
Another struct {
|
||||
First int `test4:"first" test5:"first" test1:"first" test2:"first"`
|
||||
Second string `test4:"second" test5:"second" test1:"second" test2:"second"`
|
||||
} `test4:"another" test5:"another" test1:"another" test2:"another"`
|
||||
}
|
||||
14
spec/fixtures/tags/add_range_input.go
vendored
Normal file
14
spec/fixtures/tags/add_range_input.go
vendored
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
package main
|
||||
|
||||
type Test struct {
|
||||
ID int
|
||||
Name string
|
||||
Num int64
|
||||
Cost int
|
||||
Thingy []string
|
||||
Testing int
|
||||
Another struct {
|
||||
First int
|
||||
Second string
|
||||
}
|
||||
}
|
||||
14
spec/fixtures/tags/add_range_output.go
vendored
Normal file
14
spec/fixtures/tags/add_range_output.go
vendored
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
package main
|
||||
|
||||
type Test struct {
|
||||
ID int
|
||||
Name string `gopher:"name"`
|
||||
Num int64 `gopher:"num"`
|
||||
Cost int `gopher:"cost"`
|
||||
Thingy []string
|
||||
Testing int
|
||||
Another struct {
|
||||
First int
|
||||
Second string
|
||||
}
|
||||
}
|
||||
11
spec/fixtures/tags/clear_input.go
vendored
Normal file
11
spec/fixtures/tags/clear_input.go
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
package main
|
||||
|
||||
type Test struct {
|
||||
ID int `json:"id" yaml:"id" xml:"id" db:"id"`
|
||||
Name string `json:"name" yaml:"name" xml:"name" db:"name"`
|
||||
Num int64 `json:"num" yaml:"num" xml:"num" db:"num"`
|
||||
Another struct {
|
||||
First int `json:"first" yaml:"first" xml:"first" db:"first"`
|
||||
Second string `json:"second" yaml:"second" xml:"second" db:"second"`
|
||||
} `json:"another" yaml:"another" xml:"another" db:"another"`
|
||||
}
|
||||
11
spec/fixtures/tags/clear_output.go
vendored
Normal file
11
spec/fixtures/tags/clear_output.go
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
package main
|
||||
|
||||
type Test struct {
|
||||
ID int
|
||||
Name string
|
||||
Num int64
|
||||
Another struct {
|
||||
First int
|
||||
Second string
|
||||
}
|
||||
}
|
||||
18
spec/fixtures/tags/many_input.go
vendored
Normal file
18
spec/fixtures/tags/many_input.go
vendored
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
package main
|
||||
|
||||
type (
|
||||
TestOne struct {
|
||||
Asdf string
|
||||
ID int
|
||||
}
|
||||
|
||||
TestTwo struct {
|
||||
Fesa int
|
||||
A bool
|
||||
}
|
||||
|
||||
TestThree struct {
|
||||
Asufj int
|
||||
Fs string
|
||||
}
|
||||
)
|
||||
18
spec/fixtures/tags/many_output.go
vendored
Normal file
18
spec/fixtures/tags/many_output.go
vendored
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
package main
|
||||
|
||||
type (
|
||||
TestOne struct {
|
||||
Asdf string
|
||||
ID int
|
||||
}
|
||||
|
||||
TestTwo struct {
|
||||
Fesa int `testing:"fesa"`
|
||||
A bool `testing:"a"`
|
||||
}
|
||||
|
||||
TestThree struct {
|
||||
Asufj int
|
||||
Fs string
|
||||
}
|
||||
)
|
||||
8
spec/fixtures/tags/overwrite_default_option_input.go
vendored
Normal file
8
spec/fixtures/tags/overwrite_default_option_input.go
vendored
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
package main
|
||||
|
||||
type Test struct {
|
||||
ID int
|
||||
Another struct {
|
||||
Second string
|
||||
}
|
||||
}
|
||||
8
spec/fixtures/tags/overwrite_default_option_output.go
vendored
Normal file
8
spec/fixtures/tags/overwrite_default_option_output.go
vendored
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
package main
|
||||
|
||||
type Test struct {
|
||||
ID int `xml:"id,otheroption"`
|
||||
Another struct {
|
||||
Second string `xml:"second,otheroption"`
|
||||
} `xml:"another,otheroption"`
|
||||
}
|
||||
14
spec/fixtures/tags/remove_range_input.go
vendored
Normal file
14
spec/fixtures/tags/remove_range_input.go
vendored
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
package main
|
||||
|
||||
type Test struct {
|
||||
ID int `asdf:"id"`
|
||||
Name string `asdf:"name"`
|
||||
Num int64 `asdf:"num"`
|
||||
Cost int `asdf:"cost"`
|
||||
Thingy []string `asdf:"thingy"`
|
||||
Testing int `asdf:"testing"`
|
||||
Another struct {
|
||||
First int `asdf:"first"`
|
||||
Second string `asdf:"second"`
|
||||
} `asdf:"another"`
|
||||
}
|
||||
14
spec/fixtures/tags/remove_range_output.go
vendored
Normal file
14
spec/fixtures/tags/remove_range_output.go
vendored
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
package main
|
||||
|
||||
type Test struct {
|
||||
ID int `asdf:"id"`
|
||||
Name string `asdf:"name"`
|
||||
Num int64
|
||||
Cost int
|
||||
Thingy []string
|
||||
Testing int `asdf:"testing"`
|
||||
Another struct {
|
||||
First int `asdf:"first"`
|
||||
Second string `asdf:"second"`
|
||||
} `asdf:"another"`
|
||||
}
|
||||
11
spec/fixtures/tags/remove_with_option_input.go
vendored
Normal file
11
spec/fixtures/tags/remove_with_option_input.go
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
package main
|
||||
|
||||
type Test struct {
|
||||
ID int `json:"id,omitempty" xml:"id,someoption"`
|
||||
Name string `json:"name,omitempty" xml:"name,someoption"`
|
||||
Num int64 `json:"num,omitempty" xml:"num,someoption"`
|
||||
Another struct {
|
||||
First int `json:"first,omitempty" xml:"first,someoption"`
|
||||
Second string `json:"second,omitempty" xml:"second,someoption"`
|
||||
} `json:"another,omitempty" xml:"another,someoption"`
|
||||
}
|
||||
11
spec/fixtures/tags/remove_with_option_output.go
vendored
Normal file
11
spec/fixtures/tags/remove_with_option_output.go
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
package main
|
||||
|
||||
type Test struct {
|
||||
ID int `xml:"id,someoption"`
|
||||
Name string `xml:"name,someoption"`
|
||||
Num int64 `xml:"num,someoption"`
|
||||
Another struct {
|
||||
First int `xml:"first,someoption"`
|
||||
Second string `xml:"second,someoption"`
|
||||
} `xml:"another,someoption"`
|
||||
}
|
||||
11
spec/fixtures/tags/svar_input.go
vendored
Normal file
11
spec/fixtures/tags/svar_input.go
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
package main
|
||||
|
||||
func main() {
|
||||
s := struct {
|
||||
API string
|
||||
Key string
|
||||
}{
|
||||
API: "api.com",
|
||||
Key: "key",
|
||||
}
|
||||
}
|
||||
11
spec/fixtures/tags/svar_output.go
vendored
Normal file
11
spec/fixtures/tags/svar_output.go
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
package main
|
||||
|
||||
func main() {
|
||||
s := struct {
|
||||
API string `xml:"api"`
|
||||
Key string `xml:"key"`
|
||||
}{
|
||||
API: "api.com",
|
||||
Key: "key",
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue