Skip to content

Commit 02a1ae6

Browse files
authored
docs: add Korean README (README.ko.md) (#25)
- Create README.ko.md with full Korean translation - Add language selector to both README files
1 parent 9a691e1 commit 02a1ae6

2 files changed

Lines changed: 146 additions & 0 deletions

File tree

README.ko.md

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
# Code Please
2+
3+
[English](README.md) | 한국어
4+
5+
자동 포맷팅과 LSP 진단 기능을 갖춘 AI 코딩 지원 CLI 및 Claude Code 플러그인입니다.
6+
7+
## 주요 기능
8+
9+
- **자동 포맷팅 훅** - Claude Code 편집 후 자동으로 파일 포맷팅
10+
- **LSP 진단** - AI 코딩 세션을 위한 실시간 타입 체크 피드백
11+
- **다중 언어 지원** - TypeScript, Python, Go, Rust 등
12+
13+
## 설치
14+
15+
```bash
16+
npm install -g @pleaseai/code
17+
# 또는
18+
bun add -g @pleaseai/code
19+
```
20+
21+
## 빠른 시작
22+
23+
### Claude Code 훅 설정
24+
25+
`.claude/settings.json`에 다음을 추가하세요:
26+
27+
```json
28+
{
29+
"hooks": {
30+
"PostToolUse": [
31+
{
32+
"matcher": "Write|Edit",
33+
"hooks": [
34+
{
35+
"type": "command",
36+
"command": "npx @pleaseai/code format --stdin"
37+
},
38+
{
39+
"type": "command",
40+
"command": "npx @pleaseai/code lsp --stdin"
41+
}
42+
]
43+
}
44+
]
45+
}
46+
}
47+
```
48+
49+
또는 예제 훅 파일을 복사하세요:
50+
51+
```bash
52+
cp node_modules/@pleaseai/code/hooks/hooks.json .claude/
53+
```
54+
55+
### CLI 사용법
56+
57+
```bash
58+
# 파일 포맷팅
59+
code format src/index.ts
60+
61+
# LSP 진단 확인
62+
code lsp src/index.ts
63+
```
64+
65+
## 설정
66+
67+
프로젝트 루트에 `dora.json` 또는 `opencode.json`을 생성하세요:
68+
69+
```json
70+
{
71+
"formatter": {
72+
"biome": {
73+
"extensions": [".ts", ".tsx", ".js", ".jsx", ".json"]
74+
},
75+
"prettier": {
76+
"disabled": true
77+
},
78+
"custom": {
79+
"command": ["my-formatter", "$FILE"],
80+
"extensions": [".xyz"]
81+
}
82+
}
83+
}
84+
```
85+
86+
### 모든 포매터 비활성화
87+
88+
```json
89+
{
90+
"formatter": false
91+
}
92+
```
93+
94+
## 지원 언어
95+
96+
### LSP 진단
97+
98+
| 언어 | 서버 | 자동 감지 기준 |
99+
|-----------------------|----------------------------|----------------------------------|
100+
| TypeScript/JavaScript | typescript-language-server | package.json, bun.lock |
101+
| TypeScript/JavaScript | oxlint | .oxlintrc.json, package.json |
102+
| Deno | deno lsp | deno.json |
103+
| Python | pyright | pyproject.toml, requirements.txt |
104+
| Go | gopls | go.mod |
105+
| Rust | rust-analyzer | Cargo.toml |
106+
| Kotlin | JetBrains Kotlin LSP | build.gradle.kts, pom.xml |
107+
| Dart | dart language-server | pubspec.yaml |
108+
| Prisma | @prisma/language-server | schema.prisma |
109+
| Vue | @vue/language-server | package.json (vue 포함) |
110+
111+
### 포매터
112+
113+
biome, prettier, gofmt, mix, zig fmt, clang-format, ktlint, ruff, air (R), uv format, rubocop, standardrb, htmlbeautifier, dart, ocamlformat, terraform, latexindent, gleam, prisma
114+
115+
## MCP 서버
116+
117+
(준비 중)
118+
119+
## 환경 변수
120+
121+
| 변수 | 설명 | 기본값 |
122+
|----------------------|-------------------|--------|
123+
| `CODE_PROJECT_PATH` | 프로젝트 디렉토리 | cwd |
124+
| `CLAUDE_PROJECT_DIR` | 훅 모드에서 사용 | - |
125+
126+
## 개발
127+
128+
```bash
129+
# 의존성 설치
130+
bun install
131+
132+
# 테스트 실행
133+
bun run test
134+
135+
# 타입 체크
136+
bun run typecheck
137+
138+
# 빌드
139+
bun run build
140+
```
141+
142+
## 라이선스
143+
144+
MIT

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Code Please
22

3+
English | [한국어](README.ko.md)
4+
35
CLI and Claude Code plugin for AI-assisted coding with auto-formatting and LSP diagnostics.
46

57
## Features

0 commit comments

Comments
 (0)