https://github.com/brianstrauch/gold

A fast linter for Go, written in Rust 🥇
https://github.com/brianstrauch/gold

gci go golangci-lint linter rust staticcheck

Last synced: 3 months ago
JSON representation

A fast linter for Go, written in Rust 🥇

• Host: GitHub
• URL: https://github.com/brianstrauch/gold
• Owner: brianstrauch
• License: mit
• Created: 2023-06-03T06:17:04.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-12T01:47:16.000Z (over 1 year ago)
• Last Synced: 2025-02-14T00:15:33.725Z (5 months ago)
• Topics: gci, go, golangci-lint, linter, rust, staticcheck
• Language: Rust
• Homepage:
• Size: 265 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Gold 🥇

[![Gold](https://img.shields.io/badge/code%20style-gold-yellow)](https://github.com/brianstrauch/gold)

A fast linter for Go, written in Rust.

## Usage

    gold [path] [--fix]

## Rules

| Rule               | Description                  | Fix |

| ------------------ | ---------------------------- | --- |

| [F001](tests/F001) | No redundant parameter types | ✅  |

| [F002](tests/F002) | No unsorted imports          | ✅  |

## Configuration

* Gold searches the root directory of your Go modules for a .gold.yml file

* Gold can also read .golangci.yml configuration files, if they exist

* The following is an example of a .gold.yml configuration file:

```yaml

# rules to enable, default: [] (all rules)

enable:

    - F001

    - F002

# rule-specific settings

settings:

    # order to sort imports by, default: [standard, default]

    F002:

        - standard

        - default

        - prefix(github.com/brianstrauch/gold/tests)

# directories to ignore, default: []

ignore:

    - mock

```