🧑‍💻 dprint formatter for markdown, json, toml and yaml (#688)

Author: jorenham

.dprint.jsonc

@@ -0,0 +1,27 @@
+{
+  "json": {
+    "lineWidth": 100,
+    "array.preferSingleLine": true,
+    "jsonTrailingCommaFiles": [".vscode/extensions.json", ".vscode/settings.json"],
+  },
+  "markdown": {
+    "lineWidth": 200,
+    "emphasisKind": "asterisks",
+  },
+  "toml": {
+    "lineWidth": 100,
+  },
+  "yaml": {
+    "printWidth": 100,
+    "formatComments": true,
+    // "indentBlockSequenceInMap": false,
+    "braceSpacing": false,
+  },
+  "excludes": ["**/*-lock.json", "**/*.lock", "**/node_modules/", "dist/"],
+  "plugins": [
+    "https://plugins.dprint.dev/g-plane/pretty_yaml-v0.5.1.wasm",
+    "https://plugins.dprint.dev/json-0.20.0.wasm",
+    "https://plugins.dprint.dev/markdown-0.19.0.wasm",
+    "https://plugins.dprint.dev/toml-0.7.0.wasm",
+  ],
+}

.github/workflows/ci.yml

@@ -29,14 +29,11 @@ jobs:
         with:
           plugins: sp-repo-review
 
-      - name: markdownlint
-        uses: DavidAnson/markdownlint-cli2-action@v20
-        with:
-          config: ".markdownlint.yaml"
-          globs: "**/*.md"
+      - name: dprint
+        uses: dprint/[email protected]
 
       - name: typos
-        uses: crate-ci/typos@master
+        uses: crate-ci/typos@v1.33.1
 
       - uses: astral-sh/setup-uv@v6
         with:

.markdownlint.yaml

@@ -2,13 +2,10 @@
   "recommendations": [
     "charliermarsh.ruff",
     "detachhead.basedpyright",
+    "dprint.dprint",
     "ms-python.mypy-type-checker",
     "ms-python.python",
     "seatonjiang.gitmoji-vscode",
-    "tamasfe.even-better-toml"
   ],
-  "unwantedRecommendations": [
-    "ms-pyright.pyright",
-    "ms-python.vscode-pylance"
-  ]
+  "unwantedRecommendations": ["ms-pyright.pyright", "ms-python.vscode-pylance"],
 }

.vscode/extensions.json

@@ -1,39 +1,45 @@
 {
-  "[json][jsonc][yaml][yml]": {
-    "editor.tabSize": 2
+  "[json]": {
+    "editor.defaultFormatter": "dprint.dprint",
+    "editor.rulers": [100],
+    "editor.tabSize": 2,
+  },
+  "[jsonc]": {
+    "editor.defaultFormatter": "dprint.dprint",
+    "editor.rulers": [100],
+    "editor.tabSize": 2,
   },
   "[markdown]": {
-    "editor.rulers": [
-      200
-    ]
+    "editor.defaultFormatter": "dprint.dprint",
+    "editor.rulers": [200],
   },
   "[python]": {
-    "editor.rulers": [
-      130
-    ]
+    "editor.rulers": [130],
+    "editor.tabSize": 4,
   },
   "[toml]": {
-    "editor.rulers": [
-      100
-    ]
+    "editor.defaultFormatter": "dprint.dprint",
+    "editor.rulers": [100],
+    "editor.tabSize": 2,
+  },
+  "[yaml]": {
+    "editor.defaultFormatter": "dprint.dprint",
+    "editor.rulers": [100],
+    "editor.tabSize": 2,
+  },
+  "[yml]": {
+    "editor.defaultFormatter": "dprint.dprint",
+    "editor.rulers": [100],
+    "editor.tabSize": 2,
   },
-  "editor.tabSize": 4,
-  "evenBetterToml.formatter.alignComments": true,
-  "evenBetterToml.formatter.allowedBlankLines": 2,
-  "evenBetterToml.formatter.arrayTrailingComma": true,
-  "evenBetterToml.formatter.columnWidth": 100,
-  "evenBetterToml.formatter.compactArrays": true,
-  "evenBetterToml.formatter.compactInlineTables": true,
-  "evenBetterToml.formatter.indentString": "    ",
-  "evenBetterToml.formatter.indentTables": true,
-  "evenBetterToml.formatter.trailingNewline": true,
+  "dprint.path": ".venv/bin/dprint",
   "mypy-type-checker.path": [
     "uv",
     "run",
     "--frozen",
     "--isolated",
     "--no-editable",
     "--refresh-package=scipy-stubs",
-    "mypy"
-  ]
+    "mypy",
+  ],
 }

.vscode/settings.json

@@ -89,32 +89,32 @@ conda install conda-forge::scipy-typed
 ### Q: Do I need to change my existing code?
 
 **A:** No! `scipy-stubs` works with your existing code without any modifications.
-    Just install it and your type checker and IDE will automatically use the type information.
+Just install it and your type checker and IDE will automatically use the type information.
 
 ### Q: Will this slow down my code?
 
 **A:** Not at all. Type stubs are only used during development and type checking.
-    They have zero runtime overhead since they're not imported when your code runs.
+They have zero runtime overhead since they're not imported when your code runs.
 
 ### Q: What if I don't use type hints in my code?
 
 **A:** You'll still benefit! Your IDE will provide better autocompletion and error detection
-    even without explicit type annotations in your code.
+even without explicit type annotations in your code.
 
 ### Q: Can I use this with Jupyter notebooks?
 
 **A:** Yes! Most modern Jupyter environments (JupyterLab, VS Code notebooks) support
-    type checking and will benefit from `scipy-stubs`.
+type checking and will benefit from `scipy-stubs`.
 
 ### Q: What's the difference between this and the built-in scipy typing?
 
 **A:** SciPy itself has limited type annotations. `scipy-stubs` provides comprehensive,
-    precise type information for the entire SciPy API, including shape-typing and advanced type features.
+precise type information for the entire SciPy API, including shape-typing and advanced type features.
 
 ### Q: How do I know if it's working?
 
 **A:** You should see improved autocompletion in your IDE and more precise type information.
-    You can also run `pyright` or another type checker on your code to see type checking in action.
+You can also run `pyright` or another type checker on your code to see type checking in action.
 
 ### Q: How much of SciPy is covered?
 
@@ -123,8 +123,8 @@ conda install conda-forge::scipy-typed
 ### Q: What static type-checkers are supported?
 
 **A:** `scipy-stubs` is compatible with [`pyright`](https://pyright.readthedocs.io/en/latest/index.html) (a.k.a. pylance),
-    [`basedpyright`](https://github.com/DetachHead/basedpyright), and [`mypy`](https://github.com/python/mypy).
-    We only support the latest versions of these type-checkers, so make sure to keep them up to date.
+[`basedpyright`](https://github.com/DetachHead/basedpyright), and [`mypy`](https://github.com/python/mypy).
+We only support the latest versions of these type-checkers, so make sure to keep them up to date.
 
 ## Versioning and requirements
 

README.md

@@ -4,6 +4,10 @@ templates:
 pre-commit:
   parallel: true
   jobs:
+    - name: dprint
+      glob: "*.{json,jsonc,md,toml,yaml,yml}"
+      stage_fixed: true
+      run: uv {run} dprint fmt --incremental=false
     - name: ruff
       glob: "*.{py,pyi}"
       stage_fixed: true