Romajic

Build Status Coverage Status Code Climate Dependency Status Inline docs License

Automatic romaji spelling checker for programmer.

Installation

Add this line to your application's Gemfile:

gem 'romajic'

And then execute:

$ bundle

Or install it yourself as:

$ gem install romajic

Usage

Give hiragana text:

$ romajic search すし
SUSI -> sushi @ /usr/local/src/Example.java:5
sushiya -> sushi @ /usr/local/src/example.txt:2

Give romaji text:

$ romajic search sushi
SUSI -> sushi @ /usr/local/src/Example.java:5
sushiya -> sushi @ /usr/local/src/example.txt:2

Command Options

Option Description
-e/--exclude-word Word to exclude.
-c/--config Path of configuration file.
-d/--dir Path of target directory.
-E/--extensions Comma-separated target extensions.
-D/--distance Levenshtein distance.
-C/--converter Romaji converter, such as hepburn, modified_hepburn, traditional_hepburn, nihon, or kunrei.

Contributing

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

License

MIT