next-routes-list/README.md

generate next all routes list

# next-routes-list

Easy generate all available routes in Next.js .

## Support

- [x] App routes
- [x] Page routes

## Install

```bash
npm install --save-dev next-routes-list@latest
```

## Usage

### 1. Run script

add script to `package.json`:

```json
{
  "script": {
    "generate-next-routes-list": "generate-next-routes-list"
  }
}
```

If you use `src` directory:

```json
{
  "script": {
    "generate-next-routes-list": "cd src && npx generate-next-routes-list"
  }
}
```

then run npm script:

```shell
npm run generate-next-routes-list
```

### 2. Import routes

```ts
import { routes } from "next-routes-list";

console.log(routes);
/**
[
  '/',
  '/about',
  '/posts/[id]',
  ...
]
*/
```

## Options

| Option | Type   | Description                     | Example                                      |
| ------ | ------ | ------------------------------- | -------------------------------------------- |
| `-o`   | string | set the output routes file path | `npx generate-next-routes-list -o routes.ts` |

## Example

next projct is [here](./test/next-project/), generate result is: [here](./test/routes.js).

## Contribute

feel free to contribute anything or report any issues.