@es-joy/jsdoccomment - npm Package Compare versions

Comparing version 0.18.0 to 0.19.0

CHANGES.md

 # CHANGES for `@es-joy/jsdoccomment`
 
+## 0.19.0
+
+### User-impacting
+
+- feat: treat `@kind` as having no name
+
+### Dev-impacting
+
+- docs: jsdoc
+- test: begin checking `jsdoccomment`
+- test: adds lcov reporter and open script for it
+- chore: update devDeps.
+
 ## 0.18.0
@@ -4,0 +17,0 @@

package.json

 {
   "name": "@es-joy/jsdoccomment",
-  "version": "0.18.0",
+  "version": "0.19.0",
   "author": "Brett Zamir <[e-mail]>",
@@ -19,2 +19,6 @@ "contributors": [],
   "c8": {
+    "reporter": [
+      "lcov",
+      "text"
+    ],
     "checkCoverage": true,
@@ -46,3 +50,3 @@ "branches": 100,
   "devDependencies": {
-    "@babel/core": "^7.16.12",
+    "@babel/core": "^7.17.2",
     "@babel/plugin-syntax-class-properties": "^7.12.13",
@@ -53,12 +57,12 @@ "@babel/preset-env": "^7.16.11",
     "c8": "^7.11.0",
-    "chai": "^4.3.4",
-    "eslint": "^8.7.0",
+    "chai": "^4.3.6",
+    "eslint": "^8.8.0",
     "eslint-config-ash-nazg": "32.3.0",
     "eslint-config-standard": "^16.0.3",
     "eslint-plugin-array-func": "^3.1.7",
-    "eslint-plugin-compat": "^4.0.1",
+    "eslint-plugin-compat": "^4.0.2",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-html": "^6.2.0",
     "eslint-plugin-import": "^2.25.4",
-    "eslint-plugin-jsdoc": "^37.6.3",
+    "eslint-plugin-jsdoc": "^37.8.2",
     "eslint-plugin-markdown": "^2.2.1",
@@ -71,10 +75,13 @@ "eslint-plugin-no-unsanitized": "^4.0.1",
     "eslint-plugin-unicorn": "^40.1.0",
+    "espree": "^9.3.0",
+    "estraverse": "^5.3.0",
     "mocha": "^9.2.0",
-    "rollup": "^2.66.0"
+    "rollup": "^2.67.1"
   },
   "scripts": {
+    "open": "open ./coverage/lcov-report/index.html",
     "rollup": "rollup -c",
     "eslint": "eslint --ext=js,cjs,md,html .",
     "lint": "npm run eslint",
-    "mocha": "mocha --parallel --require chai/register-expect",
+    "mocha": "mocha --parallel --require chai/register-expect.js",
     "c8": "c8 npm run mocha",
@@ -81,0 +88,0 @@ "test": "npm run lint && npm run rollup && npm run c8"

src/jsdoccomment.js

@@ -18,2 +18,6 @@ /**
 
+/**
+ * @param {AST} node
+ * @returns {boolean}
+ */
 const getDecorator = (node) => {
@@ -25,3 +29,3 @@ return node?.declaration?.decorators?.[0] || node?.decorators?.[0] ||
 /**
- * Check to see if its a ES6 export declaration.
+ * Check to see if it is a ES6 export declaration.
  *
@@ -39,2 +43,6 @@ * @param {ASTNode} astNode An AST node.
 
+/**
+ * @param {AST} astNode
+ * @returns {AST}
+ */
 const getTSFunctionComment = function (astNode) {
@@ -135,3 +143,2 @@ const {parent} = astNode;
  * JSDoc comments.
- * @private
  */
@@ -138,0 +145,0 @@ const getReducedASTNode = function (node, sourceCode) {

src/parseComment.js

@@ -30,3 +30,3 @@ /* eslint-disable prefer-named-capture-group -- Temporary */
   'description',
-  'example', 'exception',
+  'example', 'exception', 'kind',
   'license',
@@ -33,0 +33,0 @@ 'return', 'returns',

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

59050

increased by0.99%

Lines of code

1207

increased by1.17%

Worsened metrics

Dev dependency count

27

increased by8%

No dependency changes