@weapp-vite/volar 0.0.2 → 1.0.0

package/README.md

@@ -0,0 +1,58 @@
+# @weapp-vite/volar
+
+> 为 weapp-vite 提供 VSCode 智能提示和类型检查的 Volar 插件
+
+## 安装
+
+此包已作为 `weapp-vite` 的依赖自动安装，**无需单独安装**。
+
+如果你确实需要单独安装：
+
+```bash
+npm install -D @weapp-vite/volar
+# or
+pnpm add -D @weapp-vite/volar
+# or
+yarn add -D @weapp-vite/volar
+```
+
+## 使用方法
+
+**推荐方式：** 通过 weapp-vite 使用，插件会自动启用。
+
+详细使用文档请参考：[weapp-vite Volar 文档](../weapp-vite/docs/volar.md)
+
+## 功能特性
+
+- ✅ **配置文件智能提示** - 为 `<json>` 代码块提供完整的类型检查和自动补全
+- ✅ **JSON Schema 支持** - 支持 JSON Schema 验证和自动补全
+- ✅ **TypeScript 类型检查** - 利用 TypeScript 类型系统确保配置正确性
+- ✅ **自动推断配置类型** - 根据文件路径自动推断是 App/Page/Component 配置
+- ✅ **多模式支持** - 支持 JSON 模式和 TypeScript 模式
+
+## 开发
+
+```bash
+# 安装依赖
+pnpm install
+
+# 开发模式
+pnpm dev
+
+# 构建
+pnpm build
+
+# 测试
+pnpm test
+```
+
+## 相关文档
+
+- [weapp-vite 文档](../weapp-vite)
+- [weapp-vite Volar 使用指南](../weapp-vite/docs/volar.md)
+- [Vue 3 文档](https://vuejs.org/)
+- [微信小程序官方文档](https://developers.weixin.qq.com/miniprogram/dev/framework/)
+
+## License
+
+MIT

package/dist/index.js

@@ -1,5 +1,5 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});// ../../node_modules/.pnpm/tsup@8.5.0_@swc+core@1.14.0_jiti@2.6.1_postcss@8.5.6_tsx@4.20.6_typescript@5.9.3_yaml@2.8.1/node_modules/tsup/assets/cjs_shims.js
-var getImportMetaUrl = () => typeof document === "undefined" ? new URL(`file:${__filename}`).href : document.currentScript && document.currentScript.src || new URL("main.js", document.baseURI).href;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }// ../../node_modules/.pnpm/tsup@8.5.1_@swc+core@1.15.8_jiti@2.6.1_postcss@8.5.6_tsx@4.21.0_typescript@5.9.3_yaml@2.8.2/node_modules/tsup/assets/cjs_shims.js
+var getImportMetaUrl = () => typeof document === "undefined" ? new URL(`file:${__filename}`).href : document.currentScript && document.currentScript.tagName.toUpperCase() === "SCRIPT" ? document.currentScript.src : new URL("main.js", document.baseURI).href;
 var importMetaUrl = /* @__PURE__ */ getImportMetaUrl();
 
 // src/index.ts
@@ -8,11 +8,24 @@ var _module = require('module');
 // package.json
 var name = "@weapp-vite/volar";
 
+// src/schema.ts
+var _schematics = require('@weapp-core/schematics');
+function getSchemaForType(type) {
+  const definition = _schematics.JSON_SCHEMA_DEFINITIONS.find((d) => d.typeName === type);
+  if (!definition) {
+    return null;
+  }
+  return definition.schema;
+}
+
 // src/index.ts
-var BLOCK_TYPE = "config";
+var BLOCK_TYPE = "json";
+var JS_LANG = "js";
+var JSONC_LANG = "jsonc";
 var JSON_LANG = "json";
-var TS_LANG = "ts";
+var JSON5_LANG = "json5";
 var PLUGIN_VERSION = 2.2;
