ontwik ui

Ontwik-UI

헤드리스 UI 라이브러리 및 CLI 테마 생성기

제작자 :

• ? Turborepo-Monorepos를위한 고성능 빌드 시스템
• React - 사용자 인터페이스 용 JavaScript 라이브러리
• ? TSUP - Esbuild가 구동하는 TypeScript Bundler
• 스토리 북 - vite로 구동되는 UI 구성 요소 환경

몇 가지 다른 도구뿐만 아니라 미리 구성된 도구 :

• 정적 유형 검사를위한 타이프 스크립트
• 버전 관리 및 변경 사항 관리를위한 변경 사항
• 완전 자동화 된 패키지 게시를위한 GitHub 액션

시작하기

문서

유용한 명령

• yarn dev - 모든 패키지를 로컬로 실행하고 스토리 북으로 미리보기
• yarn build - 스토리 북 사이트를 포함한 모든 패키지 빌드
• yarn lint - 보풀 모든 패키지
• yarn changeset - 변경 세트를 생성합니다
• yarn clean - 모든 node_modules 및 dist 폴더 정리 (각 패키지의 깨끗한 스크립트 실행)

앱 및 패키지

이 monorepo에는 다음 패키지 및 응용 프로그램이 포함되어 있습니다.

• apps/docs : 스토리 북이있는 구성 요소 문서 사이트
• apps/public-docs : Nextra가 구동하는 공개 문서
• packages/ontwik-ui : 코어 반응 구성 요소

각 패키지와 앱은 90% 타입 스크립트입니다. 원사 작업 공간을 사용하면 루트 package.json 에 패키지 사이에 공유되는 "호이스트"종속성을 "호이스트"할 수 있습니다. 이는 node_modules 폴더가 작은 것을 의미하며 더 나은 로컬 개발 경험을 의미합니다. 전체 monorepo의 종속성을 설치하려면 yarn add 와 함께 -W 작업장 플래그를 사용하십시오.

버전 작성 및 게시 패키지

이 저장소는 변경 사항을 사용하여 버전을 관리하고 변경 사항을 생성하며 NPM에 게시합니다. 사전 구성되어있어 즉시 패키지를 게시 할 수 있습니다.

ChangeLog 생성

ChangeLog를 생성하려면 yarn changeset 로컬로 실행하십시오.

1. 어떤 패키지를 포함시키고 싶습니까? - 이것은 어떤 패키지 및 변경되었으며, 어떤 패키지가 동일하게 유지되었는지를 보여줍니다. 기본적으로 패키지가 포함되어 있지 않습니다. space 눌러 changeset 에 포함 할 패키지를 선택하십시오.
2. 어떤 패키지가 큰 범프를 가져야합니까? - space 누르면 버전을 범프하려는 패키지를 선택하십시오.
3. 첫 번째 주요 버전을 수행하는 경우 릴리스를 확인하십시오.
4. 변경 사항에 대한 요약을 작성하십시오.
5. 변경 사항이 예상대로 보이도록 확인하십시오.
6. 요약 및 포함 된 패키지 목록이 포함 된 changeset 폴더에 새 Markdown 파일이 생성됩니다.

출시

코드를 GitHub로 푸시하면 GitHub 작업이 root package.json 에 정의 된 release 스크립트를 실행합니다.

turbo run build --filter=docs^... --filter=public-docs^... && changeset publish

Turborepo는 모든 게시 가능한 패키지 (문서 및 공개 DOC 제외)에 대한 build 스크립트를 실행하고 패키지를 NPM에 게시합니다.