Skip to content
/ flog Public

Flog reports the most tortured code in an easy to read pain report. The higher the score, the more pain the code is in.

Notifications You must be signed in to change notification settings

seattlerb/flog

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

flog

home

ruby.sadi.st/

code

github.com/seattlerb/flog

rdoc

docs.seattlerb.org/flog

vim

github.com/sentientmonkey/vim-flog

DESCRIPTION:

Flog reports the most tortured code in an easy to read pain report. The higher the score, the more pain the code is in.

FEATURES/PROBLEMS:

  • Easy to read reporting of complexity/pain.

  • Uses path_expander, so you can use:

    • dir_arg – expand a directory automatically

    • @file_of_args – persist arguments in a file

    • -path_to_subtract – ignore intersecting subsets of files/directories

SYNOPSIS:

% ./bin/flog -g lib
Total Flog = 1097.2 (17.4 flog / method)

   323.8: Flog total
    85.3: Flog#output_details
    61.9: Flog#process_iter
    53.7: Flog#parse_options
...

REQUIREMENTS:

  • ruby2ruby (soft dependency: only for -v)

  • ruby_parser

  • path_expander

INSTALL:

  • sudo gem install flog

LICENSE:

(The MIT License)

Copyright © Ryan Davis, seattle.rb

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Flog reports the most tortured code in an easy to read pain report. The higher the score, the more pain the code is in.

Resources

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published

Languages