@intlayer/docs 8.12.4 → 9.0.0-canary.2

package/docs/ko/cli/debug.md

@@ -13,6 +13,7 @@ slugs:
   - concept
   - cli
   - debug
+author: aymericzip
 ---
 
 # Intlayer 명령어 디버깅

package/docs/ko/cli/doc-review.md

@@ -1,6 +1,6 @@
 ---
 createdAt: 2024-08-11
-updatedAt: 2025-11-22
+updatedAt: 2026-06-17
 title: 문서 검토
 description: 다양한 로케일에서 문서 파일의 품질, 일관성 및 완전성을 검토하는 방법을 알아보세요.
 keywords:
@@ -15,6 +15,11 @@ slugs:
   - concept
   - cli
   - doc-review
+history:
+  - version: 9.0.0
+    date: 2026-06-17
+    changes: "--log 옵션 추가"
+author: aymericzip
 ---
 
 # 문서 검토
@@ -54,8 +59,110 @@ bun x intlayer doc review
 
 ## 인수:
 
-`doc review` 명령어는 `doc translate`와 동일한 인수를 받아 특정 문서 파일을 검토하고 품질 검사를 적용할 수 있습니다.
+**파일 목록 옵션:**
 
-git 옵션 중 하나를 활성화한 경우, 명령어는 변경된 파일 부분만 검토합니다. 스크립트는 파일을 청크 단위로 처리하고 각 청크를 검토합니다. 청크에 변경 사항이 없으면 검토 프로세스를 가속화하고 AI 제공자 API 비용을 제한하기 위해 해당 청크를 건너뜁니다.
+- **`--doc-pattern [docPattern...]`**: 검토할 문서 파일과 일치하는 Glob 패턴입니다.
 
