Lib.rs

CRF

A Simple React Component Creator
Explore the docs »

Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Built With

• Rust
• structopt

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

To build your own verison of this script you will need.

• Cargo
• Rust

# if you use rustup update rust using:
rustup update

Installation

1. Clone the repo

git clone https://github.com/13sfaith/crf.git

2. Build the release

cargo build --release

3. The executable is then stored in:

./crf/target/release

Usage

Create a react component either class or function (default class)

USAGE: crf [OPTIONS]

FLAGS: -h, --help Prints help information -V, --version Prints version information

OPTIONS: -t, --type Type of component (-t c or -t f) [default: c]

ARGS: Name of component

An example use case would be:

This would create a js file named "Example.js" in the current working directory The file would contain a boilerplate class file that would look like:

The default behavior of the tool is to create a class, however if you would like to make a functional component we've got you covered.

Simply use the function tag as such:

This will create a js file named "Example.js" with the following boilerplate:

Happy Hacking!

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Spencer Faith - @13sfaith - 13sfaith@gmail.com

Project Link: https://github.com/13sfaith/crf

Acknowledgements

• Rust Lang
• Othneil Drew