SuperAPI AI 工具集

isentinel

编程与开发

查看项目

更新于 11-10 20:43

技能介绍

isentinel 是一组面向 roblox-ts 开发的“有主见”的工具与模式偏好,用于在新建 roblox-ts 项目或出现代码风格、工具链决策时提供统一约定。以下按用途、主要能力、使用方式、适用场景和限制分述。

用途:为 roblox-ts 项目提供一套默认的技术选型与工程规范,覆盖包管理器、语言与类型检查、lint 与格式化、测试、Git 钩子与提交规范,以及错误处理倾向。

主要能力与约定:

  1. 包管理器:使用 pnpm;bun 可作为脚本运行时。建议用 @antfu/ni 统一命令,它能根据锁文件自动识别 pnpm/npm/yarn/bun。常用命令包括:ni 安装依赖、ni <pkg> 添加依赖、ni -D <pkg> 添加开发依赖、nr <script> 运行脚本、nu 升级依赖、nun <pkg> 卸载依赖、nci 干净安装、nlx <pkg> 执行包。
  2. TypeScript:使用 @isentinel/tsconfig 的 roblox 预设,配置为 { "extends": "@isentinel/tsconfig/roblox" }。在严格模式之外启用额外检查:exactOptionalPropertyTypes、noUncheckedIndexedAccess、noPropertyAccessFromIndexSignature、noImplicitOverride、noImplicitReturns、noFallthroughCasesInSwitch。
  3. Linting 与格式化:使用 @isentinel/eslint-config,不使用 Prettier,由 ESLint 负责格式化。配置示例为:import { isentinel } from "@isentinel/eslint-config"; export default isentinel(); 可用 nr lint --fix 修复错误。
  4. 错误处理:偏好断言而非静默失败,主张快速失败、明确失败(fail fast, fail loud)。
  5. 测试驱动开发:采用 Red → Green → Refactor 流程——先写失败测试,再写最小实现使其通过,最后在测试保护下重构。简单性规则按顺序为:通过所有测试、清晰表达意图、无重复、元素最少;并认为三行相似代码优于过早抽象。Jest-roblox 用于测试。
  6. Git 钩子与提交:使用 husky + lint-staged;提交遵循 Conventional Commits。

使用方式:资料给出的是偏好与配置示例,未提供完整的初始化安装命令或项目模板步骤。实际使用时需要按上述约定自行配置 pnpm、@antfu/ni、@isentinel/tsconfig、@isentinel/eslint-config、Jest-roblox、husky、lint-staged 等。

适用场景:新建 roblox-ts 项目、统一团队工具链与代码风格、需要严格 TypeScript 检查、采用 TDD 与约定式提交的 roblox-ts 开发。

限制:资料未提供具体安装命令、完整配置细节、版本要求、收费或平台支持信息;引用文档(tooling.md、typescript.md、linting.md、testing.md、error-handling.md)的内容未在资料中展开。