头像 One
头像 One

更多功能请点顶栏「快捷菜单」

博客 OneBlog 673 字 3 分钟 -- 次

formatter工具

最后更新于:

formatter-tool 使用说明

版权：来自@cursor，开发于2026年8月12日。

One亲测有效哦。😘

需求

 1请给我创建一个formatter工具：
 2
 3功能1：
 4可以把`hugo-teek-site\content\docs`目录下所有.md文档 的formatter内容给清空，但是如下内容不执行此规则：
 5
 6
 7_下划线开头的所有目录及md文档 跳过；
 8`hugo-teek-site\content\docs\55.朋友圈`目录 跳过；
 9目录页的 跳过；
10涉及到菜单相关的md或者页面 跳过；
11
12
13功能2：
14可以对特定目录执行以上规则：
15例如
16formatter-tool "hugo-teek-site\content\docs\30.专题\20.博客\500.astro" #这个命令意思是把此目录下的所有md的formatter内容给清空
17
18请实现。

使用

在仓库根目录执行。

入口

环境命令
Git Bash./formatter-tool ...
cmdformatter-tool.cmd ...
通用node scripts/formatter-tool.mjs ...
Makemake clear-formatter / make clear-formatter DIR="子目录"
帮助./formatter-tool --help

三种模式

1. 只清空（删掉字段，保留空的 --- 围栏）

1./formatter-tool
2./formatter-tool "hugo-teek-site/content/docs/30.专题/20.博客/500.astro"

2. 清空 + 立即注入（迁移场景推荐）

1./formatter-tool --inject "hugo-teek-site/content/docs/30.专题/20.博客/500.astro"

3. 只注入、不清空（只补缺失字段，不覆盖已有值）

1./formatter-tool --inject-only
2./formatter-tool --inject-only "hugo-teek-site/content/docs/30.专题/20.博客/500.astro"

预览不写盘：加 --dry-run。

1./formatter-tool --dry-run --inject "hugo-teek-site/content/docs/30.专题/20.博客/500.astro"

作用范围

  • 不传路径：处理整个 hugo-teek-site/content/docs
  • 传路径：只处理该目录及子目录下的 .md

自动跳过

规则说明
_ 开头如 _其它、_index.md
55.朋友圈整棵跳过
50.关于菜单相关页
目录页catalogue: true 或 article: false
特殊页type/layout 为 about、friends、moments、websites 等

注入会写什么

只补缺失字段（已有则不动）：

字段来源
title文件名去掉排序序号（保留横线）
date当前时间
description' '
draftfalse
coverImgcoverImages.json 依次取
url按 sections.toml 一级目录前缀 + 5 位随机 id（如 /topics/xxxxx）

推荐流程😘

1# 某目录：清空并重新注入
2./formatter-tool --inject "hugo-teek-site/content/docs/30.专题/20.博客/500.astro"
3
4# 或只清空后，靠 start 兜底注入
5./formatter-tool "hugo-teek-site/content/docs/30.专题/20.博客/500.astro"
6start-blog-frontend.bat

start-blog-frontend.bat 已接入 inject-frontmatter：即使只剩空围栏，启动时也会补齐 title/date/coverImg/url 等。

Make 示例

1make clear-formatter
2make clear-formatter DIR="hugo-teek-site/content/docs/30.专题/20.博客/500.astro"
3make clear-formatter DRY_RUN=1

注意

空的 --- / --- 时，官方 hugo-teek-tools 经常注不进去。清空后请用 --inject / --inject-only，或再跑一次 start。

📡
👤 作者: One
🔗 链接: https://onedayxyy.cn/topics/oneblog-formatter-tool
🌐 版权: 本站文章除特别声明外，均采用 CC BY-NC-SA 4.0 协议，转载请注明来自 One Blog！
最新文章