Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: 한글 문자를 쿼티 자판에 맞는 영문 알파벳으로 변환하는 함수를 새로 추가합니다. #324

Merged
merged 4 commits into from
Feb 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/dry-panthers-doubt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"es-hangul": patch
---

feat: 한글 문자를 쿼티 자판에 맞는 영문 알파벳으로 변환 하는 함수를 새로 추가합니다 합니
43 changes: 43 additions & 0 deletions docs/src/pages/docs/api/convertHangulToQwerty.en.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: convertHangulToQwerty
---

import { Sandpack } from '@/components/Sandpack';

# convertHangulToQwerty

Converts Korean characters into English alphabets corresponding to the QWERTY keyboard layout.

```typescript
function convertHangulToQwerty(word: string): string;
```

## Examples

```typescript
convertHangulToQwerty('뮻'); // 'abc'
convertHangulToQwerty('겨노'); // 'rush'
convertHangulToQwerty('님노'); // 'slash'
convertHangulToQwerty('RㅏㄱEㅜrl'); // 'RkrEnrl'
convertHangulToQwerty('ㅙㅜㅎ 햐ㅣ애ㅜㅎ'); // 'hong gildong'
convertHangulToQwerty('ㄴ대ㅕㅣ, ㅏㅐㄱㄷㅁ'); // 'seoul, korea'
```

## Demo

<br />

<Sandpack>

```ts index.ts
import { convertHangulToQwerty } from 'es-hangul';

console.log(convertHangulToQwerty('뮻'));
console.log(convertHangulToQwerty('겨노'));
console.log(convertHangulToQwerty('님노'));
console.log(convertHangulToQwerty('RㅏㄱEㅜrl'));
console.log(convertHangulToQwerty('ㅙㅜㅎ 햐ㅣ애ㅜㅎ'));
console.log(convertHangulToQwerty('ㄴ대ㅕㅣ, ㅏㅐㄱㄷㅁ'));
```

</Sandpack>
43 changes: 43 additions & 0 deletions docs/src/pages/docs/api/convertHangulToQwerty.ko.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: convertHangulToQwerty
---

import { Sandpack } from '@/components/Sandpack';

# convertHangulToQwerty

한글을 qwerty 자판과 매칭되는 영어 알파벳으로 변환합니다.

```typescript
function convertHangulToQwerty(word: string): string;
```

## Examples

```typescript
convertHangulToQwerty('뮻'); // 'abc'
convertHangulToQwerty('겨노'); // 'rush'
convertHangulToQwerty('님노'); // 'slash'
convertHangulToQwerty('RㅏㄱEㅜrl'); // 'RkrEnrl'
convertHangulToQwerty('ㅙㅜㅎ 햐ㅣ애ㅜㅎ'); // 'hong gildong'
convertHangulToQwerty('ㄴ대ㅕㅣ, ㅏㅐㄱㄷㅁ'); // 'seoul, korea'
```

## 사용해보기

<br />

<Sandpack>

```ts index.ts
import { convertHangulToQwerty } from 'es-hangul';

console.log(convertHangulToQwerty('뮻'));
console.log(convertHangulToQwerty('겨노'));
console.log(convertHangulToQwerty('님노'));
console.log(convertHangulToQwerty('RㅏㄱEㅜrl'));
console.log(convertHangulToQwerty('ㅙㅜㅎ 햐ㅣ애ㅜㅎ'));
console.log(convertHangulToQwerty('ㄴ대ㅕㅣ, ㅏㅐㄱㄷㅁ'));
```

