@es-joy/jsdoccomment - npm Package Compare versions

Comparing version 0.33.0 to 0.33.1

CHANGES.md

 # CHANGES for `@es-joy/jsdoccomment`
 
+## 0.33.1
+
+- fix: add to default no types: `description`, `example`, `file`,
+    `fileoverview`, `license`, `overview`, `see`, `summary`
+- fix: add to no names: `file`, `fileoverview, `overview`
+
 ## 0.33.0
@@ -4,0 +10,0 @@

package.json

 {
   "name": "@es-joy/jsdoccomment",
-  "version": "0.33.0",
+  "version": "0.33.1",
   "author": "Brett Zamir <[e-mail]>",
@@ -5,0 +5,0 @@ "contributors": [],

README.md

@@ -82,7 +82,8 @@ # @es-joy/jsdoccomment
 - `defaultNoTypes` = The tags which allow no types by default:
-    `default`, `defaultvalue`, `see`;
+    `default`, `defaultvalue`, `description`, `example`, `file`,
+    `fileoverview`, `license`, `overview`, `see`, `summary`;
 - `defaultNoNames` - The tags which allow no names by default:
     `access`, `author`, `default`, `defaultvalue`, `description`, `example`,
-    `exception`, `kind`, `license`, `return`, `returns`, `since`, `summary`,
-    `throws`, `version`, `variation`
+    `exception`, `file`, `fileoverview`, `kind`, `license`, `overview`,
+    `return`, `returns`, `since`, `summary`, `throws`, `version`, `variation`
 
@@ -204,6 +205,10 @@ ## ESLint AST produced for `comment-parser` nodes (`JsdocBlock`, `JsdocTag`, and `JsdocDescriptionLine`)
 1. Get complete code coverage
-2. Might add `trailing` for `JsdocBlock` to know whether it is followed by a
+1. Given that `esquery` expects a `right` property to search for `>` (the
+    child selector), we should perhaps insist, for example, that params are
+    the child property for `JsdocBlock` or such. Where `:has()` is currently
+    needed, one could thus instead just use `>`.
+1. Might add `trailing` for `JsdocBlock` to know whether it is followed by a
     line break or what not; `comment-parser` does not provide, however
-3. Fix and properly utilize `indent` argument (challenging for
+1. Fix and properly utilize `indent` argument (challenging for
     `eslint-plugin-jsdoc` but needed for `jsdoc-eslint-parser` stringifiers
     to be more faithful); should also then use the proposed `trailing` as well

src/parseComment.js

@@ -18,3 +18,7 @@ /* eslint-disable prefer-named-capture-group -- Temporary */
 
-export const defaultNoTypes = ['default', 'defaultvalue', 'see'];
+export const defaultNoTypes = [
+  'default', 'defaultvalue', 'description', 'example',
+  'file', 'fileoverview', 'license',
+  'overview', 'see', 'summary'
+];
 
@@ -25,4 +29,5 @@ export const defaultNoNames = [
   'description',
-  'example', 'exception', 'kind',
-  'license',
+  'example', 'exception', 'file', 'fileoverview',
+  'kind',
+  'license', 'overview',
   'return', 'returns',
@@ -29,0 +34,0 @@ 'since', 'summary',

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

68268

increased by1.25%

Lines of code

1510

increased by0.33%

Number of lines in readme file

213

increased by2.4%

No dependency changes