About
routes-gen is a framework agnostic CLI tool for routes parsing and generation of a type-safe helper for safe route usage. Think of it as Prisma, but for routes.
Installation
First, you have to install the routes generator itself:
yarn add routes-gen
Note that it should not be a dev dependency, since you'll be importing the
routemethod from here.
Official Drivers
The generator works with "drivers", which are route parsers for different frameworks.
| Driver | Installation | Default export path |
|---|---|---|
| Remix | yarn add -D @routes-gen/remix |
/app/routes.d.ts |
Usage Example
You can simply run:
yarn routes-gen -d @routes-gen/remix
It will parse and export the routes, based on the driver that you've provided.
For example, the @routes-gen/remix driver will export the routes by default to /app/routes.d.ts.
Note that you can change the output path via the
--outputor-oflag.
Now you can import the generated route helper anywhere and enjoy the typings:
import { route } from "routes-gen";
// Compiles to /products
route("/products");
// Compiles to /products/1337
route("/products/:productId", {
productId: "1337",
});
CLI Options
| Option | Alias | Description |
|---|---|---|
| --help | Print the help message and exit | |
| --version | -v | Print the CLI version and exit |
| --output | -o | The path for routes export |
| --driver | -d | The driver of handling routes parsing |
Writing Your Driver
If there is no driver for your preferred framework, you can write your own. For example, create a simple driver.js file in your project, with the following content:
module.exports = {
// Where to export the file if the "output" flag was not provided
defaultOutputPath: "src/routes.d.ts",
// The routes parser. Must export and array of routes matching the interface: { path: string }
routes: async () => {
return [
{
path: "/products",
},
{
path: "/products/:productId", // Note that the dynamic segments must match the pattern :myVar
},
];
},
}
Now you can easily use it:
routes-gen -d driver.js
You can also publish it to npm, and use it as a package:
routes-gen -d my-driver-package
Please consider submitting your drivers to this repository.
![[FEATURE REQUEST] Add query string support](https://avatars.githubusercontent.com/u/76668284?v=4)
180 Jan 3, 2023
50 Nov 9, 2022
2 Sep 12, 2022
2 May 2, 2022
47 Dec 22, 2022
6 Dec 21, 2022
97 Dec 30, 2022
54 Dec 29, 2022
111 Jan 5, 2023
20 Dec 17, 2022
7 Sep 13, 2022
6 May 5, 2023
3 May 18, 2022
4 May 3, 2022
14 Jan 3, 2023
344 Dec 29, 2022
10 Dec 23, 2022
9 Dec 9, 2022
13 Dec 1, 2022