-
Notifications
You must be signed in to change notification settings - Fork 52
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(suspensive.org): add docs for codemods
- Loading branch information
Showing
5 changed files
with
112 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
export default { | ||
motivation: { title: '어떤 이유로 사용하나요?' }, | ||
usage: { title: '사용하기' }, | ||
'--- Codemods': { | ||
type: 'separator', | ||
title: 'Codemods', | ||
}, | ||
tanstackQueryImport: { title: 'TanStack Query로 import 경로 변경' }, | ||
} |
46 changes: 46 additions & 0 deletions
46
docs/suspensive.org/src/pages/ko/docs/codemods/motivation.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
import { Steps } from 'nextra/components' | ||
import { Callout } from '@/components' | ||
|
||
# 어떤 이유로 사용하나요? | ||
|
||
<Callout type='experimental'> | ||
|
||
`@suspensive/codemods`는 실험 기능이므로 이 인터페이스는 변경될 수 있습니다. | ||
|
||
</Callout> | ||
|
||
Codemods는 코드베이스 내에서 반복적이고 대규모로 발생하는 작업을 자동화하여 코드를 효율적으로 업데이트할 수 있는 강력한 도구입니다. 이를 통해 수많은 변경 사항을 수동으로 검토할 필요 없이 빠르고 안전하게 업데이트할 수 있습니다. | ||
|
||
Suspensive는 API 업데이트나 더 이상 사용되지 않는 API를 쉽게 관리할 수 있도록 Codemods를 제공합니다. | ||
|
||
<Steps> | ||
|
||
### 대규모 API 변경을 쉽고 빠르게 처리할 수 있습니다. | ||
|
||
Suspensive 패키지를 사용하는 프로젝트에서는 패키지가 코드베이스 전역에서 활용되기 마련입니다. 이때 모든 사용처를 수동으로 찾고 수정하는 것은 많은 시간이 소요될 뿐만 아니라 실수할 가능성도 큽니다. | ||
|
||
```ansi | ||
npx @suspensive/codemods | ||
✔ Which transform would you like to apply? > tanstack-query-import | ||
✔ On which files or directory should the codemods be applied? … . | ||
Processing 130 files... | ||
Spawning 10 workers... | ||
Sending 13 files to free worker... | ||
Sending 13 files to free worker... | ||
... | ||
All done. | ||
Results: | ||
0 errors | ||
31 unmodified | ||
0 skipped | ||
99 ok | ||
Time elapsed: 2.980 seconds | ||
``` | ||
|
||
위 로그는 `@suspensive/react-query` & `@tanstack/react-query` v5 환경에서 `@deprecated`된 `@suspensive/react-query` API를 자동으로 전환하기 위해 [`tanstack-query-import`](/ko/docs/codemods/tanstackQueryImport) codemod를 실행한 결과입니다. 총 130개 파일 중 99개 파일이 단 2.980초 만에 변환되었습니다. | ||
|
||
### Suspensive 패키지를 쉽고 안전하게 업데이트할 수 있습니다. | ||
|
||
패키지의 메이저 업데이트에서는 종종 Break Change가 발생해 코드 마이그레이션이 복잡해집니다. Suspensive는 이러한 Break Change를 쉽게 관리할 수 있도록 Codemods를 통해 꼼꼼하게 지원할 예정입니다. Codemods를 사용하면 새로운 버전과 기능으로 빠르고 안전하게 업그레이드할 수 있습니다. | ||
|
||
</Steps> |
31 changes: 31 additions & 0 deletions
31
docs/suspensive.org/src/pages/ko/docs/codemods/tanstackQueryImport.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
import { Callout } from '@/components' | ||
|
||
# TanStack Query로 import 경로 변경 | ||
|
||
<Callout type='info'> | ||
|
||
해당 codemod는 `@suspensive/react-query` & `@tanstack/react-query` v4 환경에서 `@tanstack/react-query`를 v5로 업데이트 하는 경우 추천합니다. | ||
|
||
</Callout> | ||
|
||
```shell | ||
npx @suspensive/codemods tanstack-query-import . | ||
``` | ||
|
||
`@suspensive/react-query` & `@tanstack/react-query` v5 환경에서는 `@suspensive/react-query`가 제공하는 Suspense Hooks와 queryOptions가 `@deprecated`로 표시됩니다. 이는 `@tanstack/react-query` v5에 동일한 API인 Suspense Hooks와 queryOptions를 `@suspensive/react-query`가 제공하고 있어, 개발자가 `@tanstack/react-query`의 v5 API를 우선적으로 사용하도록 유도하기 위함입니다. | ||
|
||
이 codemod를 통해 `@suspensive/react-query`에서 `@tanstack/react-query` v5로 import 경로를 자동 변환할 수 있습니다. | ||
|
||
예: | ||
|
||
```tsx | ||
import { queryOptions } from '@suspensive/react-query'; | ||
import { useSuspenseQuery } from '@suspensive/react-query-5'; // 버전 패키지도 변환됩니다! | ||
``` | ||
|
||
변환 후: | ||
|
||
```tsx | ||
import { queryOptions } from '@tanstack/react-query'; | ||
import { useSuspenseQuery } from '@tanstack/react-query'; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
import { Callout } from '@/components' | ||
|
||
# 사용하기 | ||
|
||
<Callout type='experimental'> | ||
|
||
`@suspensive/codemods`는 실험 기능이므로 이 인터페이스는 변경될 수 있습니다. | ||
|
||
</Callout> | ||
|
||
단 하나의 명령어로 Suspensive의 Codemods를 실행할 수 있으며, 종속성으로 설치할 필요 없이 npx로 간편하게 사용할 수 있습니다. | ||
|
||
터미널에서 프로젝트 폴더로 이동한 후 다음 명령어를 실행하세요. | ||
|
||
[![npm version](https://img.shields.io/npm/v/@suspensive/codemods?color=000&labelColor=000&logo=npm)](https://www.npmjs.com/package/@suspensive/codemods) | ||
|
||
```shell | ||
npx @suspensive/codemods <transform> <path> | ||
``` | ||
|
||
Codemod를 적용하고자 하는 환경에서 맞춰서 `<transform>`과 `<path>`를 변경하세요. | ||
|
||
- `<transform>`: 실행할 Codemods의 이름 | ||
- `<path>`: 변환할 디렉터리 |