@uni-helper/vite-plugin-uni-pages 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 KeJun <https://github.com/kejunmao>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,9 @@
+# @uni-helper/vite-plugin-uni-pages
+
+**WIP** File system based routing for uni-app applications using Vite
+
+## TODO
+
+- [ ] only update change page
+- [ ] middleware
+- [ ] pages [type](./src/config/types.ts)

package/dist/index.cjs

@@ -0,0 +1,156 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const vite = require('vite');
+const unconfig = require('unconfig');
+const path = require('path');
+const fs = require('fs');
+const fg = require('fast-glob');
+const compilerDom = require('@vue/compiler-dom');
+const jsoncParser = require('jsonc-parser');
+const defu = require('defu');
+
+const isPagePath = (path$1, options) => {
+  const dirPath = path.resolve(process.cwd(), options.pagesDir);
+  const filter = vite.createFilter(dirPath + "/**/*.(vue|nvue)");
+  return filter(path$1);
+};
+
+function definePages(config) {
+  return config;
+}
+
+function defineMiddleware(middleware) {
+  return middleware;
+}
+
+function resolveOptions(userOptions) {
+  return {
+    pagesDir: "src/pages",
+    outDir: "src",
+    entry: "pages.config",
+    extension: "ts",
+    ...userOptions
+  };
+}
+const loadUserPagesConfig = async (options) => {
+  const { config } = await unconfig.loadConfig({
+    sources: [
+      {
+        files: options.entry,
+        extensions: [options.extension]
+      }
+    ],
+    merge: false
+  });
+  return config;
+};
+const scanPages = async (options) => {
+  const files = await fg("**/*.(vue|nvue)", {
+    ignore: ["node_modules", ".git", "**/__*__/*"],
+    onlyFiles: true,
+    cwd: path.resolve(process.cwd(), options.pagesDir)
+  });
+  const basePath = path.relative(
+    path.resolve(process.cwd(), options.outDir),
+    options.pagesDir
+  );
+  return files.map((file) => {
+    return {
+      relative: vite.normalizePath(path.join(basePath, file)),
+      absolute: vite.normalizePath(path.resolve(process.cwd(), options.pagesDir, file))
+    };
+  });
+};
+const parsePage = async ({
+  relative: relative2,
+  absolute
+}) => {
+  const code = await fs.promises.readFile(absolute, {
+    encoding: "utf-8"
+  });
+  const t = compilerDom.parse(code);
+  const path$1 = relative2.replace(path.extname(relative2), "");
+  let pageMeta = {
+    path: path$1,
+    type: "page"
+  };
+  t?.children.forEach((v) => {
+    if (v.type !== 1) {
+      return;
+    }
+    if (v.tag === "route") {
+      v.props.forEach((prop) => {
+        if (prop.type === 6 && prop.name === "type") {
+          pageMeta.type = prop.value?.content ?? pageMeta.type;
+        }
+      });
+      const astContent = v.children?.[0];
+      if (astContent && astContent.type === 2) {
+        const _pageMeta = jsoncParser.parse(astContent.content);
+        Object.keys(_pageMeta).forEach((key) => {
+          pageMeta[key] = _pageMeta[key];
+        });
+        pageMeta["path"] = path$1;
+      }
+    }
+  });
+  return pageMeta;
+};
+const createOrUpdatePagesJSON = async (options, path$1) => {
+  const outputName = "pages.json";
+  const resolvedOutput = vite.normalizePath(
+    path.resolve(process.cwd(), options.outDir, outputName)
+  );
+  if (!fs.existsSync(resolvedOutput)) {
+    fs.writeFileSync(resolvedOutput, "{}", {
+      encoding: "utf-8"
+    });
+  }
+  const config = await loadUserPagesConfig(options);
+  const pagesPathList = await scanPages(options);
+  const pagesMeta = await Promise.all(
+    pagesPathList.map(async (page) => await parsePage(page))
+  );
+  const pages = Object.values(defu.defu({}, pagesMeta, config.pages));
+  pages.sort((a) => a.type === "home" ? -1 : 0);
+  config.pages = pages;
+  fs.writeFileSync(resolvedOutput, JSON.stringify(config), {
+    encoding: "utf-8"
+  });
+};
+const VitePluginUniPages = async (userOptions = {}) => {
+  const options = resolveOptions(userOptions);
+  const pagesConfigSource = vite.normalizePath(
+    path.resolve(process.cwd(), `${options.entry}.${options.extension}`)
+  );
+  await createOrUpdatePagesJSON(options);
+  return {
+    name: "vite-plugin-uni-pages",
+    enforce: "pre",
+    configureServer({ watcher }) {
+      watcher.add(pagesConfigSource);
+      watcher.on("change", async (path) => {
+        if (vite.normalizePath(path) === pagesConfigSource || isPagePath(path, options)) {
+          await createOrUpdatePagesJSON(options);
+        }
+      });
+      watcher.on("add", async (path) => {
+        if (isPagePath(path, options)) {
+          await createOrUpdatePagesJSON(options);
+        }
+      });
+      watcher.on("unlink", async (path) => {
+        if (isPagePath(path, options)) {
+          await createOrUpdatePagesJSON(options);
+        }
+      });
+    }
+  };
+};
+
+exports.VitePluginUniPages = VitePluginUniPages;
+exports.default = VitePluginUniPages;
+exports.defineMiddleware = defineMiddleware;
+exports.definePages = definePages;

