docs(repository): add missing documentations for repository (#58)

seokju-na · web-flow · commit c88be6bdfcad · 2025-03-17T21:54:28.000+09:00
diff --git a/docs/ko/reference/Repository/Methods/head.md b/docs/ko/reference/Repository/Methods/head.md
@@ -0,0 +1,23 @@
+# head
+
+`HEAD`가 가리키는 레퍼런스를 가져와요.
+
+## 시그니처
+
+```ts
+class Repository {
+  head(): Reference;
+}
+```
+
+### 반환 값
+
+<ul class="param-ul">
+  <li class="param-li param-li-root">
+    <span class="param-type">레퍼런스</span>
+    <br>
+    <p class="param-description">
+      <code>HEAD</code>가 가리키는 레퍼런스를 반환해요.
+    </p>
+  </li>
+</ul>
diff --git a/docs/ko/reference/Repository/Methods/isBare.md b/docs/ko/reference/Repository/Methods/isBare.md
@@ -0,0 +1,21 @@
+# isBare
+
+이 리포지토리가 `bare` 리포지토리인지 확인해요.
+
+## 시그니처
+
+```ts
+class Repository {
+  isBare(): boolean;
+}
+```
+
+### 반환 값
+
+<ul class="param-ul">
+  <li class="param-li param-li-root">
+    <span class="param-type">boolean</span>
+    <br>
+    <p class="param-description">리포지토리가 <code>bare</code> 리포지토리이면 <code>true</code>를 반환해요.</p>
+  </li>
+</ul>
diff --git a/docs/ko/reference/Repository/Methods/isEmpty.md b/docs/ko/reference/Repository/Methods/isEmpty.md
@@ -0,0 +1,21 @@
+# isEmpty
+
+이 리포지토리가 비어 있는지 확인해요.
+
+## 시그니처
+
+```ts
+class Repository {
+  isEmpty(): boolean;
+}
+```
+
+### 반환 값
+
+<ul class="param-ul">
+  <li class="param-li param-li-root">
+    <span class="param-type">boolean</span>
+    <br>
+    <p class="param-description">리포지토리가 비어 있으면 <code>true</code>를 반환해요.</p>
+  </li>
+</ul>
diff --git a/docs/ko/reference/Repository/Methods/isShallow.md b/docs/ko/reference/Repository/Methods/isShallow.md
@@ -0,0 +1,21 @@
+# isShallow
+
+이 리포지토리가 얕은 클론(shallow clone)인지 확인해요.
+
+## 시그니처
+
+```ts
+class Repository {
+  isShallow(): boolean;
+}
+```
+
+### 반환 값
+
+<ul class="param-ul">
+  <li class="param-li param-li-root">
+    <span class="param-type">boolean</span>
+    <br>
+    <p class="param-description">리포지토리가 얕은 클론이면 <code>true</code>를 반환해요.</p>
+  </li>
+</ul>
diff --git a/docs/ko/reference/Repository/Methods/isWorktree.md b/docs/ko/reference/Repository/Methods/isWorktree.md
@@ -0,0 +1,21 @@
+# isWorktree
+
+이 리포지토리가 작업 트리(worktree)인지 확인해요.
+
+## 시그니처
+
+```ts
+class Repository {
+  isWorktree(): boolean;
+}
+```
+
+### 반환 값
+
+<ul class="param-ul">
+  <li class="param-li param-li-root">
+    <span class="param-type">boolean</span>
+    <br>
+    <p class="param-description">리포지토리가 작업 트리이면 <code>true</code>를 반환해요.</p>
+  </li>
+</ul>
diff --git a/docs/ko/reference/Repository/Methods/path.md b/docs/ko/reference/Repository/Methods/path.md
@@ -0,0 +1,21 @@
+# path
+
+일반 리포지토리의 경우 `.git` 폴더의 경로를 반환하고, `bare` 리포지토리의 경우 리포지토리 자체의 경로를 반환해요.
+
+## 시그니처
+
+```ts
+class Repository {
+  path(): string;
+}
+```
+
+### 반환 값
+
+<ul class="param-ul">
+  <li class="param-li param-li-root">
+    <span class="param-type">string</span>
+    <br>
+    <p class="param-description">일반 리포지토리의 경우 <code>.git</code> 폴더의 경로를 반환하고, <code>bare</code> 리포지토리의 경우 리포지토리 자체의 경로를 반환해요.</p>
+  </li>
+</ul>
diff --git a/docs/ko/reference/Repository/Methods/setHead.md b/docs/ko/reference/Repository/Methods/setHead.md
@@ -0,0 +1,28 @@
+# setHead
+
+리포지토리의 `HEAD`를 지정된 레퍼런스로 변경해요.
+
+- 지정된 레퍼런스가 트리(tree)나 블롭(blob)을 가리키면 `HEAD`는 변경되지 않고, 에러가 발생해요.
+- 지정된 레퍼런스가 브랜치를 가리키면 `HEAD`는 해당 브랜치를 가리키게 돼요.
+    - 이미 브랜치에 연결된 상태라면 그대로 유지돼요.
+    - 기존에 연결되지 않은 상태였다면 연결돼요.
+    - 브랜치가 아직 존재하지 않아도 에러가 발생하지 않으며, `HEAD`는 생성되지 않은 브랜치를 가리키게 돼요.
+- 위 조건에 해당하지 않으면 `HEAD`는 분리 상태가 되어 특정 커밋을 직접 가리켜요.
+
+## 시그니처
+
+```ts
+class Repository {
+  setHead(refname: string): void;
+}
+```
+
+### 파라미터
+
+<ul class="param-ul">
+  <li class="param-li param-li-root">
+    <span class="param-name">refname</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">string</span>
+    <br>
+    <p class="param-description"><code>HEAD</code>가 가리킬 레퍼런스를 지정해요.</p>
+  </li>
+</ul>
diff --git a/docs/ko/reference/Repository/Methods/state.md b/docs/ko/reference/Repository/Methods/state.md
@@ -0,0 +1,25 @@
+# state
+
+현재 리포지토리의 상태를 반환해요.
+
+## 시그니처
+
+```ts
+class Repository {
+  state(): RepositoryState;
+}
+```
+
+### 반환 값
+
+<ul class="param-ul">
+  <li class="param-li param-li-root">
+    <span class="param-type">RepositoryState</span>
+    <br>
+    <p class="param-description">현재 리포지토리의 상태를 반환해요.</p>
+    <p class="param-description">사용 가능한 상태는 다음과 같아요:
+      <code>Clean</code>, <code>Merge</code>, <code>Revert</code>, <code>RevertSequence</code>, <code>CherryPick</code>,<br>
+      <code>CherryPickSequence</code>, <code>Bisect</code>, <code>Rebase</code>, <code>RebaseInteractive</code>, <code>RebaseMerge</code>,<br>
+      <code>ApplyMailbox</code>, <code>ApplyMailboxOrRebase</code>.</p>
+  </li>
+</ul>
diff --git a/docs/ko/reference/Repository/Methods/workdir.md b/docs/ko/reference/Repository/Methods/workdir.md
@@ -0,0 +1,21 @@
+# workdir
+
+현재 리포지토리의 작업 디렉터리 경로를 가져와요.
+
+## 시그니처
+
+```ts
+class Repository {
+  workdir(): string | null;
+}
+```
+
+### 반환 값
+
+<ul class="param-ul">
+  <li class="param-li param-li-root">
+    <span class="param-type">null | string</span>
+    <br>
+    <p class="param-description">리포지토리의 작업 디렉터리 경로를 반환해요. <code>bare</code> 리포지토리인 경우 <code>null</code>을 반환해요.</p>
+  </li>
+</ul>
diff --git a/docs/reference/Repository/Methods/head.md b/docs/reference/Repository/Methods/head.md
@@ -0,0 +1,21 @@
+# head
+
+Retrieve and resolve the reference pointed at by `HEAD`.
+
+## Signature
+
+```ts
+class Repository {
+  head(): Reference;
+}
+```
+
+### Returns
+
+<ul class="param-ul">
+  <li class="param-li param-li-root">
+    <span class="param-type">Reference</span>
+    <br>
+    <p class="param-description">Reference pointed at by  <code>HEAD</code> .</p>
+  </li>
+</ul>
diff --git a/docs/reference/Repository/Methods/isBare.md b/docs/reference/Repository/Methods/isBare.md
@@ -0,0 +1,21 @@
+# isBare
+
+Tests whether this repository is a bare repository or not.
+
+## Signature
+
+```ts
+class Repository {
+  isBare(): boolean;
+}
+```
+
+### Returns
+
+<ul class="param-ul">
+  <li class="param-li param-li-root">
+    <span class="param-type">boolean</span>
+    <br>
+    <p class="param-description">Returns  <code>true</code>  if repository is a bare.</p>
+  </li>
+</ul>
diff --git a/docs/reference/Repository/Methods/isEmpty.md b/docs/reference/Repository/Methods/isEmpty.md
@@ -0,0 +1,21 @@
+# isEmpty
+
+Tests whether this repository is empty.
+
+## Signature
+
+```ts
+class Repository {
+  isEmpty(): boolean;
+}
+```
+
+### Returns
+
+<ul class="param-ul">
+  <li class="param-li param-li-root">
+    <span class="param-type">boolean</span>
+    <br>
+    <p class="param-description">Returns  <code>true</code>  if repository is empty.</p>
+  </li>
+</ul>
diff --git a/docs/reference/Repository/Methods/isShallow.md b/docs/reference/Repository/Methods/isShallow.md
@@ -0,0 +1,21 @@
+# isShallow
+
+Tests whether this repository is a shallow clone.
+
+## Signature
+
+```ts
+class Repository {
+  isShallow(): boolean;
+}
+```
+
+### Returns
+
+<ul class="param-ul">
+  <li class="param-li param-li-root">
+    <span class="param-type">boolean</span>
+    <br>
+    <p class="param-description">Returns  <code>true</code>  if repository is a shallow clone.</p>
+  </li>
+</ul>
diff --git a/docs/reference/Repository/Methods/isWorktree.md b/docs/reference/Repository/Methods/isWorktree.md
@@ -0,0 +1,21 @@
+# isWorktree
+
+Tests whether this repository is a worktree.
+
+## Signature
+
+```ts
+class Repository {
+  isWorktree(): boolean;
+}
+```
+
+### Returns
+
+<ul class="param-ul">
+  <li class="param-li param-li-root">
+    <span class="param-type">boolean</span>
+    <br>
+    <p class="param-description">Returns  <code>true</code>  if repository is a worktree.</p>
+  </li>
+</ul>
diff --git a/docs/reference/Repository/Methods/path.md b/docs/reference/Repository/Methods/path.md
@@ -0,0 +1,22 @@
+# path
+
+Returns the path to the `.git` folder for normal repositories or the
+repository itself for bare repositories.
+
+## Signature
+
+```ts
+class Repository {
+  path(): string;
+}
+```
+
+### Returns
+
+<ul class="param-ul">
+  <li class="param-li param-li-root">
+    <span class="param-type">string</span>
+    <br>
+    <p class="param-description">The path to the  <code>.git</code>  folder for normal repositories or the repository itself<br>for bare repositories.</p>
+  </li>
+</ul>
diff --git a/docs/reference/Repository/Methods/setHead.md b/docs/reference/Repository/Methods/setHead.md
@@ -0,0 +1,32 @@
+# setHead
+
+Make the repository `HEAD` point to the specified reference.
+
+If the provided reference points to a tree or a blob, the `HEAD` is
+unaltered and an error is returned.
+
+If the provided reference points to a branch, the `HEAD` will point to
+that branch, staying attached, or become attached if it isn't yet. If
+the branch doesn't exist yet, no error will be returned. The `HEAD` will
+then be attached to an unborn branch.
+
+Otherwise, the `HEAD` will be detached and will directly point to the
+commit.
+
+## Signature
+
+```ts
+class Repository {
+  setHead(refname: string): void;
+}
+```
+
+### Parameters
+
+<ul class="param-ul">
+  <li class="param-li param-li-root">
+    <span class="param-name">refname</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">string</span>
+    <br>
+    <p class="param-description">Specified reference to point into <code>HEAD</code>.</p>
+  </li>
+</ul>
diff --git a/docs/reference/Repository/Methods/state.md b/docs/reference/Repository/Methods/state.md
diff --git a/docs/reference/Repository/Methods/workdir.md b/docs/reference/Repository/Methods/workdir.md
diff --git a/index.d.ts b/index.d.ts
diff --git a/src/repository.rs b/src/repository.rs
