lint-install

command module
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 4, 2025 License: Apache-2.0 Imports: 13 Imported by: 0

README

lint-install

GoReport Widget stability-stable

Automated linter installation and configuration for consistent code quality across teams and environments.

Quick Start

# Install
go install github.com/codeGROOVE-dev/lint-install@latest

# Add linters to your project
lint-install .

# Run linters
make lint

Why Use It?

  • One command setup - Adds industry-standard linters instantly
  • Version pinning - Same linter versions for everyone
  • Battle-tested configs - Opinionated rules that catch real bugs
  • Multi-environment - Works locally, in CI/CD, and IDEs

Supported Languages

  • Go - golangci-lint
  • Shell - shellcheck
  • Dockerfile - hadolint
  • YAML - yamllint

Usage Examples

# Basic usage
lint-install .
make lint

# Only Go and Shell linters
lint-install -dockerfile=ignore -yaml=ignore .

# Preview changes
lint-install -dry-run .

# CI/CD (GitHub Actions)
- run: make lint-install
- run: make lint

Command Options

-dockerfile string   Dockerfile linting: [ignore, warn, error] (default "error")
-go string          Go linting: [ignore, warn, error] (default "error")
-shell string       Shell linting: [ignore, warn, error] (default "error")
-yaml string        YAML linting: [ignore, warn, error] (default "error")
-dry-run            Preview changes without applying
-makefile string    Makefile name (default "Makefile")

What Gets Added

  • Makefile targets: lint, lint-<language>, lint-install
  • Config files: .golangci.yml, .hadolint.yaml, .yamllint
  • Version files: .*.version for reproducible builds
  • Linter binaries: ./out/linters/ (git-ignored)

Contributing

Contributions welcome! Submit issues or pull requests.

License

See LICENSE for details.

Documentation

Overview

Package main provides a tool to automatically install and configure linters in Go projects.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL