@lark-apaas/fullstack-presets 1.1.3 → 1.1.4-alpha.2

package/lib/custom-eslint-rules/index.d.ts

@@ -1,3 +1,5 @@
 export declare const customRules: {
     'no-nested-styled-jsx': import("eslint").Rule.RuleModule;
+    'require-app-container': import("eslint").Rule.RuleModule;
+    'no-direct-capability-api': import("eslint").Rule.RuleModule;
 };

package/lib/custom-eslint-rules/index.js

@@ -5,6 +5,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.customRules = void 0;
 const no_nested_styled_jsx_1 = __importDefault(require("./no-nested-styled-jsx"));
+const require_app_container_1 = __importDefault(require("./require-app-container"));
+const no_direct_capability_api_1 = __importDefault(require("./no-direct-capability-api"));
 exports.customRules = {
     'no-nested-styled-jsx': no_nested_styled_jsx_1.default,
+    'require-app-container': require_app_container_1.default,
+    'no-direct-capability-api': no_direct_capability_api_1.default,
 };

package/lib/custom-eslint-rules/no-direct-capability-api.d.ts

@@ -0,0 +1,16 @@
+/**
+ * ESLint 规则：禁止直接使用 axios 调用 /__innerapi__/capability/ 路径
+ *
+ * 此规则确保开发者使用 capabilityClient.load().call() 方式调用能力，
+ * 而不是直接通过 axios 调用内部 API 路径。
+ *
+ * 错误示例：
+ *   axios.post('/__innerapi__/capability/xxx')
+ *   axiosForBackend.get('/__innerapi__/capability/list')
+ *
+ * 正确示例：
+ *   capabilityClient.load('capabilityId').call('action', params)
+ */
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+export default rule;

package/lib/custom-eslint-rules/no-direct-capability-api.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const DEFAULT_MESSAGE = "Direct API calls to /__innerapi__/capability/ are not allowed. Use capabilityClient.load('capabilityId').call('action', params) instead.";
+// 匹配 capability 内部 API 路径的正则表达式
+const CAPABILITY_PATH_PATTERN = /__innerapi__\/capability\//;
+// HTTP 方法列表
+const HTTP_METHODS = [
+    'get',
+    'post',
+    'put',
+    'delete',
+    'patch',
+    'request',
+    'head',
+    'options',
+];
+// 需要检测的 axios 标识符
+const AXIOS_IDENTIFIERS = ['axios', 'axiosForBackend'];
+/**
+ * 从 AST 节点中提取 URL 字符串值
+ * 支持：字符串字面量、模板字符串、字符串拼接
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function extractUrlValue(node) {
+    if (!node)
+        return null;
+    switch (node.type) {
+        case 'Literal':
+            return typeof node.value === 'string' ? node.value : null;
+        case 'TemplateLiteral':
+            // 拼接所有静态部分（quasis）
+            return node.quasis.map((q) => q.value.raw).join('');
+        case 'BinaryExpression':
+            // 处理字符串拼接 'a' + 'b'
+            if (node.operator === '+') {
+                const left = extractUrlValue(node.left);
+                const right = extractUrlValue(node.right);
+                if (left !== null || right !== null) {
+                    return (left || '') + (right || '');
+                }
+            }
+            return null;
+        default:
+            return null;
+    }
+}
+const rule = {
+    meta: {
+        type: 'problem',
+        docs: {
+            description: '禁止直接使用 axios 调用 /__innerapi__/capability/ 路径',
+            category: 'Best Practices',
+            recommended: true,
+        },
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    message: {
+                        type: 'string',
+                        description: '自定义错误信息',
+                    },
+                    axiosIdentifiers: {
+                        type: 'array',
+                        items: { type: 'string' },
+                        description: '额外需要检测的 axios 实例标识符',
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
+        messages: {
+            noDirectCapabilityApi: DEFAULT_MESSAGE,
+        },
+    },
+    create(context) {
+        const options = context.options[0];
+        const customMessage = options?.message;
+        const additionalIdentifiers = options?.axiosIdentifiers || [];
+        // 合并默认和自定义的 axios 标识符
+        const allAxiosIdentifiers = [
+            ...AXIOS_IDENTIFIERS,
+            ...additionalIdentifiers,
+        ];
+        return {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            CallExpression(node) {
+                // 1. 检查是否为 MemberExpression 调用 (xxx.method())
+                if (node.callee.type !== 'MemberExpression')
+                    return;
+                // 2. 检查方法名是否为 HTTP 方法
+                const methodName = node.callee.property?.name;
+                if (!methodName || !HTTP_METHODS.includes(methodName.toLowerCase())) {
+                    return;
+                }
+                // 3. 检查调用者是否为 axios 相关标识符
+                const objectName = node.callee.object?.name;
+                if (!objectName || !allAxiosIdentifiers.includes(objectName)) {
+                    return;
+                }
+                // 4. 获取第一个参数（URL）
+                const urlArg = node.arguments[0];
+                if (!urlArg)
+                    return;
+                // 5. 提取 URL 并检查是否包含 capability 路径
+                const urlValue = extractUrlValue(urlArg);
+                if (urlValue && CAPABILITY_PATH_PATTERN.test(urlValue)) {
+                    context.report({
+                        node,
+                        ...(customMessage
+                            ? { message: customMessage }
+                            : { messageId: 'noDirectCapabilityApi' }),
+                    });
+                }
+            },
+        };
+    },
+};
+exports.default = rule;

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

@@ -0,0 +1,15 @@
+/**
+ * ESLint 规则：要求入口文件中必须包含 AppContainer 组件
+ *
+ * 此规则确保 client/src/app.tsx 或 client/src/index.tsx 中
+ * 包含 AppContainer 组件，以保证平台功能正常运行。
+ *
+ * 跨文件检查逻辑：
+ * - 只在 app.tsx 上执行检查和报错
+ * - 如果 app.tsx 没有 AppContainer，会检查 index.tsx
+ * - 只要任一文件使用了 AppContainer 就算通过
+ * - 只有两个文件都没有时才在 app.tsx 上报错
+ */
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+export default rule;

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

