Home

Awesome

💧 plop generator react component

version downloads size github actions coverage typescript contributing contributors discord

A plop generator for react components.

📦 Installation

This package is hosted on npm.

npm install --save-dev @bradgarropy/plop-generator-react-component

🥑 Usage

First, be sure you have plop installed. Then, add the following line to your plopfile.js.

plop.load("@bradgarropy/plop-generator-react-component")

Now you'll have access to the component generator as shown below.

plop component

The component generator scaffolds a component, including tests and an associated css module. The resulting directory looks like this for a component named Component.

src
└── components
   └── Component
      ├── index.ts
      ├── Component.tsx
      ├── Component.test.tsx
      └── Component.module.css

❔ Questions

🐛 report bugs by filing issues
📢 provide feedback with issues or on twitter
🙋🏼‍♂️ use my ama or twitter to ask any other questions

✨ contributors

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tr> <td align="center"><a href="https://bradgarropy.com"><img src="https://avatars.githubusercontent.com/u/11336745?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Brad Garropy</b></sub></a><br /><a href="https://github.com/bradgarropy/plop-generator-react-component/commits?author=bradgarropy" title="Code">💻</a> <a href="https://github.com/bradgarropy/plop-generator-react-component/commits?author=bradgarropy" title="Documentation">📖</a> <a href="https://github.com/bradgarropy/plop-generator-react-component/commits?author=bradgarropy" title="Tests">⚠️</a> <a href="#infra-bradgarropy" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td> </tr> </table> <!-- markdownlint-restore --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END -->