@es-joy/jsdoccomment - npm Package Compare versions

Comparing version 0.33.4 to 0.34.0

CHANGES.md

 # CHANGES for `@es-joy/jsdoccomment`
 
+## 0.34.0
+
+- feat: add `descriptionStartLine` and `descriptionEndLine` properties
+- fix: avoid duplication with 0 line comments
+- chore: update devDeps.
+
 ## 0.33.4
@@ -4,0 +10,0 @@

package.json

 {
   "name": "@es-joy/jsdoccomment",
-  "version": "0.33.4",
+  "version": "0.34.0",
   "author": "Brett Zamir <[e-mail]>",
@@ -49,10 +49,10 @@ "contributors": [],
   "devDependencies": {
-    "@babel/core": "^7.19.3",
+    "@babel/core": "^7.19.6",
     "@babel/plugin-syntax-class-properties": "^7.12.13",
     "@babel/preset-env": "^7.19.4",
     "@brettz9/eslint-plugin": "^1.0.4",
-    "@rollup/plugin-babel": "^6.0.0",
+    "@rollup/plugin-babel": "^6.0.2",
     "c8": "^7.12.0",
     "chai": "^4.3.6",
-    "eslint": "^8.25.0",
+    "eslint": "^8.26.0",
     "eslint-config-ash-nazg": "34.3.0",
@@ -65,8 +65,8 @@ "eslint-config-standard": "^17.0.0",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jsdoc": "^39.3.13",
+    "eslint-plugin-jsdoc": "^39.6.0",
     "eslint-plugin-markdown": "^3.0.0",
-    "eslint-plugin-n": "^15.3.0",
+    "eslint-plugin-n": "^15.4.0",
     "eslint-plugin-no-unsanitized": "^4.0.1",
     "eslint-plugin-no-use-extend-native": "^0.5.0",
-    "eslint-plugin-promise": "^6.1.0",
+    "eslint-plugin-promise": "^6.1.1",
     "eslint-plugin-sonarjs": "^0.16.0",
@@ -77,3 +77,3 @@ "eslint-plugin-unicorn": "^44.0.2",
     "mocha": "^10.1.0",
-    "rollup": "^3.2.3"
+    "rollup": "^3.2.5"
   },
@@ -80,0 +80,0 @@ "scripts": {

README.md

@@ -107,2 +107,6 @@ # @es-joy/jsdoccomment
 2. `endLine` - A number representing the line number with `end`/`terminal`
+3. `descriptionStartLine` - A 0+ number indicating the line where any
+    description begins
+4. `descriptionEndLine` - A 0+ number indicating the line where the description
+    ends
 
@@ -109,0 +113,0 @@ May also have the following non-visitable properties from `comment-parser`:

src/commentParserToESTree.js

@@ -133,4 +133,3 @@ import {parse as jsdocTypePrattParse} from 'jsdoc-type-pratt-parser';
     start: startRoot,
-    end: endRoot,
-    description: descriptionRoot
+    end: endRoot
   }} = source[0];
@@ -141,3 +140,3 @@
     delimiter: delimiterRoot,
-    description: descriptionRoot,
+    description: '',
 
@@ -159,2 +158,3 @@ descriptionLines: [],
   let lastTag = null;
+  let descLineStateOpen = true;
 
@@ -173,3 +173,11 @@ source.forEach((info, idx) => {
 
+    if (description && descLineStateOpen) {
+      if (ast.descriptionStartLine === undefined) {
+        ast.descriptionStartLine = idx;
+      }
+      ast.descriptionEndLine = idx;
+    }
+
     if (tag || end) {
+      descLineStateOpen = false;
       if (lastDescriptionLine === undefined) {
@@ -189,3 +197,12 @@ lastDescriptionLine = idx;
         ast.terminal = end;
-
+        if (description) {
+          ast.description += (ast.description ? '\n' : '') + description;
+          ast.descriptionLines.push({
+            delimiter,
+            description,
+            postDelimiter,
+            initial,
+            type: 'JsdocDescriptionLine'
+          });
+        }
         return;
@@ -192,0 +209,0 @@ }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

69927

increased by1.96%

Lines of code

1568

increased by3.57%

Number of lines in readme file

217

increased by1.88%

No dependency changes