refactor: a huge update

.github/workflows/release.yml

@@ -9,17 +9,17 @@ jobs:
   release:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
       - name: Install pnpm
-        uses: pnpm/action-setup@v2
+        uses: pnpm/action-setup@v3
 
       - name: Set node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 16.x
+          node-version-file: .nvmrc
           cache: pnpm
           registry-url: 'https://registry.npmjs.org'
 
@@ -31,7 +31,10 @@ jobs:
       - name: Install Dependencies
         run: pnpm i
 
+      - name: PNPM build
+        run: pnpm run build
+
       - name: Publish to NPM
-        run: pnpm publish --access public --no-git-checks
+        run: pnpm -r publish --access public --no-git-checks
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.gitignore

@@ -9,5 +9,3 @@ lib-cov
 logs
 node_modules
 temp
-
-manifest.json

.nvmrc

@@ -0,0 +1 @@
+20

.vscode/settings.json

@@ -1,53 +1,31 @@
 {
   // Enable the ESlint flat config support
   "eslint.experimental.useFlatConfig": true,
+
   // Disable the default formatter, use eslint instead
   "prettier.enable": false,
   "editor.formatOnSave": false,
+
   // Auto fix
   "editor.codeActionsOnSave": {
-    "source.fixAll": "explicit",
+    "source.fixAll.eslint": "explicit",
     "source.organizeImports": "never"
   },
+
   // Silent the stylistic rules in you IDE, but still auto fix them
   "eslint.rules.customizations": [
-    {
-      "rule": "style/*",
-      "severity": "off"
-    },
-    {
-      "rule": "*-indent",
-      "severity": "off"
-    },
-    {
-      "rule": "*-spacing",
-      "severity": "off"
-    },
-    {
-      "rule": "*-spaces",
-      "severity": "off"
-    },
-    {
-      "rule": "*-order",
-      "severity": "off"
-    },
-    {
-      "rule": "*-dangle",
-      "severity": "off"
-    },
-    {
-      "rule": "*-newline",
-      "severity": "off"
-    },
-    {
-      "rule": "*quotes",
-      "severity": "off"
-    },
-    {
-      "rule": "*semi",
-      "severity": "off"
-    }
+    { "rule": "style/*", "severity": "off" },
+    { "rule": "format/*", "severity": "off" },
+    { "rule": "*-indent", "severity": "off" },
+    { "rule": "*-spacing", "severity": "off" },
+    { "rule": "*-spaces", "severity": "off" },
+    { "rule": "*-order", "severity": "off" },
+    { "rule": "*-dangle", "severity": "off" },
+    { "rule": "*-newline", "severity": "off" },
+    { "rule": "*quotes", "severity": "off" },
+    { "rule": "*semi", "severity": "off" }
   ],
+
   // Enable eslint for all supported languages
   "eslint.validate": [
     "javascript",
@@ -59,6 +37,7 @@
     "markdown",
     "json",
     "jsonc",
-    "yaml"
+    "yaml",
+    "toml"
   ]
 }

bump.config.ts

@@ -0,0 +1,9 @@
+import { defineConfig } from 'bumpp'
+
+export default defineConfig({
+  files: [
+    'package.json',
+    'packages/core/package.json',
+    'packages/schema/package.json',
+  ],
+})

package.json

@@ -2,7 +2,8 @@
   "name": "@uni-helper/vite-plugin-uni-manifest",
   "type": "module",
   "version": "0.2.3",
-  "packageManager": "[email protected]",
+  "private": true,
+  "packageManager": "[email protected]",
   "description": "Use TypeScript to write manifest.json of uni-app",
   "author": "KeJun",
   "license": "MIT",
@@ -14,47 +15,26 @@
   "bugs": "https://github.com/uni-helper/vite-plugin-uni-manifest/issues",
   "keywords": [],
   "sideEffects": false,
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./dist/index.d.mts",
-        "default": "./dist/index.mjs"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
-    }
-  },
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
   "scripts": {
-    "build": "unbuild",
-    "dev": "unbuild --stub",
-    "play": "nr -C playground dev:h5",
+    "stub": "pnpm -r --filter=./packages/* --parallel run stub",
+    "dev": "pnpm stub",
+    "build": "rimraf --glob packages/*/dist && pnpm -r --filter=./packages/* run build && pnpm -r run build-post",
+    "play:mp-weixin": "pnpm dev && npm -C packages/playground run dev:mp-weixin",
+    "build:mp-weixin": "pnpm build && npm -C packages/playground run build:mp-weixin",
+    "play:h5": "pnpm dev && npm -C packages/playground run dev:h5",
+    "build:h5": "pnpm build && npm -C packages/playground run build:h5",
     "prepublishOnly": "pnpm build",
     "release": "bumpp",
-    "start": "esno src/index.ts",
-    "test": "vitest",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix"
   },
-  "dependencies": {
-    "c12": "^1.4.2",
-    "type-fest": "^4.4.0"
-  },
   "devDependencies": {
-    "@antfu/eslint-config": "1.0.0-beta.25",
-    "@types/node": "^18.18.4",
-    "bumpp": "^9.2.0",
-    "eslint": "^8.51.0",
-    "esno": "^0.17.0",
-    "typescript": "^5.2.2",
-    "unbuild": "^2.0.0",
-    "vite": "^4.4.11"
+    "@antfu/eslint-config": "^2.16.0",
+    "@types/node": "^20.12.7",
+    "bumpp": "^9.4.1",
+    "eslint": "^8.57.0",
+    "rimraf": "^5.0.5",
+    "typescript": "^5.4.5",
+    "unbuild": "^2.0.0"
   }
 }

