{"_id":"@daun_jung/korean-romanizer","_rev":"2-ed8b0e620c3e28fbeca0c9d59363026b","name":"@daun_jung/korean-romanizer","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@daun_jung/korean-romanizer","version":"1.0.0","keywords":["korean","romanization","hangul","transliteration","typescript","npm","한글","로마자","변환"],"author":{"name":"Daunjung-dev"},"license":"MIT","_id":"@daun_jung/korean-romanizer@1.0.0","maintainers":[{"name":"daun_jung","email":"daun@vendit.co.kr"}],"homepage":"https://github.com/daunjung-dev/korean-romanizer#readme","bugs":{"url":"https://github.com/daunjung-dev/korean-romanizer/issues"},"dist":{"shasum":"42863e12059501bbeb7edf0e71179b483b0a9942","tarball":"https://registry.npmjs.org/@daun_jung/korean-romanizer/-/korean-romanizer-1.0.0.tgz","fileCount":17,"integrity":"sha512-kAAivtl2bEnt52VlVqVWtYknZWZR59O6r7IJIOW96p59smyoJYdS5EqfCh8eOkVJ+I9z8CRkQt53FG4Uq8mBAQ==","signatures":[{"sig":"MEQCIE6vAONmu1VFebrJKjTnPTNbS4rDgHNESBQMHnUNV+eTAiA7NheH/vgt8Wn7O76oGiN40GpDDeww1fNw+1hcCnPrpg==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":231338},"main":"dist/index.js","types":"dist/types/index.d.ts","module":"dist/esm/index.js","engines":{"node":">=14.0.0"},"exports":{".":{"types":"./dist/types/index.d.ts","import":"./dist/esm/index.js","require":"./dist/index.js"},"./romanize":{"types":"./dist/types/index.d.ts","import":"./dist/functions/romanize.js","require":"./dist/functions/romanize.cjs"},"./romanizeWithType":{"types":"./dist/types/index.d.ts","import":"./dist/functions/romanizeWithType.js","require":"./dist/functions/romanizeWithType.cjs"},"./romanizeWithAssimilation":{"types":"./dist/types/index.d.ts","import":"./dist/functions/romanizeWithAssimilation.js","require":"./dist/functions/romanizeWithAssimilation.cjs"}},"gitHead":"e91af4debc686b24412cc8cff922f2c9bbc879f6","scripts":{"lint":"biome lint .","test":"jest","build":"npm run clean && node scripts/build.js && node scripts/types.js","check":"biome check .","clean":"rm -rf dist","format":"biome format --write .","lint:src":"biome check ./src ./scripts --write --unsafe","build:legacy":"tsc && tsc -p tsconfig.esm.json","prepublishOnly":"npm run build"},"_npmUser":{"name":"daun_jung","email":"daun@vendit.co.kr"},"repository":{"url":"git+https://github.com/daunjung-dev/korean-romanizer.git","type":"git"},"_npmVersion":"10.8.2","description":"한글 로마자 변환 라이브러리 - TypeScript 버전","directories":{},"sideEffects":false,"_nodeVersion":"18.20.8","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.5.0","esbuild":"^0.25.2","ts-jest":"^29.1.0","typescript":"^5.0.4","@types/jest":"^29.5.0","@biomejs/biome":"^1.5.3"},"_npmOperationalInternal":{"tmp":"tmp/korean-romanizer_1.0.0_1744474915219_0.532161287794555","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@daun_jung/korean-romanizer","version":"1.0.1","description":"한글 로마자 변환 라이브러리 - TypeScript 버전","main":"dist/index.js","module":"dist/esm/index.js","types":"dist/types/index.d.ts","exports":{".":{"types":"./dist/types/index.d.ts","import":"./dist/esm/index.js","require":"./dist/index.js"},"./romanize":{"types":"./dist/types/index.d.ts","import":"./dist/functions/romanize.js","require":"./dist/functions/romanize.cjs"},"./romanizeWithType":{"types":"./dist/types/index.d.ts","import":"./dist/functions/romanizeWithType.js","require":"./dist/functions/romanizeWithType.cjs"},"./romanizeWithAssimilation":{"types":"./dist/types/index.d.ts","import":"./dist/functions/romanizeWithAssimilation.js","require":"./dist/functions/romanizeWithAssimilation.cjs"}},"sideEffects":false,"scripts":{"clean":"rm -rf dist","build":"npm run clean && node scripts/build.js && node scripts/types.js","build:legacy":"tsc && tsc -p tsconfig.esm.json","test":"jest","lint":"biome lint .","lint:src":"biome check ./src ./scripts --write --unsafe","format":"biome format --write .","check":"biome check .","prepublishOnly":"npm run build"},"repository":{"type":"git","url":"git+https://github.com/daunjung-dev/korean-romanizer.git"},"keywords":["korean","romanization","hangul","transliteration","typescript","npm","한글","로마자","변환"],"author":{"name":"Daunjung-dev"},"license":"MIT","bugs":{"url":"https://github.com/daunjung-dev/korean-romanizer/issues"},"homepage":"https://github.com/daunjung-dev/korean-romanizer#readme","devDependencies":{"@biomejs/biome":"^1.5.3","@types/jest":"^29.5.0","esbuild":"^0.25.2","jest":"^29.5.0","ts-jest":"^29.1.0","typescript":"^5.0.4"},"engines":{"node":">=14.0.0"},"publishConfig":{"access":"public"},"_id":"@daun_jung/korean-romanizer@1.0.1","gitHead":"839c0f0e90dd720d2931ffbe2bc40b0ffbcbcd20","_nodeVersion":"22.10.0","_npmVersion":"10.9.0","dist":{"integrity":"sha512-V5eY5iB3kUt6u9uYcjilra9vkJ8cIdJpDYSNeaX9dle1qPPYqis+XrOn+Zf/+FsbxOLAL9WqMmkJEDwNOd+0OQ==","shasum":"d8460021eb97bd88c8cb8888d094783287e3b355","tarball":"https://registry.npmjs.org/@daun_jung/korean-romanizer/-/korean-romanizer-1.0.1.tgz","fileCount":17,"unpackedSize":231450,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQCl5GbzeI/ubRHf1hmwmMuNqneZUoQ7dKjNdEow4sqdTgIgNT8UT0uzSsTUGF12MxrVKWxjl3Pj029m1HMUAxosYVg="}]},"_npmUser":{"name":"daun_jung","email":"daun@vendit.co.kr"},"directories":{},"maintainers":[{"name":"daun_jung","email":"daun@vendit.co.kr"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/korean-romanizer_1.0.1_1744475070800_0.43653377831411166"},"_hasShrinkwrap":false}},"time":{"created":"2025-04-12T16:21:55.153Z","modified":"2025-04-12T16:24:31.204Z","1.0.0":"2025-04-12T16:21:55.420Z","1.0.1":"2025-04-12T16:24:31.013Z"},"bugs":{"url":"https://github.com/daunjung-dev/korean-romanizer/issues"},"author":{"name":"Daunjung-dev"},"license":"MIT","homepage":"https://github.com/daunjung-dev/korean-romanizer#readme","keywords":["korean","romanization","hangul","transliteration","typescript","npm","한글","로마자","변환"],"repository":{"type":"git","url":"git+https://github.com/daunjung-dev/korean-romanizer.git"},"description":"한글 로마자 변환 라이브러리 - TypeScript 버전","maintainers":[{"name":"daun_jung","email":"daun@vendit.co.kr"}],"readme":"[![Build Status](https://github.com/daunjung-dev/korean-romanizer/workflows/CI/badge.svg)](https://github.com/daunjung-dev/korean-romanizer/actions?query=workflow%3ACI)\n[![npm version](https://img.shields.io/npm/v/@daun_jung/korean-romanizer.svg)](https://www.npmjs.com/package/@daun_jung/korean-romanizer)\n[![MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)\n[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://www.typescriptlang.org/)\n\n# Korean Romanizer\n\n한글을 로마자로 변환하는 TypeScript 라이브러리입니다. 국립국어원 로마자 표기법을 기반으로 구현되었으며, 많은 부분을 커버할 수 있지만 한글의 특성상 단어 사전 데이터가 없으면 100% 구현하기 어려워 완벽하지는 않습니다.\n\n> 이 라이브러리는 [crizin/korean-romanizer](https://github.com/crizin/korean-romanizer) 자바 라이브러리를 TypeScript로 포팅한 버전입니다. 원본 자바 버전과 동일한 기능을 제공하지만, 현대적인 JavaScript/TypeScript 환경에 맞게 최적화되었습니다.\n\n## 특징\n\n- ✨ 경량화된 번들 (약 15KB)\n- 🚀 Tree-shaking 지원\n- 📦 ESM과 CommonJS 모듈 모두 지원\n- 🔄 국립국어원 로마자 표기법 준수\n- 💡 모듈, 네임스페이스, 함수 레벨 임포트 모두 지원\n\n## 설치\n\n```bash\nnpm install @daun_jung/korean-romanizer\n```\n\n## 사용 방법\n\n### 함수 직접 임포트 (권장)\n\n```typescript\n// 개별 함수 직접 임포트 - 가장 간결하고 우아한 방식\nimport {\n  romanize,\n  romanizeWithType,\n  romanizeWithAssimilation,\n} from \"@daun_jung/korean-romanizer\";\nimport { Type, ConsonantAssimilation } from \"@daun_jung/korean-romanizer\";\n\n// 기본 변환\nconsole.log(romanize(\"안녕하세요\")); // \"Annyeonghaseyo\"\n\n// 자음 동화 옵션 사용\nconsole.log(\n  romanizeWithAssimilation(\"한라산\", ConsonantAssimilation.Progressive)\n); // \"Hallasan\"\n\n// 단어 유형 옵션 사용\nconsole.log(romanizeWithType(\"김철수\", Type.Name)); // \"Kim Cheolsu\"\n```\n\n### 특정 함수만 임포트\n\n각 함수를 별도의 경로에서 가져올 수도 있습니다. 이 방식은 트리쉐이킹과 번들 사이즈 최적화에 도움이 됩니다.\n\n```typescript\n// 특정 함수만 필요할 경우\nimport romanize from \"@daun_jung/korean-romanizer/romanize\";\nimport romanizeWithType from \"@daun_jung/korean-romanizer/romanizeWithType\";\nimport romanizeWithAssimilation from \"@daun_jung/korean-romanizer/romanizeWithAssimilation\";\n\n// 타입 임포트\nimport { Type, ConsonantAssimilation } from \"@daun_jung/korean-romanizer\";\n```\n\n### 네임스페이스 사용 (기존 방식)\n\n```typescript\n// 네임스페이스 방식 (하위 호환성 유지)\nimport { KoreanRomanizer } from \"@daun_jung/korean-romanizer\";\nimport { Type, ConsonantAssimilation } from \"@daun_jung/korean-romanizer\";\n\n// 기본 변환\nconsole.log(KoreanRomanizer.romanize(\"안녕하세요\")); // \"Annyeonghaseyo\"\n\n// 자음 동화 옵션 사용\nconsole.log(\n  KoreanRomanizer.romanizeWithAssimilation(\n    \"한라산\",\n    ConsonantAssimilation.Progressive\n  )\n); // \"Hallasan\"\n\n// 단어 유형 옵션 사용\nconsole.log(KoreanRomanizer.romanizeWithType(\"김철수\", Type.Name)); // \"Kim Cheolsu\"\n```\n\n### 옵션\n\n#### 자음 동화 (ConsonantAssimilation)\n\n- `Progressive`: 순행동화\n- `Regressive`: 역행동화 (기본값)\n\n#### 단어 유형 (Type)\n\n- `Substantives`: 명사와 같은 실체언\n- `Compound`: 복합어\n- `District`: 주소, 위치\n- `Name`: 사람의 이름\n- `NameTypical`: 가장 일반적으로 사용되는 표기법을 따르는 사람의 이름\n- `Typical`: 일반 단어 (기본값)\n\n## 개발\n\n### 빌드\n\n```bash\nnpm run build\n```\n\n### 테스트\n\n```bash\nnpm test\n```\n\n## 원본 프로젝트\n\n이 라이브러리는 [@crizin](https://github.com/crizin)이 개발한 [korean-romanizer](https://github.com/crizin/korean-romanizer) 자바 라이브러리를 기반으로 합니다. 훌륭한 원본 라이브러리를 제공해 주신 crizin님께 감사드립니다.\n\n## 라이선스\n\nMIT License\n","readmeFilename":"README.md"}