Skip to content

Config

Docflow의 설정 타입이에요. 프로젝트 설정, 명령어 설정, 플러그인 설정을 포함해요.

시그니처

typescript
type Config = z.infer<typeof configSchema>;

매개변수

  • projectRequired · object

    프로젝트 설정 정보

    • rootRequired · string

      프로젝트 루트 디렉토리

    • packageManagerRequired · "yarn" | "pnpm" | "npm"

      사용할 패키지 매니저

    • workspaceRequired · object

      워크스페이스 설정

    • workspace.includeRequired · string[]

      빌드에 포함할 패키지 패턴

    • workspace.excludeRequired · string[]

      빌드에서 제외할 패키지 패턴

  • commandsRequired · object

    명령어 설정

    • buildRequired · object

      build 명령어 설정

    • checkRequired · object

      check 명령어 설정

    • generateRequired · object

      generate 명령어 설정

  • plugins · object[]

    플러그인 설정

    • nameRequired · string

      플러그인 이름

    • pluginRequired · function

      플러그인 인스턴스를 반환하는 팩토리 함수

    • options · object

      플러그인 옵션

MIT 라이선스에 따라 배포됩니다.