package/dist/index.d.ts

@@ -0,0 +1,53 @@
+import { Plugin } from 'vite';
+
+interface Options {
+    /**
+     * pages dir
+     * @default "src/pages"
+     */
+    pagesDir: string;
+    /**
+     * pages.json dir
+     * @default "src"
+     */
+    outDir: string;
+    /**
+     * pages config entry
+     * @default "pages.config"
+     */
+    entry: string;
+    /**
+     * pages config extension
+     * @default "ts"
+     */
+    extension: string;
+}
+interface UserOptions extends Partial<Options> {
+}
+
+interface PagesConfig {
+    pages: any;
+    globalStyle: any;
+    easycom: any;
+    tabBar: any;
+    condition: any;
+    subPackages: any;
+    preloadRule: any;
+    workers: any;
+    leftWindow: any;
+    topWindow: any;
+    rightWindow: any;
+    uniIdRouter: any;
+}
+interface UserPagesConfig extends Partial<PagesConfig> {
+}
+
+declare function definePages(config: UserPagesConfig): UserPagesConfig;
+
+declare type Middleware = (to: string, from: string) => void | boolean | string;
+
+declare function defineMiddleware(middleware: Middleware): Middleware;
+
+declare const VitePluginUniPages: (userOptions?: UserOptions) => Promise<Plugin>;
+
+export { Middleware, PagesConfig, UserPagesConfig, VitePluginUniPages, VitePluginUniPages as default, defineMiddleware, definePages };

package/dist/index.mjs

