naloveyuki/BitLogger
1
0
Fork 0
mirror of https://github.com/Nanaloveyuki/BitLogger.git synced 2026-07-25 17:32:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

📝 clarify formatter export docs

Browse Source
This commit is contained in:
Nanaloveyuki
2026-06-14 01:45:18 +08:00
parent 323d58059b
commit e53555edb2
2 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/stringify-text-formatter-config.md
+7
View File
@@ -40,6 +40,7 @@ Detailed rules explaining key parameters and behaviors
- `pretty=false` returns compact JSON.
- `pretty=true` returns indented JSON for humans.
- This helper is built on top of `text_formatter_config_to_json(...)`.
- Internally it serializes the `JsonValue` result with `@json_parser.stringify(...)` or `@json_parser.stringify_pretty(value, 2)`, so the text form stays aligned with the structured formatter export helper.
- The output preserves the supported formatter config schema instead of any runtime-only formatter instance details.
### How to Use
@@ -73,3 +74,9 @@ e.g.:
- If `style_tags` is empty, the serialized text omits that field rather than forcing an empty object.
### Notes
1. Use this helper when the next consumer expects JSON text instead of `JsonValue`.
2. Use `text_formatter_config_to_json(...)` when you still need to embed formatter config inside a larger JSON object before final stringification.