How do I install ineffassign and run it on my Go code?

Install via `go install github.com/gordonklaus/ineffassign@latest`, then run `ineffassign ./...` from your project root to analyze all packages. It's a simple command-line tool with minimal setup required.

What kinds of assignments does ineffassign typically miss?

As per the README, it misses assignments to struct fields and other cases where type analysis is needed. For example, if a struct field is assigned but not used elsewhere, it won't be flagged as ineffectual.

How does ineffassign compare to staticcheck for finding dead code?

ineffassign specializes in ineffectual assignments with zero false positives, while staticcheck offers broader checks including unused variables and imports. Choose ineffassign for focused reliability, but use staticcheck for more comprehensive analysis.

Can I use ineffassign in a pre-commit hook to prevent bad code?

Yes, its exit code reporting makes it suitable for pre-commit hooks. Set it up to run on staged files, and it will fail if ineffectual assignments are found, helping enforce code quality early.

Does ineffassign work with Go modules and modern Go versions?

Yes, it's compatible with Go modules and standard Go tooling. The installation command uses `@latest`, and it analyzes packages in the same way as other Go tools, so it should work with recent Go releases.

What do the exit codes mean in ineffassign?

Exit code 1 indicates problems were found (ineffectual assignments), and 3 means invalid arguments were provided. This is documented in the README, making it easy to script and integrate into CI/CD systems.

Is ineffassign actively maintained and updated for new Go features?

Check the GitHub repository for activity; historically, it's a lightweight tool with infrequent updates. For critical projects, verify compatibility with newer Go versions, as it might lag behind on language changes.

Open-Awesome

ineffassign

MITGo

Detects ineffectual assignments in Go code where variables are assigned but never used.

GitHub

464 stars54 forks0 contributors

What is ineffassign?

ineffassign is a static analysis tool for Go that detects ineffectual assignments in code, where a variable is assigned a value but never used afterward. It helps developers identify and remove unnecessary code to improve efficiency and maintainability. The tool focuses on this specific issue without performing full type analysis, making it fast and straightforward.

Target Audience

Go developers and teams looking to improve code quality by eliminating dead or redundant code, particularly those integrating linting tools into their development workflow.

Value Proposition

Developers choose ineffassign for its reliability in detecting ineffectual assignments with zero false positives, its simplicity in integration, and its focus on a common code smell without the overhead of complex analysis.

Overview

Detect ineffectual assignments in Go code.

Use Cases

Best For

Identifying unused variable assignments in Go projects
Integrating lightweight static analysis into CI/CD pipelines
Improving code cleanliness by removing dead code
Educational purposes to learn about code inefficiencies in Go
Quick code reviews focused on assignment usage
Pre-commit hooks to catch simple code issues

Not Ideal For

Projects requiring detection of ineffectual assignments in struct fields or complex data types
Teams needing a comprehensive linter with multiple checks beyond assignment analysis
Developers looking for tools that provide automatic fixes or detailed remediation suggestions

Pros & Cons

Pros

Zero False Positives

As stated in the README, the tool is designed to never report incorrect ineffectual assignments, ensuring reliable results that developers can trust without manual verification.

Simple CLI Integration

The README highlights commands like `ineffassign ./...`, making it straightforward to analyze all packages in a project with minimal setup or configuration.

CI/CD Friendly Exit Codes

It returns exit code 1 if problems are found and 3 for invalid arguments, as per the README, facilitating easy integration into automated pipelines for continuous code quality checks.

Lightweight and Fast

Since it focuses on ineffectual assignments without full type analysis, it operates quickly and with low overhead, ideal for frequent use in development workflows.

Cons

Limited Detection Scope

The README admits it misses cases like assignments to struct fields due to no type analysis, meaning it may not catch all ineffectual assignments in complex codebases.

No Type-Aware Analysis

It does not consider type information, which can lead to undetected inefficiencies in scenarios involving interfaces, methods, or indirect variable usage.

Minimal Error Guidance

While it reports issues, it lacks detailed suggestions for fixes or explanations, requiring developers to manually inspect and resolve each flagged assignment.

Frequently Asked Questions

Related Projects

PHP Parser

A PHP parser written in PHP

Stars17,430

Forks1,122

Last commit2 months ago

TypeScript ESLint

:sparkles: Monorepo for all the tooling which enables ESLint to support TypeScript

Stars16,245

Forks2,905

Last commit12 hours ago

pyright

Static Type Checker for Python

Stars15,436

Forks1,784

Last commit4 days ago

Reviewdog

🐶 Automated code review tool integrated with any code analysis tools regardless of programming language

Stars9,302

Forks488

Last commit1 day ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub