SuperAPI AI 工具集

typescript

编程与开发

查看项目

更新于 10-15 21:43

技能介绍

用途:这是一份 TypeScript 编码规范与约定,用于统一代码风格与写法,来源为 forcedotcom/apex-language-support。

主要能力与规则要点:新建文件版权头使用 2026 年(如 Copyright (c) 2026, salesforce.com, inc.);不使用 barrel 文件;避免类型断言(as Foo、as unknown as、Foo!),改用守卫或 Effect.schema(如 is);异步不使用 void,改用 async/effect(vscode-window-messages 例外);不使用 export *,导出需显式命名;优先 undefined 而非 null(服务端要求 null 时除外);优先 undefined 而非空字符串;优先 map/filter 而非循环与条件判断;避免可变状态;避免 any;不使用 enum 与 namespace(enum 编译出的 JS 较怪异,改用字符串联合类型;本仓库外无法修改的接口例外);开发者失误不应产生运行时错误(用类型保证 switch/case 穷尽,输入在可控范围内时不为 null/undefined 抛错);除非绝对必要避免 fallback,fallback 通常是掩盖上游 bug 的补丁,应修复根因,确需 fallback 时注释说明为何无法在上游修复。

命名与注释:.ts 文件名使用 camelCase,不含连字符,不以大写字母开头;重构时保留注释,错误或过时的注释应删除;导出函数在名称不清晰时使用单行 jsdoc /*_ foo _/,不写参数与返回值(TypeScript 已提供类型)。

其他:留意使用 (Object|Map).groupBy 替代旧写法;LSP 位置索引与 VS Code Web 扩展限制参见 references/lsp-and-web-extension.md。

限制:资料未提供安装命令、配置方式、适用平台与收费信息。