Skip to content

feat: add note feature #165

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.

Sign up for GitHub

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

Merged
seokju-na merged 5 commits into from
Nov 29, 2025
Merged

feat: add note feature #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ca731db
implements note features
seokju-na Nov 28, 2025
5f54dfc
add tests
seokju-na Nov 28, 2025
35c71aa
generated files
seokju-na Nov 28, 2025
32948ba
add docs
seokju-na Nov 28, 2025
8a37e54
fix
seokju-na Nov 28, 2025
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
38 changes: 38 additions & 0 deletions docs/ko/reference/Note/Methods/author.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# author

노트 작성자를 가져와요

## 시그니처

```ts
class Note {
author(): Signature;
}
```

### 반환 값

<ul class="param-ul">
<li class="param-li param-li-root">
<span class="param-type">Signature</span>
<br>
<p class="param-description">노트 작성자 서명 정보</p>
<ul class="param-ul">
<li class="param-li">
<span class="param-name">email</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">string</span>
<br>
<p class="param-description">서명에 사용된 이메일 주소</p>
</li>
<li class="param-li">
<span class="param-name">name</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">string</span>
<br>
<p class="param-description">서명에 사용된 이름</p>
</li>
<li class="param-li">
<span class="param-name">timestamp</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">number</span>
<br>
<p class="param-description">Epoch 기준 초 단위 시간</p>
</li>
</ul>
</li>
</ul>
38 changes: 38 additions & 0 deletions docs/ko/reference/Note/Methods/committer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# committer

노트 커미터를 가져와요

## 시그니처

```ts
class Note {
committer(): Signature;
}
```

### 반환 값

<ul class="param-ul">
<li class="param-li param-li-root">
<span class="param-type">Signature</span>
<br>
<p class="param-description">노트 커미터 서명 정보예요</p>
<ul class="param-ul">
<li class="param-li">
<span class="param-name">email</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">string</span>
<br>
<p class="param-description">서명에 사용된 이메일이에요</p>
</li>
<li class="param-li">
<span class="param-name">name</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">string</span>
<br>
<p class="param-description">서명에 사용된 이름이에요</p>
</li>
<li class="param-li">
<span class="param-name">timestamp</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">number</span>
<br>
<p class="param-description">epoch 기준 초 단위 시간이에요</p>
</li>
</ul>
</li>
</ul>
21 changes: 21 additions & 0 deletions docs/ko/reference/Note/Methods/id.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# id

노트 개체의 id를 가져와요

## 시그니처

```ts
class Note {
id(): string;
}
```

### 반환 값

<ul class="param-ul">
<li class="param-li param-li-root">
<span class="param-type">string</span>
<br>
<p class="param-description">노트 개체의 id 값</p>
</li>
</ul>
31 changes: 31 additions & 0 deletions docs/ko/reference/Note/Methods/message.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# message

노트 메시지를 문자열로 가져와요.

## 시그니처

```ts
class Note {
message(): string;
}
```

### 반환 값

<ul class="param-ul">
<li class="param-li param-li-root">
<span class="param-type">string</span>
<br>
<p class="param-description">문자열인 노트 메시지</p>
</li>
</ul>

### 에러

<ul class="param-ul">
<li class="param-li param-li-root">
<span class="param-type">Error</span>
<br>
<p class="param-description">메시지가 utf-8이 아니면 오류를 던져요.</p>
</li>
</ul>
104 changes: 104 additions & 0 deletions docs/ko/reference/Repository/Methods/deleteNote.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
# deleteNote

개체에 대한 노트를 제거해요.

`notesRef` 인수는 사용할 참조의 정규 이름이에요.
기본값은 "refs/notes/commits"예요.

지정된 id는 노트를 제거할 Git 개체의 Oid예요.

## 시그니처

```ts
class Repository {
deleteNote(id: string, options?: DeleteNoteOptions | null | undefined): void;
}
```

### 파라미터

