White

White is a little command line utility to clean up whitespace in source files.

What gets cleaned up?

Collapses multple blank lines into one
Removes white spaces at the end of lines
Removes blank lines at the end of a file
Converts tabs to spaces

Backups?

A backup file is saved for every file. By default, this backup files are automatically removed after the cleanup succeeded.

Installation

White is currently in alpha stage and is not available as a gem yet. Just place the script somewhere on your file system and put it into your path.

Getting Started

Clean up one file:

white my-source-file.rb

Clean up all (text) files in a directory:

white path/to/source/files/

By default, white uses 2 spaces per tab for Ruby and CoffeeScript files, and 4 spaces per tab for the rest.

Cleaning only Changed Files (Git)

Make sure white and git-white scripts are in your path, then simply do:

git white

All changed files will be cleaned.

Configuration

As of release 0.1 it is not possible to customize the behavior other than editing the script directly. Feel free to fork, implement and make a pull request.

Known Issues

git-white doesn't work properly when file names have spaces.
Intentional two spaces for markdown documents are sometimes cleaned even though they shouldn't be.

Conventions

Use dashed notation for directories, files, and URLs: milk/core-extensions, date-extensions.coffee, http://konstantinbender.com/blog/introducing-the-milk-framework
Use dashed notation for XML, HTML and CSS: person-name, table-of-people, regular-xml-parser
No arbitrary abbreviations, such as src, mod, lib, obj, ...

License

Released under the MIT license.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

konstantinbe/white