{"id":20851655,"url":"https://github.com/emsk/romajic","last_synced_at":"2025-10-18T16:25:39.497Z","repository":{"id":56892620,"uuid":"51682992","full_name":"emsk/romajic","owner":"emsk","description":"Automatic romaji spelling checker for programmer.","archived":false,"fork":false,"pushed_at":"2021-06-17T13:23:52.000Z","size":121,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-12T12:42:32.277Z","etag":null,"topics":["cli","gem","japanese","romaji","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/emsk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-02-14T06:33:52.000Z","updated_at":"2021-06-17T13:23:55.000Z","dependencies_parsed_at":"2022-08-21T01:20:49.076Z","dependency_job_id":null,"html_url":"https://github.com/emsk/romajic","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/emsk/romajic","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emsk%2Fromajic","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emsk%2Fromajic/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emsk%2Fromajic/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emsk%2Fromajic/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/emsk","download_url":"https://codeload.github.com/emsk/romajic/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emsk%2Fromajic/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262364839,"owners_count":23299654,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","gem","japanese","romaji","ruby"],"created_at":"2024-11-18T03:14:28.522Z","updated_at":"2025-10-18T16:25:34.447Z","avatar_url":"https://github.com/emsk.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Romajic\n\n[![Gem Version](https://badge.fury.io/rb/romajic.svg)](https://badge.fury.io/rb/romajic)\n[![Build Status](https://github.com/emsk/romajic/actions/workflows/build.yml/badge.svg)](https://github.com/emsk/romajic/actions/workflows/build.yml)\n[![Build Status](https://travis-ci.org/emsk/romajic.svg?branch=main)](https://travis-ci.org/emsk/romajic)\n[![Build status](https://ci.appveyor.com/api/projects/status/hmralky8g9v146qq?svg=true)](https://ci.appveyor.com/project/emsk/romajic)\n[![Build Status](https://dev.azure.com/emsk/romajic/_apis/build/status/emsk.romajic?branchName=main)](https://dev.azure.com/emsk/romajic/_build/latest?definitionId=4\u0026branchName=main)\n[![Codecov](https://codecov.io/gh/emsk/romajic/branch/main/graph/badge.svg)](https://codecov.io/gh/emsk/romajic)\n[![Code Climate](https://codeclimate.com/github/emsk/romajic/badges/gpa.svg)](https://codeclimate.com/github/emsk/romajic)\n[![Inline docs](http://inch-ci.org/github/emsk/romajic.svg?branch=main)](http://inch-ci.org/github/emsk/romajic)\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.txt)\n\nAutomatic romaji spelling checker for programmer.\n\nhttp://qiita.com/emsk/items/3e24628c220c825da709 (Japanese)\n\n## Prerequisite\n\nYou have to install Ruby 2.0.0 or higher.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'romajic'\n```\n\nAnd then execute:\n\n```sh\n$ bundle\n```\n\nOr install it yourself as:\n\n```sh\n$ gem install romajic\n```\n\n## Usage\n\nSearch by hiragana text:\n\n```sh\n$ romajic search すし\nSUSI -\u003e sushi @ /usr/local/src/Example.java:5\nsushiya -\u003e sushi @ /usr/local/src/example.txt:2\n```\n\nSearch by romaji text:\n\n```sh\n$ romajic search sushi\nSUSI -\u003e sushi @ /usr/local/src/Example.java:5\nsushiya -\u003e sushi @ /usr/local/src/example.txt:2\n```\n\nGenerate a configuration file:\n\n```sh\n$ romajic --init\n```\n\n## Command Options\n\n| Option | Description | Default |\n| :----- | :---------- | :------ |\n| `-e/--exclude-word` | Word to exclude. | |\n| `-c/--config` | Path of configuration file. | `.romajic.yml` in the working directory |\n| `-d/--dir` | Path of target directory. | The working directory |\n| `-E/--extensions` | Comma-separated target extensions. | All extensions |\n| `-D/--distance` | Levenshtein distance. | `3` |\n| `-C/--converter` | Romaji converter, such as `hepburn`, `modified_hepburn`, `traditional_hepburn`, `nihon`, or `kunrei`. | `hepburn` |\n\n## Configurations\n\nThe keys below are available in the configuration file.\n\n| Key | Description | Type |\n| :-- | :---------- | :--- |\n| `target_words` | Target romaji. | Array |\n| `exclude_words` | Words to exclude. | Array |\n| `dir` | Path of target directory. | String |\n| `extensions` | Target extensions. | Array |\n| `distance` | Levenshtein distance. | Integer |\n| `converter` | Romaji converter. | String |\n\n## Documentation\n\nhttp://www.rubydoc.info/gems/romajic\n\n## Supported Ruby Versions\n\nRuby 2.0.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 3.0\n\n## Contributing\n\n1. Fork it ( https://github.com/emsk/romajic/fork )\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create a new Pull Request\n\n## Related\n\n* [romajify](https://github.com/emsk/romajify) - Japanese romanization library for Ruby\n\n## License\n\n[MIT](LICENSE.txt)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femsk%2Fromajic","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femsk%2Fromajic","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femsk%2Fromajic/lists"}