feat(prettier): addprettier-plugin-jsdoc (#10)

Adds the prettier plugin `prettier-plugin-jsdoc`.
mheob · Jul 25, 2022 · ad1fc96 · ad1fc96
1 parent b9e3a2b
commit ad1fc96
Show file tree

Hide file tree

Showing 6 changed files with 314 additions and 8 deletions.
diff --git a/.changeset/gentle-wasps-try.md b/.changeset/gentle-wasps-try.md
@@ -0,0 +1,5 @@
+---
+"@mheob/prettier-config": minor
+---
+
+Add `prettier-plugin-jsdoc` to the prettier config.
diff --git a/package.json b/package.json
@@ -33,8 +33,8 @@
     "@changesets/cli": "^2.24.0",
     "@commitlint/cli": "^17.0.3",
     "@commitlint/config-conventional": "^17.0.3",
-    "@mheob/eslint-config": "workspace:0.0.0",
-    "@mheob/prettier-config": "workspace:0.0.0",
+    "@mheob/eslint-config": "workspace:*",
+    "@mheob/prettier-config": "workspace:*",
     "eslint": "^8.20.0",
     "lint-staged": "^13.0.3",
     "prettier": "^2.7.1",

diff --git a/packages/prettier-config/README.md b/packages/prettier-config/README.md
@@ -46,18 +46,25 @@ This configuration uses the
 plugin and set these styles:
 
 ```js
+const jsDocPlugin = require('prettier-plugin-jsdoc');
 const sortImports = require('@trivago/prettier-plugin-sort-imports');
 
 /** @type {import('prettier').Config} */
 module.exports = {
-  plugins: [sortImports],
+  plugins: [jsDocPlugin, sortImports],
+  arrowParens: 'always',
+  endOfLine: 'lf',
   printWidth: 100,
   proseWrap: 'always',
   importOrder: ['^node:', '<THIRD_PARTY_MODULES>', '^[./]'],
   importOrderSeparation: true,
   importOrderSortSpecifiers: true,
   singleQuote: true,
   semi: true,
+  tabWidth: 2,
+  trailingComma: 'all',
+  useTabs: false,
+
   overrides: [
     {
       files: '*.{yaml,yml}',

diff --git a/packages/prettier-config/index.cjs b/packages/prettier-config/index.cjs
@@ -1,8 +1,9 @@
+const jsDocPlugin = require('prettier-plugin-jsdoc');
 const sortImports = require('@trivago/prettier-plugin-sort-imports');
 
 /** @type {import('prettier').Config} */
 module.exports = {
-  plugins: [sortImports],
+  plugins: [jsDocPlugin, sortImports],
   arrowParens: 'always',
   endOfLine: 'lf',
   printWidth: 100,

diff --git a/packages/prettier-config/package.json b/packages/prettier-config/package.json
@@ -25,7 +25,8 @@
     "lint": "TIMING=1 eslint src/**/*.ts* --fix"
   },
   "dependencies": {
-    "@trivago/prettier-plugin-sort-imports": "^3.3.0"
+    "@trivago/prettier-plugin-sort-imports": "^3.3.0",
+    "prettier-plugin-jsdoc": "^0.3.38"
   },
   "devDependencies": {
     "@mheob/eslint-config": "workspace:*",