create-plg-lib

create-plg-lib is a CLI tool designed to help you quickly set up a component project. With just a few commands, you can generate a complete scaffold for your component library, allowing you to focus on building great components.

Installation and Usage

You can use create-plg-lib without installation by running the following command:

npx create-plg-lib@latest

This will create a new component project in your local environment, ready for further customization and development.

Features

• Rapid Setup: Quickly generate a complete component library project with essential configuration.
• Flexible Structure: The generated project comes with a structure that is easy to adapt and extend based on your needs.
• Modern Tooling: Preconfigured with popular tools to streamline development, testing, and packaging.

Getting Started

To create a new project, simply run:

npx create-plg-lib@latest

You will be prompted to answer a few questions to configure your project, such as the project name and other settings.

Example

To create a new component library named my-awesome-lib:

npx create-plg-lib@latest

Follow the prompts and input my-awesome-lib as the project name. After the CLI completes, navigate to the new directory and start developing your components:

cd my-awesome-lib

Project Structure

The generated project will have a typical structure like this:

my-awesome-lib/
├── .storybook
│   ├── main.ts
│   └── preview.ts
├── node_modules/
├── packages/
│   └── button/
│       └── index.ts
├── public/
├── stories/
│   └── Button.stories.ts
├── .gitignore
├── eslint.config.js
├── index.css
├── package-lock.json
├── package.json
├── postcss.config.js
├── README.md
├── tailwind.config.js
├── tsconfig.app.json
├── tsconfig.json
├── tsconfig.node.json
├── vite.config.ts
└── yarn.lock

Development

After generating your project, you can start developing components using your preferred code editor. The generated setup will include scripts to help you build, test, and publish your library.

License

MIT License