README.md in ruby-beautify-0.96.0 vs README.md in ruby-beautify-0.97.0
- old
+ new
@@ -1,74 +1,73 @@
# Ruby Beautify
**Master** [](https://codeclimate.com/github/erniebrodeur/ruby-beautify) [](https://travis-ci.org/erniebrodeur/ruby-beautify) [](https://gemnasium.com/erniebrodeur/ruby-beautify)
-**Development** [](https://travis-ci.org/erniebrodeur/ruby-beautify)
+**Development** [](https://travis-ci.org/erniebrodeur/ruby-beautify)
+
[](https://gitter.im/erniebrodeur/ruby-beautify?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
This gem provides a cli binary named 'ruby-beautify' that will pretty up ruby code.
Currenty, 'rbeautify' is included for backwards compatibility but will likely be phased out at some point.
## Installation
- % gem install ruby-beautify
+ `gem install ruby-beautify`
## Usage
To Pretty up a file:
- % ruby-beautify filename
+ `ruby-beautify filename`
Without a filename it reads from STDIN, suitable for piping:
- % curl 'http://example.org/ugly-file.rb' | ruby-beautify
+ `curl https://raw.githubusercontent.com/erniebrodeur/ruby-beautify/master/spec/monolithic_example.rb | ruby-beautify`
It has help:
- % ruby-beautify --help
+ `ruby-beautify --help`
You can pick your indent character:
- % ruby-beautify --(t)abs
+ `ruby-beautify --(t)abs`
- % ruby-beautify --(s)paces
+ `ruby-beautify --(s)paces`
You can also pick the count of characters:
- % ruby-beautify --indent_(c)ount 1
+ `ruby-beautify --indent_(c)ount 1`
Examples:
- % ruby-beautify -c 2 -s filename
+ `ruby-beautify -c 2 -s filename`
- % ruby-beautify filename
+ `ruby-beautify filename`
- % ruby-beautify -t -c 2 filename
+ `ruby-beautify -t -c 2 filename`
-## Bugs
+## Advanced Usage
-I don't have every ruby style tested against, so I expect some gaps. Feel free to submit issues (please include an example) and I'll figure out how to 'beautify' it.
+You can over write files in place, this is useful for doing an entire directory of files at once. This will not over write any files that fail syntax check.
+ `ruby-beautify --overwrite **/*.rb`
+
+## Bugs
+
Please feel free to open issues, I am actively working on this project again, thanks entirely to the ripper gem.
+The gaps are getting smaller. I think we have most of the basic ruby use cases in place. I don't use rails/dsl's too often so I haven't tested those. I suspect it should 'just work' since the way we do syntax matching is really agnostic to what a DSL can change.
+
## Todo
* Add vim style comment hinting.
-* Add overwrite in place to files.
-* Add 'best guest' for files that fail syntax checking.
-* Add syntax checking to files rendered via STDIN.
-* Seperate the content of the main bin into a proper namespace/library (so it doesn't pollute by default).
-* Split up the spec into multiple specs.
* remove the link to rbeautify (by 1.0).
Longer term I'd like to do some more to assignment, line wrapping, and spacing in/around keywords.
## Contributing
-* fork it.
-* create it.
-* push it.
-* pull it.
+Please see the [Contribution Guide](CONTRIB.md) file for specifics on how to contribute to this project.
# History
The original analyzer is available at: http://www.arachnoid.com/ruby/rubyBeautifier.html.