packages/core/README.md

@@ -0,0 +1,136 @@
+# @uni-helper/vite-plugin-uni-pages
+
+File system-based routing for uni-app applications using Vite.
+
+<a href="https://www.npmjs.com/package/@uni-helper/vite-plugin-uni-pages"><img src="https://img.shields.io/npm/v/@uni-helper/vite-plugin-uni-pages" alt="NPM version"></a></p>
+
+English | [简体中文](./README.Zh-CN.md)
+
+## Installation
+
+```bash
+pnpm i -D @uni-helper/vite-plugin-uni-pages
+```
+
+## Usage
+
+```ts
+// vite.config.ts
+import { defineConfig } from 'vite'
+import Uni from '@dcloudio/vite-plugin-uni'
+import UniPages from '@uni-helper/vite-plugin-uni-pages'
+
+// It is recommended to put it in front of Uni
+export default defineConfig({
+  plugins: [UniPages(), Uni()],
+})
+```
+
+Define global properties in `pages.config.(ts|mts|cts|js|cjs|mjs|json)`, You can use like `#ifdef H5` in the file.
+
+```ts
+// pages.config.ts
+import { defineUniPages } from '@uni-helper/vite-plugin-uni-pages'
+
+export default defineUniPages({
+  // You can also define pages fields, which have the highest priority.priority.
+  pages: [],
+  globalStyle: {
+    navigationBarTextStyle: 'black',
+    navigationBarTitleText: '@uni-helper',
+  },
+})
+```
+
+Now all pages will be found automatically!
+
+### SFC custom block for Route Data
+
+Add route meta to the route by adding a `<route>` block to the SFC. This will be
+directly added to the route after it is generated, and will override it.
+
+You can specific a parser to use using `<route lang="yaml">`, or set a default
+parser using `routeBlockLang` option.
+
+- **Supported parser:** JSON, JSON5, YAML
+- **Default:** JSON5
+
+```html
+<!-- index.vue -->
+<!-- use type to set index -->
+<route type="home">
+{
+  "style": { "navigationBarTitleText": "@uni-helper" }
+}
+</route>
+
+<!-- other.vue -->
+<route lang="yaml">
+style:
+  navigationBarTitleText: "@uni-helper"
+</route>
+```
+
+Import the virtual module to access the metadata of all pages
+
+```ts
+/// <reference types="@uni-helper/vite-plugin-uni-pages/client" />
+import { pages } from 'virtual:uni-pages'
+
+console.log(pages)
+```
+
+## Configuration
+
+```ts
+export interface Options {
+  /**
+   * Whether to scan and merge pages in pages.json
+   * @default true
+   */
+  mergePages: boolean
+
+  /**
+   * Paths to the directory to search for page components.
+   * @default 'src/pages'
+   */
+  dir: string
+
+  /**
+   * pages.json dir
+   * @default "src"
+   */
+  outDir: string
+
+  /**
+   * exclude page
+   * @default []
+   */
+  exclude: string[]
+
+  /**
+   * Set the default route block parser, or use `<route lang="xxx">` in SFC route block
+   * @default 'json5'
+   */
+  routeBlockLang: 'json5' | 'json' | 'yaml' | 'yml'
+
+  onBeforeLoadUserConfig: (ctx: PageContext) => void
+  onAfterLoadUserConfig: (ctx: PageContext) => void
+  onBeforeScanPages: (ctx: PageContext) => void
+  onAfterScanPages: (ctx: PageContext) => void
+  onBeforeMergePageMetaData: (ctx: PageContext) => void
+  onAfterMergePageMetaData: (ctx: PageContext) => void
+  onBeforeWriteFile: (ctx: PageContext) => void
+  onAfterWriteFile: (ctx: PageContext) => void
+}
+```
+
+## TODO
+
+- [x] only update the changed page
+- [x] [vite-plugin-uni-middleware](https://github.com/uni-helper/vite-plugin-uni-middleware)
+- [x] pages [type](./src/config/types.ts)
+
+## Acknowledgement
+
+- [vite-plugin-pages](https://github.com/hannoeru/vite-plugin-pages.git)

build.config.ts → packages/core/build.config.ts

@@ -6,7 +6,6 @@ export default defineBuildConfig({
   clean: true,
   rollup: {
     emitCJS: true,
+    inlineDependencies: true,
   },
-  failOnWarn: false,
-  externals: ['vite'],
 })

packages/core/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@uni-helper/vite-plugin-uni-manifest",
+  "type": "module",
+  "version": "0.2.18",
+  "description": "File system based routing for uni-app applications using Vite",
+  "author": "KeJun",
+  "license": "MIT",
+  "homepage": "https://github.com/uni-helper/vite-plugin-uni-manifest#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/uni-helper/vite-plugin-uni-manifest.git"
+  },
+  "bugs": "https://github.com/uni-helper/vite-plugin-uni-manifest/issues",
+  "keywords": [],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "unbuild",
+    "stub": "unbuild --stub"
+  },
+  "peerDependencies": {
+    "vite": "^4.0.0 || ^5.0.0"
+  },
+  "dependencies": {
+    "c12": "^1.10.0"
+  },
+  "devDependencies": {
+    "vite": "^5.2.10"
+  }
+}