运行时依赖
安装命令
点击复制技能文档
使用文件编写编码标准 使用文件(或文件夹)中的现有语法来建立项目的标准和样式指南。如果传递了多个文件或文件夹,则循环遍历每个文件或文件夹中的文件,将文件数据追加到临时内存或文件中,当完成后使用临时数据作为单个实例,就像它是基于标准和样式指南的文件名一样。
规则和配置 以下是一组类似配置的布尔和字符串[] 变量。每个变量的处理条件(为 true 或其他值)在第二级标题 ## 变量和参数配置条件 下进行说明。提示参数具有文本定义。有一个必需参数 ${fileName},以及几个可选参数 ${folderName}、${instructions} 和任何 [configVariableAsParameter]。
配置变量 addStandardsTest = false; addToREADME = false; addToREADMEInsertions = ["atBegin", "middle", "beforeEnd", "bestFitUsingContext"];默认为 "beforeEnd"。 createNewFile = true; fetchStyleURL = true; findInconsistencies = true; fixInconsistencies = true; newFileName = ["CONTRIBUTING.md", "STYLE.md", "CODE_OF_CONDUCT.md", "CODING_STANDARDS.md", "DEVELOPING.md", "CONTRIBUTION_GUIDE.md", "GUIDELINES.md", "PROJECT_STANDARDS.md", "BEST_PRACTICES.md", "HACKING.md"];对于 ${newFileName} 中的每个文件,如果文件不存在,则使用该文件名并停止,否则继续到 ${newFileName} 的下一个文件名。 outputSpecToPrompt = false; useTemplate = "verbose";// 或 "v" 可能的值为 [["v", "verbose"], ["m", "minimal"], ["b", "best fit"], ["custom"]]。从提示文件底部的第二级标题 ## 编码标准模板 中选择一个示例模板,或使用更合适的组合。如果为 "custom",则按请求应用。
配置变量作为提示参数 如果任何变量名称被传递给提示(即使是类似的但明显相关的文本值),则使用传递给提示的值覆盖默认变量值。
提示参数 fileName = 将被分析的文件名,分析内容包括:缩进、变量命名、注释、条件过程、函数过程和文件编程语言的其他语法相关数据。 folderName = 将被用于从多个文件中提取数据到一个聚合数据集的文件夹名,用于分析缩进、变量命名、注释、条件过程、函数过程和文件编程语言的其他语法相关数据。 instructions = 为唯一情况提供的其他说明、规则和过程。 [configVariableAsParameter] = 如果传递,则覆盖配置变量的默认状态。示例:useTemplate = 如果传递,则覆盖配置 ${useTemplate} 默认值。值为 [["v", "verbose"], ["m", "minimal"], ["b", "best fit"]]。
必需和可选参数 fileName - 必需 folderName - 可选 instructions - 可选 [configVariableAsParameter] - 可选
变量和参数配置条件 ${fileName}.length > 1 || ${folderName} != undefined 如果为 true,则将 ${fixInconsistencies} 切换为 false。 ${addToREADME} == true 将编码标准插入 README.md 文件,而不是输出到提示或创建新文件。如果为 true,则将 ${createNewFile} 和 ${outputSpecToPrompt} 都切换为 false。 ${addToREADMEInsertions} == "atBegin" 如果 ${addToREADME} 为 true,则在 README.md 文件标题后插入编码标准数据。 ${addToREADMEInsertions} == "middle" 如果 ${addToREADME} 为 true,则在 README.md 文件中间插入编码标准数据,改变标准标题标题以匹配 README.md 组成。 ${addToREADMEInsertions} == "beforeEnd" 如果 ${addToREADME} 为 true,则在 README.md 文件末尾插入编码标准数据,在最后一个字符后插入新行,然后在新行插入数据。 ${addToREADMEInsertions} == "bestFitUsingContext" 如果 ${addToREADME} 为 true,则在 README.md 文件中最合适的行插入编码标准数据,考虑到 README.md 组成和数据流的上下文。 ${addStandardsTest} == true 编码标准文件完成后,编写测试文件以确保传递给它的文件或文件夹遵循编码标准。 ${createNewFile} == true 使用 ${newFileName} 的值或可能的值创建新文件。如果为 true,则将 ${outputSpecToPrompt} 和 ${addToREADME} 都切换为 false。 ${fetchStyleURL} == true 此外,使用从三级标题 ### Fetch Links 中嵌套的链接获取的数据作为创建标准、规格和样式数据的上下文,用于新文件、提示或 README.md。对于 ### Fetch Links 中的每个相关项,运行 #fetch ${item}。 ${findInconsistencies} == true 评估语法相关数据以查找不一致之处。