Aim of the loader

Let's say we have a vue project with router configuration bellow:

  [
    {
      path: '/module_1/page_1',
      component: component_11
    },
    {
      path: '/module_1/page_2',
      component: component_12
    },
    ...
    {
      path: '/module_1/page_n',
      component: component_1n
    },
    {
      path: '/module_2/page_1',
      component: component_21
    }
    {
      path: '/module_2/page_2',
      component: component_22
    },
    ...
    {
      path: '/module_2/page_n',
      component: component_2n
    }
  ]

We are now working on 'module_1', but every time we want to rebuild the project in development, we have to rebulid the 'module_2' as well, which wastes a lot of time. So we want to eliminate modules we don't care right now in development. This loader can help you with loader options bellow:

  options: {
    all: false,
    include: [
      'module_1'
    ]
  }

With the configuation, the loader will keep the router object whose path starts with 'module_1', and delete the rest . Obviously, the lesser router object, the shorter time cost in building.

install

npm install --save-dev router-cut-loader

Usage

webpack.config.js

module.exports = {
  module: {
    rules: [
      {
        test: /file\/to\/process/,
        loader: 'router-cut-loader',
        options: {
          all: false, // false or true
          include: [
            // first word in router path
            // ex: { path: '/detail/:id', component: '...' }
            // if you want to load this component, you should have "detail" written here
          ]
        }
      }
    ]
  }
}

options

name|type|default|description :---:|:--:|:---:|:--- all|Boolean|true|load all router components or not, if set to true, the include config below will be ignored. include|Array of string|[]|the item of the array is the first word of router path, if all is set to true, this will be ignored. printPath|String|''|Absolute path to print out the router configuration after shifting, file name must be contained in the path. Not required. showTimeCost|Boolean|false|Print out milliseconds the loader cost. Not required.

notice

1. Be aware that this loader is only aimed at improving development efficiency, so use this loader only in development environment.