Project

bigfiles

0.01
A long-lived project that still receives updates
Finds largest source files in a project
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

Runtime

 Project Readme

BigFiles

CircleCI

Simple tool to find the largest source files in your project - maybe to target for refactoring!

Installation

Add this line to your application's Gemfile:

gem 'bigfiles'

And then execute:

bundle

Or install it yourself as:

gem install bigfiles

Usage

This is typically used as part of general use of the quality gem. You can also run it on the command line directly:

$ bigfiles
165: spec/big_files/big_files_spec.rb
76: .rubocop.yml
59: spec/big_files/file_with_lines_spec.rb
$

Options

You can control what files are included and excluded, and how many files are reported:

$ bigfiles --help
Usage: bigfiles [options]
    -g, --glob glob here             Which files to parse - default is {Dockerfile,Rakefile,{*,.*}.{c,clj,cljs,cpp,gemspec,groovy,html,java,js,json,py,rake,rb,scala,sh,swift,yml},{app,config,db,feature,lib,spec,src,test,tests,vars,www}/**/{*,.*}.{c,clj,cljs,cpp,gemspec,groovy,html,java,js,json,py,rake,rb,scala,sh,swift,yml}}
    -e, --exclude-glob glob here     Files to exclude - default is none
    -h, --help                       This message
    -n, --num-files number-here      Top number of files to show--default 3
$

Configuration

You can set different defaults for the above in a .bigfiles.yml in the current directory:

---
bigfiles:
  num_files: 8
  include:
    glob: '**/*.my-favorite-extension'
  exclude:
    glob: fix.sh

Contributing

Bug reports and pull requests are welcome on GitHub. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Pronto::Punchlist project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Contributions

This project, as with all others, rests on the shoulders of a broad ecosystem supported by many volunteers doing thankless work, along with specific contributors.

In particular I'd like to call out:

  • Audrey Roy Greenfeld for the cookiecutter tool and associated examples, which keep my many projects building with shared boilerplate with a minimum of fuss.