chore: add JSDoc formatting to prettier

HenriqueLimas · Oct 10, 2023 · 57ddea7 · 57ddea7
1 parent 3516710
commit 57ddea7
Show file tree

Hide file tree

Showing 3 changed files with 67 additions and 37 deletions.
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -1,4 +1,7 @@
 {
+  "plugins": ["./node_modules/prettier-plugin-jsdoc/dist/index.js"],
+  "jsdocPreferCodeFences": true,
+  "tsdoc": true,
   "trailingComma": "es5",
   "tabWidth": 2,
   "semi": true,

diff --git a/package.json b/package.json
@@ -70,6 +70,7 @@
     "ora": "6.3.1",
     "path-browserify": "1.0.1",
     "prettier": "3.0.0",
+    "prettier-plugin-jsdoc": "^1.1.1",
     "pretty-quick": "^3.1.3",
     "prompts": "2.4.2",
     "rollup": "3.26.3",
@@ -120,7 +121,7 @@
     "cli.validate": "tsm scripts/validate-cli.ts",
     "commit": "git-cz",
     "deps": "pnpm upgrade -i -r --latest",
-    "docs.sync": "tsm scripts/docs_sync/index.ts",
+    "docs.sync": "tsm scripts/docs_sync/index.ts && pnpm fmt",
     "eslint.update": "tsm scripts/eslint-docs.ts",
     "fmt": "pnpm prettier.fix && pnpm syncpack format",
     "fmt.staged": "pretty-quick --staged",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml