{"_id":"@birchill/to-romaji","name":"@birchill/to-romaji","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@birchill/to-romaji","version":"1.0.0","description":"Basic kana to romaji converter","keywords":["romaji","Japanese"],"author":{"name":"Brian Birtles"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/birchill/to-romaji.git"},"publishConfig":{"registry":"https://registry.npmjs.org"},"bugs":{"url":"https://github.com/birchill/to-romaji/issues"},"type":"module","main":"./dist/index.cjs","module":"./dist/index.js","exports":{".":{"import":"./dist/index.js","require":"./dist/index.cjs"}},"lint-staged":{"*.{ts,json,md}":["prettier --write"]},"prettier":{"singleQuote":true,"trailingComma":"es5","bracketSpacing":true},"devDependencies":{"@release-it/conventional-changelog":"8.0.1","husky":"9.0.11","knip":"5.23.1","lint-staged":"15.2.7","prettier":"3.3.2","release-it":"17.4.0","tsup":"8.1.0","typescript":"5.5.2","vitest":"1.6.0","vitest-github-actions-reporter":"0.11.1"},"dependencies":{"@birchill/normal-jp":"^1.5.0"},"scripts":{"build":"tsup","test":"vitest run"},"types":"./dist/index.d.ts","homepage":"https://github.com/birchill/to-romaji#readme","_id":"@birchill/to-romaji@1.0.0","_integrity":"sha512-7XGvs4uWd0Jzggl1CbE9yN+3pOhk5mBOYLCg9xyXWEI2aRGWfMvEqtgnIg+CHoDK6IxyXRGnSft4DSwnfaZAFA==","_resolved":"/tmp/14c86ce7ac5c73d021f5cb65777d5090/birchill-to-romaji-1.0.0.tgz","_from":"file:birchill-to-romaji-1.0.0.tgz","_nodeVersion":"20.11.0","_npmVersion":"10.2.4","dist":{"integrity":"sha512-7XGvs4uWd0Jzggl1CbE9yN+3pOhk5mBOYLCg9xyXWEI2aRGWfMvEqtgnIg+CHoDK6IxyXRGnSft4DSwnfaZAFA==","shasum":"1527fcb433758ac4db9bddecc96ae1e9d29b4b2b","tarball":"https://registry.npmjs.org/@birchill/to-romaji/-/to-romaji-1.0.0.tgz","fileCount":8,"unpackedSize":43297,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCRRYP7dRdHHPHQ7hy3/+jocAJHMLlSeMkuYT/OJai7XwIgfpNnfutYPedsAWmfM+lzwFg96wL9eU2fNm+EFdu1Dgc="}]},"_npmUser":{"name":"birtles","email":"birtles@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/to-romaji_1.0.0_1719560361884_0.6495207083960486"},"_hasShrinkwrap":false}},"time":{"created":"2024-06-28T07:39:21.746Z","1.0.0":"2024-06-28T07:39:22.119Z","modified":"2024-06-28T07:39:22.397Z"},"maintainers":[{"name":"birtles","email":"birtles@gmail.com"}],"description":"Basic kana to romaji converter","homepage":"https://github.com/birchill/to-romaji#readme","keywords":["romaji","Japanese"],"repository":{"type":"git","url":"git+https://github.com/birchill/to-romaji.git"},"author":{"name":"Brian Birtles"},"bugs":{"url":"https://github.com/birchill/to-romaji/issues"},"license":"MIT","readme":"# `to-romaji`\n\nA very basic kana to modern Hepburn-like rōmaji converter.\n\ne.g. converts \"にんじゃりばんばん\" to \"ninjaribanban\".\n\n## Notes\n\n- Handles repeated っ (e.g. \"すっっっごくいい\" → \"suggggokuii\",\n  \"あつっ\" → \"atsu'\").\n- Separates a final ん from a following vowel with a hyphen (e.g.\n  かんいかきとめ → \"kan-ikakitome\").\n  Maybe we should use an apostrophe instead?\n\n- Does **not** produce macrons for long vowels (長音) since it's too hard to\n  distinguish between cases like みずうみ which should be \"mizuumi\" and\n  すうがく which should be \"sūgaku\".\n- Does **not** distinguish between は becoming \"ha\" and \"wa\".\n  We tried to do this by using\n  [`@birchill/tiny-segmenter`](https://github.com/birchill/tiny-segmenter)\n  to find 'は' particles but it turned up false positives on input like\n  \"おふろにはいる\" (which it segments as \"おふろ | に | は | いる\").\n- Does **not** convert half-width katakana.\n  [`toNormalized`](https://github.com/birchill/normal-jp/?tab=readme-ov-file#tonormalized)\n  from [`@birchill/normal-jp`](https://github.com/birchill/normal-jp/) can be\n  used as a pre-processing step to handle half-width katakana.\n\n## Installation\n\n```\nnpm install @birchill/to-romaji\n```\n\n## Usage\n\n```typescript\nimport { toRomaji } from '@birchill/to-romaji';\n\nconst romaji = toRomaji('にんじゃりばんばん');\n// romaji = 'ninjaribanban'\n```\n","readmeFilename":"README.md"}