eagolint

package module
v0.0.0-...-ba66b80 Latest Latest
Warning

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

Go to latest
Published: Jun 20, 2020 License: MIT Imports: 11 Imported by: 1

README

Eagolint

Eagolint is a go linter that keeps your comments punctuated and double-space free.

Usage

A go linter that checks for comments with missing punctuation and double spaces.

Usage:
  eagolint [flags] [path ...]

Flags:
  -e, --exclude string      Exclude lines that match this regex
      --files               Read file names from stdin
  -g, --go-only             Only check .go files
  -h, --help                help for eagolint
  -s, --skip-list strings   List of directories to skip
  -t, --skip-tests          Skip _test.go files
      --vendor              Check files in vendor directory

License

This project is under the MIT license. See LICENSE for more information.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Process

func Process(r io.Reader, w io.Writer, path string, exclude *regexp.Regexp) error

Process checks all lines in the reader and writes an error if the line length is greater than MaxLength.

func ProcessFile

func ProcessFile(w io.Writer, path string, exclude *regexp.Regexp) error

ProcessFile checks all lines in the file and writes an error if the line length is greater than MaxLength.

func ShouldSkip

func ShouldSkip(path string, isDir bool, skipList []string, goOnly bool, skipTests bool) (bool, error)

ShouldSkip checks a path and determines if it should be skipped. SkipList contains paths to be skipped skip. All directories are skipped, only files are processed. If GoOnly is true, non-go files are skipped. Otherwise, checks that file is readable text file.

Types

This section is empty.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
JackTT - Gopher 🇻🇳