@@ -0,0 +1,148 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const path = __importStar(require("path"));
+const fs = __importStar(require("fs"));
+const DEFAULT_MESSAGE = 'Missing platform component AppContainer. Please ensure that App is wrapped with AppContainer (in app.tsx or index.tsx) to enable platform features.';
+// 主检查文件（报错在此文件上）
+const PRIMARY_FILE = 'app.tsx';
+// 备选检查文件
+const SECONDARY_FILE = 'index.tsx';
+// 匹配 client/src/ 目录的正则表达式
+const CLIENT_SRC_PATTERN = /[/\\]client[/\\]src[/\\]$/;
+// 检测文件内容是否包含 <AppContainer 的正则（比完整 AST 解析更快）
+const APP_CONTAINER_PATTERN = /<AppContainer[\s/>]/;
+/**
+ * 同步检查文件是否包含 AppContainer 使用
+ * 使用正则匹配，性能优于完整 AST 解析
+ */
+function checkFileForAppContainer(filePath) {
+    try {
+        if (!fs.existsSync(filePath)) {
+            return false;
+        }
+        const content = fs.readFileSync(filePath, 'utf-8');
+        return APP_CONTAINER_PATTERN.test(content);
+    }
+    catch {
+        // 文件不存在或无法读取，视为没有使用
+        return false;
+    }
+}
+const rule = {
+    meta: {
+        type: 'problem',
+        docs: {
+            description: '要求入口文件中必须包含 AppContainer 组件',
+            category: 'Possible Errors',
+            recommended: true,
+        },
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    message: {
+                        type: 'string',
+                        description: '自定义错误信息',
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
+        messages: {
+            missingAppContainer: DEFAULT_MESSAGE,
+        },
+    },
+    create(context) {
+        const options = context.options[0];
+        const customMessage = options?.message;
+        const filename = context.filename || context.getFilename();
+        // 获取文件名和目录名
+        const basename = path.basename(filename).toLowerCase();
+        const dirname = path.dirname(filename);
+        // 判断是否在 client/src/ 目录下
+        const isInClientSrc = CLIENT_SRC_PATTERN.test(dirname + path.sep);
+        // 只在 app.tsx 上执行检查和报错
+        // index.tsx 不执行检查（避免重复报错）
+        const isPrimaryFile = basename === PRIMARY_FILE && isInClientSrc;
+        if (!isPrimaryFile) {
+            return {};
+        }
+        // 标记当前文件是否使用了 AppContainer
+        let hasAppContainerInCurrentFile = false;
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        let programNode = null;
+        return {
+            // 检查 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') {
+                    hasAppContainerInCurrentFile = true;
+                }
+            },
+            // 保存 Program 节点，用于在文件末尾报错时定位
+            Program(node) {
+                programNode = node;
+            },
+            // 文件解析完成后，检查是否在 JSX 中使用了 AppContainer
+            'Program:exit'() {
+                // 如果当前文件（app.tsx）有 AppContainer，通过
+                if (hasAppContainerInCurrentFile) {
+                    return;
+                }
+                // 当前文件没有，检查 index.tsx
+                const secondaryFilePath = path.join(dirname, SECONDARY_FILE);
+                const hasAppContainerInSecondary = checkFileForAppContainer(secondaryFilePath);
+                // 如果 index.tsx 有 AppContainer，也算通过
+                if (hasAppContainerInSecondary) {
+                    return;
+                }
+                // 两个文件都没有，报错
+                if (programNode) {
+                    context.report({
+                        node: programNode,
+                        ...(customMessage
+                            ? { message: customMessage }
+                            : { messageId: 'missingAppContainer' }),
+                    });
+                }
+            },
+        };
+    },
+};
+exports.default = rule;

