使用说明

以下是使用 RouterGenerator 类生成路由配置的步骤：

1. 引入依赖

首先，需要引入 RouterGenerator 类，以便能够使用生成路由配置的功能。可以使用以下代码将该类导入到你的项目中：

const RouterGenerator = require('./RouterGenerator');

2. 创建配置选项

接下来，需要创建一个配置选项对象，用于配置生成路由配置的相关参数。可以根据需要设置以下参数：

root (必需): 指定项目的根目录路径。
viewsPath (可选): 视图文件（Vue 文件）所在的路径，默认为 /src/views。
keyName (可选): 路由配置标识符，默认为 $$route。
cleanDir (可选): 是否清空输出目录，默认为 true。
outputDir (可选): 输出目录的路径，默认为 /src/router/auto。
outputFileName (可选): 输出文件的名称，默认为 index.js。
ignore (可选): 忽略的文件路径列表，默认为空数组。

以下是一个示例配置选项对象：

const options = {
  root: '/path/to/project', // 项目根目录路径
  viewsPath: '/src/views',  // 视图文件路径
  keyName: '$$route',       // 路由配置标识符
  cleanDir: true,           // 是否清空输出目录
  outputDir: '/src/router/auto', // 输出目录路径
  outputFileName: 'index.js',    // 输出文件名
  ignore: ['**/components/**'],  // 忽略的文件路径
};

3. 实例化 RouterGenerator 类

接下来，需要实例化 RouterGenerator 类，并将配置选项对象作为参数传入。示例如下：

const generator = new RouterGenerator(options);

4. 开始生成路由配置

调用 start 方法开始生成路由配置。该方法会根据配置选项中的参数，在指定的视图文件夹中查找所有的 Vue 文件，并根据文件中的路由配置生成路由对象。最后，会将生成的路由配置写入到输出文件中。

generator.start();

完整示例

以下是一个完整示例，展示了如何使用 RouterGenerator 类生成路由配置：

const RouterGenerator = require('./RouterGenerator');
const options = {
  root: '/path/to/project',
};
const generator = new RouterGenerator(options);
generator.start();

Auto Router

SongWenGuang