@seed-design/codemod 0.0.0-alpha-20241020064329 → 0.0.0-alpha-20241020090615
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +57 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1 +1,57 @@
|
|
|
1
|
-
# codemod
|
|
1
|
+
# @seed-design/codemod
|
|
2
|
+
|
|
3
|
+
코드 마이그레이션 도구
|
|
4
|
+
|
|
5
|
+
## 사용
|
|
6
|
+
|
|
7
|
+
```shell
|
|
8
|
+
npx @seed-design/codemod <transform> <경로> <옵션>
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## 지원하는 Transforms
|
|
12
|
+
|
|
13
|
+
### `migrate-icons`
|
|
14
|
+
|
|
15
|
+
- 기존 아이콘 React 패키지를 참조하는 코드를 [새 패키지](https://github.com/daangn/seed-icon-v3/blob/main/packages/react/README.md)를 참조하도록 변환해요.
|
|
16
|
+
- `@seed-design/icon` 또는 `@seed-design/react-icon` import source를 @daangn/react-icon으로 변환해요
|
|
17
|
+
- 아이콘 이름 변경에 따른 코드 수정을 수행해요
|
|
18
|
+
|
|
19
|
+
> [!IMPORTANT] 중요
|
|
20
|
+
>
|
|
21
|
+
> - `@daangn/react-icon` 패키지 설치/업데이트와 이전 패키지 제거는 직접 수행해주세요.
|
|
22
|
+
|
|
23
|
+
> [!CAUTION] 주의
|
|
24
|
+
>
|
|
25
|
+
> - 코드 변환 이후 몇 가지 사항을 직접 확인해야 해요. 자세한 내용은 [Notion 페이지](https://www.notion.so/daangn/12128c3a9f8f8063b569c897116c8f40)를 참고해주세요.
|
|
26
|
+
> - 기존 아이콘 198개 중 6개 아이콘은, 신규 아이콘팩에 대응되는 아이콘이 **없어요**. 6개 아이콘이 사용된 경우 직접 대응해주세요.
|
|
27
|
+
|
|
28
|
+
#### 사용
|
|
29
|
+
|
|
30
|
+
```shell
|
|
31
|
+
npx @seed-design/codemod migrate-icons <경로> <옵션>
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
```shell
|
|
35
|
+
npx @seed-design/codemod migrate-icons src/ui --extensions=ts,tsx
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
- `src/ui` 디렉토리 내의 `ts, tsx` 파일을 변환해요.
|
|
39
|
+
|
|
40
|
+
#### 지원하는 옵션
|
|
41
|
+
|
|
42
|
+
- [`--extensions`](https://jscodeshift.com/run/cli/#--extensionsext)
|
|
43
|
+
- 변환할 파일 확장자를 지정해요.
|
|
44
|
+
- 지정하지 않으면 `<경로>` 안의 `js,jsx,ts,tsx` 파일을 변환해요.
|
|
45
|
+
- e.g. `--extensions="ts,tsx"`
|
|
46
|
+
- [`--ignore-pattern`](https://jscodeshift.com/run/cli/#--ignore-patternglob)
|
|
47
|
+
- 변환하지 않을 파일 패턴을 지정해요.
|
|
48
|
+
- e.g. `--ignore-pattern="**/foo.*"`
|
|
49
|
+
- [`--ignore-config`](https://jscodeshift.com/run/cli/#--ignore-configfile)
|
|
50
|
+
- 변환하지 않을 파일 패턴이 정의된 파일을 지정해요.
|
|
51
|
+
- e.g. `--ignore-config=".gitignore"`
|
|
52
|
+
|
|
53
|
+
## 테스트
|
|
54
|
+
|
|
55
|
+
```shell
|
|
56
|
+
cd packages/codemod && yarn test
|
|
57
|
+
```
|