1.0.2 • Published 4 years ago

create-routes v1.0.2

Weekly downloads
-
License
ISC
Repository
-
Last release
4 years ago

create-routes

generate routes for nuxt pages.

Installation

npm install create-routes --save

Examples

This file tree:

pages/
--| _slug/
-----| comments.vue
-----| index.vue
--| user/
-----| index.vue
-----| one.vue
--| users/
-----| _id.vue
-----| index.vue
--| index.vue

will automatically generate:

[
  {
    "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

import createRoutes from 'create-routes'

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