docs: standardize Git submodule and workspace installation
Deploy Storybook / deploy (push) Successful in 1m12s

This commit is contained in:
shkim4 committed 2026-10-23 11:06:19 +09:00
1 parent 3a4c63b5a4
commit 89011a2e42
18 files changed
+51 -39

No files matched your search

+9 -3
View File
@@ -14,7 +14,7 @@
`@hm-design/sw`의 SW Header를 화면에 연결하는 방법입니다. 디자인 값과 판정은 [디자인 명세](./sw-header-design-spec.md)를 따릅니다.
> 패키지는 아직 npm Registry에 게시하지 않았습니다. 아래 설치 방법은 HMDesign Workspace 또는 로컬 tarball 기준입니다.
> `@hm-design/sw` 패키지는 npm Registry로 배포하지 않습니다. 다른 프로젝트는 [Git Submodule + npm Workspace](../guidelines/external-install-submodule.md)로 연결하며, 로컬 tarball은 검증용 대안입니다.
## 1. 패키지 구조
@@ -51,16 +51,22 @@ npm run build:sw
`build:packages`(typecheck·build·Storybook 전처리)도 마지막에 `build:sw`를 실행합니다.
### 다른 React 프로젝트(로컬 tarball)
### 다른 React 프로젝트(Git Submodule + npm Workspace, 기본)
HMDesign을 Submodule로 고정하고 HMDesign 안에서 `npm ci`·`npm run build:packages`를 실행한 뒤, 소비 프로젝트 `workspaces`에 `HMDesign/packages/sw`를, dependency에 `"@hm-design/sw": "*"`를 추가하고 `npm install`합니다. 상세는 [외부 프로젝트 설치](../guidelines/external-install-submodule.md)를 따릅니다.
### 다른 React 프로젝트(로컬 tarball, 검증용)
```bash
npm pack -w @hm-design/sw --pack-destination ../packs
```
```bash
npm install ../packs/hm-design-sw-0.1.0.tgz
npm install ../packs/hm-design-sw-0.2.0.tgz
```
`hm-design-sw-0.2.0.tgz`는 배포 파일이 아니라 위 `npm pack`이 로컬에서 만드는 파일 이름의 예시입니다. 실제 이름은 `packages/sw/package.json`의 `version`을 따르며 `npm pack` 출력에서 확인합니다.
소비 프로젝트는 `src` 내부 파일을 참조하지 않고 `dist` 공개 API만 사용합니다.
## 3. Import