https://github.com/tinkerbell/lint-install

Consistently install reasonable linter rules for open-source projects
https://github.com/tinkerbell/lint-install

Last synced: 3 months ago
JSON representation

Consistently install reasonable linter rules for open-source projects

• Host: GitHub
• URL: https://github.com/tinkerbell/lint-install
• Owner: tinkerbell
• License: apache-2.0
• Created: 2021-08-23T16:47:20.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-05-05T15:40:33.000Z (over 1 year ago)
• Last Synced: 2024-07-15T18:01:57.504Z (4 months ago)
• Language: Go
• Size: 79.1 KB
• Stars: 6
• Watchers: 9
• Forks: 7
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-software-supply-chain-security - tinkerbell/lint-install: Consistently install reasonable linter rules for open-source projects

README

        
# lint-install

[![GoReport Widget]][GoReport Status]

[![stability-stable](https://img.shields.io/badge/stability-stable-green.svg)](https://github.com/emersion/stability-badges#stable)

[GoReport Status]: https://goreportcard.com/report/github.com/tinkerbell/lint-install

[GoReport Widget]: https://goreportcard.com/badge/github.com/tinkerbell/lint-install

Idiomatic linters for opinionated projects.

This tool installs well-configured linters to any project, open-source or

otherwise. The linters can be used in a repeatable and consistent way across CI,

local tests, and IDE's.

lint-install adds linter configuration to the root of your project, and Makefile

rules to install a consistently versioned set of linters to be used in any

environment. These Makefile rules can also be upgrading by lint-install, updating

all environments simultaneously.

Currently supported languages:

- Go

- Shell

- Dockerfile

- YAML

## Philosophy

- Catch all the bugs!

- Improve readability as much as possible.

- Be idiomatic: only raise issues that the language authors would flag

## Usage

Installation:

`go get github.com/tinkerbell/lint-install`

Add Makefile rules for a git repository:

`$HOME/go/bin/lint-install `

Users can then lint the project using:

`make lint`

Other options:

```

  -dockerfile string

     Level to lint Dockerfile with: [ignore, warn, error] (default "error")

  -dry-run

     Display changes to make

  -go string

     Level to lint Go with: [ignore, warn, error] (default "error")

  -makefile string

     name of Makefile to update (default "Makefile")

  -shell string

     Level to lint Shell with: [ignore, warn, error] (default "error")

  -yaml string

     Level to lint YAML with: [ignore, warn, error] (default "error")

```