Title (#XXXX by user)【免费下载链接】prettierPrettier is an opinionated code formatter.项目地址: https://gitcode.com/gh_mirrors/pr/prettier// Input (foo ?? baz) || baz; // Prettier stable foo ?? baz || baz; // Prettier main (foo ?? baz) || baz;其中 1–23 行是 HTML 注释充当使用说明25 行开始的 #### 标题与代码块则是「可复制」的条目骨架。整个模板被 [scripts/generate-changelog.js](https://link.gitcode.com/i/52df3a0eb1a1c7f106f4d3cb27842259) 和 [scripts/utilities/changelog.js](https://link.gitcode.com/i/c6de925db5d05b73689a00ffbc5bcbf1) 直接读取、字符串替换后生成实际条目文件因此注释中的每一句说明都对应着真实的自动化行为。 模板注释第 2–22 行规定了 8 个步骤下文逐一展开并结合源码验证。 ## 第一步按语言选择分类目录 模板要求先根据 PR 涉及的语言选择文件夹 - JavaScript 语法选 javascript/ - TypeScript 特有语法选 typescript/ - 同时影响多种语言如 TypeScript 与 Flow时选其中一个目录并在描述中注明适用范围。 这些分类目录在 [scripts/utilities/changelog.js](https://link.gitcode.com/i/c6de925db5d05b73689a00ffbc5bcbf1#L10-L31) 中被硬编码为 20 个类别javascript、typescript、flow、json、css、scss、less、html、vue、angular、lwc、mjml、handlebars、graphql、markdown、mdx、yaml、api、cli、misc杂项。该列表同时被 [scripts/generate-changelog.js](https://link.gitcode.com/i/52df3a0eb1a1c7f106f4d3cb27842259#L39-L46) 用作交互式分类选择菜单以及被 [scripts/lint-changelog.js](https://link.gitcode.com/i/14f98b1fb2dc22cdd930e0061871ce78) 用作目录白名单校验——changelog_unreleased/ 下只允许存在这些分类目录、TEMPLATE.md 与 BLOG_POST_INTRO_TEMPLATE.md任何多余文件都会触发 Please remove xxx from changelog_unreleased. 的报错。 ## 第二步以 PR 号命名文件 模板要求新建文件名为 XXXX.md例如 typescript/6728.md。命名规则在 [scripts/lint-changelog.js](https://link.gitcode.com/i/7a8b731643897691e371a1c404286198) 中以正则 /^(\d{4,})(-\d)?\.md$/ 强制约束 - PR 号至少 4 位数字防止 3 位编号被误认为年份 - 允许 19897-2.md 这类带 -N 后缀的同 PR 多条目文件同一 PR 修复多个问题时拆成多条 - 跨目录不允许出现同名文件checkedFiles 查重见 [lint-changelog.js](https://link.gitcode.com/i/f6707fad086afd048ce38f9d62c677d1)。 仓库中实际存在大量此类文件例如 [changelog_unreleased/typescript/19897.md](https://link.gitcode.com/i/62d0ab36ce4549e951e106bcde5bc5da) 与 [changelog_unreleased/typescript/19897-2.md](https://link.gitcode.com/i/cfbaef2d2c1c1aa58685ca42299b0cb3) 即属同一 PR 拆分出的两条记录。 ## 第三步与第四步复制模板并填写标题 将模板正文复制到新文件后需要填充三要素 - **Title**用 PR 的标题替换 - **#XXXX**替换为真实 PR 号 - **user**替换为 PR 作者的 GitHub 用户名。 最终格式为 #### Title (#12345 by author)。该格式不是随意的而是被工具链严格解析 - [scripts/utilities/changelog.js](https://link.gitcode.com/i/c6de925db5d05b73689a00ffbc5bcbf1#L42) 读取条目文件时按换行切分第一行即标题 - 后续处理[changelog.js](https://link.gitcode.com/i/c6de925db5d05b73689a00ffbc5bcbf1#L109-L118) 的 processTitle会把 username 自动转为 GitHub 用户链接、把 #12345 自动转为 PR 链接 - [scripts/lint-changelog.js](https://link.gitcode.com/i/ef0d14ecc9021d9084bc68e12be3eb7f) 用正则校验标题必须以 #### h4 标题开头、必须包含 (#\d{4,} 形式的 PR 链接与 by 形式的作者信息并进一步规定标题与 PR 链接之间必须且只能有一个空格第 135–139 行、标题内不得残留分类前缀第 126–133 行、标题内禁止出现 HTML 标签validateTitle第 165–179 行。 ## 第五步按需撰写描述 模板中 !-- Optional description if it makes sense. -- 是可选的文字描述。实际条目中许多变更仅凭代码示例就能说明问题此时描述可以省略当示例不足以表达意图如修复的是不稳定输出、Unicode 宽度等难以从代码本身看出的问题时则补充一句话描述。典型例子 - [changelog_unreleased/misc/19538.md](https://link.gitcode.com/i/e2f84b7354a3666f4b2d8e7a652cb134) 在代码块前写了 Prettier now treats Unicode nonspacing and enclosing marks as zero-width when measuring lines.用于解释藏文零宽字符处理 - [changelog_unreleased/javascript/19345.md](https://link.gitcode.com/i/1f4142625cae0583b83db2724153fbca) 则只给示例不给描述。 校验脚本会逐条扫描模板中的注释[lint-changelog.js](https://link.gitcode.com/i/c34533c12bef7ed8c788a008fe7a6244)除 !-- prettier-ignore -- 外任何残留的模板注释都会被报错并要求删除——这保证了不会有人忘记填写字段。 ## 第六步与第七步按语言替换代码块语法与注释符号 模板默认使用 jsx 代码块和 // 行注释// Input、// Prettier stable、// Prettier main。这两者都需根据分类目录调整 | 分类目录 | 代码块语法 | 注释示例 | | --- | --- | --- | | javascript / api / misc | jsx | // Input | | typescript | tsx | // Input | | flow | flow | // Input | | css / scss / less | css | /* Input */ | | html / angular / lwc / mjml | html | !-- Input -- | | handlebars | hbs | {{! Input }} | | graphql | gql | # Input | | markdown | md | !-- Input -- | | mdx | mdx | !-- Input -- | | json | jsonc | // Input | | yaml | yaml | # Input | | cli | sh | # Input | 这张映射表并非仅存在于文档注释中而是被 [scripts/generate-changelog.js](https://link.gitcode.com/i/52df3a0eb1a1c7f106f4d3cb27842259#L166-L224) 以 getSyntaxFromCategory 和 generateComment 两个函数硬编码实现。也就是说当你用官方脚本生成条目时这些替换是自动完成的 bash node ./scripts/generate-changelog.js脚本会依次交互式询问 PR 号与分类通过 GitHub API 拉取 PR 标题和作者generate-changelog.js读取TEMPLATE.md后按分类做字符串替换最终写入changelog_unreleased/category/prNumber.mdgenerate-changelog.js。第八步编写示例代码并对比前后输出模板要求「选择一段漂亮的输入示例代码并同时给出 PR 前后before/after的输出」。这形成了 changelog 条目的核心结构// Input (foo ?? baz) || baz; // Prettier stable foo ?? baz || baz; // Prettier main (foo ?? baz) || baz;【免费下载链接】prettierPrettier is an opinionated code formatter.项目地址: https://gitcode.com/gh_mirrors/pr/prettier创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考