an extendible dispatcher to lint/format code, based on rifle
Project description
rifleman
An extendible dispatcher to lint/format code, based on rifle
This lets you run one command over lots of files/directories which could be in different languages - it classifies them by inspecting the mime type, extension, name or shebang, and then runs a command on those files.
This heavily simplifies and modifies the rifle config file format; including a condition to help check the 'shebang' value for scripts.
See config/format.conf for the default configuration file, I recommend you customize it to include the commands you use.
By default, I've included lots of the format
ers/lint
ers I use, an excerpt:
# html
ext x?html?, has prettier = prettier -w "$@"
# web technologies, handled by prettier
ext vue|yaml|json|graphql|tsx?|jsx?|s?css|less|md, has prettier = prettier -w "$@"
# golang
ext go, has go = go fmt "$@"
# python
ext py, has black = black "$@"
mime text/x-script.python, has black = black "$@"
shebang python(2|3)?, has black = black "$@"
# shell script
shebang zsh|bash, has shfmt = shfmt -w "$@"
shebang \/bin\/sh, has shfmt = shfmt -w "$@"
ext sh|(ba|z)sh, has shfmt = shfmt -w "$@"
mime text/x-shellscript, has shfmt = shfmt -w "$@"
Used emacs-format-all-the-code as reference.
Feel free to PR additional formatters!
Installation
Requires python3.6+
To install with pip, run:
pip install rifleman
Usage
Usage: rifleman [-ljcah] [files]...
Options:
-h, --help show this help message and exit
-l list actions for files
-j list actions for files as JSON
-c CONFIG_FILE read config from specified file instead of default
-a ACTION name of configuration file in config directory to use
(format|lint)
This doesn't offer a way to discover/search for files, because so many tools already exist to do that.
For example, to run this against all files in a git-tracked directory:
rifleman $(git ls-files)
You can find
(with the -exec
flag), or the friendlier fd
, to run against all files in the directory recursively:
fd -X rifleman
The -j
and -l
flags print what commands which would be used on each file instead of running the command.
The -c
and -a
files are used to determine which config file to use, completely altering the functionality of this.
By default, it uses the format.conf
file in the ${XDG_CONFIG_HOME:-${HOME}/.config}/rifleman
directory. -a
is a shorthand; specifying -a lint
looks for a file in the configuration directory called lint.conf
When this is first run, it will try to download the configuration files into the corresponding directories.
Tests
git clone 'https://github.com/seanbreckenridge/rifleman'
cd ./rifleman
pip install '.[testing]'
mypy ./rifleman
pytest
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.