Skip to content

umn-asr/reekup

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Reekup

Creates or updates a project's Reek configuration file with the current ASR default.

Installation

To get a pre-compiled binary (Mac only), you can use Homebrew

  • brew tap umn-asr/homebrew-tap
  • brew install umn-asr/homebrew-tap/reekup

Otherwise, you can compile it yourself

  • Install Rust
  • Clone this repo
  • cd reekup
  • cargo build --release
  • cp ./target/release/reekup [somewhere in your $PATH]

Usage

reekup will append ASR's default Reek configuration to a config.reek file in the current directory.

If no config.reek file exists, it will be created.

If a config.reek file already exists, the contents of it will be preserved.

You can run reekup multiple times in the same project, keeping your config.reek file up to date with ASR's default.

reekup -h will show you the help.

Flag Use
-o or --out file where your reek config will be stored. Defaults to config.reek
-u or --url urr where your default reek config lives. Defaults to the ASR default

Development

  • Install Rust
  • Clone this repo
  • cd reekup
  • ./script/setup
  • ./script/test

License

See License.txt