ran-component-creator

Component Creator

Component Creator is a CLI tool that allows you to create React components quickly and easily. With Component Creator, you can focus on writing code instead of setting up boilerplate files.

Quick Start

To use Component Creator, simply run the following command:

npx component-creator

This will launch the CLI tool and guide you through the process of creating a new React component.

Features

• Quick and Easy 🚀 - Component Creator allows you to create React components quickly and easily. With Component Creator, you can focus on writing code instead of setting up boilerplate files.
• Clean DX ⭐ - Component Creator is designed to be as simple as possible. It doesn't require any configuration or setup, so you can start using it right away. It's built with TypeScript.
• Customizable 🪄 - Component Creator is highly customizable. You can configure it to suit your needs and preferences.
• Modular 🧩 - Component Creator is modular. You can use it with any React project (create-react-app, next.js, astro, ...etc.), regardless of its size or complexity. Also it's easy to extend Component Creator with new features.
• No Installation Required 📦 - Component Creator doesn't require any installation. You can use it right away without having to install anything.

Table of Contents

• Component Creator
  • Quick Start
  • Features
  • Table of Contents
  • Settings
  • Examples
  • NPM Scripts
  • CLI Arguments
  • How to create custom plugin
  • Contributing
  • License

Settings

There are two options for running component creator. Just simply run npx component-creator or You can also run Component Creator with .compcreator.json file. This file allows you to specify default options for Component Creator.

Here's an example of what the .compcreator.json file might look like:

{
  "plugins": [
    {
      "name": "general",
      "options": {
        "srcFolderLocation": "./src"
      }
    },
    "css",
    {
      "name": "reactJS",
      "options": {
        "createInterface": true,
        "styleLibrary": "chakraUI"
      }
    },
    "chakraUI"
  ]
}

This file sets the default options for Component Creator to avoid having to enter them every time you run the tool. And when you create a new component, Component Creator will create react component with Chakra UI and interface support on ./src folder.

After creating .compcreator.json file, you can run Component Creator with the following command:

npx component-creator

For more information on the available options, please check the options page.

Examples

For Examples, please check the examples folder. You can just copy JSON files from this folder and paste to root folder of your project. Then you can just run Component Creator.

NPM Scripts

For NPM Scripts, please check the npm scripts page. You can use Component Creator with npm scripts easily.

CLI Arguments

For CLI Arguments, please check the CLI arguments page.

How to create custom plugin

For creating custom plugin, please check the custom plugin page. You can create your own libraries' plugin easily with extensive functionally and Handlebars template engine.

Contributing

If you'd like to contribute to Component Creator, please check the contributing page. Contributions are always welcome! If you want to integrate your library/plugin/boilerplate to Component Creator, please check the how to create custom plugin page.

License

Distributed under the GPL-3.0 License. See LICENSE for more information.