Ayi does house-keeping.
Ruby Shell
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
spec
.gitignore
.travis.yml
Gemfile
Gemfile.ci
Guardfile
LICENSE
README.md
Rakefile
ayi.gemspec
screenshot.png

README.md

Ayi

Build Status Code Climate Coverage Status Gem Version

Ayi does house-keeping.

http://google.com/search?q=chinese+ayi

Screenshot

screenshot

Why Ayi

Because source code, like your apartment, should be kept nice and clean.

What Does Ayi Do

Currently, ayi does these:

  • remove trailing white spaces
  • replace tabs with 2 spaces
  • replace new line characters with \n
  • append a \n before EOF unless already exists

And some more. Not all operations applies for all languages supported, and for some languages, special strategies will be applied as well (like prettify JSON etc).

Of course we will teach her to do more.

Supported Languages and File Types

  • C
  • CSS
  • Go
  • JavaScript
  • JSON
  • Markdown
  • Objective-C
  • Ruby
  • Shell

Coming up soon

  • command line options
  • remove excess new lines at end of file

Installation

$ gem install ayi --no-ri --no-doc

Usage

To clean up your project, specify a path for her to work on

$ ayi ~/path-to-the-project-to-be-tidied

Or send file paths to its STDIN

$ find 

Oh, you do have revision control, don't you?

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Miscellaneous

Made with love through Readme Driven Development

Changelog

0.0.6 / 2014-11-26

  • do not depends on thor gem

0.0.5 / 2014-11-22

  • better git repo detection

0.0.2 / 2012-12-14

  • Added JavaScript and Objective-C support
  • Added CHANGELOG.md

0.0.1 / 2012-12-11

  • Initial release