SuperAPI AI 工具集

write-coding-standards-from-file

编程与开发

查看项目

更新于 10-15 21:52

技能介绍

用途:根据传入的文件或文件夹,提取其缩进、变量命名、注释、条件与函数结构等语法风格,为项目编写编码规范文档。

主要能力:支持单文件(fileName,必填)、文件夹(folderName,可选)及额外说明(instructions,可选);多文件或文件夹时会把各文件数据汇总为一份数据集再分析。可选能力包括:发现不一致(findInconsistencies 默认为 true)、修复不一致(fixInconsistencies 默认为 true,但传入多个文件或文件夹时会被关闭)、创建新文件(createNewFile 默认 true,按 newFileName 列表选取不存在的文件名)、写入 README(addToREADME,可取 atBegin、middle、beforeEnd、bestFitUsingContext,默认 beforeEnd)、输出到提示(outputSpecToPrompt)、生成规范测试文件(addStandardsTest)、按语言抓取外部风格指南(fetchStyleURL)、选择模板(useTemplate 可为 v/verbose、m/minimal、b/best 或自定义)。

使用方式:在提示中提供必填的 fileName,可选 folderName、instructions,并以配置变量同名参数覆盖默认值。这些配置变量为布尔或字符串数组,默认值包括 addStandardsTest = false、addToREADME = false、createNewFile = true、fetchStyleURL = true、findInconsistencies = true、fixInconsistencies = true、outputSpecToPrompt = false、useTemplate = "verbose" 等。

适用场景:需要统一既有项目代码风格、生成 CONTRIBUTING.md/STYLE.md 类文档、或让规范与现有代码保持一致时。

限制:输出内容取决于传入文件;多文件场景下不自动修复不一致;未提供具体的收费、平台与效果信息。