-전체 인수 목록은 [문서 번역](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ko/cli/doc-translate.md) 명령어 문서를 참조하세요.
+  > 예시: `npx intlayer doc review --doc-pattern "docs/**/*.md" "src/**/*.mdx"`
+
+- **`--excluded-glob-pattern [excludedGlobPattern...]`**: 검토에서 제외할 Glob 패턴입니다.
+
+  > 예시: `npx intlayer doc review --excluded-glob-pattern "docs/internal/**"`
+
+- **`--skip-if-modified-before [skipIfModifiedBefore]`**: 지정된 시간 이전에 수정된 파일은 건너뜁니다.
+  - "2025-12-05"와 같은 절대 시간 (문자열 또는 Date)일 수 있습니다.
+  - `1 * 60 * 60 * 1000` (1시간)과 같은 상대 시간(ms)일 수 있습니다.
+  - 이 옵션은 `fs.stat` 메서드를 사용하여 파일의 수정 시간을 확인합니다. 따라서 Git이나 파일을 수정하는 다른 도구의 영향을 받을 수 있습니다.
+
+  > 예시: `npx intlayer doc review --skip-if-modified-before "2025-12-05"`
+
+- **`--skip-if-modified-after [skipIfModifiedAfter]`**: 지정된 시간 이내에 수정된 파일은 건너뜁니다.
+  - "2025-12-05"와 같은 절대 시간(문자열 또는 Date)일 수 있습니다.
+  - `1 * 60 * 60 * 1000` (1시간)과 같은 상대 시간(ms)일 수 있습니다.
+  - 이 옵션은 `fs.stat` 메서드를 사용하여 파일의 수정 시간을 확인합니다. 따라서 Git이나 파일을 수정하는 다른 도구의 영향을 받을 수 있습니다.
+
+  > 예시: `npx intlayer doc review --skip-if-modified-after "2025-12-05"`
+
+- **`--skip-if-exists`**: 파일이 이미 존재하면 건너뜁니다.
+
+  > 예시: `npx intlayer doc review --skip-if-exists`
+
+**검토 모드 옵션:**
+
+- **`--log`**: 로그 전용 모드. AI로 번역하지 않고, 대신 다른 에이전트가 번역을 생성할 수 있도록 기본 및 대상 로케일에 대해 주의가 필요한 블록(줄 번호 및 내용 포함)을 기록합니다.
+
+  > 예시: `npx intlayer doc review --log`
+
+**출력 옵션:**
+
+- **`--locales [locales...]`**: 문서를 검토할 대상 로케일입니다.
+
+  > 예시: `npx intlayer doc review --locales fr es de`
+
+- **`--base-locale [baseLocale]`**: 비교할 원본 로케일(기본 문서)입니다.
+
+  > 예시: `npx intlayer doc review --base-locale en`
+
+**파일 처리 옵션:**
+
+- **`--nb-simultaneous-file-processed [nbSimultaneousFileProcessed]`**: 동시에 검토할 파일 수입니다.
+
+  > 예시: `npx intlayer doc review --nb-simultaneous-file-processed 5`
+
+**AI 옵션:**
+
+- **`--model [model]`**: 검토에 사용할 AI 모델 (예: `gpt-3.5-turbo`).
+- **`--provider [provider]`**: 검토에 사용할 AI 제공자.
+- **`--temperature [temperature]`**: AI 모델의 온도 설정.
+- **`--api-key [apiKey]`**: AI 서비스에 사용할 API 키를 제공합니다.
+- **`--application-context [applicationContext]`**: AI 검토에 추가 컨텍스트를 제공합니다.
+- **`--data-serialization [dataSerialization]`**: Intlayer의 AI 기능에 사용할 데이터 직렬화 형식. 옵션: `json` (표준, 신뢰할 수 있음), `toon` (토큰 적음, 일관성 낮음).
+- **`--custom-prompt [prompt]`**: 검토에 사용되는 기본 프롬프트를 사용자 정의합니다. (참고: 대부분의 사용 사례에서는 동작을 더 잘 제어할 수 있는 `--custom-instructions` 옵션을 사용하는 것이 권장됩니다.)
+
+  > 예시: `npx intlayer doc review --model deepseek-chat --provider deepseek --temperature 0.5 --api-key sk-1234567890 --application-context "My application is a cat store"`
+
+**환경 변수 옵션:**
+
+- **`--env`**: 환경을 지정합니다 (예: `development`, `production`).
+- **`--env-file [envFile]`**: 변수를 로드할 사용자 정의 환경 파일을 제공합니다.
+- **`--base-dir`**: 프로젝트의 기본 디렉토리를 지정합니다.
+- **`--no-cache`**: 캐시를 비활성화합니다.
+
+  > 예시: `npx intlayer doc review --base-dir ./docs --env-file .env.production.local`
+
+**로그 옵션:**
+
+- **`--verbose`**: 디버깅을 위한 상세 로그 활성화. (CLI에서 기본값은 true)
+
+  > 예시: `npx intlayer doc review --verbose`
+
+**사용자 지정 지침 옵션:**
+
+- **`--custom-instructions [customInstructions]`**: 프롬프트에 추가되는 사용자 지정 지침. 포맷팅, URL 번역 등 특정 규칙을 적용할 때 유용합니다.
+
+  > 예시: `npx intlayer doc review --custom-instructions "URL 번역을 피하고, 마크다운 형식을 유지하세요"`
+
+  > 예시: `npx intlayer doc review --custom-instructions "$(cat ./instructions.md)"`
+
+**Git 옵션:**
+
+- **`--git-diff`**: 기준(기본값 `origin/main`)에서 현재 브랜치(기본값 `HEAD`)로 변경된 파일만 실행합니다.
+- **`--git-diff-base`**: git diff의 기준 참조를 지정합니다 (기본값 `origin/main`).
+- **`--git-diff-current`**: git diff의 현재 참조를 지정합니다 (기본값 `HEAD`).
+- **`--uncommitted`**: 커밋되지 않은 변경사항을 포함합니다.
+- **`--unpushed`**: 푸시되지 않은 변경사항을 포함합니다.
+- **`--untracked`**: 추적되지 않은 파일을 포함합니다.
+
+  > 예시: `npx intlayer doc review --git-diff --git-diff-base origin/main --git-diff-current HEAD`
+
+  > 예시: `npx intlayer doc review --uncommitted --unpushed --untracked`
+
+> 출력 파일 경로는 다음 패턴을 대체하여 결정됩니다:
+>
+> - `/{{baseLocale}}/` 는 `/{{locale}}/` 로 대체 (Unix)
+> - `\{{baseLocale}}\` 는 `\{{locale}}\` 로 대체 (Windows)
+> - `_{{baseLocale}}.` 는 `_{{locale}}.` 로 대체
+> - `{{baseLocale}}_` 는 `{{locale}}_` 로 대체
+> - `.{{baseLocaleName}}.` 는 `.{{localeName}}.` 로 대체
+>
+> 만약 패턴이 발견되지 않으면, 출력 파일은 파일 확장자에 `.{{locale}}` 를 추가합니다. 예를 들어 `./my/file.md` 는 검토되고, 프랑스어 로케일의 경우 `./my/file.fr.md` 로 업데이트됩니다.

package/docs/ko/cli/doc-translate.md

@@ -15,6 +15,7 @@ slugs:
   - concept
   - cli
   - doc-translate
+author: aymericzip
 ---
 
 # 문서 번역

package/docs/ko/cli/editor.md

@@ -13,6 +13,7 @@ slugs:
   - concept
   - cli
   - editor
+author: aymericzip
 ---
 
 # 에디터 명령어

package/docs/ko/cli/extract.md

@@ -14,6 +14,7 @@ slugs:
   - concept
   - cli
   - extract
+author: aymericzip
 ---
 
 # 문자열 추출

package/docs/ko/cli/fill.md

@@ -16,6 +16,7 @@ slugs:
   - concept
   - cli
   - fill
+author: aymericzip
 ---
 
 # 사전 채우기 / 감사 / 번역

package/docs/ko/cli/index.md

@@ -17,6 +17,9 @@ slugs:
   - concept
   - cli
 history:
+  - version: 9.0.0
+    date: 2026-06-11
+    changes: "scan 명령어 추가"
   - version: 8.6.4
     date: 2026-03-31
     changes: "standalone 명령어 추가"
@@ -62,6 +65,7 @@ history:
   - version: 5.5.10
     date: 2025-06-29
     changes: "기록 초기화"
+author: aymericzip
 ---
 
 # Intlayer CLI - 다국어 웹사이트를 위한 모든 Intlayer CLI 명령어
@@ -162,6 +166,10 @@ Intlayer는 여러 설정 파일 형식을 허용합니다:
 
 - **[CI 명령어](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ko/cli/ci.md)** - CI/CD 파이프라인을 위해 자동으로 주입된 자격 증명으로 Intlayer 명령어를 실행합니다.
 
+### 감사 및 진단
+
+- **[웹사이트 스캔](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ko/cli/scan.md)** - 공개 URL의 페이지 크기를 측정하고 i18n/SEO 상태를 감사하게 해줍니다.
+
 ### 개발 도구
 
 - **[CLI SDK](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ko/cli/sdk.md)** - 자체 코드에서 Intlayer CLI SDK를 사용합니다.
@@ -184,7 +192,8 @@ Intlayer는 여러 설정 파일 형식을 허용합니다:
   "intlayer:extract": "npx intlayer extract",
   "intlayer:projects": "npx intlayer projects list",
   "intlayer:doc:translate": "npx intlayer doc translate",
-  "intlayer:doc:review": "npx intlayer doc review"
+  "intlayer:doc:review": "npx intlayer doc review",
+  "intlayer:scan": "npx intlayer scan https://example.com"
 }
 ```
 

