@uni-helper/vite-plugin-uni-pages 0.3.0 → 0.3.2

package/README.md

@@ -112,7 +112,7 @@ export interface Options {
    * Set the default route block parser, or use `<route lang="xxx">` in SFC route block
    * @default 'json5'
    */
-  routeBlockLang: 'json5' | 'json' | 'yaml' | 'yml'
+  routeBlockLang: 'json5' | 'jsonc' | 'json' | 'yaml' | 'yml'
 
   onBeforeLoadUserConfig: (ctx: PageContext) => void
   onAfterLoadUserConfig: (ctx: PageContext) => void

package/dist/index.cjs

@@ -13,6 +13,7 @@ const Debug = require('debug');
 const uniEnv = require('@uni-helper/uni-env');
 const detectIndent = require('detect-indent');
 const detectNewline = require('detect-newline');
+const commentJson = require('comment-json');
 const fs = require('node:fs');
 const promises = require('node:fs/promises');
 const groupBy = require('lodash.groupby');
@@ -111,12 +112,21 @@ function parseCustomBlock(block, filePath, options) {
   };
   let content;
   debug.routeBlock(`use ${lang} parser`);
-  if (lang === "json5" || lang === "jsonc") {
+  if (lang === "json5") {
     try {
       content = JSON5__default.parse(block.content);
     } catch (err) {
       throw new Error(
         `Invalid JSON5 format of <${block.type}> content in ${filePath}
+${err.message}`
+      );
+    }
+  } else if (lang === "jsonc") {
+    try {
+      content = commentJson.parse(block.content);
+    } catch (err) {
+      throw new Error(
+        `Invalid JSONC format of <${block.type}> content in ${filePath}
 ${err.message}`
       );
     }
@@ -206,12 +216,12 @@ function useCachedPages() {
     };
   }
   function setCache(filePath, routeBlock) {
-    pages.set(filePath, JSON.stringify(parseData(routeBlock)));
+    pages.set(filePath, commentJson.stringify(parseData(routeBlock)));
   }
   async function hasChanged(filePath, routeBlock) {
     if (!routeBlock)
       routeBlock = await getRouteSfcBlock(vite.normalizePath(filePath));
-    return !pages.has(filePath) || JSON.stringify(parseData(routeBlock)) !== pages.get(filePath);
+    return !pages.has(filePath) || commentJson.stringify(parseData(routeBlock)) !== pages.get(filePath);
   }
   return {
     setCache,
@@ -302,7 +312,7 @@ function getPageFiles(path, options) {
 }
 function checkPagesJsonFile(path) {
   if (!fs__default.existsSync(path)) {
-    writeFileSync(path, JSON.stringify({ pages: [{ path: "" }] }, null, 2));
+    writeFileSync(path, commentJson.stringify({ pages: [{ path: "" }] }, null, 2));
     return false;
   }
   return true;
@@ -457,7 +467,7 @@ class PageContext {
       type: routeBlock?.attr.type ?? "page"
     };
     if (routeBlock)
-      Object.assign(pageMetaDatum, routeBlock.content);
+      commentJson.assign(pageMetaDatum, routeBlock.content);
     return pageMetaDatum;
   }
   /**
@@ -544,7 +554,10 @@ class PageContext {
     await this.mergeSubPageMetaData();
     this.options.onAfterMergePageMetaData(this);
     const pagesMap = /* @__PURE__ */ new Map();
-    const pages = this.withUniPlatform ? this.pageMetaData.filter((v) => !/\..*$/.test(v.path) || v.path.includes(uniEnv.platform)).map((v) => ({ ...v, path: v.path.replace(/\..*$/, "") })) : this.pageMetaData;
+    const pages = this.withUniPlatform ? this.pageMetaData.filter((v) => !/\..*$/.test(v.path) || v.path.includes(uniEnv.platform)).map((v) => {
+      v.path = v.path.replace(/\..*$/, "");
+      return v;
+    }) : this.pageMetaData;
     pages.forEach((v) => pagesMap.set(v.path, v));
     this.pageMetaData = [...pagesMap.values()];
     this.options.onBeforeWriteFile(this);
@@ -553,7 +566,7 @@ class PageContext {
       pages: this.pageMetaData,
       subPackages: this.subPageMetaData
     };
-    const pagesJson = JSON.stringify(
+    const pagesJson = commentJson.stringify(
       data,
       null,
       this.options.minify ? void 0 : this.resolvedPagesJSONIndent
@@ -574,10 +587,10 @@ class PageContext {
     return [pages, subPackages].join("\n");
   }
   resolveRoutes() {
-    return JSON.stringify(this.pageMetaData, null, 2);
+    return commentJson.stringify(this.pageMetaData, null, 2);
   }
   resolveSubRoutes() {
-    return JSON.stringify(this.subPageMetaData, null, 2);
+    return commentJson.stringify(this.subPageMetaData, null, 2);
   }
   generateDeclaration() {
     if (!this.options.dts)

package/dist/index.d.cts

@@ -1,5 +1,6 @@
 import { Logger, ViteDevServer, Plugin } from 'vite';
 import { LoadConfigSource } from 'unconfig';
+import { CommentJSONValue } from 'comment-json';
 import { FSWatcher } from 'chokidar';
 import Debug from 'debug';
 import { SFCBlock, SFCDescriptor } from '@vue/compiler-sfc';
@@ -2995,7 +2996,7 @@ declare function useCachedPages(): {
 
 interface CustomBlock {
     attr: Record<string, any>;
-    content: Record<string, any>;
+    content: Record<string, any> | CommentJSONValue;
 }
 type debugType = keyof typeof debug;
 type ConfigSource = string | LoadConfigSource<PagesConfig> | LoadConfigSource<PagesConfig>[];
@@ -3048,7 +3049,7 @@ interface Options {
      * Set the default route block parser, or use `<route lang="xxx">` in SFC route block
      * @default 'json5'
      */
-    routeBlockLang: 'json5' | 'json' | 'yaml' | 'yml';
+    routeBlockLang: 'json5' | 'jsonc' | 'json' | 'yaml' | 'yml';
     /**
      * minify the `pages.json`
      * @default false

package/dist/index.d.mts

@@ -1,5 +1,6 @@
 import { Logger, ViteDevServer, Plugin } from 'vite';
 import { LoadConfigSource } from 'unconfig';
+import { CommentJSONValue } from 'comment-json';
 import { FSWatcher } from 'chokidar';
 import Debug from 'debug';
 import { SFCBlock, SFCDescriptor } from '@vue/compiler-sfc';
@@ -2995,7 +2996,7 @@ declare function useCachedPages(): {
 
 interface CustomBlock {
     attr: Record<string, any>;
-    content: Record<string, any>;
+    content: Record<string, any> | CommentJSONValue;
 }
 type debugType = keyof typeof debug;
 type ConfigSource = string | LoadConfigSource<PagesConfig> | LoadConfigSource<PagesConfig>[];
@@ -3048,7 +3049,7 @@ interface Options {
      * Set the default route block parser, or use `<route lang="xxx">` in SFC route block
      * @default 'json5'
      */
-    routeBlockLang: 'json5' | 'json' | 'yaml' | 'yml';
+    routeBlockLang: 'json5' | 'jsonc' | 'json' | 'yaml' | 'yml';
     /**
      * minify the `pages.json`
      * @default false

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { Logger, ViteDevServer, Plugin } from 'vite';
 import { LoadConfigSource } from 'unconfig';
+import { CommentJSONValue } from 'comment-json';
 import { FSWatcher } from 'chokidar';
 import Debug from 'debug';
 import { SFCBlock, SFCDescriptor } from '@vue/compiler-sfc';
@@ -2995,7 +2996,7 @@ declare function useCachedPages(): {
 
 interface CustomBlock {
     attr: Record<string, any>;
-    content: Record<string, any>;
+    content: Record<string, any> | CommentJSONValue;
 }
 type debugType = keyof typeof debug;
 type ConfigSource = string | LoadConfigSource<PagesConfig> | LoadConfigSource<PagesConfig>[];
@@ -3048,7 +3049,7 @@ interface Options {
      * Set the default route block parser, or use `<route lang="xxx">` in SFC route block
      * @default 'json5'
      */
-    routeBlockLang: 'json5' | 'json' | 'yaml' | 'yml';
+    routeBlockLang: 'json5' | 'jsonc' | 'json' | 'yaml' | 'yml';
     /**
      * minify the `pages.json`
      * @default false

package/dist/index.mjs

@@ -9,11 +9,12 @@ import Debug from 'debug';
 import { platform } from '@uni-helper/uni-env';
 import detectIndent from 'detect-indent';
 import detectNewline from 'detect-newline';
+import { parse as parse$1, stringify, assign } from 'comment-json';
 import fs, { existsSync } from 'node:fs';
 import { readFile, mkdir, writeFile as writeFile$1 } from 'node:fs/promises';
 import groupBy from 'lodash.groupby';
 import JSON5 from 'json5';
-import { parse as parse$1 } from 'yaml';
+import { parse as parse$2 } from 'yaml';
 import { parse } from '@vue/compiler-sfc';
 import fg from 'fast-glob';
 
@@ -93,12 +94,21 @@ function parseCustomBlock(block, filePath, options) {
   };
   let content;
   debug.routeBlock(`use ${lang} parser`);
-  if (lang === "json5" || lang === "jsonc") {
+  if (lang === "json5") {
     try {
       content = JSON5.parse(block.content);
     } catch (err) {
       throw new Error(
         `Invalid JSON5 format of <${block.type}> content in ${filePath}
+${err.message}`
+      );
+    }
+  } else if (lang === "jsonc") {
+    try {
+      content = parse$1(block.content);
+    } catch (err) {
+      throw new Error(
+        `Invalid JSONC format of <${block.type}> content in ${filePath}
 ${err.message}`
       );
     }
@@ -113,7 +123,7 @@ ${err.message}`
     }
   } else if (lang === "yaml" || lang === "yml") {
     try {
-      content = parse$1(block.content);
+      content = parse$2(block.content);
     } catch (err) {
       throw new Error(
         `Invalid YAML format of <${block.type}> content in ${filePath}
@@ -188,12 +198,12 @@ function useCachedPages() {
     };
   }
   function setCache(filePath, routeBlock) {
-    pages.set(filePath, JSON.stringify(parseData(routeBlock)));
+    pages.set(filePath, stringify(parseData(routeBlock)));
   }
   async function hasChanged(filePath, routeBlock) {
     if (!routeBlock)
       routeBlock = await getRouteSfcBlock(normalizePath(filePath));
-    return !pages.has(filePath) || JSON.stringify(parseData(routeBlock)) !== pages.get(filePath);
+    return !pages.has(filePath) || stringify(parseData(routeBlock)) !== pages.get(filePath);
   }
   return {
     setCache,
@@ -284,7 +294,7 @@ function getPageFiles(path, options) {
 }
 function checkPagesJsonFile(path) {
   if (!fs.existsSync(path)) {
-    writeFileSync(path, JSON.stringify({ pages: [{ path: "" }] }, null, 2));
+    writeFileSync(path, stringify({ pages: [{ path: "" }] }, null, 2));
     return false;
   }
   return true;
@@ -439,7 +449,7 @@ class PageContext {
       type: routeBlock?.attr.type ?? "page"
     };
     if (routeBlock)
-      Object.assign(pageMetaDatum, routeBlock.content);
+      assign(pageMetaDatum, routeBlock.content);
     return pageMetaDatum;
   }
   /**
@@ -526,7 +536,10 @@ class PageContext {
     await this.mergeSubPageMetaData();
     this.options.onAfterMergePageMetaData(this);
     const pagesMap = /* @__PURE__ */ new Map();
-    const pages = this.withUniPlatform ? this.pageMetaData.filter((v) => !/\..*$/.test(v.path) || v.path.includes(platform)).map((v) => ({ ...v, path: v.path.replace(/\..*$/, "") })) : this.pageMetaData;
+    const pages = this.withUniPlatform ? this.pageMetaData.filter((v) => !/\..*$/.test(v.path) || v.path.includes(platform)).map((v) => {
+      v.path = v.path.replace(/\..*$/, "");
+      return v;
+    }) : this.pageMetaData;
     pages.forEach((v) => pagesMap.set(v.path, v));
     this.pageMetaData = [...pagesMap.values()];
     this.options.onBeforeWriteFile(this);
@@ -535,7 +548,7 @@ class PageContext {
       pages: this.pageMetaData,
       subPackages: this.subPageMetaData
     };
-    const pagesJson = JSON.stringify(
+    const pagesJson = stringify(
       data,
       null,
       this.options.minify ? void 0 : this.resolvedPagesJSONIndent
@@ -556,10 +569,10 @@ class PageContext {
     return [pages, subPackages].join("\n");
   }
   resolveRoutes() {
-    return JSON.stringify(this.pageMetaData, null, 2);
+    return stringify(this.pageMetaData, null, 2);
   }
   resolveSubRoutes() {
-    return JSON.stringify(this.subPageMetaData, null, 2);
+    return stringify(this.subPageMetaData, null, 2);
   }
   generateDeclaration() {
     if (!this.options.dts)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@uni-helper/vite-plugin-uni-pages",
   "type": "module",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "File system based routing for uni-app applications using Vite",
   "author": "KeJun",
   "maintainers": [
@@ -61,7 +61,8 @@
     "lodash.groupby": "^4.6.0",
     "magic-string": "^0.30.11",
     "unconfig": "^7.3.2",
-    "yaml": "^2.5.0"
+    "yaml": "^2.5.0",
+    "comment-json": "^4.2.5"
   },
   "devDependencies": {
     "@antfu/utils": "^0.7.10",