Skip to content

jtrrll/snekcheck

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

snekcheck

Version CI Status License

An opinionated filename linter that loves snake case.

Demo

Usage

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 {} +

Flags

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> ...

Build From Source

  1. Install Nix

  2. Run the build command:

    nix build github:jtrrll/snekcheck
  3. Find the snekcheck binary at result/bin/snekcheck

About

An opinionated filename linter that loves snake case

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Contributors