Flint

You think there is no place in code reviews to discuss about files naming conventions ? Impose consistent files and directories naming rules with flint: the filesystem linter.

1. Installation
2. Docker image
3. Usage
4. Configuration
5. Available rules
6. Available formatters
7. License

Installation

Using go (nightly)

$ go get -u github.com/bloom42/flint

Binary releases

https://github.com/bloom42/flint/releases/latest

Docker image

bloom42/flint

Usage

Go to your project's root directory then

$ flint init # create a configuration file with default configuration
$ flint
# or cd my_directory && flint to lint only current directory and subfiles

Configuration

Configuration is stored in a .flint.sane file at the root of your project (repo).

When runned, flint will recursively search upward for a configuraiton file, starting in the current directory.

$ cat .flint.sane

description = "This is a configuration file for flint, the filesystem linter. More information here: https://github.com/z0mbie42/flint"
default_severity = "warning" # valid values are [off, warning, error]
error_exit_code = 1
warning_exit_code = 0
match_format = "blob" # match format for ignore_directories and ignore_files, valid values are [blob, regexp]


# you can ignore files and directories using glob or regexp syntax according to the configuration above
ignore_files = [".*", "vendor", "Gopkg.toml", "Gopkg.lock", "README.md", "LICENSE"]
ignore_directories = [".*", "vendor"]


# define used rules
rules = {
  "dir/no_dot" = {}
  "file/lower_case_ext" = {}
  "file/no_multi_ext" = {}
  no_empty_name = {}
  no_leading_underscores = {}
  no_trailing_underscores = {}
  no_whitespaces = {}
  snake_case = {
    severity = "error"
  }
}

Available rules

Available formatters

Console

Basic

Json

Ndjson

License

See LICENSE.txt and https://opensource.bloom.sh/licensing