ABOUT

An opinionated filename linter that loves snake case

Go 75.0%

Nix 19.5%

Nushell 5.0%

Shell 0.5%

README

An opinionated filename linter that loves snake case.

snekcheck accepts a list of filenames to lint.

To lint a filename, simply pass it to snekcheck.
```
snekcheck <filename>
```
To lint several filenames, provide them in a list.
```
snekcheck <filename> <filename> <dirname> ...
```
To recursively lint directories and apply filters,
use tools like find to provide arguments to snekcheck.
```
find . -exec snekcheck {} +
```

snekcheck's behavior can be modified with various flags.

To print a help message, specify the --help flag.
```
snekcheck --help
```
To automatically rename invalid filenames, specify the --fix flag.
Be careful, as the renaming strategy may not produce the results you want.
```
snekcheck --fix <filename> ...
```
To print inspected filenames, specify the --verbose flag.
```
snekcheck --verbose <filename> ...
```