@lark-apaas/fullstack-presets 1.1.5-alpha.1 → 1.1.5-alpha.3

package/lib/custom-eslint-rules/require-app-container.d.ts

@@ -1,8 +1,8 @@
 /**
- * ESLint rule to require AppContainer component in entry files.
+ * ESLint 规则：要求入口文件中必须包含 AppContainer 组件
  *
- * This rule ensures that client/src/index.tsx and client/src/app.tsx
- * files contain the AppContainer component to ensure platform features work correctly.
+ * 此规则确保 client/src/index.tsx 和 client/src/app.tsx 文件中
+ * 包含 AppContainer 组件，以保证平台功能正常运行。
  */
 import type { Rule } from 'eslint';
 declare const rule: Rule.RuleModule;

package/lib/custom-eslint-rules/require-app-container.js

@@ -34,16 +34,17 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 const path = __importStar(require("path"));
-const DEFAULT_MESSAGE = '缺少平台组件AppContainer，请确认App外层包裹了AppContainer组件以确保平台功能正常运行';
-// Files that must contain AppContainer
-const REQUIRED_FILES = ['index.tsx', 'app.tsx'];
-// Directory pattern to match
+const DEFAULT_MESSAGE = 'Missing platform component AppContainer. Please ensure that App is wrapped with AppContainer to enable platform features.';
+// 必须包含 AppContainer 的文件列表
+// TODO: 后续放开 index.tsx 的校验
+const REQUIRED_FILES = ['app.tsx'];
+// 匹配 client/src/ 目录的正则表达式
 const CLIENT_SRC_PATTERN = /[/\\]client[/\\]src[/\\]$/;
 const rule = {
     meta: {
         type: 'problem',
         docs: {
-            description: 'Require AppContainer component in entry files',
+            description: '要求入口文件中必须包含 AppContainer 组件',
             category: 'Possible Errors',
             recommended: true,
         },
@@ -53,7 +54,7 @@ const rule = {
                 properties: {
                     message: {
                         type: 'string',
-                        description: 'Custom error message',
+                        description: '自定义错误信息',
                     },
                 },
                 additionalProperties: false,
@@ -67,48 +68,38 @@ const rule = {
         const options = context.options[0];
         const customMessage = options?.message;
         const filename = context.filename || context.getFilename();
-        // Check if this file should be validated
+        // 获取文件名和目录名
         const basename = path.basename(filename);
         const dirname = path.dirname(filename);
-        // Only check files in client/src/ directory that match our required files
+        // 判断是否为需要检查的文件：必须在 client/src/ 目录下且文件名匹配
         const isRequiredFile = REQUIRED_FILES.includes(basename.toLowerCase()) &&
             CLIENT_SRC_PATTERN.test(dirname + path.sep);
+        // 如果不是需要检查的文件，直接跳过
         if (!isRequiredFile) {
             return {};
         }
-        let hasAppContainer = false;
+        // 标记是否在 JSX 中实际使用了 AppContainer
+        let hasAppContainerUsage = false;
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         let programNode = null;
         return {
-            // Track if AppContainer is imported
-            ImportDeclaration(node) {
-                // Check for default or named import of AppContainer
-                for (const specifier of node.specifiers) {
-                    if (specifier.type === 'ImportSpecifier' ||
-                        specifier.type === 'ImportDefaultSpecifier') {
-                        if (specifier.local.name === 'AppContainer') {
-                            hasAppContainer = true;
-                            break;
-                        }
-                    }
-                }
-            },
-            // Check for JSX usage of <AppContainer>
+            // 检查 JSX 中是否使用了 <AppContainer> 组件
+            // 注意：仅导入不使用不算通过，必须在 JSX 中实际使用
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
             JSXOpeningElement(node) {
                 const elementName = node.name;
                 if (elementName?.type === 'JSXIdentifier' &&
                     elementName?.name === 'AppContainer') {
-                    hasAppContainer = true;
+                    hasAppContainerUsage = true;
                 }
             },
-            // Store the program node for reporting at the end
+            // 保存 Program 节点，用于在文件末尾报错时定位
             Program(node) {
                 programNode = node;
             },
-            // Check at the end of file if AppContainer was found
+            // 文件解析完成后，检查是否在 JSX 中使用了 AppContainer
             'Program:exit'() {
-                if (!hasAppContainer && programNode) {
+                if (!hasAppContainerUsage && programNode) {
                     context.report({
                         node: programNode,
                         ...(customMessage

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lark-apaas/fullstack-presets",
-  "version": "1.1.5-alpha.1",
+  "version": "1.1.5-alpha.3",
   "files": [
     "lib"
   ],