<ul class="param-ul">
<li class="param-li param-li-root">
<span class="param-name">id</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">string</span>
<br>
<p class="param-description">노트를 제거할 Git 개체의 OID예요.</p>
</li>
<li class="param-li param-li-root">
<span class="param-name">options</span><span class="param-type">null | DeleteNoteOptions</span>
<br>
<p class="param-description">노트를 삭제하기 위한 옵션이에요.</p>
<ul class="param-ul">
<li class="param-li">
<span class="param-name">author</span><span class="param-type">SignaturePayload</span>
<br>
<p class="param-description">노트 커밋 작성자의 서명이에요. 제공하지 않으면 리포지토리의 기본 서명을 사용해요. 리포지토리에 기본 서명이 설정되어 있지 않으면 오류가 발생해요.</p>
<ul class="param-ul">
<li class="param-li">
<span class="param-name">email</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">string</span>
<br>
<p class="param-description">서명에 사용되는 이메일이에요.</p>
</li>
<li class="param-li">
<span class="param-name">name</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">string</span>
<br>
<p class="param-description">서명에 사용되는 이름이에요.</p>
</li>
<li class="param-li">
<span class="param-name">timeOptions</span><span class="param-type">SignatureTimeOptions</span>
<br>
<ul class="param-ul">
<li class="param-li">
<span class="param-name">offset</span><span class="param-type">number</span>
<br>
<p class="param-description">시간대 오프셋(분 단위)이에요.</p>
</li>
<li class="param-li">
<span class="param-name">timestamp</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">number</span>
<br>
<p class="param-description">에포크 기준 초 단위 시간이에요.</p>
</li>
</ul>
</li>
</ul>
</li>
<li class="param-li">
<span class="param-name">committer</span><span class="param-type">SignaturePayload</span>
<br>
<p class="param-description">노트 커밋 커미터의 서명이에요. 제공하지 않으면 리포지토리의 기본 서명을 사용해요. 리포지토리에 기본 서명이 설정되어 있지 않으면 오류가 발생해요.</p>
<ul class="param-ul">
<li class="param-li">
<span class="param-name">email</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">string</span>
<br>
<p class="param-description">서명에 사용되는 이메일이에요.</p>
</li>
<li class="param-li">
<span class="param-name">name</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">string</span>
<br>
<p class="param-description">서명에 사용되는 이름이에요.</p>
</li>
<li class="param-li">
<span class="param-name">timeOptions</span><span class="param-type">SignatureTimeOptions</span>
<br>
<ul class="param-ul">
<li class="param-li">
<span class="param-name">offset</span><span class="param-type">number</span>
<br>
<p class="param-description">시간대 오프셋(분 단위)이에요.</p>
</li>
<li class="param-li">
<span class="param-name">timestamp</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">number</span>
<br>
<p class="param-description">에포크 기준 초 단위 시간이에요.</p>
</li>
</ul>
</li>
</ul>
</li>
<li class="param-li">
<span class="param-name">notesRef</span><span class="param-type">string</span>
<br>
<p class="param-description">사용할 참조의 정규 이름이에요. 기본값은 &quot;refs/notes/commits&quot;예요.</p>
</li>
</ul>
</li>
</ul>
46 changes: 46 additions & 0 deletions docs/ko/reference/Repository/Methods/findNote.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# findNote

개체에 대한 노트를 읽어요.

`notesRef` 인수는 사용할 기준 참조 이름이고, 기본값은 "refs/notes/commits"예요.

지정된 id는 노트를 읽을 Git 개체의 Oid예요.

## 시그니처

```ts
class Repository {
findNote(id: string, options?: FindNoteOptions | null | undefined): Note | null;
}
```

### 파라미터

<ul class="param-ul">
<li class="param-li param-li-root">
<span class="param-name">id</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">string</span>
<br>
<p class="param-description">노트를 읽을 Git 개체의 OID 값</p>
</li>
<li class="param-li param-li-root">
<span class="param-name">options</span><span class="param-type">null | FindNoteOptions</span>
<br>
<p class="param-description">노트를 찾을 때 사용할 옵션</p>
<ul class="param-ul">
<li class="param-li">
<span class="param-name">notesRef</span><span class="param-type">string</span>
<br>
</li>
</ul>
</li>
</ul>

### 반환 값

<ul class="param-ul">
<li class="param-li param-li-root">
<span class="param-type">null | Note</span>
<br>
<p class="param-description">노트 인스턴스. 존재하지 않으면 <code>null</code>을 반환하는 값</p>
</li>
</ul>
57 changes: 57 additions & 0 deletions docs/ko/reference/Repository/Methods/getNote.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# getNote

개체에 대한 노트를 읽어요.

`notesRef` 인수는 사용할 참조의 정식 이름이에요.
기본값은 "refs/notes/commits"예요.

지정된 id는 노트를 읽을 Git 개체의 Oid예요.

## 시그니처

```ts
class Repository {
getNote(id: string, options?: FindNoteOptions | null | undefined): Note;
}
```

### 파라미터

<ul class="param-ul">
<li class="param-li param-li-root">
<span class="param-name">id</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">string</span>
<br>
<p class="param-description">노트를 읽을 Git 개체의 OID예요.</p>
</li>
<li class="param-li param-li-root">
<span class="param-name">options</span><span class="param-type">null | FindNoteOptions</span>
<br>
<p class="param-description">노트를 찾기 위한 옵션이에요.</p>
<ul class="param-ul">
<li class="param-li">
<span class="param-name">notesRef</span><span class="param-type">string</span>
<br>
</li>
</ul>
</li>
</ul>

### 반환 값

<ul class="param-ul">
<li class="param-li param-li-root">
<span class="param-type">Note</span>
<br>
<p class="param-description">노트의 인스턴스예요.</p>
</li>
</ul>

### 에러

<ul class="param-ul">
<li class="param-li param-li-root">
<span class="param-type">Error</span>
<br>
<p class="param-description">노트가 존재하지 않으면 에러를 던져요.</p>
</li>
</ul>
Loading