+var TS_LANG = "ts";
 var FULL_CAPABILITIES = {
   verification: true,
   completion: true,
@@ -37,15 +50,6 @@ try {
 } catch (e) {
   hasSchematicsTypes = false;
 }
-function normalizeLang(lang) {
-  if (!lang) {
-    return JSON_LANG;
-  }
-  if (lang === "txt") {
-    return JSON_LANG;
-  }
-  return lang;
-}
 function normalizeFilename(filename) {
   if (!filename) {
     return "";
@@ -71,7 +75,77 @@ function inferConfigType(filename) {
   }
   return "Page";
 }
-var plugin = () => {
+function normalizeLang(lang) {
+  if (!lang) {
+    return JSON_LANG;
+  }
+  const lower = lang.toLowerCase();
+  if (lower === "txt") {
+    return JSON_LANG;
+  }
+  return lower;
+}
+function findExportDefaultExpression(code, tsModule, lang) {
+  const scriptKind = lang === TS_LANG ? tsModule.ScriptKind.TS : tsModule.ScriptKind.JS;
+  const sourceFile = tsModule.createSourceFile(
+    `config.${lang}`,
+    code,
+    tsModule.ScriptTarget.Latest,
+    true,
+    scriptKind
+  );
+  for (const statement of sourceFile.statements) {
+    if (tsModule.isExportAssignment(statement)) {
+      const expressionStart = statement.expression.getStart(sourceFile);
+      const expressionEnd = statement.expression.getEnd();
+      const leading = code.slice(0, statement.getStart(sourceFile));
+      const expression = code.slice(expressionStart, expressionEnd);
+      const trailing = code.slice(statement.getEnd());
+      return {
+        expression,
+        expressionStart,
+        expressionEnd,
+        leading,
+        trailing
+      };
+    }
+  }
+  return null;
+}
+function injectSchemaIntoJsonObject(content, schemaId) {
+  const trimmed = content.trim();
+  if (!trimmed.startsWith("{")) {
+    return content;
+  }
+  const leftBraceIndex = content.indexOf("{");
+  if (leftBraceIndex < 0) {
+    return content;
+  }
+  const afterLeft = content.slice(leftBraceIndex + 1);
+  const firstNonSpace = afterLeft.match(/\S/);
+  const nextCharIndex = firstNonSpace ? leftBraceIndex + 1 + firstNonSpace.index : -1;
+  const isEmptyObject = nextCharIndex >= 0 && content[nextCharIndex] === "}";
+  const schemaLine = `  "$schema": "${schemaId}"`;
+  const injected = isEmptyObject ? `{
+${schemaLine}
+}` : `{
+${schemaLine},${content.slice(leftBraceIndex + 1)}`;
+  if (trimmed === content) {
+    return injected;
+  }
+  const leading = content.slice(0, content.indexOf(trimmed));
+  const trailing = content.slice(content.indexOf(trimmed) + trimmed.length);
+  return `${leading}${injected}${trailing}`;
+}
+var plugin = (ctx) => {
+  let tsModule = _optionalChain([ctx, 'optionalAccess', _2 => _2.modules, 'optionalAccess', _3 => _3.typescript]);
+  if (!tsModule) {
+    try {
+      tsModule = require2("typescript");
+    } catch (e2) {
+      tsModule = void 0;
+    }
+  }
   return {
     name,
     version: PLUGIN_VERSION,
@@ -81,8 +155,13 @@ var plugin = () => {
         const block = sfc.customBlocks[i];
         if (block.type === BLOCK_TYPE) {
           const normalizedLang = normalizeLang(block.lang);
-          const lang = hasSchematicsTypes ? TS_LANG : normalizedLang;
-          names.push({ id: `${BLOCK_TYPE}_${i}`, lang });
+          const isJsLike = normalizedLang === JS_LANG || normalizedLang === TS_LANG;
+          if (isJsLike) {
+            names.push({ id: `${BLOCK_TYPE}_${i}`, lang: TS_LANG });
+            continue;
+          }
+          const embeddedLang = normalizedLang === JSON_LANG || normalizedLang === JSONC_LANG || normalizedLang === JSON5_LANG ? JSONC_LANG : JSON_LANG;
+          names.push({ id: `${BLOCK_TYPE}_${i}`, lang: embeddedLang });
         }
       }
       return names;
@@ -97,6 +176,8 @@ var plugin = () => {
       if (!block) {
         return;
       }
+      const normalizedLang = normalizeLang(block.lang);
+      const configType = inferConfigType(fileName);
       if (!hasSchematicsTypes) {
         embeddedCode.content.push([
           block.content,
@@ -106,29 +187,79 @@ var plugin = () => {
         ]);
         return;
       }
-      const configType = inferConfigType(fileName);
-      const prefix = `import type { ${configType} as __WeappConfig } from '@weapp-core/schematics'
-
-export default `;
-      const suffix = " satisfies __WeappConfig\n";
-      embeddedCode.content.push([
-        prefix,
-        void 0,
-        0,
-        VOID_CAPABILITIES
-      ]);
+      const userWantsJs = normalizedLang === JS_LANG || normalizedLang === TS_LANG;
+      if (userWantsJs) {
+        const parsed = tsModule && findExportDefaultExpression(block.content, tsModule, normalizedLang);
+        if (parsed && hasSchematicsTypes) {
+          const typeImport = `import type { ${configType} as __WeappConfig } from '@weapp-core/schematics'
+`;
+          const helper = "const __weapp_defineConfig = <T extends __WeappConfig>(config: T) => config\n\n";
+          embeddedCode.content.push([
+            `${typeImport}${helper}`,
+            void 0,
+            0,
+            VOID_CAPABILITIES
+          ]);
+          if (parsed.leading) {
+            embeddedCode.content.push([
+              parsed.leading,
+              block.name,
+              0,
+              FULL_CAPABILITIES
+            ]);
+          }
+          embeddedCode.content.push([
+            "export default __weapp_defineConfig(",
+            void 0,
+            parsed.expressionStart,
+            VOID_CAPABILITIES
+          ]);
+          embeddedCode.content.push([
+            parsed.expression,
+            block.name,
+            parsed.expressionStart,
+            FULL_CAPABILITIES
+          ]);
+          embeddedCode.content.push([
+            ")",
+            void 0,
+            parsed.expressionEnd,
+            VOID_CAPABILITIES
+          ]);
+          if (parsed.trailing) {
+            embeddedCode.content.push([
+              parsed.trailing,
+              block.name,
+              parsed.expressionEnd,
+              FULL_CAPABILITIES
+            ]);
+          }
+          return;
+        }
+        embeddedCode.content.push([
+          block.content,
+          block.name,
+          0,
+          FULL_CAPABILITIES
+        ]);
+        return;
+      }
+      const schema = getSchemaForType(configType);
+      if (schema && schema.$id && !block.content.includes("$schema")) {
+        embeddedCode.content.push([
+          injectSchemaIntoJsonObject(block.content, schema.$id),
+          block.name,
+          0,
+          FULL_CAPABILITIES
+        ]);
+        return;
+      }
       embeddedCode.content.push([
         block.content,
         block.name,
         0,
         FULL_CAPABILITIES
       ]);
-      embeddedCode.content.push([
-        suffix,
-        void 0,
-        block.content.length,
-        VOID_CAPABILITIES
-      ]);
     }
   };
 };

package/dist/index.mjs

@@ -4,11 +4,24 @@ import { createRequire } from "module";
 // package.json
 var name = "@weapp-vite/volar";
 
+// src/schema.ts
+import { JSON_SCHEMA_DEFINITIONS } from "@weapp-core/schematics";
+function getSchemaForType(type) {
+  const definition = JSON_SCHEMA_DEFINITIONS.find((d) => d.typeName === type);
+  if (!definition) {
+    return null;
+  }
+  return definition.schema;
+}
+
 // src/index.ts
-var BLOCK_TYPE = "config";
+var BLOCK_TYPE = "json";
+var JS_LANG = "js";
+var JSONC_LANG = "jsonc";
 var JSON_LANG = "json";
-var TS_LANG = "ts";
+var JSON5_LANG = "json5";
 var PLUGIN_VERSION = 2.2;
+var TS_LANG = "ts";
 var FULL_CAPABILITIES = {
   verification: true,
   completion: true,
@@ -33,15 +46,6 @@ try {
 } catch {
   hasSchematicsTypes = false;
 }
-function normalizeLang(lang) {
-  if (!lang) {
-    return JSON_LANG;
-  }
-  if (lang === "txt") {
-    return JSON_LANG;
-  }
-  return lang;
-}
 function normalizeFilename(filename) {
   if (!filename) {
     return "";
@@ -67,7 +71,77 @@ function inferConfigType(filename) {
   }
   return "Page";
 }
-var plugin = () => {
+function normalizeLang(lang) {
+  if (!lang) {
+    return JSON_LANG;
+  }
+  const lower = lang.toLowerCase();
+  if (lower === "txt") {
+    return JSON_LANG;
+  }
+  return lower;
+}
+function findExportDefaultExpression(code, tsModule, lang) {
+  const scriptKind = lang === TS_LANG ? tsModule.ScriptKind.TS : tsModule.ScriptKind.JS;
+  const sourceFile = tsModule.createSourceFile(
+    `config.${lang}`,
+    code,
+    tsModule.ScriptTarget.Latest,
+    true,
+    scriptKind
+  );
+  for (const statement of sourceFile.statements) {
+    if (tsModule.isExportAssignment(statement)) {
+      const expressionStart = statement.expression.getStart(sourceFile);
+      const expressionEnd = statement.expression.getEnd();
+      const leading = code.slice(0, statement.getStart(sourceFile));
+      const expression = code.slice(expressionStart, expressionEnd);
+      const trailing = code.slice(statement.getEnd());
+      return {
+        expression,
+        expressionStart,
+        expressionEnd,
+        leading,
+        trailing
+      };
+    }
+  }
+  return null;
+}
+function injectSchemaIntoJsonObject(content, schemaId) {
+  const trimmed = content.trim();
+  if (!trimmed.startsWith("{")) {
+    return content;
+  }
+  const leftBraceIndex = content.indexOf("{");
+  if (leftBraceIndex < 0) {
+    return content;
+  }
+  const afterLeft = content.slice(leftBraceIndex + 1);
+  const firstNonSpace = afterLeft.match(/\S/);
+  const nextCharIndex = firstNonSpace ? leftBraceIndex + 1 + firstNonSpace.index : -1;
+  const isEmptyObject = nextCharIndex >= 0 && content[nextCharIndex] === "}";
+  const schemaLine = `  "$schema": "${schemaId}"`;
+  const injected = isEmptyObject ? `{
+${schemaLine}
+}` : `{
+${schemaLine},${content.slice(leftBraceIndex + 1)}`;
+  if (trimmed === content) {
+    return injected;
+  }
+  const leading = content.slice(0, content.indexOf(trimmed));
+  const trailing = content.slice(content.indexOf(trimmed) + trimmed.length);
+  return `${leading}${injected}${trailing}`;
+}
+var plugin = (ctx) => {
+  let tsModule = ctx?.modules?.typescript;
+  if (!tsModule) {
+    try {
+      tsModule = require2("typescript");
+    } catch {
+      tsModule = void 0;
+    }
+  }
   return {
     name,
     version: PLUGIN_VERSION,
@@ -77,8 +151,13 @@ var plugin = () => {
         const block = sfc.customBlocks[i];
         if (block.type === BLOCK_TYPE) {
           const normalizedLang = normalizeLang(block.lang);
-          const lang = hasSchematicsTypes ? TS_LANG : normalizedLang;
-          names.push({ id: `${BLOCK_TYPE}_${i}`, lang });
+          const isJsLike = normalizedLang === JS_LANG || normalizedLang === TS_LANG;
+          if (isJsLike) {
+            names.push({ id: `${BLOCK_TYPE}_${i}`, lang: TS_LANG });
+            continue;
+          }
+          const embeddedLang = normalizedLang === JSON_LANG || normalizedLang === JSONC_LANG || normalizedLang === JSON5_LANG ? JSONC_LANG : JSON_LANG;
+          names.push({ id: `${BLOCK_TYPE}_${i}`, lang: embeddedLang });
         }
       }
       return names;
@@ -93,6 +172,8 @@ var plugin = () => {
       if (!block) {
         return;
       }
+      const normalizedLang = normalizeLang(block.lang);
+      const configType = inferConfigType(fileName);
       if (!hasSchematicsTypes) {
         embeddedCode.content.push([
           block.content,
@@ -102,29 +183,79 @@ var plugin = () => {
         ]);
         return;
       }
-      const configType = inferConfigType(fileName);
-      const prefix = `import type { ${configType} as __WeappConfig } from '@weapp-core/schematics'
-
-export default `;
-      const suffix = " satisfies __WeappConfig\n";
-      embeddedCode.content.push([
-        prefix,
-        void 0,
-        0,
-        VOID_CAPABILITIES
-      ]);
+      const userWantsJs = normalizedLang === JS_LANG || normalizedLang === TS_LANG;
+      if (userWantsJs) {
+        const parsed = tsModule && findExportDefaultExpression(block.content, tsModule, normalizedLang);
+        if (parsed && hasSchematicsTypes) {
+          const typeImport = `import type { ${configType} as __WeappConfig } from '@weapp-core/schematics'
+`;
+          const helper = "const __weapp_defineConfig = <T extends __WeappConfig>(config: T) => config\n\n";
+          embeddedCode.content.push([
+            `${typeImport}${helper}`,
+            void 0,
+            0,
+            VOID_CAPABILITIES
+          ]);
+          if (parsed.leading) {
+            embeddedCode.content.push([
+              parsed.leading,
+              block.name,
+              0,
+              FULL_CAPABILITIES
+            ]);
+          }
+          embeddedCode.content.push([
+            "export default __weapp_defineConfig(",
+            void 0,
+            parsed.expressionStart,
+            VOID_CAPABILITIES
+          ]);
+          embeddedCode.content.push([
+            parsed.expression,
+            block.name,
+            parsed.expressionStart,
+            FULL_CAPABILITIES
+          ]);
+          embeddedCode.content.push([
+            ")",
+            void 0,
+            parsed.expressionEnd,
+            VOID_CAPABILITIES
+          ]);
+          if (parsed.trailing) {
+            embeddedCode.content.push([
+              parsed.trailing,
+              block.name,
+              parsed.expressionEnd,
+              FULL_CAPABILITIES
+            ]);
+          }
+          return;
+        }
+        embeddedCode.content.push([
+          block.content,
+          block.name,
+          0,
+          FULL_CAPABILITIES
+        ]);
+        return;
+      }
+      const schema = getSchemaForType(configType);
+      if (schema && schema.$id && !block.content.includes("$schema")) {
+        embeddedCode.content.push([
+          injectSchemaIntoJsonObject(block.content, schema.$id),
+          block.name,
+          0,
+          FULL_CAPABILITIES
+        ]);
+        return;
+      }
       embeddedCode.content.push([
         block.content,
         block.name,
         0,
         FULL_CAPABILITIES
       ]);
-      embeddedCode.content.push([
-        suffix,
-        void 0,
-        block.content.length,
-        VOID_CAPABILITIES
-      ]);
     }
   };
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@weapp-vite/volar",
-  "version": "0.0.2",
-  "description": "tsup(esbuild) build package template",
+  "version": "1.0.0",
+  "description": "Volar plugin for weapp-vite - Provides IntelliSense and type checking for WeChat mini-program config blocks",
   "author": "ice breaker <1324318532@qq.com>",
   "license": "MIT",
   "repository": {
@@ -12,7 +12,16 @@
   "bugs": {
     "url": "https://github.com/weapp-vite/weapp-vite/issues"
   },
-  "keywords": [],
+  "keywords": [
+    "volar",
+    "vue",
+    "wechat",
+    "miniprogram",
+    "weapp",
+    "intellisense",
+    "typescript",
+    "json-schema"
+  ],
   "sideEffects": false,
   "exports": {
     ".": {
@@ -31,7 +40,7 @@
     "dist"
   ],
   "dependencies": {
-    "@weapp-core/schematics": "4.0.0"
+    "@weapp-core/schematics": "5.0.0"
   },
   "scripts": {
     "dev": "tsup --watch --sourcemap",