# create-routes

> generate routes for nuxt pages.

Latest version **1.0.2** (published 2020-10-14) · ISC license · 0 weekly downloads

## Install

```sh
npm install create-routes
pnpm add create-routes
yarn add create-routes
bun add create-routes
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2020-10-14 |
| First published | 2020-10-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 3.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | jaredwang |
| Maintainers | wongjorie |
| Keywords | router, vue, nuxt |

## Links

- npm: https://www.npmjs.com/package/create-routes
- npm.io page: https://npm.io/package/create-routes

## Dependencies (1)

- [require-context](https://npm.io/package/require-context.md) ^1.1.0

## Alternatives

- [express-promise-router](https://npm.io/package/express-promise-router.md) — 736.1K weekly downloads
- [next-usequerystate](https://npm.io/package/next-usequerystate.md) — 29.8K weekly downloads
- [@bitkyc08/opencodex](https://npm.io/package/@bitkyc08/opencodex.md) — 4.6K weekly downloads
- [lynkr](https://npm.io/package/lynkr.md) — 575 weekly downloads
- [baremetal.js](https://npm.io/package/baremetal.js.md) — 42 weekly downloads

## Recent versions

- 1.0.2 (latest) — 2020-10-14
- 1.0.1 — 2020-10-14
- 1.0.0 — 2020-10-14

## README

# create-routes

generate routes for nuxt pages.

## Installation

```bash
npm install create-routes --save
```

## Examples

This file tree:
```bash
pages/
--| _slug/
-----| comments.vue
-----| index.vue
--| user/
-----| index.vue
-----| one.vue
--| users/
-----| _id.vue
-----| index.vue
--| index.vue
```

will automatically generate:
```js
[
  {
    "path": "/:slug",
    "name": "slug",
    "component": "test/pages/_slug/index.vue",
    "children": [
      {
        "path": "/:slug/comments",
        "name": "comments",
        "component": "test/pages/_slug/comments.vue"
      }
    ]
  },
  {
    "path": "/",
    "name": "main",
    "component": "test/pages/index.vue"
  },
  {
    "path": "/user",
    "name": "user",
    "component": "test/pages/user/index.vue",
    "children": [
      {
        "path": "/user/one",
        "name": "one",
        "component": "test/pages/user/one.vue"
      }
    ]
  },
  {
    "path": "/users",
    "name": "users",
    "component": "test/pages/users/index.vue",
    "children": [
      {
        "path": "/users/:id",
        "name": "id",
        "component": "test/pages/users/_id.vue"
      }
    ]
  }
]
```


## Usage

```js
import createRoutes from 'create-routes'

const routes = createRoutes({
    rootDir: __dirname,
    pagesDir: 'test/pages'
})
```

---
_Source: https://npm.io/package/create-routes · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._