Overview
PBandJ is an all-in-one tool that allows users to quickly create and publish a high-quality component library. It takes care of the setup process and ensures best practices are followed. The tool is not only limited to React with TypeScript, but can also be used for publishing vanilla TypeScript libraries. With PBandJ, users can easily publish their libraries to be reused in other projects or shared with others.
Features
- React with TypeScript by default
- Tsup for building and bundling
- GitHub Actions for publishing to npm and testing
- Storybook v7 running on Vite for instant Hot Module Replacement
- Vite playground dev server
- Changesets for versioning
- Vitest for testing
- Eslint for linting
- Prettier for formatting
Installation
To get started with PBandJ, you can follow these steps:
- Run the following command in your terminal:
<command>
This CLI command will guide you through the setup process and install all the necessary tools.
Summary
PBandJ is a comprehensive tool that simplifies the process of creating and publishing a component library. It provides a streamlined setup and ensures best practices are followed. With PBandJ, users can easily publish their libraries to be reused across projects or shared with others. The tool supports React with TypeScript and vanilla TypeScript libraries. It includes features like Tsup for building and bundling, GitHub Actions for publishing and testing, Storybook v7 with Vite for instant HMR, Changesets for versioning, Vitest for testing, and Eslint with Prettier for linting and formatting. PBandJ is an efficient solution for developers looking to create and share high-quality component libraries.