# ineffassign
Detect ineffectual assignments in Go code.

This tool misses some cases because it does not consider any type information in its analysis.  (For example, assignments to struct fields are never marked as ineffectual.)  It should, however, never give any false positives.

# ineffassign

Detect ineffectual assignments in Go code.

This tool misses some cases because it does not consider any type information in its analysis.  (For example, assignments to struct fields are never marked as ineffectual.)  It should, however, never give any false positives.

## Install

    go get -u github.com/gordonklaus/ineffassign

## Usage

For basic usage, run the following command from the root of your project:

    ineffassign ./*

Which will analyze all packages beneath the current directory.

## Exit Codes

ineffassign returns 1 if any problems were found in the checked files.  It returns 3 if there were any invalid arguments.

Add docs on tool install and usage
Add docs on tool install and usage

Add simple documentation on how to install the tool and how to use the
tool to the README. This is based on my limited experience with the
tool, so it may contain some mistakes.

The docs are inspired by the docs for the errcheck tool, see:
https://github.com/kisielk/errcheck
