gen:yup (RHF + Yup)
대화형 cli 를 통해 일관된 형식의 yup 스키마를 생성하는 스크립트입니다.
변수 목적에 따라 정규식과 에러 텍스트를 연결하여 편의성과 안정성을 제공합니다.
✔ hook 이름 · use___
✔ 필요한 Schema (Space 선택 / Enter 확정) · 아이디 / 비밀번호
✔ 필수 Schema (Space 선택 / Enter 확정) · 아이디
=> src/generated/hooks/use___.ts
Installation
- npm
- yarn
- pnpm
npm i -D @toktokhan-dev/cli @toktokhan-dev/cli-plugin-gen-yup
yarn add -D @toktokhan-dev/cli @toktokhan-dev/cli-plugin-gen-yup
pnpm add -D @toktokhan-dev/cli @toktokhan-dev/cli-plugin-gen-yup
Run Script
command 를 별도로 입력하지 않으면 대화형으로 실행되어 등록되어있는 스크립트 중 선택하여 사용이 가능합니다.
npx tokript
command 를 입력하면 해당 스크립트가 바로 실행됩니다.
npx tokript gen:yup
팁
자주 사용될 수 있는 스크립트는 협업간 편의성을 위해 package.json
에 등록하는걸 권장 드립니다.
package.json
{
...
"scripts": {
"gen:yup": "tokript gen:yup",
}
}
- yarn
- npm
- pnpm
yarn run gen:yup
npm run gen:yup
pnpm run gen:yup
Configuration
tok-cli.config.ts
에서 config 정의가 가능합니다.
tokript.config.ts
import { genYup } from '@toktokhan-dev/cli-plugin-gen-yup'
const config: RootConfig<{
plugins: [typeof genYup]
}> = {
plugins: [genYup],
'gen:yup': {
...
},
}
export default config
output
- Required:
false
- Type:
string
- Default:
src/generated/hooks/___.ts
- Cli Option:
--output
-o
config
tok-cli.config.ts
{
'gen:yup': {
output: 'path/to/hooks',
...
},
}
cli
tokript gen:yup --output "path/to/hooks"