Skip to content

Latest commit

 

History

History
124 lines (91 loc) · 5.33 KB

README.md

File metadata and controls

124 lines (91 loc) · 5.33 KB
Raw

gopkgs - List Go packages FAST by using the same implementation as goimports

Travis Build Status Appveyor Build status Releases LICENSE GoDoc

gopkgs outputs list of importable Go packages.

By using the same implementation as goimports, it's faster than go list ... and it also has -f option.

gopkgs cares .goimportsignore which was introduced by golang/go#16386 since it uses the same implementation as goimports.

gopkgs_usage.gif (890×542) Sample usage of gopkgs with other tools like godoc and filtering tools (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

gopkgs_vim.gif (890×542)

Sample usage of gopkgs in Vim: open godoc and import with vim-go and fzf

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.

LICENSE

LICENSE

under 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: golang/go#16427

🐦 Author

haya14busa (https://github.com/haya14busa)