github.com/golangci/go-tools@v0.0.0-20190318060251-af6baa5dc196/README.md (about)

     1  # github.com/golangci/go-tools
     2  
     3  `github.com/golangci/go-tools/...` is a collection of tools and libraries for
     4  working with Go code, including linters and static analysis.
     5  
     6  **These tools are supported by
     7  [patrons on Patreon](https://www.patreon.com/dominikh) and
     8  [sponsors](#sponsors). If you use these tools at your company,
     9  consider purchasing
    10  [commercial support](https://staticcheck.io/pricing).**
    11  
    12  ## Installation
    13  
    14  To install or update all tools run
    15  ```
    16  go get -u github.com/golangci/go-tools/...
    17  ```
    18  
    19  Alternatively, see individual tool pages below.
    20  
    21  ## Tools
    22  
    23  All of the following tools can be found in the cmd/ directory. Each
    24  tool is accompanied by its own README, describing it in more detail.
    25  
    26  | Tool                                               | Description                                                             |
    27  |----------------------------------------------------|-------------------------------------------------------------------------|
    28  | [keyify](cmd/keyify/)                              | Transforms an unkeyed struct literal into a keyed one.                  |
    29  | [rdeps](cmd/rdeps/)                                | Find all reverse dependencies of a set of packages                      |
    30  | [staticcheck](cmd/staticcheck/)                    | Go static analysis, detecting bugs, performance issues, and much more. |
    31  | [structlayout](cmd/structlayout/)                  | Displays the layout (field sizes and padding) of structs.               |
    32  | [structlayout-optimize](cmd/structlayout-optimize) | Reorders struct fields to minimize the amount of padding.               |
    33  | [structlayout-pretty](cmd/structlayout-pretty)     | Formats the output of structlayout with ASCII art.                      |
    34  
    35  ## Libraries
    36  
    37  In addition to the aforementioned tools, this repository contains the
    38  libraries necessary to implement these tools.
    39  
    40  Unless otherwise noted, none of these libraries have stable APIs.
    41  Their main purpose is to aid the implementation of the tools. If you
    42  decide to use these libraries, please vendor them and expect regular
    43  backwards-incompatible changes.
    44  
    45  ## Documentation
    46  
    47  You can find more documentation on
    48  [staticcheck.io](https://staticcheck.io).
    49  
    50  ## Sponsors
    51  
    52  This project is sponsored by:
    53  
    54  [<img src="images/sponsors/digitalocean.png" alt="DigitalOcean" height="35"></img>](https://digitalocean.com)  
    55  [<img src="images/sponsors/fastly.png" alt="Fastly" height="55"></img>](https://fastly.com)  
    56  [<img src="images/sponsors/uber.png" alt="Uber" height="35"></img>](https://uber.com)
    57  
    58  ## Licenses
    59  
    60  All original code in this repository is licensed under the following
    61  MIT license.
    62  
    63  > Copyright (c) 2016 Dominik Honnef
    64  >
    65  > Permission is hereby granted, free of charge, to any person obtaining
    66  > a copy of this software and associated documentation files (the
    67  > "Software"), to deal in the Software without restriction, including
    68  > without limitation the rights to use, copy, modify, merge, publish,
    69  > distribute, sublicense, and/or sell copies of the Software, and to
    70  > permit persons to whom the Software is furnished to do so, subject to
    71  > the following conditions:
    72  >
    73  > The above copyright notice and this permission notice shall be
    74  > included in all copies or substantial portions of the Software.
    75  >
    76  > THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    77  > EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    78  > MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
    79  > NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
    80  > LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
    81  > OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
    82  > WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
    83  
    84  In addition, some libraries reuse code owned by The Go Authors and
    85  licensed under the following BSD 3-clause license:
    86  
    87  > Copyright (c) 2013 The Go Authors. All rights reserved.
    88  >
    89  > Redistribution and use in source and binary forms, with or without
    90  > modification, are permitted provided that the following conditions are
    91  > met:
    92  >
    93  >    * Redistributions of source code must retain the above copyright
    94  > notice, this list of conditions and the following disclaimer.
    95  >    * Redistributions in binary form must reproduce the above
    96  > copyright notice, this list of conditions and the following disclaimer
    97  > in the documentation and/or other materials provided with the
    98  > distribution.
    99  >    * Neither the name of Google Inc. nor the names of its
   100  > contributors may be used to endorse or promote products derived from
   101  > this software without specific prior written permission.
   102  >
   103  > THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   104  > "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   105  > LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   106  > A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   107  > OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   108  > SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   109  > LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   110  > DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
   111  > THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   112  > (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
   113  > OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.