package/docs/ko/cli/init.md

@@ -20,6 +20,7 @@ history:
   - version: 7.5.9
     date: 2025-12-30
     changes: "init 명령어 추가"
+author: aymericzip
 ---
 
 # Intlayer 초기화

package/docs/ko/cli/list.md

@@ -20,6 +20,7 @@ history:
   - version: 7.5.11
     date: 2026-01-06
     changes: "list 명령에 JSON 출력 옵션 추가"
+author: aymericzip
 ---
 
 # 콘텐츠 선언 파일 목록

package/docs/ko/cli/list_projects.md

@@ -18,6 +18,7 @@ history:
   - version: 7.5.12
     date: 2026-01-06
     changes: "list projects 명령에 절대 경로 출력 옵션 추가"
+author: aymericzip
 ---
 
 # Intlayer 프로젝트 목록

package/docs/ko/cli/live.md

@@ -14,6 +14,7 @@ slugs:
   - concept
   - cli
   - live
+author: aymericzip
 ---
 
 # 라이브 싱크 명령어

package/docs/ko/cli/login.md

@@ -15,6 +15,7 @@ slugs:
   - concept
   - cli
   - login
+author: aymericzip
 ---
 
 # Intlayer CLI 로그인 명령

package/docs/ko/cli/pull.md

@@ -15,6 +15,7 @@ slugs:
   - concept
   - cli
   - pull
+author: aymericzip
 ---
 
 # 원격 사전 가져오기

package/docs/ko/cli/push.md

@@ -15,6 +15,7 @@ slugs:
   - concept
   - cli
   - push
+author: aymericzip
 ---
 
 # 사전 푸시하기

package/docs/ko/cli/scan.md

