Skip to content

Commit c4acdb5

Browse files
seokju-naseokju-na
authored
docs: fill missing documentations (#128)
1 parent 28f3abd commit c4acdb5

File tree

76 files changed

+4045
-47
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+4045
-47
lines changed

‎docs/gen/commands/reference.ts‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ export class ReferenceCommand extends Command {
2525
description: 'AI model for when translating documentation with OpenAI. Default model is "gpt-4o".',
2626
env: 'TRANSLATE_AI_MODEL',
2727
});
28+
readonly translateAiBaseUrl = Option.String('--translate-ai-base-url', {
29+
description: 'Base url for Open AI.',
30+
env: 'TRANSLATE_AI_BASE_URL',
31+
});
2832

2933
async execute() {
3034
const rootDir = await findRootDir();
@@ -60,7 +64,12 @@ export class ReferenceCommand extends Command {
6064
});
6165

6266
const ai =
63-
this.translateAiToken != null && this.lang !== 'en' ? new OpenAI({ apiKey: this.translateAiToken }) : null;
67+
this.translateAiToken != null && this.lang !== 'en'
68+
? new OpenAI({
69+
apiKey: this.translateAiToken,
70+
baseURL: this.translateAiBaseUrl,
71+
})
72+
: null;
6473

6574
for (let i = 0; i < references.length; i += 1) {
6675
const reference = references[i]!;

‎docs/gen/translate.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import type { Language } from './lang';
55
interface Options {
66
/** @defaultValue 'gpt-4o' */
77
model?: OpenAI.ChatModel;
8+
baseUrl?: string;
89
}
910

1011
export async function translate(

‎docs/ko/reference/Repository/Methods/addIgnoreRule.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# addIgnoreRule
2+
3+
리포지토리에 무시 규칙을 추가해요.
4+
5+
이것은 리포지토리에 무시 규칙을 추가해요. 이 규칙들은
6+
기존의 무시 규칙들(.gitignore 파일 등)과 함께 사용돼요.
7+
8+
## 시그니처
9+
10+
```ts
11+
class Repository {
12+
addIgnoreRule(rules: string): void;
13+
}
14+
```
15+
16+
### 파라미터
17+
18+
<ul class="param-ul">
19+
<li class="param-li param-li-root">
20+
<span class="param-name">rules</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">string</span>
21+
<br>
22+
<p class="param-description">추가할 규칙들, 줄바꿈으로 구분</p>
23+
</li>
24+
</ul>
25+
26+
## 예제
27+
28+
```ts
29+
import { openRepository } from 'es-git';
30+
31+
const repo = await openRepository('./path/to/repo');
32+
repo.addIgnoreRule("node_modules/");
33+
```

‎docs/ko/reference/Repository/Methods/blameFile.md‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
# blameFile
2+
3+
지정된 경로의 파일에 대한 blame 개체를 생성해요
4+
5+
## 시그니처
6+
7+
```ts
8+
class Repository {
9+
blameFile(path: string, options?: BlameOptions): Blame;
10+
}
11+
```
12+
13+
### 파라미터
14+
15+
<ul class="param-ul">
16+
<li class="param-li param-li-root">
17+
<span class="param-name">path</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">string</span>
18+
<br>
19+
<p class="param-description">blame할 파일의 경로</p>
20+
</li>
21+
<li class="param-li param-li-root">
22+
<span class="param-name">options</span><span class="param-type">null | BlameOptions</span>
23+
<br>
24+
<p class="param-description">blame 동작을 제어하는 옵션</p>
25+
<ul class="param-ul">
26+
<li class="param-li">
27+
<span class="param-name">firstParent</span><span class="param-type">boolean</span>
28+
<br>
29+
<p class="param-description">첫 번째 부모만 따라가며 도달 가능한 커밋으로 검색을 제한해요.</p>
30+
</li>
31+
<li class="param-li">
32+
<span class="param-name">ignoreWhitespace</span><span class="param-type">boolean</span>
33+
<br>
34+
<p class="param-description">공백 차이를 무시해요.</p>
35+
</li>
36+
<li class="param-li">
37+
<span class="param-name">maxLine</span><span class="param-type">number</span>
38+
<br>
39+
<p class="param-description">blame할 최대 줄 번호 (1부터 시작하는 인덱스)</p>
40+
</li>
41+
<li class="param-li">
42+
<span class="param-name">minLine</span><span class="param-type">number</span>
43+
<br>
44+
<p class="param-description">blame할 최소 줄 번호 (1부터 시작하는 인덱스)</p>
45+
</li>
46+
<li class="param-li">
47+
<span class="param-name">newestCommit</span><span class="param-type">string</span>
48+
<br>
49+
<p class="param-description">고려할 가장 최신 커밋의 oid. blame 알고리즘은 이 커밋에 도달하면 중단해요.</p>
50+
</li>
51+
<li class="param-li">
52+
<span class="param-name">oldestCommit</span><span class="param-type">string</span>
53+
<br>
54+
<p class="param-description">고려할 가장 오래된 커밋의 oid. blame 알고리즘은 이 커밋에 도달하면 중단해요.</p>
55+
</li>
56+
<li class="param-li">
57+
<span class="param-name">path</span><span class="param-type">string</span>
58+
<br>
59+
<p class="param-description">작업 중인 파일의 경로. 경로는 리포지토리 루트에 상대적이어야 해요.</p>
60+
</li>
61+
<li class="param-li">
62+
<span class="param-name">trackCopiesAnyCommitCopies</span><span class="param-type">boolean</span>
63+
<br>
64+
<p class="param-description">어떤 커밋에든 존재하는 다른 파일에서 복사된 줄을 추적해요.</p>
65+
</li>
66+
<li class="param-li">
67+
<span class="param-name">trackCopiesSameCommitCopies</span><span class="param-type">boolean</span>
68+
<br>
69+
<p class="param-description">같은 커밋에 존재하는 다른 파일에서 복사된 줄을 추적해요.</p>
70+
</li>
71+
<li class="param-li">
72+
<span class="param-name">trackCopiesSameCommitMoves</span><span class="param-type">boolean</span>
73+
<br>
74+
<p class="param-description">같은 커밋에서 파일 간에 이동한 줄을 추적해요.</p>
75+
</li>
76+
<li class="param-li">
77+
<span class="param-name">trackLinesMovement</span><span class="param-type">boolean</span>
78+
<br>
79+
<p class="param-description">파일 내에서 이동한 줄을 추적해요. 이것은 git-blame -M 옵션이에요.</p>
80+
</li>
81+
<li class="param-li">
82+
<span class="param-name">useMailmap</span><span class="param-type">boolean</span>
83+
<br>
84+
<p class="param-description">mailmap 파일을 사용하여 작성자와 커미터의 이름과 이메일 주소를 정식 실명과 이메일 주소로 매핑해요.</p>
85+
</li>
86+
</ul>
87+
</li>
88+
</ul>
89+
90+
### 반환 값
91+
92+
<ul class="param-ul">
93+
<li class="param-li param-li-root">
94+
<span class="param-type">Blame</span>
95+
<br>
96+
<p class="param-description">지정된 파일에 대한 Blame 개체</p>
97+
</li>
98+
</ul>
99+
100+
### 에러
101+
102+
<ul class="param-ul">
103+
<li class="param-li param-li-root">
104+
<span class="param-type">Error</span>
105+
<br>
106+
<p class="param-description">파일이 존재하지 않거나 열 수 없는 경우</p>
107+
</li>
108+
</ul>
109+
110+
## 예제
111+
112+
```ts
113+
// 전체 파일을 blame
114+
const blame = repo.blameFile('path/to/file.js');
115+
116+
// 한 줄만 blame
117+
const lineBlame = repo.blameFile('path/to/file.js', { minLine: 10, maxLine: 10 });
118+
119+
// 줄 범위를 blame
120+
const rangeBlame = repo.blameFile('path/to/file.js', { minLine: 5, maxLine: 15 });
121+
```

‎docs/ko/reference/Repository/Methods/checkoutHead.md‎

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
# checkoutHead
2+
3+
HEAD가 가리키는 커밋의 내용과 일치하도록 인덱스와 작업 트리의 파일을 업데이트해요.
4+
5+
## 시그니처
6+
7+
```ts
8+
class Repository {
9+
checkoutHead(options?: CheckoutOptions | undefined | null): void;
10+
}
11+
```
12+
13+
### 파라미터
14+
15+
<ul class="param-ul">
16+
<li class="param-li param-li-root">
17+
<span class="param-name">options</span><span class="param-type">null | CheckoutOptions</span>
18+
<br>
19+
<p class="param-description">체크아웃 옵션</p>
20+
<ul class="param-ul">
21+
<li class="param-li">
22+
<span class="param-name">allowConflicts</span><span class="param-type">boolean</span>
23+
<br>
24+
<p class="param-description">안전 모드에서 체크아웃을 취소하는 대신 충돌이 있어도 안전한 파일 업데이트를 적용해요. 기본값은 false예요.</p>
25+
</li>
26+
<li class="param-li">
27+
<span class="param-name">ancestorLabel</span><span class="param-type">string</span>
28+
<br>
29+
<p class="param-description">충돌의 공통 조상 쪽 이름</p>
30+
</li>
31+
<li class="param-li">
32+
<span class="param-name">conflictStyleDiff3</span><span class="param-type">boolean</span>
33+
<br>
34+
<p class="param-description">충돌에 대한 diff3 형식 파일에 공통 조상 데이터를 포함할지 나타내요. 기본값은 false예요.</p>
35+
</li>
36+
<li class="param-li">
37+
<span class="param-name">conflictStyleMerge</span><span class="param-type">boolean</span>
38+
<br>
39+
<p class="param-description">충돌에 대해 일반 병합 파일을 작성해야 하는지 나타내요. 기본값은 false예요.</p>
40+
</li>
41+
<li class="param-li">
42+
<span class="param-name">dirPerm</span><span class="param-type">number</span>
43+
<br>
44+
<p class="param-description">새 디렉토리가 생성되는 모드를 설정해요. 기본값은 0755예요.</p>
45+
</li>
46+
<li class="param-li">
47+
<span class="param-name">disableFilters</span><span class="param-type">boolean</span>
48+
<br>
49+
<p class="param-description">CRLF 변환 같은 필터를 적용할지 나타내요.</p>
50+
</li>
51+
<li class="param-li">
52+
<span class="param-name">disablePathspecMatch</span><span class="param-type">boolean</span>
53+
<br>
54+
<p class="param-description"><code>path</code>에 지정된 경로를 pathspec이 아닌 정확한 파일 경로로 처리해요.</p>
55+
</li>
56+
<li class="param-li">
57+
<span class="param-name">dryRun</span><span class="param-type">boolean</span>
58+
<br>
59+
<p class="param-description">이 체크아웃이 충돌을 확인하되 실제 변경은 하지 않는 드라이 런을 수행해야 함을 나타내요.</p>
60+
</li>
61+
<li class="param-li">
62+
<span class="param-name">filePerm</span><span class="param-type">number</span>
63+
<br>
64+
<p class="param-description">새 파일이 생성되는 모드를 설정해요. 기본값은 blob에 의해 지정된 0644 또는 0755예요.</p>
65+
</li>
66+
<li class="param-li">
67+
<span class="param-name">force</span><span class="param-type">boolean</span>
68+
<br>
69+
<p class="param-description">작업 디렉토리를 대상과 일치시키기 위해 필요한 모든 작업을 수행하며, 수정된 파일을 잠재적으로 삭제할 수 있어요.</p>
70+
</li>
71+
<li class="param-li">
72+
<span class="param-name">ourLabel</span><span class="param-type">string</span>
73+
<br>
74+
<p class="param-description">충돌의 우리 쪽 이름</p>
75+
</li>
76+
<li class="param-li">
77+
<span class="param-name">overwriteIgnored</span><span class="param-type">boolean</span>
78+
<br>
79+
<p class="param-description">체크아웃 중 무시된 파일을 덮어써야 하는지 나타내요. 기본값은 true예요.</p>
80+
</li>
81+
<li class="param-li">
82+
<span class="param-name">path</span><span class="param-type">string</span>
83+
<br>
84+
<p class="param-description">체크아웃할 경로를 추가해요. 경로는 <code>disablePathspecMatch</code>가 설정되지 않는 한 &lt;a href=&quot;https://git-scm.com/docs/gitglossary.html#Documentation/gitglossary.txt-aiddefpathspecapathspec&quot;&gt;pathspec&lt;/a&gt; 패턴이에요. 경로가 지정되지 않으면 모든 파일이 체크아웃돼요. 그렇지 않으면 지정된 경로만 체크아웃돼요.</p>
85+
</li>
86+
<li class="param-li">
87+
<span class="param-name">recreateMissing</span><span class="param-type">boolean</span>
88+
<br>
89+
<p class="param-description">안전 모드에서 존재하지 않는 파일을 생성해요. 기본값은 false예요.</p>
90+
</li>
91+
<li class="param-li">
92+
<span class="param-name">refresh</span><span class="param-type">boolean</span>
93+
<br>
94+
<p class="param-description">작업 전에 인덱스와 git 속성을 디스크에서 새로 고쳐야 하는지 나타내요. 기본값은 true예요.</p>
95+
</li>
96+
<li class="param-li">
97+
<span class="param-name">removeIgnored</span><span class="param-type">boolean</span>
98+
<br>
99+
<p class="param-description">작업 디렉토리에서 무시된 파일을 제거해요. 기본값은 false예요.</p>
100+
</li>
101+
<li class="param-li">
102+
<span class="param-name">removeUntracked</span><span class="param-type">boolean</span>
103+
<br>
104+
<p class="param-description">작업 디렉토리에서 추적되지 않는 파일을 제거해요. 기본값은 false예요.</p>
105+
</li>
106+
<li class="param-li">
107+
<span class="param-name">safe</span><span class="param-type">boolean</span>
108+
<br>
109+
<p class="param-description">체크아웃이 안전하게 수행되어야 함을 나타내며, 새 파일 생성은 허용하지만 기존 파일이나 변경 사항은 덮어쓰지 않아요. 이것이 기본값이에요.</p>
110+
</li>
111+
<li class="param-li">
112+
<span class="param-name">skipUnmerged</span><span class="param-type">boolean</span>
113+
<br>
114+
<p class="param-description">병합되지 않은 인덱스 항목이 있는 파일을 건너뛰어요. 기본값은 false예요.</p>
115+
</li>
116+
<li class="param-li">
117+
<span class="param-name">targetDir</span><span class="param-type">string</span>
118+
<br>
119+
<p class="param-description">체크아웃할 디렉토리 설정</p>
120+
</li>
121+
<li class="param-li">
122+
<span class="param-name">theirLabel</span><span class="param-type">string</span>
123+
<br>
124+
<p class="param-description">충돌의 그들 쪽 이름</p>
125+
</li>
126+
<li class="param-li">
127+
<span class="param-name">updateIndex</span><span class="param-type">boolean</span>
128+
<br>
129+
<p class="param-description">체크아웃이 업데이트된 파일 정보를 인덱스에 쓰지 못하게 해요. 기본값은 true예요.</p>
130+
</li>
131+
<li class="param-li">
132+
<span class="param-name">updateOnly</span><span class="param-type">boolean</span>
133+
<br>
134+
<p class="param-description">이미 존재하는 파일의 내용만 업데이트해요. 설정하면 파일이 생성되거나 삭제되지 않아요. 기본값은 false예요.</p>
135+
</li>
136+
<li class="param-li">
137+
<span class="param-name">useOurs</span><span class="param-type">boolean</span>
138+
<br>
139+
<p class="param-description">체크아웃이 충돌 시 파일의 스테이지 2 버전(&quot;ours&quot;)을 사용하여 진행해야 하는지 나타내요. 기본값은 false예요.</p>
140+
</li>
141+
<li class="param-li">
142+
<span class="param-name">useTheirs</span><span class="param-type">boolean</span>
143+
<br>
144+
<p class="param-description">체크아웃이 충돌 시 파일의 스테이지 3 버전(&quot;theirs&quot;)을 사용하여 진행해야 하는지 나타내요. 기본값은 false예요.</p>
145+
</li>
146+
</ul>
147+
</li>
148+
</ul>

0 commit comments

Comments
 (0)