How do I exclude vendor directories in goreporter?

Use the -e flag to specify packages to exclude, such as 'vendor' or other directories. For example, run `goreporter -p ./myproject -r ./report -e vendor` to skip analysis of vendor packages, as explained in the Run it section.

goreporter vs golangci-lint: which is better?

goreporter excels at generating detailed, customizable reports with dependency graphs, while golangci-lint focuses on faster, parallel linting with modern linter support. Choose goreporter for comprehensive reporting, but golangci-lint for CI/CD integration and up-to-date linters.

Can goreporter run in CI/CD pipelines?

Yes, it can be integrated by running it as a command and checking output reports in JSON or text format. However, its dependency on Graphviz and potential slowness with large projects might affect pipeline efficiency.

How to customize the HTML report template in goreporter?

Provide a custom HTML file using the -t flag, like `goreporter -p ./project -r ./report -f html -t ./custom_template.html`. The template must follow goreporter's structure, but the README lacks detailed documentation on this.

Does goreporter support Go modules?

The README mentions handling vendor paths, but for full Go modules support, ensure your project is operational, as it might have issues with module-based dependencies and newer Go features.

What linters are included in goreporter?

It includes over 15 linters like gofmt, govet, golint, deadcode, and gocyclo, as listed in the Supported linters section. However, some are outdated or missing, so check the Todo List for gaps.

Open-Awesome

goreporter

Apache-2.0Goversion3.0.2

A Go tool that runs multiple linters concurrently to perform static analysis, unit testing, and generate comprehensive code quality reports.

GitHub

3.1k stars263 forks0 contributors

What is goreporter?

goreporter is a Go tool that performs static analysis, unit testing, and code review by concurrently running a suite of linters and generating unified code quality reports. It helps developers identify issues like unused code, complexity, formatting errors, and more to improve overall code health. The tool aggregates outputs from linters such as gofmt, govet, golint, and gocyclo into readable HTML, JSON, or text reports.

Target Audience

Go developers and teams looking to automate code quality checks, enforce coding standards, and maintain high-quality codebases through comprehensive static analysis.

Value Proposition

Developers choose goreporter for its ability to run multiple linters concurrently in a single command, saving time and providing a consolidated view of code quality. Its support for custom templates and exclusion filters makes it adaptable to various project needs.

Overview

A Golang tool that does static analysis, unit testing, code review and generate code quality report.

Use Cases

Best For

Automating code quality checks in Go CI/CD pipelines
Generating comprehensive code quality reports for team reviews
Identifying code smells and complexity issues in large Go codebases
Enforcing consistent coding standards across Go projects
Visualizing package dependencies to understand project architecture
Running multiple linters efficiently without manual configuration

Not Ideal For

Teams needing real-time linting feedback integrated directly into their IDE or editor
Projects requiring the latest Go linters not supported or deprecated in goreporter's suite (e.g., safesql)
Environments where installing Graphviz is impractical or adds unnecessary overhead
Small, single-package Go projects where running a full suite of linters is overkill compared to simpler tools

Pros & Cons

Pros

Concurrent Multi-Linter Execution

Runs over 15 popular Go linters like gofmt, govet, and gocyclo concurrently, as listed in the Supported linters section, providing fast and comprehensive static analysis.

Unified Report Formats

Generates consolidated code quality reports in HTML, JSON, or text formats from all linter outputs, offering a single view for team reviews, as shown in the example report.

Customizable HTML Templates

Supports custom HTML templates via the -t flag, allowing teams to tailor report presentation and branding, as mentioned in the Template section.

Dependency Graph Visualization

Includes godepgraph for generating package dependency graphs, helping developers understand project structure, though it requires Graphviz installation.

Cons

Incomplete Linter Coverage

The README's Todo List admits missing linters like interfacer and safesql, and some like copycode are deprecated, reducing effectiveness compared to newer tools.

External Dependency on Graphviz

Requires Graphviz for dependency visualization, adding setup complexity and potential compatibility issues in environments where it's not pre-installed.

Limited Modern Go Support

May have limitations with Go modules or newer Go versions, as the README notes issues with vendor paths and operational project requirements.

Frequently Asked Questions

Related Projects

Gitleaks

Find secrets with Gitleaks 🔑

Stars27,580

Forks2,100

Last commit5 days ago

PHP Parser

A PHP parser written in PHP

Stars17,440

Forks1,121

Last commit3 months ago

TypeScript ESLint

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

Static Type Checker for Python

Stars15,472

Forks1,787

Last commit2 days 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