Merge branch 'main' into dependabot/npm_and_yarn/stylelint-15.6.1

docs/lemon-core/code-of-conduct.md

@@ -0,0 +1,84 @@
+---
+layout: default
+title: Code of conduct
+parent: Use lemon-core
+nav_order: 999
+permalink: /docs/lemon-core/code-of-conduct
+---
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

docs/lemon-core/elastic-search/elastic-hangul-service.md

@@ -0,0 +1,247 @@
+---
+layout: default
+title: Hangul Service
+parent: Use ElasticSearch
+grand_parent: Use lemon-core
+nav_order: 3
+permalink: docs/lemon-core/elastic-search/hangul-service
+---
+
+# Hangul Service
+{: .no_toc }
+
+## Table of contents
+{: .no_toc .text-delta }
+
+1. TOC
+{:toc}
+
+---
+
+## Overview
+한글을 처리하기 위한 공통 서비스를 제공합니다.
+
+이 서비스는 한글을 자모 시퀀스로 변환하고, 자모를 QWERTY 키보드 입력으로 변환하는 기능 등을 포함합니다.
+
+---
+
+## Constructor
+
+HangulService의 인스턴스를 생성합니다.
+- **How to use:**
+    ```typescript
+    const hangulService = new HangulService();
+    ```
+
+---
+
+## Hello Hangul ✋
+
+### hello()
+
+`hello(): string`
+
+서비스의 인스턴스를 식별하는 문자열을 반환합니다.
+   - **Response:**
+     - `string` : `hangul-service`
+   - **How to use:**
+     ```typescript
+     const message = hangulService.hello();
+     console.log(message);  // "hangul-service"
+     ```
+
+---
+
+## Methods
+
+### isHangul()
+
+`isHangul(text: string, partial: boolean = false): boolean`
+
+주어진 텍스트가 한글인지 여부를 확인합니다.
+   - **Params:**
+     - `text: string` : 입력 텍스트
+     - `partial: boolean` : 텍스트에 한글이 하나라도 포함되어 있으면 true (default: false)
+   - **Response:**
+     - `boolean` : 한글 여부
+   - **How to use:**
+     ```typescript
+     const isHangul = hangulService.isHangul('한글');
+     console.log(isHangul);  // true
+     ```
+
+### asJamoSequence()
+
+`asJamoSequence(text: string): string`
+
+한글을 Compatibility Jamo 시퀀스로 분해합니다.
+   - **Params:**
+     - `text: string` : 입력 텍스트
+   - **Response:**
+     - `string` : 분해된 자모 시퀀스
+   - **How to use:**
+     ```typescript
+     const jamoSequence = hangulService.asJamoSequence('한글');
+     console.log(jamoSequence);  // "ㅎㅏㄴㄱㅡㄹ"
+     ```
+
+### asBasicJamoSequence()
+
+`asBasicJamoSequence(text: string): string`
+
+한글을 기본 자모 시퀀스로 분해합니다.
+   - **Params:**
+     - `text: string` : 입력 텍스트
+   - **Response:**
+     - `string` : 분해된 기본 자모 시퀀스
+   - **How to use:**
+     ```typescript
+     const basicJamoSequence = hangulService.asBasicJamoSequence('한글');
+     console.log(basicJamoSequence);  // "ㅎㅏㄴㄱㅡㄹ"
+     ```
+
+### asAlphabetKeyStokes()
+
+`asAlphabetKeyStokes(text: string): string`
+
+한글을 QWERTY 키보드 입력 시퀀스로 변환합니다.
+   - **Params:**
+     - `text: string` : 입력 텍스트
+   - **Response:**
+     - `string` : QWERTY 키보드 입력 시퀀스
+   - **How to use:**
+     ```typescript
+     const keyStrokes = hangulService.asAlphabetKeyStokes('한글');
+     console.log(keyStrokes);  // "gksrmf"
+     ```
+
+### asChoseongSequence()
+
+`asChoseongSequence(text: string): string`
+
+텍스트에서 초성만 추출합니다.
+   - **Params:**
+     - `text: string` : 입력 텍스트
+   - **Response:**
+     - `string` : 초성 시퀀스
+   - **How to use:**
+     ```typescript
+     const choseongSequence = hangulService.asChoseongSequence('한글');
+     console.log(choseongSequence);  // "ㅎㄱ"
+     ```
+
+### static isHangulChar()
+
+`static isHangulChar(code: number): boolean`
+
+주어진 코드가 한글 문자인지 확인합니다.
+   - **Params:**
+     - `code: number` : 문자 코드
+   - **Response:**
+     - `boolean` : 한글 문자 여부
+   - **How to use:**
+     ```typescript
+     const isHangulChar = HangulService.isHangulChar(0xAC00);
+     console.log(isHangulChar);  // true
+     ```
+
+### static isHangulSyllable()
+
+`static isHangulSyllable(code: number): boolean`
+
+주어진 코드가 한글 음절인지 확인합니다.
+   - **Params:**
+     - `code: number` : 문자 코드
+   - **Response:**
+     - `boolean` : 한글 음절 여부
+   - **How to use:**
+     ```typescript
+     const isHangulSyllable = HangulService.isHangulSyllable(0xAC00);
+     console.log(isHangulSyllable);  // true
+     ```
+
+### static isHangulJamo()
+
+`static isHangulJamo(code: number): boolean`
+
+주어진 코드가 한글 자모인지 확인합니다.
+   - **Params:**
+     - `code: number` : 문자 코드
+   - **Response:**
+     - `boolean` : 한글 자모 여부
+   - **How to use:**
+     ```typescript
+     const isHangulJamo = HangulService.isHangulJamo(0x1100);
+     console.log(isHangulJamo);  // true
+     ```
+
+### static isHangulCompatibilityJamo()
+
+`static isHangulCompatibilityJamo(code: number): boolean`
+
+주어진 코드가 한글 호환 자모인지 확인합니다.
+   - **Params:**
+     - `code: number` : 문자 코드
+   - **Response:**
+     - `boolean` : 한글 호환 자모 여부
+   - **How to use:**
+     ```typescript
+     const isHangulCompatibilityJamo = HangulService.isHangulCompatibilityJamo(0x3131);
+     console.log(isHangulCompatibilityJamo);  // true
+     ```
+
+---
+
+## Constants
+
+### CHOSEONG
+
+- `CHOSEONG: string[]` : 초성 자모 배열
+   - **How to use:**
+     ```typescript
+     console.log(HangulService.CHOSEONG);  // ['ㄱ', 'ㄲ', 'ㄴ', 'ㄷ', ...]
+     ```
+
+### JUNGSEONG
+
+- `JUNGSEONG: string[]` : 중성 자모 배열
+   - **How to use:**
+     ```typescript
+     console.log(HangulService.JUNGSEONG);  // ['ㅏ', 'ㅐ', 'ㅑ', 'ㅒ', ...]
+     ```
+
+### JONGSEONG
+
+- `JONGSEONG: string[]` : 종성 자모 배열
+   - **How to use:**
+     ```typescript
+     console.log(HangulService.JONGSEONG);  // ['ㄱ', 'ㄲ', 'ㄳ', 'ㄴ', ...]
+     ```
+
+---
+
+## Examples of using Hangul Service
+
+```typescript
+const hangulService = new HangulService();
+
+// Check if the text is Hangul
+const isHangul = hangulService.isHangul('한글');
+console.log(isHangul);  // true
+
+// Get Jamo sequence
+const jamoSequence = hangulService.asJamoSequence('한글');
+console.log(jamoSequence);  // "ㅎㅏㄴㄱㅡㄹ"
+
+// Get Basic Jamo sequence
+const basicJamoSequence = hangulService.asBasicJamoSequence('한글');
+console.log(basicJamoSequence);  // "ㅎㅏㄴㄱㅡㄹ"
+
+// Get QWERTY keystrokes
+const keyStrokes = hangulService.asAlphabetKeyStokes('한글');
+console.log(keyStrokes);  // "gksrmf"
+
+// Get Choseong sequence
+const choseongSequence = hangulService.asChoseongSequence('한글');
+console.log(choseongSequence);  // "ㅎㄱ"
+```