Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bradgarropy/plop-generator-react-hook
A plop generator for React hooks.
https://github.com/bradgarropy/plop-generator-react-hook
eslint jest node plop plop-generator plop-pack prettier react typescript
Last synced: about 1 month ago
JSON representation
A plop generator for React hooks.
- Host: GitHub
- URL: https://github.com/bradgarropy/plop-generator-react-hook
- Owner: bradgarropy
- License: mit
- Created: 2021-06-21T18:56:24.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-03T20:32:16.000Z (11 months ago)
- Last Synced: 2024-09-22T07:37:44.339Z (about 2 months ago)
- Topics: eslint, jest, node, plop, plop-generator, plop-pack, prettier, react, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@bradgarropy/plop-generator-react-hook
- Size: 906 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- Contributing: contributing.md
- License: license
Awesome Lists containing this project
README
# 💧 plop generator react hook
[![version][version-badge]][npm]
[![downloads][downloads-badge]][npm]
[![size][size-badge]][bundlephobia]
[![github actions][github-actions-badge]][github-actions]
[![coverage][codecov-badge]][codecov]
[![typescript][typescript-badge]][typescript]
[![contributing][contributing-badge]][contributing]
[![contributors][contributors-badge]][contributors]
[![discord][discord-badge]][discord]
_A [`plop`][plop] generator for [`react`][react] hooks._
## 📦 Installation
This package is hosted on [`npm`][npm].
```bash
npm install --save-dev @bradgarropy/plop-generator-react-hook
```
## 🥑 Usage
First, be sure you have [`plop`][plop] installed. Then, add the following line to your `plopfile.js`.
```javascript
plop.load("@bradgarropy/plop-generator-react-hook")
```
Now you'll have access to the `hook` generator as shown below.
```bash
plop hook
```
The `hook` generator scaffolds a hook, including tests, and adds it to the `index.ts` file for easy importing. The resulting directory looks like this for a hook named `useHook`.
```text
src
└── hooks
├── index.ts
└── useHook
├── index.ts
├── useHook.tsx
└── useHook.test.tsx
```
## ❔ Questions
🐛 report bugs by filing [issues][issues]
📢 provide feedback with [issues][issues] or on [twitter][twitter]
🙋🏼♂️ use my [ama][ama] or [twitter][twitter] to ask any other questions
## ✨ contributors
[codecov]: https://app.codecov.io/gh/bradgarropy/plop-generator-react-hook
[contributing]: https://github.com/bradgarropy/plop-generator-react-hook/blob/master/contributing.md
[contributors]: #-contributors
[npm]: https://www.npmjs.com/package/@bradgarropy/plop-generator-react-hook
[codecov-badge]: https://img.shields.io/codecov/c/github/bradgarropy/plop-generator-react-hook?style=flat-square
[version-badge]: https://img.shields.io/npm/v/@bradgarropy/plop-generator-react-hook.svg?style=flat-square
[downloads-badge]: https://img.shields.io/npm/dt/@bradgarropy/plop-generator-react-hook?style=flat-square
[contributing-badge]: https://img.shields.io/badge/PRs-welcome-success?style=flat-square
[contributors-badge]: https://img.shields.io/github/all-contributors/bradgarropy/plop-generator-react-hook?style=flat-square
[issues]: https://github.com/bradgarropy/plop-generator-react-hook/issues
[twitter]: https://twitter.com/bradgarropy
[ama]: https://bradgarropy.com/ama
[bundlephobia]: https://bundlephobia.com/result?p=@bradgarropy/plop-generator-react-hook
[size-badge]: https://img.shields.io/bundlephobia/minzip/@bradgarropy/plop-generator-react-hook?style=flat-square
[github-actions]: https://github.com/bradgarropy/plop-generator-react-hook/actions
[github-actions-badge]: https://img.shields.io/github/workflow/status/bradgarropy/plop-generator-react-hook/%F0%9F%9A%80%20release?style=flat-square
[typescript]: https://www.typescriptlang.org/dt/search?search=%40bradgarropy%2Fplop-generator-react-hook
[typescript-badge]: https://img.shields.io/npm/types/@bradgarropy/plop-generator-react-hook?style=flat-square
[discord]: https://bradgarropy.com/discord
[discord-badge]: https://img.shields.io/discord/748196643140010015?style=flat-square
[plop]: https://plopjs.com
[react]: https://reactjs.org
