snekcheck

An opinionated filename linter that loves snake case.

Usage

• To lint several filenames, provide them in a list.

  snekcheck <filename> <filename> ...

• To lint an entire directory, or several, directory names can be provided instead.

  snekcheck <dirname> <dirname> ...

• Several filenames and directory names can be provided simultaneously.

  snekcheck <filename> <dirname> ...

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 limit directory traversal, specify the --depth flag and a depth limit. This can be useful for only checking top-level names or for improving performance on large file systems.

  snekcheck --depth 1 <dirname> ...

• To print inspected filenames, specify the --verbose flag.

  snekcheck --verbose <filename> ...

Build From Source

1. Install Nix

2. Clone this repository

3. Run the following command:

   nix develop --impure -c build

4. Find the snekcheck binary at result/bin/snekcheck