docs: add docs about scriptFormatter option

g-plane · Dec 2, 2024 · de628cf · de628cf
1 parent e1b7a20
commit de628cf
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -25,5 +25,6 @@
   - [svelteAttrShorthand](./config/svelte-attr-shorthand.md)
   - [svelteDirectiveShorthand](./config/svelte-directive-shorthand.md)
   - [astroAttrShorthand](./config/astro-attr-shorthand.md)
+  - [scriptFormatter](./config/script-formatter.md)
   - [ignoreCommentDirective](./config/ignore-comment-directive.md)
   - [ignoreFileCommentDirective](./config/ignore-file-comment-directive.md)
diff --git a/docs/src/config/script-formatter.md b/docs/src/config/script-formatter.md
@@ -0,0 +1,10 @@
+# `scriptFormatter`
+
+Tell markup_fmt what script formatter you are using.
+
+Possible options:
+
+- `"dprint"`: Use this if you're using dprint-plugin-typescript.
+- `"biome"`: Use this if you're using Biome or dprint-plugin-biome.
+
+In dprint, default option is `"dprint"`; otherwise, default option is `null`.
diff --git a/dprint_plugin/deployment/schema.json b/dprint_plugin/deployment/schema.json
@@ -342,6 +342,11 @@
       "type": ["boolean", "null"],
       "default": null
     },
+    "scriptFormatter": {
+      "description": "Tell markup_fmt what script formatter you are using.",
+      "type": ["string", "null"],
+      "default": "dprint"
+    },
     "ignoreCommentDirective": {
       "description": "Text directive for ignoring formatting specific element or node.",
       "type": "string",