Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/haya14busa/gopkgs
:zap: List Go packages FAST by using the same implementation as goimports
https://github.com/haya14busa/gopkgs
go golang golang-tools
Last synced: 29 days ago
JSON representation
:zap: List Go packages FAST by using the same implementation as goimports
- Host: GitHub
- URL: https://github.com/haya14busa/gopkgs
- Owner: haya14busa
- License: other
- Created: 2016-09-06T12:05:03.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-10-24T12:14:39.000Z (about 6 years ago)
- Last Synced: 2024-10-10T12:18:51.700Z (about 1 month ago)
- Topics: go, golang, golang-tools
- Language: Go
- Homepage:
- Size: 94.7 KB
- Stars: 54
- Watchers: 5
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## gopkgs - List Go packages FAST by using the same implementation as [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports)
[](https://travis-ci.org/haya14busa/gopkgs)
[](https://ci.appveyor.com/project/haya14busa/gopkgs)
[](https://github.com/haya14busa/gopkgs/releases)
[](LICENSE)
[](https://godoc.org/github.com/haya14busa/gopkgs)
gopkgs outputs list of importable Go packages.
By using the same implementation as [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports),
it's faster than [go list ...](https://golang.org/cmd/go/#hdr-List_packages) and it also has `-f` option.
gopkgs cares .goimportsignore which was introduced by https://github.com/golang/go/issues/16386
since it uses the same implementation as [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports).
Sample usage of gopkgs with other tools like [godoc](https://godoc.org/golang.org/x/tools/cmd/godoc) and filtering tools ([peco](https://github.com/peco/peco)).
### Installation
#### Install Binary from GitHub Releases
https://github.com/haya14busa/gopkgs/releases
#### go get
```
go get -u github.com/haya14busa/gopkgs/cmd/gopkgs
```
### SYNOPSIS
```
$ gopkgs -h
Usage of gopkgs:
-f string
alternate format for the output using the syntax of template package. e.g. {{.Name}};{{ImportPathShort}}
-fullpath
output absolute file path to package directory. ("/usr/lib/go/src/net/http")
-include-name
fill Pkg.Name which can be used with -f flag
-short
output vendorless import path ("net/http", "foo/bar/vendor/a/b") (default true)
Use -f to custom the output using template syntax. The struct being passed to template is:
type Pkg struct {
Dir string // absolute file path to Pkg directory ("/usr/lib/go/src/net/http")
ImportPath string // full Pkg import path ("net/http", "foo/bar/vendor/a/b")
ImportPathShort string // vendorless import path ("net/http", "a/b")
// It can be empty. It's filled only when -include-name flag is true.
Name string // package name ("http")
}
```
### Vim
Sample usage of gopkgs in Vim: open godoc and import with [vim-go](https://github.com/fatih/vim-go) and [fzf](https://github.com/junegunn/fzf)
```vim
augroup gopkgs
autocmd!
autocmd FileType go command! -buffer Import exe 'GoImport' fzf#run({'source': 'gopkgs'})[0]
autocmd FileType go command! -buffer Doc exe 'GoDoc' fzf#run({'source': 'gopkgs'})[0]
augroup END
```
Above Vim script is just a sample and isn't robust. I'm planning to create or contribute Vim plugins to include the same feature.
- https://github.com/rhysd/unite-go-import.vim
- [unite.vim](https://github.com/Shougo/unite.vim) (and
[vim-go](https://github.com/fatih/vim-go)) intergration for importing
package or opening godoc in Vim.
### LICENSE
[](LICENSE)
#### under [x/tools/imports/](x/tools/imports/) directory
```
Copyright (c) 2009 The Go Authors. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.
* Neither the name of Google Inc. nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
```
gopkgs copied and modified https://godoc.org/golang.org/x/tools/imports to export some interface
in accordance with LICENSE.
If The Go Authors provide goimports's directory scanning code as a library, I plan to use it.
ref: https://github.com/golang/go/issues/16427
### :bird: Author
haya14busa (https://github.com/haya14busa)