gwjun-ui v0.2.2

gwjun-ui

A CLI tool to directly add component code to your React project.

Installation

If you have not set up a React project, please follow the instructions in the Getting Started Guide.

If you have already set up a React project, please proceed with the following steps.

Add tsconfig alias

Add baseUrl and alias in your tsconfig.json to correctly configure the import paths for utility functions. If configured differently, you must input the alias according to the corresponding path when running init.

{
  "compilerOptions": {
    // ...
    "baseUrl": ".",
    "paths": {
      "#*": ["./src/*"]
    }
  }
}

Note If you are using other frameworks or build tool such as Vite, additional steps may be required to configure alias.

Please refer to the documentation in the Getting Started Guide for detailed instructions.

Usage

init

Use the init command to initialize dependencies for a new project.

The init command sets up the component-config.json file, which makes configuration settings.

npx gwjun-ui init

add

Use the add command to add components to your project.

The add command adds a component to your project and installs all required dependencies.

npx gwjun-ui add [component]

Example

npx gwjun-ui add button