# uni-vite-read-pages

![npm](https://img.shields.io/badge/npm-v6.14.15-yellowgreen) ![yarn](https://img.shields.io/badge/yarn-v1.22.10-green) ![license](https://img.shields.io/badge/license-MIT-red) ![size](https://img.shields.io/badge/size-14.3kB-lightgrey)

通过 [vite.config.js](https://cn.vitejs.dev/config/) 配合此库，可以随心所欲的读取 `pages.json` 下的所有配置
## 声明
该库时基于 [uni-read-pages](https://github.com/SilurianYang/uni-read-pages) 二次封装，仅适用于使用vite创建的[uni-app](https://uniapp.dcloud.io/)项目,不适用于vue-cli创建的uni-app[uni-app](https://uniapp.dcloud.io/)项目!!!
## 安装

您可以使用 `Yarn` 或 `npm` 安装该软件包（选择一个）：

##### Yarn

```sh
yarn add uni-vite-read-pages
```
##### npm

```sh
npm install uni-vite-read-pages
```
## 开始
配置 `vite.config.js` 通过 `vite` 注入全局变量

#### 配置 `vite.config.js`
```js
//vite.config.js
import TransformPages from "uni-vite-read-pages";
const r = new TransformPages(
  {
    includes: ["meta", "path", "aliasPath", "name"],
  },
  "./src"
);
// https://vitejs.dev/config/
export default defineConfig({
  define: {
    ROUTES: r.routes,
  },
});

```
#### 配置 `types.d.ts` (不使用typescript,请忽略这步)
```ts
//type.d.ts
declare const ROUTES: [];
```

借助`define` 轻松注入全局变量。`ROUTES` 及可全局使用

#### 使用
```js
// xxx.vue
<script>
export default {
    data() {
        return {
            title: 'Hello'
        }
    },
    onLoad() {
        console.log(ROUTES)
    },
}
</script>
```