@@ -0,0 +1,160 @@
+---
+createdAt: 2026-06-11
+updatedAt: 2026-06-11
+title: 웹사이트 스캔
+description: Intlayer CLI scan 명령어를 사용하여 모든 웹사이트의 페이지 크기를 측정하고 i18n/SEO 상태를 감사하는 방법을 알아봅니다.
+keywords:
+  - Scan
+  - SEO
+  - i18n
+  - 감사
+  - CLI
+  - Intlayer
+  - 페이지 크기
+  - 번들
+slugs:
+  - doc
+  - concept
+  - cli
+  - scan
+history:
+  - version: 9.0.0
+    date: 2026-06-11
+    changes: "scan 명령어 추가"
+author: aymericzip
+---
+
+# 웹사이트 스캔
+
+`scan` 명령어는 공개 URL을 가져와 총 페이지 크기를 측정하고 페이지의 i18n 및 SEO 상태를 감사(audit)합니다. HTML 속성, 정규(canonical) 링크, hreflang 태그, robots.txt, sitemap.xml, 로컬라이즈된 내부 링크, 그리고 JavaScript 번들의 로케일 가중치를 다루는 평가 보고서(0-100)를 생성합니다.
+
+추가적인 종속성은 필요하지 않습니다. [puppeteer](https://pptr.dev/)가 설치된 경우, 더 정밀한 번들 분석을 위해 지연 로드(lazy-loaded)되는 JavaScript 청크를 캡처할 수 있으며, 그렇지 않은 경우 HTML에 선언된 즉시 로드되는 스크립트를 검사하는 기본 방식으로 대체됩니다.
+
+## 사용법
+
+```bash packageManager="npm"
+npx intlayer scan <url>
+```
+
+```bash packageManager="yarn"
+yarn intlayer scan <url>
+```
+
+```bash packageManager="pnpm"
+pnpm intlayer scan <url>
+```
+
+```bash packageManager="bun"
+bun x intlayer scan <url>
+```
+
+### 예시
+
+```bash packageManager="npm"
+npx intlayer scan https://example.com
+```
+
+출력 예시:
+
+```
+🔍 Scanned https://example.com (basic mode)
+
+Score: 90/100
+Page size: 10.60 MB (HTML 42.31 KB)
+Locales: en, fr, es, de, …
+
+Checks:
+  ✓ html lang attribute
+  ✓ html dir attribute
+  ✓ canonical link
+  ✓ hreflang tags
+  ✓ x-default hreflang
+  ✓ localized internal links
+  ⚠ all internal links localized
+  ✓ current locale detected
+  ✓ robots.txt present
+  ✓ robots.txt keeps locale paths crawlable
+  ✓ sitemap.xml present
+  ✓ sitemap lists every locale
+  ✓ sitemap has alternate links
+  ✓ sitemap has x-default
+
+Bundle locale weight:
+  Translations shipped: 120.50 KB
+  Unused (other locales): 45.20 KB (37%)
+```
+
+## 옵션
+
+### `<url>` (필수)
+
+스캔할 정규 URL(예: `https://example.com`).
+
+### `--no-deep`
+
+렌더링 기반의 정밀 스캔을 비활성화합니다.
+
+기본적으로 명령어는 [puppeteer](https://pptr.dev/)를 사용하여 헤드리스 브라우저에서 페이지를 렌더링하고, 지연 로드되는 JavaScript 청크를 캡처하여 실제 전송 크기를 측정하려고 시도합니다. puppeteer가 설치되어 있지 않으면 자동으로 기본 모드로 대체됩니다.
+
+puppeteer가 활성화되어 있어도 기본 모드를 강제하려면 `--no-deep`을 전달하십시오.
+
+> 예시: `npx intlayer scan https://example.com --no-deep`
+
+### `--json`
+
+서식화된 보고서 대신 전체 스캔 결과를 JSON 객체로 출력합니다. 프로그램 방식의 소비 또는 CI 파이프라인에 유용합니다.
+
+> 예시: `npx intlayer scan https://example.com --json`
+
+### 표준 설정 옵션
+
+- **`--base-dir`** — `intlayer.config.*` 파일을 찾는 데 사용되는 기준 디렉토리.
+- **`-e, --env`** — 대상 환경 (예: `development`, `production`).
+- **`--env-file`** — 사용자 지정 `.env` 파일의 경로.
+- **`--no-cache`** — 설정 캐시를 비활성화합니다.
+- **`--verbose`** — 세부 로깅을 활성화합니다 (CLI 모드에서 기본값).
+- **`--prefix`** — 사용자 지정 로그 접두사.
+
+## 검사 항목
+
+| 검사 항목                 | 설명                                                                         | 점수 가중치 |
+| ------------------------- | ---------------------------------------------------------------------------- | ----------- |
+| `html lang`               | `<html lang="…">` 속성 존재 여부                                             | 9           |
+| `html dir`                | `<html dir="…">` 속성 존재 여부                                              | 3           |
+| `canonical`               | `<link rel="canonical">` 존재 여부                                           | 10          |
+| `hreflang`                | `<link rel="alternate" hreflang="…">` 태그 존재 여부                         | 9           |
+| `x-default hreflang`      | `x-default` hreflang 대체 링크 존재 여부                                     | 7           |
+| `localized links`         | 하나 이상의 내부 링크에 로케일 세그먼트가 포함되어 있는지 여부               | 5           |
+| `all links localized`     | 모든 내부 링크에 로케일 세그먼트가 포함되어 있는지 여부                      | 5           |
+| `current locale`          | 페이지 로케일 감지 가능 여부                                                 | 3           |
+| `robots.txt present`      | `/robots.txt`가 200 응답을 반환하는지 여부                                   | 10          |
+| `robots.txt locale paths` | robots.txt에서 로케일 경로가 차단되지 않았는지 여부                          | 10          |
+| `sitemap.xml present`     | `/sitemap.xml`이 200 응답을 반환하는지 여부                                  | 10          |
+| `sitemap locale coverage` | 감지된 모든 로케일이 사이트맵에 나타나는지 여부                              | 10          |
+| `sitemap alternates`      | 사이트맵에 `hreflang` 대체 링크가 포함되어 있는지 여부                       | 5           |
+| `sitemap x-default`       | 사이트맵에 `x-default` hreflang이 포함되어 있는지 여부                       | 5           |
+| `unused bundle content`   | JS 번들에 불필요하게 사용되지 않는 로케일 데이터가 포함되어 있지 않은지 여부 | 9           |
+
+최종 점수는 모든 통과된 검사의 가중치 합계를 백분율(0-100)로 나타낸 것입니다.
+
+## 프로그램 방식으로 스캔 함수 사용하기
+
+`scan` 함수는 `@intlayer/cli`에서도 내보내지므로 사용자 지정 스크립트에서 직접 호출할 수 있습니다:
+
+```ts
+import { scan } from "@intlayer/cli";
+
+await scan("https://example.com", {
+  deep: false,
+  json: false,
+});
+```
+
+더 낮은 수준의 액세스를 위해 `@intlayer/chokidar/scan`의 `scanWebsite`는 구조화된 `ScanResult` 객체를 반환합니다:
+
+```ts
+import { scanWebsite } from "@intlayer/chokidar/scan";
+
+const result = await scanWebsite("https://example.com", { deep: false });
+console.log(result.score, result.totalPageSize, result.events);
+```

package/docs/ko/cli/sdk.md

@@ -13,6 +13,7 @@ slugs:
   - concept
   - cli
   - sdk
+author: aymericzip
 ---
 
 # CLI SDK

package/docs/ko/cli/standalone.md

@@ -19,6 +19,7 @@ history:
   - version: 8.6.4
     date: 2026-03-31
     changes: "독립 실행형 명령어 문서 초기화"
+author: aymericzip
 ---
 
 # 독립 실행형 번들 (Standalone Bundle)

package/docs/ko/cli/test.md

@@ -13,6 +13,7 @@ slugs:
   - concept
   - cli
   - test
+author: aymericzip
 ---
 
 # 누락된 번역 테스트

package/docs/ko/cli/version.md

@@ -12,6 +12,7 @@ slugs:
   - concept
   - cli
   - version
+author: aymericzip
 ---
 
 # CLI 버전 확인

package/docs/ko/cli/watch.md

@@ -13,6 +13,7 @@ slugs:
   - concept
   - cli
   - watch
+author: aymericzip
 ---
 
 # 사전 감시

package/docs/ko/compiler.md

@@ -29,6 +29,7 @@ history:
   - version: 7.3.1
     date: 2025-11-27
     changes: "컴파일러 출시"
+author: aymericzip
 ---
 
 # Intlayer 컴파일러 | i18n을 위한 자동화된 콘텐츠 추출

package/docs/ko/component_i18n.md

@@ -16,6 +16,7 @@ slugs:
   - i18n
 applicationTemplate: https://github.com/aymericzip/intlayer-vite-react-template
 youtubeVideo: https://www.youtube.com/watch?v=dS9L7uJeak4
+author: aymericzip
 ---
 
 # Intlayer로 컴포넌트를 다국어(i18n)로 만드는 방법