chloe

Chloe is a command line utility written in Go to simplify deletion of un-needed files.

Files to be deleted are inferred from a json file (--input) which is expected to contain an array with key chloe. The lines in this array will be interpreted in the same way that a .gitignore file is parsed.

The rules for parsing the files specified under the chloe key obey the rules found at the gitignore docs.

The parsing rules and interface methods can be found at the go-git-ignore repository.

Installation

Just like any good Go package (assuming you have a working go env setup), just do:

$go get github.com/sabhiram/go-chloe
$go install github.com/sabhiram/go-chloe/...
$chloe -v
1.0.0

Why in the world?

When playing with Bower (which is an awesome tool), I started noticing that I ended up fetching a whole bunch of extra files which I probably never would use. This is usually not an issue since these unused files will probably never be fetched from your server / whatever.

However, when working on a raspberry pi project, where all my editing is done on my dev box, and then sync'd over to my pi (using kitchen-sink), I would end up spending much time just pulling / checking for updated timestamps on files which I never needed.

I wanted a flexible way to keep my bower downloads slimmer, so enter chloe.

The easiest way to get going is to add a chloe key to your bower.json file, which points to a list of patterns. When you run chloe list in this same dir - it will list for you any files targeted by the patterns under the chloe key. Run chloe dispatch to delete them!

WARNING: Deleting files can be fun, and dangerous. Be aware of what you are asking the tool to do

Sample json file

test.json

{
    "other_key": "some value",

    "chloe": [
        "**/bower/**/*.md",
        "**/*.out"
    ]
}

The above file will instruct chloe to tag any files with a .md extension two folders deep from a folder called "bower". It also tags all .out files within a folder (relative to the root dir where chloe is run)

Sample Usage:

Assuming the above test.json file (this is a make-believe environment...)

$chloe list -i test.json
Found 5 extra files:
 - app/public/bower/angular/README.md
 - app/public/bower/angular-route/README.md
 - app/public/bower/bootstrap/README.md
 - app/public/bower/jquery-ui/README.md
 - app/public/bower/underscore/README.md

$chloe dispatch -i test.json
Found 5 extra files:
 - app/public/bower/angular/README.md
 - app/public/bower/angular-route/README.md
 - app/public/bower/bootstrap/README.md
 - app/public/bower/jquery-ui/README.md
 - app/public/bower/underscore/README.md
Purge 5 files? [ Yes | No ]: 
y
Deleted 5 files!

$chloe list -i test.json
Found no files to cleanup

Command line usage:

    Usage:

        chloe <command> [<options>]

    Commands:

        list             lists all files which are deletable
        dispatch         deletes any files which are deemed redundant


    Options:

        -i --input       sets the input JSON file, default is "bower.json"
        -f --force       force delete without prompting user
        -v --version     prints the application version
        -h --help        prints this help menu


    Version:

        1.0.0

sabhiram / go-chloe