@lcap/nasl-language-server-core 4.0.0-beta.9 → 4.0.0-creator.1

package/README.md

@@ -1,3 +1,88 @@
 # Nasl Language Server
 
 Nasl 语言服务
+
+## 描述
+
+NetEase Application Specific Language (NASL) 语言服务器核心包，提供 NASL 语言的类型检查、语法分析和其他语言服务功能。
+
+## 技术栈
+
+### 核心技术
+- **TypeScript 5.4.4** - 主要开发语言
+- **Node.js 18+** - 运行环境
+
+### 主要依赖
+- **@lcap/nasl-concepts** - NASL 概念定义
+- **@lcap/nasl-types** - NASL 类型系统
+- **@lcap/nasl-utils** - NASL 工具库
+- **decimal.js** - 精确数值计算
+- **json5** - JSON5 格式支持
+- **lodash** - 实用工具库
+- **mnemonist** - 数据结构库
+
+### 开发工具
+- **Vitest 3.2.4** - 现代测试框架
+- **Chai 4.3.7** - 断言库
+- **Mocha** - 传统测试框架（通过 @lcap/nasl-test-toolkit）
+
+## 开发
+
+### 构建
+```bash
+# 清理输出目录
+npm run clear
+
+# 构建项目
+npm run build
+
+# 监听模式构建
+npm run watch
+```
+
+### 测试
+
+#### Vitest 测试（推荐）
+```bash
+# 运行所有 Vitest 测试
+npm run test:vite
+
+# 监听模式运行测试
+npm run test:watch
+
+# 启动测试 UI 界面
+npm run test:ui
+```
+
+#### Mocha 测试 (遗留)
+
+注意:
+- Mocha 测试框架已经废弃，对于新的单元测试的编写，请使用 Vitest 测试框架。
+- Mocha 测试框架的测试用例，请迁移到 Vitest 测试框架。请参考 [TESTING_MIGRATION.md](./tests/TESTING_MIGRATION.md) 文件，让LLM自动化地完成迁移。
+
+```bash
+# 运行标准 Mocha 测试套件
+npm run test
+
+# 运行应用测试
+npm run test:apps
+
+# 运行 CI 测试
+npm run test:ci
+
+# 更新测试快照
+npm run test:update
+
+# 运行性能测试
+npm run test:perf
+```
+
+### 其他工具
+```bash
+# 压缩测试数据
+npm run compress-test-data
+```
+
+## 许可证
+
+MIT

