From 8dc8924cbef2abca6bfbd859916ee66d3a9f3af5 Mon Sep 17 00:00:00 2001 From: csh Date: Wed, 21 Jan 2026 10:20:19 +0800 Subject: [PATCH] :wrench: chore(markdown): add prettier config and usage --- .prettierrc.json | 4 ++++ docs/markdown/index.md | 4 ++-- package.json | 10 ++++++++++ rulesets/markdown/index.md | 2 +- 4 files changed, 17 insertions(+), 3 deletions(-) create mode 100644 .prettierrc.json create mode 100644 package.json diff --git a/.prettierrc.json b/.prettierrc.json new file mode 100644 index 0000000..bd07196 --- /dev/null +++ b/.prettierrc.json @@ -0,0 +1,4 @@ +{ + "proseWrap": "preserve", + "embeddedLanguageFormatting": "off" +} diff --git a/docs/markdown/index.md b/docs/markdown/index.md index 7c7b765..308a3af 100644 --- a/docs/markdown/index.md +++ b/docs/markdown/index.md @@ -18,8 +18,8 @@ ## 格式化工具 -- 优先使用仓库已固定的工具配置 -- 若存在 Prettier 配置，使用项目脚本或 `npx prettier -w ` +- 优先使用 Prettier（仓库已固定配置/脚本） +- 若存在项目脚本，优先使用 `npm run format:md`；否则可用 `npx prettier -w ` - 不引入新的 Markdown 格式化工具 ## 关联规则 diff --git a/package.json b/package.json new file mode 100644 index 0000000..7f6bf85 --- /dev/null +++ b/package.json @@ -0,0 +1,10 @@ +{ + "name": "playbook", + "private": true, + "devDependencies": { + "prettier": "3.2.5" + }, + "scripts": { + "format:md": "prettier -w \"**/*.md\"" + } +} diff --git a/rulesets/markdown/index.md b/rulesets/markdown/index.md index 49fea16..9603d60 100644 --- a/rulesets/markdown/index.md +++ b/rulesets/markdown/index.md @@ -18,7 +18,7 @@ ### 工具 -- 优先使用仓库既有的格式化工具（如 Prettier） +- 优先使用 Prettier（仓库已固定配置/脚本） - 不引入新的 Markdown 格式化依赖 ### 行内代码