</Sandpack>
38 changes: 38 additions & 0 deletions src/convertHangulToQwerty/constants.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
/**
* qwerty 키보드 자판의 한글 음소를 영어 알파벳으로 맵핑한 객체
*/
export const HANGUL_TO_QWERTY_KEYBOARD_MAP = {
ㄱ: 'r',
ㄲ: 'R',
ㄴ: 's',
ㄷ: 'e',
ㄸ: 'E',
ㄹ: 'f',
ㅁ: 'a',
ㅂ: 'q',
ㅃ: 'Q',
ㅅ: 't',
ㅆ: 'T',
ㅇ: 'd',
ㅈ: 'w',
ㅉ: 'W',
ㅊ: 'c',
ㅋ: 'z',
ㅌ: 'x',
ㅍ: 'v',
ㅎ: 'g',
ㅏ: 'k',
ㅐ: 'o',
ㅑ: 'i',
ㅒ: 'O',
ㅓ: 'j',
ㅔ: 'p',
ㅕ: 'u',
ㅖ: 'P',
ㅗ: 'h',
ㅛ: 'y',
ㅜ: 'n',
ㅠ: 'b',
ㅡ: 'm',
ㅣ: 'l',
} as const;
31 changes: 31 additions & 0 deletions src/convertHangulToQwerty/convertHangulToQwerty.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import { convertHangulToQwerty } from './convertHangulToQwerty';

describe('convertQwertyToHangul', () => {
it('한글을 알파벳으로 변환한다.', () => {
expect(convertHangulToQwerty('뮻')).toBe('abc');
expect(convertHangulToQwerty('겨노')).toBe('rush');
expect(convertHangulToQwerty('님노')).toBe('slash');
expect(convertHangulToQwerty('ㅙㅜㅎ 햐ㅣ애ㅜㅎ')).toBe('hong gildong');
});

it('쌍자음 및 이중모음도 그에 대응되는 영문 알파벳으로 변환한다.', () => {
expect(convertHangulToQwerty('쨰ㅉ')).toBe('WOW');
expect(convertHangulToQwerty('빠짜따까싸')).toBe('QkWkEkRkTk');
expect(convertHangulToQwerty('과궈괴귀긔')).toBe('rhkrnjrhlrnlrml');
});

it('영문, 숫자 등 한글이 아닌 글자는 그대로 유지한다.', () => {
expect(convertHangulToQwerty('FE개발!')).toBe('FEroqkf!');
expect(convertHangulToQwerty('ㄴ대ㅕㅣ, ㅏㅐㄱㄷㅁ')).toBe('seoul, korea');
});

it('한글 음소 또한 알파벳으로 변환한다.', () => {
expect(convertHangulToQwerty('ㅍㅡㄹㅗㄴㅌㅡ')).toBe('vmfhsxm');
expect(convertHangulToQwerty('RㅏㄱEㅜrl')).toBe('RkrEnrl');
expect(convertHangulToQwerty('ㅇPdml')).toBe('dPdml');
});

it('빈 문자열은 빈 문자열을 반환한다.', () => {
expect(convertHangulToQwerty('')).toBe('');
});
});
22 changes: 22 additions & 0 deletions src/convertHangulToQwerty/convertHangulToQwerty.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import { hasProperty } from '@/_internal';
import { disassemble } from '@/disassemble';
import { HANGUL_TO_QWERTY_KEYBOARD_MAP } from './constants';

/**
* @name convertHangulToQwerty
* @description
* 한글을 qwerty 자판과 매칭되는 영어 알파벳으로 변환합니다.
* @param word 영문으로 변환하고자 하는 한글
* @returns 한글을 규칙에 맞게 qwerty 자판의 영어 알파벳으로 변환한 문자열
*/
export function convertHangulToQwerty(word: string): string {
if (!word) {
return '';
}
return disassemble(word)
.split('')
.map(inputText =>
hasProperty(HANGUL_TO_QWERTY_KEYBOARD_MAP, inputText) ? HANGUL_TO_QWERTY_KEYBOARD_MAP[inputText] : inputText
)
.join('');
}
1 change: 1 addition & 0 deletions src/convertHangulToQwerty/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from './convertHangulToQwerty';
1 change: 1 addition & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export { canBeJongseong } from './canBeJongseong';
export { canBeJungseong } from './canBeJungseong';
export { combineCharacter } from './combineCharacter';
export { combineVowels } from './combineVowels';
export { convertHangulToQwerty } from './convertHangulToQwerty';
export { convertQwertyToAlphabet } from './convertQwertyToAlphabet';
export { convertQwertyToHangul } from './convertQwertyToHangul';
export { days } from './days';
Expand Down