package/out/checker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"checker.d.ts","sourceRoot":"","sources":["../src/checker.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,UAAU,EAU0F,GAAG,EAMvG,QAAQ,EACT,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACgE,cAAc,EAGpF,MAAM,qBAAqB,CAAC;AAS7B,OAAO,EAA4B,KAAK,MAAM,EAAE,MAAM,SAAS,CAAC;AAIhE,OAAO,EAAE,UAAU,IAAI,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAEpE,oBAAY,QAAQ;IAClB,IAAI,YAAY;IAChB,KAAK,UAAU;CAChB;AAED,MAAM,MAAM,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;AAEnE,KAAK,YAAY,GAAG;IAClB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,CAAC;AAMF,MAAM,MAAM,kBAAkB,GAAG,GAAG,CAAC,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;AAEpE,MAAM,MAAM,kBAAkB,GAAG,GAAG,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC;AAMrE,KAAK,gBAAgB,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAqBF,KAAK,eAAe,GAAG;IACrB,GAAG,EAAE,GAAG,CAAC;IACT,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,OAAO,CAAC;IACf,yBAAyB,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC/C,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,CAAC;AAiQF;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,eAAe;oCAwiIpB,OAAO;sDAPW,gBAAgB,EAAE;;;;sBAhBjD,UAAU,GAAG,SAAS;;;8BAsCf,UAAU;2BAuBb,UAAU;;kBAthInB,UAAU,WAAW,MAAM,YAAY,YAAY;EAwiIzE;AAGD,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IACrC,mBAAmB,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IACvC,qBAAqB,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC1C;AAED,eAAO,MAAM,6BAA6B,aAAc,UAAU,sCAAoC,MAAM,gBAAgB,CAmC3H,CAAA;AAMD,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAC"}
+{"version":3,"file":"checker.d.ts","sourceRoot":"","sources":["../src/checker.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,UAAU,EAU0F,GAAG,EAMvG,QAAQ,EACT,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACgE,cAAc,EAGpF,MAAM,qBAAqB,CAAC;AAS7B,OAAO,EAA4B,KAAK,MAAM,EAAE,MAAM,SAAS,CAAC;AAIhE,OAAO,EAAE,UAAU,IAAI,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAIpE,oBAAY,QAAQ;IAClB,IAAI,YAAY;IAChB,KAAK,UAAU;CAChB;AAED,MAAM,MAAM,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;AAEnE,KAAK,YAAY,GAAG;IAClB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,CAAC;AAMF,MAAM,MAAM,kBAAkB,GAAG,GAAG,CAAC,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;AAEpE,MAAM,MAAM,kBAAkB,GAAG,GAAG,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC;AAMrE,KAAK,gBAAgB,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAqBF,KAAK,eAAe,GAAG;IACrB,GAAG,EAAE,GAAG,CAAC;IACT,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,OAAO,CAAC;IACf,yBAAyB,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC/C,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,CAAC;AAiQF;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,eAAe;oCAmmIpB,OAAO;sDAPW,gBAAgB,EAAE;;;;sBAhBjD,UAAU,GAAG,SAAS;;;8BA4Df,UAAU;2BAuBb,UAAU;;kBAvmInB,UAAU,WAAW,MAAM,YAAY,YAAY;EAynIzE;AAGD,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IACrC,mBAAmB,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IACvC,qBAAqB,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC1C;AAED,eAAO,MAAM,6BAA6B,aAAc,UAAU,sCAAoC,MAAM,gBAAgB,CAmC3H,CAAA;AAMD,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAC"}

package/out/checker.js

@@ -338,6 +338,15 @@ function createErrorDiagnoser(context) {
         }
         else { }
     }
