line-detector - line ending detector

line-detector detects the type of line ending(s) a file uses.

line-detector is used by lili to search for strange line endings in software projects.

EXAMPLES

$ line-detector examples/index.html
examples/index.html: lf, with final eol

$ line-detector examples/index-separated.html
$ examples/index-separated.html: lf, without final eol

$ line-detector examples/index-ie.html
examples/index-ie.html: crlf, with final eol

$ line-detector examples/index-macweb.html
examples/index-macweb.html: cr, with final eol

$ line-detector examples/index-monstrosity.html
examples/index-monstrosity.html: mix, without final eol

$ line-detector examples/empty.txt
examples/empty.txt: none, without final eol

$ line-detector examples/index.min.html
examples/index.min.html: none, without final eol

$ line-detector < examples/index.html
lf, with final eol

line-detector also features a more capable alternative to String#lines, that handles some of the more obscure line ending formats.

$ irb
> require 'line-detector'
> LineDetector.lines("abc\u0085def\u0085ghi")
 => ["abc", "def", "ghi"]

HOMEPAGE

https://github.com/mcandre/line-detector

RUBYGEMS

https://rubygems.org/gems/line-detector

ABOUT

line-detector detects the line ending format of files and arbitrary text:

• Unix (lf)
• Windows/DOS (crlf)
• Old Mac (cr)
• Acorn BBC (lfcr)
• Vertical Tab (vt)
• Form Feed (ff)
• Line Separator (ls)
• Paragraph Separator (ps)
• Next Line (nel)
• Multiple line endings (mix)
• Single-line and empty files (none)

For more information on line endings, see Wikipedia: Newline.

REQUIREMENTS

• Ruby 2.0+

Optional

There are a handful of programs for identifying line ending formats:

• od can elucidate file contents by printing the raw byte values.
• The Unix file command can report CRLF files, but fails to report CRLFs in .html files. Hence the inspiration for line-detector.

There are numerous programs that can help convert files to different line ending formats:

• dos2unix
• tofrodos
• tr
• sed
• awk
• perl
• emacs
• vim

INSTALL

Install via RubyGems:

$ gem install line-detector

LICENSE

FreeBSD

DEVELOPMENT

Testing

Keep the logic working:

$ rspec

Keep the interface working:

$ cucumber

Linting

Keep the code tidy:

$ rake lint

Git Hooks

See hooks/.