bakku / peacock Goto Github PK

View Code? Open in Web Editor NEW

0.0 2.0 1.0 81 KB

Easily manage your .gitignore

License: MIT License

Ruby 100.00%

peacock's Introduction

Peacock

Peacock is a small tool to easily manage your .gitignore written in ruby.

It lets you extract files and directories from .gitignore files as well as inserting new files to .gitignore

Installation

Install by executing:

$ gem install peacock

Usage

Usage:

peacock [options] [files/directories]

Options:

-h, [--help]        # show this text
-r, [--root]        # use root .gitignore
-s, [--silent]      # suppress output
-e, [--extract]     # extract file from .gitignore

Example

$ git status
...
Untracked files:
    these
    are
    some
    files

$ peacock are some
added are to .gitignore
added some to .gitignore

$ git status
...
Untracked files:
    these
    files

$ peacock -e are
removed are from .gitignore

$ git status
...
Untracked files:
    these
    are
    files

TODO

Issues are used for TODOs

Contributing

Fork it ( https://github.com/bakku/peacock/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create a new Pull Request

peacock's People

Contributors

Watchers

peacock's Issues

Restructure CLI

The peacock cli is old fashioned.
The following changes should be made:

commands should be executed as follows
peacock ignore
peacock extract
peacock clean

the first two commands will expect files after the command
root git ignore should be removed and only local git ignore is available

verbose option is a wrongly used name for the executed behaviour

In peacock the -v (verbose) option makes peacock suppress output.

-s (--silent) should be used here

Make options combinable

Options are not combinable yet.

e.g. using

peacock -ev script.rb

does not work yet.

Either peacock switches to a 3rd-party CI library for ruby or it's own CI class/module will have to be extended

New option: Cleanup

There should be an option for cleaning up a .gitignore file.

The behaviour should be as follows:

-c/--cleanup should be used
there should be an optional argument expected with the .gitignore file
if no .gitignore file was passed then peacock will just search recursively upwards until it finds one
relatively from the .gitignore file which peacock uses here, it should check if the file or directory in the .gitignore exists, if not then peacock should delete that entry

Update Readme for version 1.0

Remove Peacock Commiting

After publishing the gem I encountered feedback which responded to me to remove the auto-commiting behaviour of peacock.

This shall be done now

Peacock should just manage the gitignore file but not commit to the repository

Stable Test Environment

Currently the tests are horrible. A more stable test environment is needed.

Rethink the tests and find a way. Also maybe rcov should be used here.

New option: Comments when inserting a new entry

Often we see in the gitignore file entries as follows:

# Ignore all logfiles and tempfiles.
/log/*.log

Adding a comment should be possible with peacock

Maybe the following syntax might be used

peacock file.txt "# secret text file"

which should result to

# secret text file
file.txt

The comment can be passed as the last argument which should be a string starting with an hashtag

If more than one file/directory was passed then the result should be as follows:

peacock file1.txt file2.txt file3.txt "# some unnecessary stuff"

Result:

# some unnecessary stuff
file1.txt
file2.txt
file3.txt

If the extractor engine did not find an entry it should log this if silent is not set

.gitignore:

hello.rb
byebye.rb

Executing

peacock -e hello

should result to

could not find 'hello' in .gitignore

Gitignore should be created if it does not exist yet

Extractor should be able to extract directories no matter which format was given

A normalized directory format is needed