+    function scopedError(node, message, context) {
+        const scope = node?.constructor?.nodeTitle;
+        if (scope) {
+            error(node, `${scope}：${message}`, context);
+        }
+        else {
+            error(node, message, context);
+        }
+    }
     /**
      * 获取当前错误信息
      * @param node
@@ -691,7 +700,7 @@ function createErrorDiagnoser(context) {
      * @returns
      */
     function isNonRequiredParam(param) {
-        return param?.defaultValue?.expression || param?.defaultExpression || param?.optional || param?.spread || (nasl_concepts_1.asserts.isInterfaceParam(param) && !param.required);
+        return param?.defaultValue?.expression || param?.defaultExpression || param?.optional || (nasl_concepts_1.asserts.isInterfaceParam(param) && !param.required);
     }
     /**
      * 确定函数签名中所需的最小参数数量
@@ -701,6 +710,9 @@ function createErrorDiagnoser(context) {
         let minArgsCount = 0;
         for (let i = 0; i < paramLen; i++) {
             const param = params[i];
+            if (param?.spread) {
+                continue;
+            }
             if (!isNonRequiredParam(param)) {
                 minArgsCount++; // 如果参数有默认值，则跳过
             }
@@ -803,7 +815,7 @@ function createErrorDiagnoser(context) {
     /**
      * 检查 调用表达式的参数
      * @param node
-     * @param ref
+     *( @param r) as anyef
      */
     function* checkCallExpressionParameters(node, ref) {
         // Handle both TypeAnnotation and FunctionDefinition formats
@@ -823,13 +835,17 @@ function createErrorDiagnoser(context) {
         }
         yield* (0, nasl_utils_1.wrapForEachToGenerator)(args, function* (arg, index) {
             const param = params?.[index];
-            if (!param)
-                return;
-            const isParamRequired = !(hasSpreadParam && index > spreadParamIndex) && !isNonRequiredParam(param);
+            // 若 param 的定义不存在，则默认是必填的。
+            const isParamRequired = param ? !isNonRequiredParam(param) : true;
             arg.paramRequired = isParamRequired;
+            // 即便是 param 的定义不存在，也需要检查 arg。这样可以检查出 arg 是否引用了一些未定义的变量
+            const argType = yield* checkNode(arg);
+            if (!param) {
+                return;
+            }
             const paramType = param.typeAnnotation ??
                 (nasl_concepts_1.asserts.isTypeAnnotation(param) ? param : env.getType(param));
-            const argType = yield* checkNode(arg);
+            // 检查高阶函数参数个数是否匹配
             if (paramType?.typeKind === 'function' && argType?.typeKind === 'function') {
                 const argTypeArgs = argType?.typeArguments || [];
                 const paramTypeArgs = paramType?.typeArguments || [];
@@ -927,12 +943,11 @@ function createErrorDiagnoser(context) {
         const type = yield* checkNode(node);
         if (isUnresolvedType(type)) {
             const scope = node?.constructor?.nodeTitle;
-            if (node.concept === 'Identifier') {
-                error(node, `${scope}：${node.name} 未定义。`);
-            }
-            else {
-                error(node, `${scope}：所选择的内容未定义。`);
-            }
+            // if (node.concept === 'Identifier') {
+            //   error(node, `${scope}：${node.name} 未定义。`);
+            // } else {
+            error(node, `${scope}：所选择的内容未定义。`);
+            // }
             return errorType;
         }
         return type;
@@ -1220,13 +1235,14 @@ function createErrorDiagnoser(context) {
         }
     }
     /**
-     * 检查 变量
+     * 检查【局部】变量
      * @param node
      */
     function* checkVariable(node) {
         yield* checkNode(node.defaultValue);
         // 前面加了报错，省点时间，报错不用那么精确
         // yield* checkVariableType(node);
+        yield* checkNode(node.typeAnnotation);
     }
     /**
      * 检查 前端全局变量
@@ -1721,6 +1737,7 @@ function createErrorDiagnoser(context) {
         yield* checkNode(node.defaultValue);
         // 前面加了报错，省点时间，报错不用那么精确
         // yield* checkVariableType(node);
+        yield* checkNode(node.typeAnnotation);
     }
     /**
      * 检查 接口
@@ -1867,6 +1884,7 @@ function createErrorDiagnoser(context) {
             ...(node.variables || []),
             ...(node.logics || []),
         ]);
+        checkVariableAndReturnTypeAnnotations(node.variables, [], false);
         const module = node.getAncestor('Module');
         if (!(module?.parentKey === 'dependencies')) {
             if (node.params?.length) {
@@ -1997,6 +2015,21 @@ function createErrorDiagnoser(context) {
         if (node._foldInView) {
             error(node, `组件${node.name}已经极速折叠`);
         }
+        // 已知：选择器会漏报，因为 children 里是两个空 template。暂时先这样吧。
+        let dsFilled = true;
+        let errNode = node;
+        const ds = node.bindAttrs.find(nd => nd.name === 'dataSource');
+        if (ds) {
+            if (ds.type === 'dynamic' && !ds.expression) {
+                dsFilled = false;
+                errNode = ds;
+            }
+        }
+        const hasSubComponents = node.children.filter(c => c.tag !== 'template').length > 0 ||
+            node.children.filter(c => c.tag === 'template').some(cc => cc.children.length > 0);
+        if (!dsFilled && !hasSubComponents) {
+            error(errNode, '数据源不能为空');
+        }
         unbindVariables?.();
     }
     /**
@@ -2257,7 +2290,8 @@ function createErrorDiagnoser(context) {
         yield* checkNode(node.bind);
         if (node.processDefinitions?.length) {
             yield* (0, nasl_utils_1.wrapForEachToGenerator)(node.processDefinitions, function* (node) {
-                yield* checkNode(node);
+                // 现有流程版本 [v1, v2]，加个 v3 后，变成了 [proxy(v1), proxy(v2), v3]，无法理解
+                yield* checkNode(toRaw(node));
             });
         }
         if (node?.subLogics?.length) {
@@ -2433,7 +2467,7 @@ function createErrorDiagnoser(context) {
                 const prop = getPropertyOfType(type, propertyName);
                 if (!prop) {
                     const scope = item?.constructor?.nodeTitle;
-                    error(item, `${scope}：找不到 ${type?.typeTitle} 上的 ${propertyName}。`);
+                    error(item, `${scope}：找不到 ${(0, type_manager_1.showUserLevelType)(type)} 上的 ${propertyName}。`);
                 }
                 type = env.getType(prop);
                 if (type?.typeKind === 'generic' && type.typeName === 'List') {
@@ -2461,6 +2495,10 @@ function createErrorDiagnoser(context) {
             ...(node.variables || []),
             ...(node.virtualParams || [])
         ]);
+        // 仅检查用户写的逻辑
+        // if (node.nodePath?.startsWith('app.logics')) {
+        checkVariableAndReturnTypeAnnotations(node.variables ?? [], node.returns ?? []);
+        // }
         const module = node.getAncestor('Module');
         if (!(module?.parentKey === 'dependencies')) {
             if (node.params?.length) {
@@ -2641,6 +2679,9 @@ function createErrorDiagnoser(context) {
             ...(node.returns || []),
             ...(node.variables || []),
         ]);
+        // if (nd.nodePath?.startsWith('app.logics')) {
+        checkVariableAndReturnTypeAnnotations(node.variables, node.returns);
+        // }
         const module = node.getAncestor('Module');
         if (!(module?.parentKey === 'dependencies')) {
             if (node.params?.length) {
@@ -2731,30 +2772,27 @@ function createErrorDiagnoser(context) {
             return;
         }
         yield* checkVoidCallUsedAsStatement(node);
-        const ref = env.resolvedCallInfo.get(node) ?? env.resolveRef(node);
-        const typeUnresolved = ref.ret
-            ? (0, type_manager_1.hasUnresolvedTyInCallInfo)(ref) // 其他
-            : (0, type_predicate_1.isUnResolvedTy)(ref); // 前端页面，TODO： 需要统一处理
-        // Handle the new FunctionDefinition structure
-        if (ref?.params && !typeUnresolved) {
-            // It's a FunctionDefinition object
-            yield* checkScopeOfUse(node, ref);
-            yield* checkCallExpressionParameters(node, ref);
-        }
-        else if (ref && !typeUnresolved) {
-            // 检查使用范围
-            yield* checkScopeOfUse(node, ref);
-            yield* checkCallExpressionParameters(node, ref);
-        }
-        else {
-            if (ref.depLibName) {
-                error(node, `找不到依赖库 ${ref.depLibName} 上的 ${getExpressionNodeName(node.concept)} ${node.calleeName}。`);
+        const ref = env.resolveRef(node); // 前端
+        // TODO: sql 函数的 namespace 带有数据库名 nasl.sqlFunction.mysql nasl.sqlFunction.oracle ...
+        // 暂时不在 qNameDefs 里，用 isBuiltInCall 简单判断了
+        if (!ref && !isBuiltInCall(node)) {
+            const depLibName = getExtensionLibName(node);
+            if (depLibName) {
+                error(node, `找不到依赖库 ${depLibName} 上的 ${getExpressionNodeName(node.concept)} ${node.calleeName}。`);
             }
             else {
                 error(node, `找不到${getExpressionNodeName(node.concept)} ${node.calleeName}。`);
             }
             return errorType;
         }
+        /**
+         * 目前的 callInfo：所有内置函数 + 服务端调用。前端因为有组件库调用，还没统一
+         * 排除未求解出类型变元等引发的报错，这些不应该报 '找不到'
+         */
+        // FIXME: wudengke 帮帮忙，行行好
+        const callInfo = env.resolvedCallInfo.get(node);
+        yield* checkScopeOfUse(node, (callInfo ?? ref));
+        yield* checkCallExpressionParameters(node, (callInfo ?? ref));
         switch (node.concept) {
             case 'CallFunction':
                 return yield* checkCallFunction(node);
@@ -3127,18 +3165,29 @@ function createErrorDiagnoser(context) {
                 }
             });
         }
+        else if (!isOtherCase(node)) {
+            // pattern 为空时，如果不是其他就报错
+            error(node, '匹配分支：匹配模式不能为空', {
+                titleTip: '匹配模式不能为空',
+            });
+        }
         if (node.body?.length) {
             yield* (0, nasl_utils_1.wrapForEachToGenerator)(node.body, function* (node) {
                 yield* checkNode(node);
             });
         }
-        if (match?.isExpression && node.body.length === 0) {
-            // 如果不是其他就标红
-            if (node?.getIndexOfParent() !== (match?.cases?.length || 0) - 1) {
-                error(node, '匹配分支：返回内容不能为空', {
-                    titleTip: '返回内容不能为空',
-                });
+        if (match?.isExpression && node.body.length === 0 && !isOtherCase(node)) {
+            // 如果不是其他就报错
+            error(node, '匹配分支：返回内容不能为空', {
+                titleTip: '返回内容不能为空',
+            });
+        }
+        function isOtherCase(node) {
+            const indexInParent = node.getIndexOfParent();
+            if (indexInParent === -1) {
+                return false;
             }
+            return indexInParent === match.cases.length - 1;
         }
     }
     /**
@@ -3235,14 +3284,6 @@ function createErrorDiagnoser(context) {
                 }
                 else {
                     const { name } = node;
-                    // 之前有一些脏数据，先兼容
-                    // if (['true', 'false'].includes(name)) {
-                    //   return new TypeAnnotation({
-                    //     typeKind: 'primitive',
-                    //     typeName: 'Boolean',
-                    //     typeNamespace: 'nasl.core',
-                    //   });
-                    // }
                     if (
                     // name 是 A.B.C
                     name?.split('.')?.length > 1
@@ -3257,6 +3298,13 @@ function createErrorDiagnoser(context) {
                     return errorType;
                 }
             }
+            if (node.namespace === 'app.enums' &&
+                node.parentNode?.concept !== 'MemberExpression' &&
+                node.parentNode?.concept !== 'SelectMembers') {
+                // 判断枚举类是否直接被使用
+                scopedError(node, `${node.toNaturalTS()} 枚举类不能直接使用，请取它的枚举项`);
+                return errorType;
+            }
             // 检查使用范围
             yield* checkScopeOfUse(node, ref);
             return env.getType(node);
@@ -3285,7 +3333,7 @@ function createErrorDiagnoser(context) {
                 }
                 else {
                     const scope = node?.constructor?.nodeTitle;
-                    error(node, `${scope}：找不到 ${type?.typeTitle} 上的 ${nodeProperty?.name}。`);
+                    error(node, `${scope}：找不到 ${(0, type_manager_1.showUserLevelType)(type)} 上的 ${nodeProperty?.name}。`);
                     return errorType;
                 }
                 return env.getType(node);
@@ -3437,7 +3485,7 @@ function createErrorDiagnoser(context) {
                 }
                 else {
                     const scope = property?.constructor?.nodeTitle;
-                    error(property, `${scope}：找不到 ${type?.typeTitle} 上的 ${propertyName}。`);
+                    error(property, `${scope}：找不到 ${(0, type_manager_1.showUserLevelType)(type)} 上的 ${propertyName}。`);
                 }
             });
         }
@@ -4253,6 +4301,26 @@ function createErrorDiagnoser(context) {
     function setMetadataTypeEnable(enable) {
         metadataTypeEnable = enable;
     }
+    const checkVariableAndReturnTypeAnnotations = (variables, returns, inLogic = true) => {
+        for (const v of variables) {
+            if (v.typeAnnotation)
+                continue;
+            const tyAnn = v.__TypeAnnotation;
+            if (!(0, type_predicate_1.isResolvedUserTy)(tyAnn)) {
+                error(v, `局部变量 ${v.name} 未设置类型，在非草稿区正常使用可自动推断类型`);
+                v.__TypeAnnotation = undefined;
+            }
+        }
+        for (const r of returns) {
+            if (r.typeAnnotation)
+                continue;
+            const tyAnn = r.__TypeAnnotation;
+            if (!(0, type_predicate_1.isResolvedUserTy)(tyAnn)) {
+                error(r, `输出参数 ${r.name} 未设置类型，在非草稿区正常使用可自动推断类型`);
+                r.__TypeAnnotation = undefined;
+            }
+        }
+    };
     /**
      * 诊断App
      * @param app
@@ -4344,4 +4412,8 @@ const transformDiagnosticsToRecords = (fileNode, diagnostics) => {
 exports.transformDiagnosticsToRecords = transformDiagnosticsToRecords;
 // @ts-expect-error
 const toRaw = (nd) => nd.__v_raw ?? nd;
+// 是否来自系统内置
+const isBuiltInCall = (nd) => nd.calleeNamespace.startsWith('nasl.');
+// 是否来自依赖库
+const getExtensionLibName = (nd) => nd.calleeNamespace.startsWith('extensions.') ? nd.calleeNamespace.split('.')[1] : undefined;
 //# sourceMappingURL=checker.js.map