Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bradgarropy/plop-generator-remix-route

A plop generator for Remix routes.
https://github.com/bradgarropy/plop-generator-remix-route

eslint jest node plop plop-generator plop-pack prettier react remix typescript

Last synced: 3 months ago
JSON representation

A plop generator for Remix routes.

Awesome Lists containing this project

README 

        
# 💧 plop generator remix route



[![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 [`Remix`][remix] routes._



## 📦 Installation



This package is hosted on [npm][npm].



```bash

npm install @bradgarropy/plop-generator-remix-route

```



## 🥑 Usage



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



```javascript

plop.load("@bradgarropy/plop-generator-remix-route")

```



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



```bash

plop route

```



The `route` generator creates a route file under `app/routes` with the following optional additions.



-   Links Function

-   Meta Function

-   Loader Function

-   Action Function

-   Catch Boundary

-   Error Boundary



## ❔ 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



  

    
Brad Garropy
💻 📖 ⚠️ 🚇

  



[codecov]: https://app.codecov.io/gh/bradgarropy/plop-generator-remix-route

[contributing]: https://github.com/bradgarropy/plop-generator-remix-route/blob/master/contributing.md

[contributors]: #-contributors

[npm]: https://www.npmjs.com/package/@bradgarropy/plop-generator-remix-route

[codecov-badge]: https://img.shields.io/codecov/c/github/bradgarropy/plop-generator-remix-route?style=flat-square

[version-badge]: https://img.shields.io/npm/v/@bradgarropy/plop-generator-remix-route.svg?style=flat-square

[downloads-badge]: https://img.shields.io/npm/dt/@bradgarropy/plop-generator-remix-route?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-remix-route?style=flat-square

[issues]: https://github.com/bradgarropy/plop-generator-remix-route/issues

[twitter]: https://twitter.com/bradgarropy

[ama]: https://bradgarropy.com/ama

[bundlephobia]: https://bundlephobia.com/result?p=@bradgarropy/plop-generator-remix-route

[size-badge]: https://img.shields.io/bundlephobia/minzip/@bradgarropy/plop-generator-remix-route?style=flat-square

[github-actions]: https://github.com/bradgarropy/plop-generator-remix-route/actions

[github-actions-badge]: https://img.shields.io/github/workflow/status/bradgarropy/plop-generator-remix-route/%F0%9F%9A%80%20release?style=flat-square

[typescript]: https://www.typescriptlang.org/dt/search?search=%40bradgarropy%2Fplop-generator-remix-route

[typescript-badge]: https://img.shields.io/npm/types/@bradgarropy/plop-generator-remix-route?style=flat-square

[discord]: https://bradgarropy.com/discord

[discord-badge]: https://img.shields.io/discord/748196643140010015?style=flat-square

[plop]: https://plopjs.com

[remix]: https://remix.run