@homer0/prettier-plugin-jsdoc - npm Package Compare versions

Comparing version 6.0.0 to 6.0.1

CHANGELOG.md

@@ -6,2 +6,9 @@ # Change Log
 
+## 6.0.1 (2023-01-28)
+
+### Bug Fixes
+
+- **monorepo:** update all dependencies ([7618870](https://github.com/homer0/packages/commit/7618870e6ec4d6f281a79b15f139124875c760b2))
+- **prettier-plugin-jsdoc:** include 'return' as tag with name as desc ([cf3a81c](https://github.com/homer0/packages/commit/cf3a81c09ecb21bce58595626a3b99bad698a211))
+
 # [6.0.0](https://github.com/homer0/packages/compare/@homer0/prettier-plugin-jsdoc@5.1.6...@homer0/prettier-plugin-jsdoc@6.0.0) (2022-12-27)
@@ -8,0 +15,0 @@

package.json

 {
   "name": "@homer0/prettier-plugin-jsdoc",
   "description": "A Prettier plugin to format JSDoc blocks.",
-  "version": "6.0.0",
+  "version": "6.0.1",
   "repository": {
@@ -24,8 +24,8 @@ "type": "git",
     "comment-parser": "^1.3.1",
-    "prettier": "^2.8.1",
+    "prettier": "^2.8.3",
     "ramda": "0.28.0"
   },
   "devDependencies": {
-    "jest": "^29.3.1",
-    "jest-environment-node": "^29.3.1"
+    "jest": "^29.4.1",
+    "jest-environment-node": "^29.4.1"
   },
@@ -43,3 +43,3 @@ "engine-strict": true,
   },
-  "gitHead": "86d8723fd11c969e334d58c4e6bc4d290311fe26"
+  "gitHead": "59c0f6af6901b9f4edb8d2ec36abaf11f6b0780d"
 }

src/fns/constants.js

@@ -74,3 +74,9 @@ const { provider } = require('./app');
  */
-const getTagsWithNameAsDescription = () => ['see', 'borrows', 'yields', 'returns'];
+const getTagsWithNameAsDescription = () => [
+  'see',
+  'borrows',
+  'yields',
+  'returns',
+  'return',
+];
 /**
@@ -77,0 +83,0 @@ * Gets the list of languages the plugin supports.

tests/e2e/fixtures/random-01.fixture.js

@@ -22,3 +22,3 @@ //# input
  */
-const log = (name = 'batman', logger) => {};
+export function log(name = 'batman', logger) {}
 
@@ -47,2 +47,9 @@ /**
 
+/**
+ * @return A function that is used to analyze the value and the index and determine whether or not to increment the count. Return `true` to increment the count, and return `false` to keep the count the same. If the predicate is not provided, every value will be counted.
+ */
+export function foo(predicate) {
+  console.log(predicate);
+}
+
 //# output
@@ -76,3 +83,3 @@
  */
-const log = (name = 'batman', logger) => {};
+export function log(name = 'batman', logger) {}
 
@@ -118,1 +125,11 @@ /**
  */
+
+/**
+ * @returns A function that is used to analyze the value and the index and determine whether or
+ *          not to increment the count. Return `true` to increment the count, and return `false`
+ *          to keep the count the same. If the predicate is not provided, every value will be
+ *          counted.
+ */
+export function foo(predicate) {
+  console.log(predicate);
+}

No alert changes

Improved metrics

Total package byte prevSize

332348

0.33%

Lines of code

8886

0.24%

Dependency changes

• Updated

  prettier@^2.8.3