@krds.ui/vue 0.0.18 → 0.0.19

package/README.md

@@ -69,6 +69,16 @@ app.use(KrdsVue, {
 })
 ```
 
+전역 등록한 컴포넌트의 템플릿 타입 검사·자동완성(Volar/vue-tsc)을 쓰려면 `tsconfig.json`에 전역 타입을 추가합니다. 전체 컴포넌트와 `v-sr-only`, `$krds`가 전역으로 선언되므로 일부만 등록했다면 등록하지 않은 컴포넌트 사용에 주의하세요.
+
+```json
+{
+  "compilerOptions": {
+    "types": ["@krds.ui/vue/global"]
+  }
+}
+```
+
 ### 3. 개별 컴포넌트 import
 
 전역 등록이 필요 없다면 필요한 컴포넌트만 가져옵니다.
@@ -91,6 +101,33 @@ app.use(KrdsVue, {
 </template>
 ```
 
+### 4. Nuxt
+
+서버 렌더링을 지원합니다. 스타일은 `nuxt.config.ts`에 추가하고, 플러그인에서 등록합니다.
+
+```ts
+// nuxt.config.ts
+export default defineNuxtConfig({
+  css: ['@krds.ui/vue/style']
+})
+```
+
+```ts
+// plugins/krds.ts (Nuxt 4 기본 구조에서는 app/plugins/krds.ts)
+import KrdsVue from '@krds.ui/vue'
+
+export default defineNuxtPlugin(nuxtApp => {
+  nuxtApp.vueApp.use(KrdsVue)
+})
+```
+
+Nuxt는 tsconfig를 자동 생성하므로, 전역 타입은 프로젝트의 `.d.ts` 파일에 참조를 추가합니다.
+
+```ts
+// types/krds.d.ts
+/// <reference types="@krds.ui/vue/global" />
+```
+
 ## TypeScript
 
 컴포넌트 props와 공통 타입을 패키지 루트에서 가져올 수 있습니다.
@@ -216,7 +253,8 @@ cd krds-vue
 pnpm install
 pnpm storybook       # Storybook 개발 서버 실행
 pnpm test            # Vitest 실행 (Playwright 브라우저 모드)
-pnpm lint            # ESLint 검사 및 자동 수정
+pnpm lint            # oxlint 검사 (--fix로 자동 수정)
+pnpm format          # oxfmt 포매팅
 pnpm build           # 타입 검사와 라이브러리 빌드
 pnpm build-storybook # 정적 Storybook 빌드
 ```