Skip to content

Commit c1c5856

Browse files
committed
docs: add Korean README and cross-link with English version
Add README.ko.md as the Korean counterpart and wire up language switcher links between the two. Also surface the docs site URL and the missing @pleaseai/prettier-config entry in the Packages table.
1 parent c845592 commit c1c5856

2 files changed

Lines changed: 78 additions & 0 deletions

File tree

README.ko.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# @pleaseai/code-style
2+
3+
[English](./README.md) | 한국어
4+
5+
PleaseAI 프로젝트를 위한 공유 코드 스타일 설정 모노레포 — 외주, 오픈소스, 사내 프로젝트 모두에서 사용합니다.
6+
7+
문서: <https://code-style.pages.dev>
8+
9+
## 패키지
10+
11+
| 패키지 | 설명 |
12+
|--------|------|
13+
| [`@pleaseai/eslint-config`](./packages/eslint-config) | PleaseAI 기본값이 적용된 `@antfu/eslint-config` 래퍼 ESLint flat config |
14+
| [`@pleaseai/prettier-config`](./packages/perttier-config) | 공유 Prettier 설정 (JSON) |
15+
| [`@pleaseai/editorconfig`](./packages/editorconfig) | 일관된 에디터 설정을 위한 공유 `.editorconfig` |
16+
17+
## `@pleaseai/eslint-config`
18+
19+
### 설치
20+
21+
```sh
22+
bun add -D @pleaseai/eslint-config eslint
23+
```
24+
25+
### 사용법
26+
27+
```ts
28+
// eslint.config.ts
29+
import pleaseai from '@pleaseai/eslint-config'
30+
31+
export default pleaseai()
32+
```
33+
34+
커스텀 오버라이드:
35+
36+
```ts
37+
import pleaseai from '@pleaseai/eslint-config'
38+
39+
export default pleaseai(
40+
{
41+
// 기본값 오버라이드 (typescript, stylistic, gitignore는 이미 설정되어 있음)
42+
vue: true,
43+
},
44+
// 추가 flat config 엔트리
45+
{
46+
rules: {
47+
'no-console': 'warn',
48+
},
49+
},
50+
)
51+
```
52+
53+
### 기본값
54+
55+
- `stylistic`: `indent: 2`, `quotes: 'single'`, `semi: false`
56+
- `typescript: true`
57+
- `gitignore: true`
58+
59+
## 개발
60+
61+
```sh
62+
bun install
63+
bun run build # Turborepo를 통해 전체 패키지 빌드
64+
bun run lint # 저장소 자체를 린트 (dogfooding)
65+
```
66+
67+
### 릴리즈
68+
69+
```sh
70+
bun run changeset # changeset 생성
71+
bun run version # 버전 업데이트
72+
bun run release # 빌드 후 npm 배포
73+
```

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
11
# @pleaseai/code-style
22

3+
English | [한국어](./README.ko.md)
4+
35
A monorepo providing shared code style configurations for PleaseAI projects — for outsourcing, open source, and internal use.
46

7+
Documentation: <https://code-style.pages.dev>
8+
59
## Packages
610

711
| Package | Description |
812
|---------|-------------|
913
| [`@pleaseai/eslint-config`](./packages/eslint-config) | ESLint flat config wrapping `@antfu/eslint-config` with PleaseAI defaults |
14+
| [`@pleaseai/prettier-config`](./packages/perttier-config) | Shared Prettier config (JSON) |
1015
| [`@pleaseai/editorconfig`](./packages/editorconfig) | Shared `.editorconfig` for consistent editor settings |
1116

1217
## `@pleaseai/eslint-config`

0 commit comments

Comments
 (0)