package/lib/recommend/eslint/eslint-client.js

@@ -36,6 +36,10 @@ exports.default = {
     rules: {
         // React Hooks 推荐规则
         ...reactHooks.configs.recommended.rules,
+        // 平台规则：确保入口文件包含 AppContainer 组件
+        '@lark-apaas/require-app-container': 'error',
+        // 平台规则：禁止直接调用 capability 内部 API，应使用 capabilityClient
+        '@lark-apaas/no-direct-capability-api': 'error',
         // TypeScript 规则
         '@typescript-eslint/no-unused-vars': 'off', // 未使用变量检查关闭
         '@typescript-eslint/no-explicit-any': 'off', // 允许使用 any 类型

package/lib/simple/recommend/eslint/eslint-client.d.ts

@@ -18,6 +18,8 @@ declare const _default: ({
         '@lark-apaas'?: {
             rules: {
                 'no-nested-styled-jsx': import("eslint").Rule.RuleModule;
+                'require-app-container': import("eslint").Rule.RuleModule;
+                'no-direct-capability-api': import("eslint").Rule.RuleModule;
             };
         } | undefined;
         'react-hooks': any;

package/lib/simple/recommend/eslint/index.d.ts

@@ -17,6 +17,8 @@ export declare const eslintPresets: {
             '@lark-apaas'?: {
                 rules: {
                     'no-nested-styled-jsx': import("eslint").Rule.RuleModule;
+                    'require-app-container': import("eslint").Rule.RuleModule;
+                    'no-direct-capability-api': import("eslint").Rule.RuleModule;
                 };
             } | undefined;
             'react-hooks': any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lark-apaas/fullstack-presets",
-  "version": "1.1.3",
+  "version": "1.1.4-alpha.2",
   "files": [
     "lib"
   ],
@@ -45,6 +45,5 @@
   "peerDependencies": {
     "eslint": "^9.0.0",
     "typescript-eslint": "^8.44.0"
-  },
-  "gitHead": "bc9469110ed352267d992d7406578d00bc3ffe03"
+  }
 }