@rebase-agency/generate-react-cli
v0.6.0
Published
CLI for generating React component files.
Downloads
73
Readme
@rebase-agency/generate-react-cli
CLI for generating React component files. To help speed up productivity in React projects and stop copying, pasting, and renaming files each time you want to create a new component.
This tool create components with ts
Installation
npm install -g @rebase-agency/generate-react-cli
Usage
npx generate-react [options] <component> [path]
Generate Components
npx generate-react Box ./src/components
This command will create a folder with your component name in the specified path (e.g. src/components) directory, and its corresponding files.
Example of the component files structure:
|-- /src
|-- /components
|-- /Box
|-- Box.tsx
|-- Box.module.css
|-- index.ts
Example of the Storybook with option -s
component files structure:
|-- /Box
|-- Box.tsx
|-- Box.module.css
|-- Docs.mdx
|-- Box.stories.tsx
|-- README.md
|-- index.ts
Options
Generate public export file
This command will create a index.ts
file with export yours components in the specified path (e.g. src/components) directory. The command overwrites the index.ts
file.
npx generate-react export ./src/components
Example
For example, you have ./src/components
with the following component folders:
|-- /src
|-- /components
|-- /Box
|-- /Button
|-- /Card
|-- /Modal
Then the export
command will generate a file index.ts
with the following content:
export { Box } from "./Box";
export { Button } from "./Button";
export { Card } from "./Card";
export { Modal } from "./Modal";
License
@rebase-agency/generate-react-cli is an open source software licensed as MIT.