summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoe Carstairs <me@joeac.net>2025-07-17 23:00:06 +0100
committerJoe Carstairs <me@joeac.net>2025-07-17 23:11:51 +0100
commit5a75def2f5e9cd5f3421a908505c59ac074dae74 (patch)
tree1769bde608704763b5176830d60dc275fb6a9448
parentb8681be6bbac2201779a9e39b6ef8b72e085ef69 (diff)
Add dprint formatter
-rw-r--r--.dprint.json20
-rw-r--r--README.md16
2 files changed, 36 insertions, 0 deletions
diff --git a/.dprint.json b/.dprint.json
new file mode 100644
index 0000000..e1b5c04
--- /dev/null
+++ b/.dprint.json
@@ -0,0 +1,20 @@
+{
+ "plugins": [
+ "https://plugins.dprint.dev/markdown-0.19.0.wasm",
+ "https://plugins.dprint.dev/ruff-0.4.2.wasm",
+ "https://plugins.dprint.dev/toml-0.7.0.wasm",
+ "https://plugins.dprint.dev/json-0.20.0.wasm"
+ ],
+
+ "excludes": [
+ "**/target"
+ ],
+ "indentWidth": 4,
+ "lineWidth": 80,
+ "newLineKind": "lf",
+ "useTabs": true,
+
+ "markdown": {
+ "textWrap": "always"
+ }
+}
diff --git a/README.md b/README.md
index c4e0338..e75a1e2 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,22 @@
Schist is a budgeting app.
+## Formatting
+
+Schist is formatted using dprint.
+
+To install on Mac or Linux, use Homebrew:
+
+```sh
+brew install dprint
+```
+
+To format the project, run:
+
+```sh
+dprint fmt
+```
+
## Links
- [Designs](https://design.penpot.app/#/workspace/345886aa-f4d1-8033-8005-670f665094a3/a0a8e792-b2d2-818e-8005-670ffeb32184)