这个目录收纳 interview-notes 仓库的文档维护脚本,主要用于补齐导航、校验入口页和检查根文档链接。
- 从仓库首页了解整体维护约束:../README.md
- 需要贡献约定时优先阅读:../CONTRIBUTING.md
- 要执行脚本校验时,先看下方的推荐维护顺序
用途:
- 为仓库内的大多数 Markdown 文档补齐统一的“导航”区块
- 自动生成返回仓库首页、当前专题导航、上一级主题等相对链接
适用场景:
- 新增了一批文档,需要批量补导航
- 调整目录结构后,希望统一刷新导航块
示例:
node scripts/standardize-markdown-navigation.mjs用途:
- 校验根目录关键文档中的相对链接是否仍然有效
当前覆盖:
README.mdCONTRIBUTING.mdreview-tips.md
示例:
node scripts/check-root-doc-links.mjs用途:
- 扫描所有专题
README.md中的相对链接 - 找出入口页是否引用了已不存在的文档
使用方式:
node scripts/check-readme-links.mjs
node scripts/check-readme-links.mjs --strict说明:
- 默认模式会输出问题清单,但不阻断
--strict模式会在发现失效链接时返回非零退出码
用途:
- 审计专题
README.md是否真正像“入口页” - 检查是否缺少导航标记、推荐入口标题或简介段落
使用方式:
node scripts/check-readme-entry-pages.mjs
node scripts/check-readme-entry-pages.mjs --strict说明:
- 默认模式用于查看结构缺口
--strict模式适合在批量收口后做最终校验
用途:
- 审计普通笔记页是否带有统一的导航区块
- 检查导航里的相对链接是否有效,以及是否保留返回仓库首页入口
使用方式:
node scripts/check-markdown-navigation.mjs
node scripts/check-markdown-navigation.mjs --strict说明:
- 默认模式用于查看哪些普通 Markdown 页面还没有对齐导航规范
--strict模式适合在批量补齐导航后做全仓校验
用途:
- 按仓库推荐顺序串行执行全部维护校验
- 适合在提交前做一次完整的仓库维护检查
使用方式:
node scripts/run-maintenance-checks.mjs说明:
- 脚本会依次运行导航、README 链接、README 入口页、复习建议结构、贡献指南维护、脚本说明覆盖、维护顺序同步、根 README 主题覆盖、根 README 复习顺序、根 README 结构、根文档链接十一类检查
- 任一步失败都会以非零退出码结束,方便作为提交前自检入口
用途:
- 校验
review-tips.md的标题、简介和编号建议条目数量是否稳定 - 检查复习建议页是否保留导航标记和返回仓库首页入口
- 提前发现根目录复习建议文档被误删、改空或结构漂移的情况
使用方式:
node scripts/check-review-tips-structure.mjs说明:
- 适合在调整
review-tips.md内容组织或根目录复习入口后运行 - 如果复习建议页缺少关键结构,脚本会直接返回非零退出码
用途:
- 校验
CONTRIBUTING.md的核心章节是否齐全且顺序稳定 - 检查贡献指南是否保留一键维护检查入口和关键维护命令
- 提前发现贡献流程说明被误删、遗漏或与维护脚本脱节的情况
使用方式:
node scripts/check-contributing-maintenance.mjs说明:
- 适合在调整贡献指南、维护流程文案或脚本入口后运行
- 如果
CONTRIBUTING.md缺少关键命令、链接或导航标记,脚本会直接返回非零退出码
用途:
- 校验
scripts/README.md是否覆盖当前仓库中的维护脚本 - 检查脚本说明里是否引用了已经不存在的脚本文件
- 提前发现脚本新增后忘记补说明的情况
使用方式:
node scripts/check-scripts-readme-coverage.mjs说明:
- 适合在新增、删除或重命名维护脚本后运行
- 如果脚本清单和说明文档不一致,脚本会直接返回非零退出码
用途:
- 校验
scripts/run-maintenance-checks.mjs与本文件中的推荐维护顺序是否保持一致 - 检查一键维护检查入口是否仍然指向
node scripts/run-maintenance-checks.mjs - 提前发现新增校验后只改了脚本或只改了文档的漂移情况
使用方式:
node scripts/check-maintenance-check-order.mjs说明:
- 适合在调整维护脚本总入口、推荐步骤顺序或新增聚合检查项后运行
- 如果聚合检查顺序与
scripts/README.md不一致,脚本会直接返回非零退出码
用途:
- 校验根
README.md是否覆盖所有编号顶层主题目录 - 检查每个顶层主题目录是否都有
README.md - 检查根
README.md里的顶层主题入口是否存在失效或多余链接
使用方式:
node scripts/check-root-readme-topics.mjs说明:
- 适合在新增、调整或收拢一级主题目录后运行
- 如果根
README.md与顶层主题结构不一致,脚本会直接返回非零退出码
用途:
- 校验根
README.md的“推荐复习顺序”章节是否仍然存在 - 检查该章节是否保留 6 条编号建议与核心复习路径提示
- 提前发现首页复习路径被误删、缩减或改散的情况
使用方式:
node scripts/check-root-readme-study-order.mjs说明:
- 适合在调整根
README.md的复习节奏说明或首页推荐路径后运行 - 如果“推荐复习顺序”缺少关键步骤或核心主题提示,脚本会直接返回非零退出码
用途:
- 校验根
README.md的核心章节是否齐全且顺序稳定 - 检查“复习与维护”章节是否保留关键维护入口
- 提前发现首页结构被误删、打散或重排的情况
使用方式:
node scripts/check-root-readme-structure.mjs说明:
- 适合在调整根
README.md的内容组织、维护说明或目录导航后运行 - 如果首页缺少关键章节或维护入口,脚本会直接返回非零退出码
当你改动目录导航或专题入口页时,建议按这个顺序执行:
- 想一次性跑完整套检查时,直接执行
node scripts/run-maintenance-checks.mjs - 如有需要,先运行
node scripts/standardize-markdown-navigation.mjs - 运行
node scripts/check-markdown-navigation.mjs --strict - 运行
node scripts/check-readme-links.mjs --strict - 运行
node scripts/check-readme-entry-pages.mjs --strict - 如果改了复习建议页或根目录复习入口,再运行
node scripts/check-review-tips-structure.mjs - 如果改了贡献指南或维护流程入口,再运行
node scripts/check-contributing-maintenance.mjs - 如果改了
scripts/下的脚本或说明,再运行node scripts/check-scripts-readme-coverage.mjs - 如果改了维护脚本总入口或推荐步骤顺序,再运行
node scripts/check-maintenance-check-order.mjs - 如果改了根目录主题导航,再运行
node scripts/check-root-readme-topics.mjs - 如果改了首页推荐复习路径,再运行
node scripts/check-root-readme-study-order.mjs - 如果改了根 README 的章节组织,再运行
node scripts/check-root-readme-structure.mjs - 如果改了根文档,再运行
node scripts/check-root-doc-links.mjs