vue-cli-plugin-http-proxy
v0.0.4
Published
Vue CLI server proxy
Downloads
38
Readme
vue-cli-plugin-auto-routing
Vue CLI plugin that provides auto routing feature.
Overview
Ensure you are in a project generated by Vue CLI >= v3. You install this plugin by running the following command:
# If you did not install router plugin yet
$ vue add router
# Install vue-cli-plugin-auto-routing
$ vue add auto-routing
After adding the plugin, the file structure will be the below.
src/
├── pages/
├── layouts/
└── router/
Pages
.vue
files under the pages/
directory will be automatically resolved to generate routing. Vue Router routes
options will be configured with the file structure under the pages/
. The generated routing is same with Nuxt's routing.
Note that directories and files started and ended with __
(two underscores, e.g. __foo__.vue
) will be ignored.
For example, when you have the following page components:
pages/
├── __partial__.vue
├── index.vue
├── users.vue
└── users/
└── _id.vue
It is resolved to the below routes. Note that _
prefixed components generate dynamic routing.
export default [
{
name: 'index',
path: '/',
component: () => import('@/pages/index.vue')
},
{
name: 'users',
path: '/users',
component: () => import('@/pages/users.vue'),
children: [
{
name: 'users-id',
path: ':id?',
component: () => import('@/pages/users/_id.vue')
}
]
}
]
If you want to make route param required, create a directory for the param and add index.vue
in the directory. In the above example, if you replace users/_id.vue
with users/_id/index.vue
, :id
param will be required.
<route>
custom block
If a page component has <route>
custom block, the content json will be merged with route config.
For example, if index.vue
has the following <route>
block:
<route>
{
"name": "home",
"meta": {
"requiresAuth": true
}
}
</route>
<template>
<h1>Hello</h1>
</template>
The generated route config is like the following:
module.exports = [
{
name: 'home',
path: '/',
component: () => import('@/pages/index.vue'),
meta: {
requiresAuth: true
}
}
]
Layouts
Components under the layouts/
directory will be used as shared layout component in the application. You can choose a layout by specifying layout
component option in a page component. The default value of layout
is 'default'
. That means when you omit layout
options, layouts/default.vue
will be choosed as the layout component. This is the same concept with Nuxt's layouts.
For example, when you have layouts/foo.vue
and pages/index.vue
:
<!-- layouts/foo.vue -->
<template>
<div>
<h1>Foo Layout</h1>
<router-view />
</div>
</template>
<!-- pages/index.vue -->
<template>
<p>index.vue</p>
</template>
<script>
export default {
// You can specify layout component name here (default value is 'default')
layout: 'foo'
}
</script>
The following html will be rendered:
<div>
<h1>Foo Layout</h1>
<p>index.vue</p>
</div>
Modifying Chunk Name
A chunk name from auto generated file can be conflicted with your code. You may see the below error log in that case:
ERROR Failed to compile with 1 errors
error in ./node_modules/vue-auto-routing/index.js
It's not allowed to load an initial chunk on demand. The chunk name "index" is already used by an entrypoint.
ERROR Build failed with errors.
error Command failed with exit code 1.
To avoid this error, you can set chunkNamePrefix
option to change the auto generated chunk name.
// vue.config.js
module.exports = {
pluginOptions: {
autoRouting: {
// Specify a prefix which will be added to all auto generated chunk name.
chunkNamePrefix: 'page-'
}
}
}
Options
You can specify options for this plugin under pluginOptions.autoRouting
in vue.config.js
. The options are simply passed to vue-auto-routing
options.
You can see the available options list here.
// vue.config.js
module.exports = {
pluginOptions: {
autoRouting: {
// Optionally specify a custom output file, relative to the project root
outFile: "src/router/routes.js",
// Specify other vue-auto-routing options here
nested: false
}
}
}
Related Projects
- vue-router-layout: Lightweight layout resolver for Vue Router.
- vue-auto-routing: Generate Vue Router routing automatically.
- vue-route-generator: Low-level utility generating routing (used by vue-auto-routing under the hood).
License
MIT