Shadcn Registry

screenshot of Shadcn Registry

A CLI tool to generate shadcn registry files.

Overview

The shadcn-registry is a powerful CLI tool designed for developers wanting to create registries that are compatible with shadcn. Its simplicity and efficiency make it a great asset in the development process, particularly for managing component files. With this tool, developers can easily generate, build, and maintain their registries in a streamlined manner, saving time and effort while ensuring structure and consistency in their projects.

By using JSON format for registry files, the shadcn-registry enhances compatibility with various systems, and its CI/CD integration ensures that these files can be generated automatically within workflows. Overall, it’s tailored to meet the needs of modern developers looking to keep their component libraries organized.

Features

  • Registry File Creation: Create registry files easily in JSON format, adhering to the required registry schema for seamless integration.
  • Generate Command: An experimental command that allows the automatic generation of registry files from components, streamlining the file creation process.
  • Custom Output Options: Flexible options for specifying paths to output both the registry files and the index file, providing the flexibility to organize files as desired.
  • Types Inclusion: Allows users to specify which types (ui, hook, lib) to include in the registry index file, making it customizable to suit project needs.
  • CI/CD Integration: Effortlessly integrates into CI/CD pipelines, automatically generating registry files and enhancing project automation.
  • MIT Licensed: Being open source under the MIT License encourages community contributions and fosters a collaborative development environment.
  • Easy Contribution: The tool encourages contributions, making it easier for developers to join and enhance the project with their own improvements.
typescript
Typescript

TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.

zod
Zod

Zod is a TypeScript-first schema declaration and validation library. It allows you to define schemas that can validate data at runtime while providing excellent TypeScript inference, making it perfect for API validation, form validation, and type-safe data handling.