https://github.com/yesmeck/remix-routes

Typesafe routing for your Remix apps.
https://github.com/yesmeck/remix-routes

remix typescript

Last synced: about 2 months ago
JSON representation

Typesafe routing for your Remix apps.

• Host: GitHub
• URL: https://github.com/yesmeck/remix-routes
• Owner: yesmeck
• License: mit
• Created: 2021-12-12T14:02:48.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-06-23T09:15:38.000Z (3 months ago)
• Last Synced: 2024-07-26T14:27:45.461Z (about 2 months ago)
• Topics: remix, typescript
• Language: TypeScript
• Homepage:
• Size: 712 KB
• Stars: 382
• Watchers: 5
• Forks: 19
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-remix - remix-routes - Typesafe routing for your Remix apps. (Utility)
• awesome-remix - remix-routes - Typesafe routing for your Remix apps. (Utility)

README

        
# remix-routes

`remix-routes` automatically generates typesafe helper functions for manipulating internal links in your Remix apps.

https://user-images.githubusercontent.com/465125/205243864-3493733d-8586-405f-94eb-088fdb87fd23.mp4

`remix-routes` also works with [`remix-modules`](https://github.com/yesmeck/remix-modules).

## Installation

```bash

$ npm add remix-routes

```

## Setup

### With Vite

Add `remix-routes` plugin to your `vite.config.ts`:

```javascript

import { defineConfig } from "vite";

import { vitePlugin as remix } from "@remix-run/dev";

import { remixRoutes } from "remix-routes/vite";

export default defineConfig({

  plugins: [

    remix(),

    remixRoutes(options?)

  ],

});

```

Supported config options:

- `strict: boolean`

- `outDir: string`

### Without Vite

Add `remix-routes` to your dev and build script in `package.json`.

**With [`concurrently`](https://www.npmjs.com/package/concurrently) package:**

```json

{

  "scripts": {

    "build": "remix-routes && remix build",

    "dev": "concurrently \"remix-routes -w\" \"remix dev\""

  }

}

```

**With [`npm-run-all`](https://www.npmjs.com/package/npm-run-all) package:**

```json

{

  "scripts": {

    "build": "run-s build:*",

    "build:routes": "remix-routes",

    "dev": "run-p dev:*",

    "dev:routes": "remix-routes -w",

  }

}

```

## Usage

### Basic usage

```typescript

import type { ActionFunction } from 'remix';

import { redirect } from 'remix';

import { $path } from 'remix-routes'; // <-- Import magical $path helper from remix-routes.

export const action: ActionFunction = async ({ request }) => {

  let formData = await request.formData();

  const post = await createPost(formData);

  return redirect($path('/posts/:id', { id: post.id })); // <-- It's type safe.

};

```

### Appending query string:

```typescript

import { $path } from 'remix-routes';

$path('/posts/:id', { id: 6 }, { version: 18 }); // => /posts/6?version=18

$path('/posts', { limit: 10 }); // => /posts?limit=10

// You can pass any URLSearchParams init as param

$path('/posts/delete', [['id', 1], ['id', 2]]); // => /posts/delete?id=1&id=2

```

### Typed query string:

Define type of query string by exporting a type named `SearchParams` in route file:

```typescript

// app/routes/posts.tsx

export type SearchParams = {

  view: 'list' | 'grid',

  sort?: 'date' | 'views',

  page?: number,

}

```

```typescript

import { $path } from 'remix-routes';

// The query string is type-safe.

$path('/posts', { view: 'list', sort: 'date', page: 1 });

```

You can combine this feature with [zod](https://github.com/colinhacks/zod) and [remix-params-helper](https://github.com/kiliman/remix-params-helper) to add runtime params checking:

```typescript

import { z } from "zod";

import { getSearchParams } from "remix-params-helper";

const SearchParamsSchema = z.object({

  view: z.enum(["list", "grid"]),

  sort: z.enum(["price", "size"]).optional(),

  page: z.number().int().optional(),

})

export type SearchParams = z.infer;

export const loader = async (request) => {

  const result = getSearchParams(request, SearchParamsSchema)

  if (!result.success) {

    return json(result.errors, { status: 400 })

  }

  const { view, sort, page } = result.data;

}

```

### Checking params:

```typescript

import type { ActionFunction } from 'remix';

import { useParams } from "remix";

import { $params } from 'remix-routes'; // <-- Import $params helper.

export const action: ActionFunction = async ({ params }) => {

  const { id } = $params("/posts/:id/update", params) // <-- It's type safe, try renaming `id` param.

  // ...

}

export default function Component() {

  const params = useParams();

  const { id } = $params("/posts/:id/update", params);

  ...

}

```

### $routeId helper for useRouteLoaderData route ids

remix-routes exports the `RouteId` type definition with the list of all valid route ids for your repository, and has a helper function `$routeId` that tells typescript to restrict the given string to one of the valid RouteId values.

```typescript

import type { RouteId } from 'remix-routes';

import type { loader as postsLoader } from './_layout.tsx';

import { useRouteLoaderData } from '@remix-run/react';

import { $routeId } from 'remix-routes';

export default function Post() {

  const postList = useRouteLoaderData($routeId('routes/posts/_layout'));

```

## Command Line Options

- `-w`: Watch for changes and automatically rebuild.

- `-s`: Enale strict mode. In strict mode only routes that define `SearchParams` type are allowed to have query string.

- `-o`: Specify the output path for `remix-routes.d.ts`. Defaults to `./node_modules` if arg is not given.

## TypeScript Integration

A TypeScript plugin is available to help you navigate between route files.

### Installation

```bash

$ npm add -D typescript-remix-routes-plugin

```

### Setup

Add the plugin to your `tsconfig.json`:

```json

{

  "compilerOptions": {

    "plugins": [

      {

        "name": "typescript-remix-routes-plugin"

      }

    ]

  }

}

```

Select workspace version of TypeScript in VSCode:



## License

[MIT](LICENSE)