@@ -0,0 +1,149 @@
+import { createFilter, normalizePath } from 'vite';
+import { loadConfig } from 'unconfig';
+import { resolve, relative, join, extname } from 'path';
+import fs from 'fs';
+import fg from 'fast-glob';
+import { parse } from '@vue/compiler-dom';
+import { parse as parse$1 } from 'jsonc-parser';
+import { defu } from 'defu';
+
+const isPagePath = (path, options) => {
+  const dirPath = resolve(process.cwd(), options.pagesDir);
+  const filter = createFilter(dirPath + "/**/*.(vue|nvue)");
+  return filter(path);
+};
+
+function definePages(config) {
+  return config;
+}
+
+function defineMiddleware(middleware) {
+  return middleware;
+}
+
+function resolveOptions(userOptions) {
+  return {
+    pagesDir: "src/pages",
+    outDir: "src",
+    entry: "pages.config",
+    extension: "ts",
+    ...userOptions
+  };
+}
+const loadUserPagesConfig = async (options) => {
+  const { config } = await loadConfig({
+    sources: [
+      {
+        files: options.entry,
+        extensions: [options.extension]
+      }
+    ],
+    merge: false
+  });
+  return config;
+};
+const scanPages = async (options) => {
+  const files = await fg("**/*.(vue|nvue)", {
+    ignore: ["node_modules", ".git", "**/__*__/*"],
+    onlyFiles: true,
+    cwd: resolve(process.cwd(), options.pagesDir)
+  });
+  const basePath = relative(
+    resolve(process.cwd(), options.outDir),
+    options.pagesDir
+  );
+  return files.map((file) => {
+    return {
+      relative: normalizePath(join(basePath, file)),
+      absolute: normalizePath(resolve(process.cwd(), options.pagesDir, file))
+    };
+  });
+};
+const parsePage = async ({
+  relative: relative2,
+  absolute
+}) => {
+  const code = await fs.promises.readFile(absolute, {
+    encoding: "utf-8"
+  });
+  const t = parse(code);
+  const path = relative2.replace(extname(relative2), "");
+  let pageMeta = {
+    path,
+    type: "page"
+  };
+  t?.children.forEach((v) => {
+    if (v.type !== 1) {
+      return;
+    }
+    if (v.tag === "route") {
+      v.props.forEach((prop) => {
+        if (prop.type === 6 && prop.name === "type") {
+          pageMeta.type = prop.value?.content ?? pageMeta.type;
+        }
+      });
+      const astContent = v.children?.[0];
+      if (astContent && astContent.type === 2) {
+        const _pageMeta = parse$1(astContent.content);
+        Object.keys(_pageMeta).forEach((key) => {
+          pageMeta[key] = _pageMeta[key];
+        });
+        pageMeta["path"] = path;
+      }
+    }
+  });
+  return pageMeta;
+};
+const createOrUpdatePagesJSON = async (options, path) => {
+  const outputName = "pages.json";
+  const resolvedOutput = normalizePath(
+    resolve(process.cwd(), options.outDir, outputName)
+  );
+  if (!fs.existsSync(resolvedOutput)) {
+    fs.writeFileSync(resolvedOutput, "{}", {
+      encoding: "utf-8"
+    });
+  }
+  const config = await loadUserPagesConfig(options);
+  const pagesPathList = await scanPages(options);
+  const pagesMeta = await Promise.all(
+    pagesPathList.map(async (page) => await parsePage(page))
+  );
+  const pages = Object.values(defu({}, pagesMeta, config.pages));
+  pages.sort((a) => a.type === "home" ? -1 : 0);
+  config.pages = pages;
+  fs.writeFileSync(resolvedOutput, JSON.stringify(config), {
+    encoding: "utf-8"
+  });
+};
+const VitePluginUniPages = async (userOptions = {}) => {
+  const options = resolveOptions(userOptions);
+  const pagesConfigSource = normalizePath(
+    resolve(process.cwd(), `${options.entry}.${options.extension}`)
+  );
+  await createOrUpdatePagesJSON(options);
+  return {
+    name: "vite-plugin-uni-pages",
+    enforce: "pre",
+    configureServer({ watcher }) {
+      watcher.add(pagesConfigSource);
+      watcher.on("change", async (path) => {
+        if (normalizePath(path) === pagesConfigSource || isPagePath(path, options)) {
+          await createOrUpdatePagesJSON(options);
+        }
+      });
+      watcher.on("add", async (path) => {
+        if (isPagePath(path, options)) {
+          await createOrUpdatePagesJSON(options);
+        }
+      });
+      watcher.on("unlink", async (path) => {
+        if (isPagePath(path, options)) {
+          await createOrUpdatePagesJSON(options);
+        }
+      });
+    }
+  };
+};
+
+export { VitePluginUniPages, VitePluginUniPages as default, defineMiddleware, definePages };

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@uni-helper/vite-plugin-uni-pages",
+  "type": "module",
+  "version": "0.0.1",
+  "packageManager": "pnpm@7.14.0",
+  "description": "File system based routing for uni-app applications using Vite",
+  "author": "KeJun",
+  "license": "MIT",
+  "homepage": "https://github.com/uni-helper/vite-plugin-uni-pages#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/uni-helper/vite-plugin-uni-pages.git"
+  },
+  "bugs": "https://github.com/uni-helper/vite-plugin-uni-pages/issues",
+  "keywords": [],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "./dist/*",
+        "./dist/index.d.ts"
+      ]
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "unbuild",
+    "dev": "unbuild --stub",
+    "play": "nr -C playground dev:h5",
+    "prepublishOnly": "pnpm build",
+    "release": "bumpp && npm publish --access public",
+    "start": "esno src/index.ts",
+    "test": "vitest"
+  },
+  "devDependencies": {
+    "@types/node": "^18.11.9",
+    "bumpp": "^8.2.1",
+    "esno": "^0.16.3",
+    "typescript": "^4.8.4",
+    "unbuild": "^0.9.4",
+    "vite": "^3.2.3",
+    "vitest": "^0.24.5"
+  },
+  "dependencies": {
+    "@vue/compiler-dom": "^3.2.45",
+    "defu": "^6.1.0",
+    "fast-glob": "^3.2.12",
+    "jsonc-parser": "^3.2.0",
+    "unconfig": "^0.3.7"
+  }
+}