npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@triyanox/next-routes

v0.1.5

Published

You will never have broken links in your Next.js app again

Downloads

46

Readme

@triyanox/next-routes - Never worry about broken links in your Next.js app again!

@triyanox/next-routes is a powerful plugin for Next.js that ensures your application's links are always valid. It generates routes and utilities for your application, making link management a breeze.

Roadmap

  • [x] Support TypeScript out of the box
  • [x] Support Next.js 13+ app directory structure
  • [x] Generate routes and utilities for your application
  • [x] Support static routes (e.g. /about)
  • [x] Support dynamic routes (e.g. /[slug])
  • [x] Support route groups (e.g. (auth)/login)
  • [ ] Support catch-all routes (e.g. /[...slug])
  • [ ] Support optional catch-all routes (e.g. /[[...slug]])
  • [ ] more features coming soon...

Installation

Install @triyanox/next-routes using your favorite package manager:

# pnpm
pnpm add @triyanox/next-routes

# bun
bun add @triyanox/next-routes

# npm
npm i @triyanox/next-routes

# yarn
yarn add @triyanox/next-routes

Usage

Basic Setup

  1. In your next.config.js file, add the following:
import withRoutes from '@triyanox/next-routes';
// if you are using the `src` directory you can just
// wrap your config object with `withRoutes`

const config = withRoutes({
  //... your next config
});

export default config;
  1. Import link$ function from @/lib and use it in your components:
import link$ from '@/lib';
import Link from 'next/link';

const MyComponent = () => {
  return (
    <Link
      href={link$({
          path: '/[slug]',
          params: {
            slug: 'home',
          },
          hash: 'my-hash',
          query: {
            foo: 'bar',
          },
      })}
    >
      Home
    </Link>
  );
};
  1. Run your app and enjoy!

Advanced Setup

You can customize the behavior of @triyanox/next-routes by passing an options object to the withRoutes function. Here's an example:

import withRoutes from '@triyanox/next-routes';
import path from 'path';
import { cwd } from 'process';

// this is an example not using the `src` directory
const config = withRoutes(
  {
    //... your next config
  },
  {
    appDir: path.resolve(cwd(), './app'),
    declarationPath: path.resolve(
      cwd(),
      './node_modules/@types/next-routes/index.d.ts',
    ),
    utilsPath: path.resolve(cwd(), './lib/link.ts'),
  },
);

export default config;

In this example, the appDir, declarationPath, and utilsPath options are used to customize the behavior of @triyanox/next-routes.

Contributing

Contributions are welcome! Please read our contributing guidelines for more information.

License

This project is licensed under the MIT License - see the LICENSE file for details.