prettier-plugin-jsdoc - npm Package Compare versions

Comparing version 1.1.0 to 1.1.1

CHANGELOG.md

@@ -5,2 +5,9 @@ # Changelog
 
+### [1.1.1](https://github.com/hosseinmd/prettier-plugin-jsdoc/compare/v1.1.0...v1.1.1) (2023-10-07)
+
+
+### Bug Fixes
+
+* export Options to better assist type checking for .prettierrc.js ([#210](https://github.com/hosseinmd/prettier-plugin-jsdoc/issues/210)) ([77cf7af](https://github.com/hosseinmd/prettier-plugin-jsdoc/commit/77cf7af56d1170e9bcd848280c4ffaf8ced13f98))
+
 ## [1.1.0](https://github.com/hosseinmd/prettier-plugin-jsdoc/compare/v1.0.5...v1.1.0) (2023-10-06)
@@ -7,0 +14,0 @@

dist/index.d.ts

@@ -166,1 +166,2 @@ import prettier from "prettier";
 export { options, parsers, defaultOptions };
+export type Options = Partial<JsdocOptions>;

package.json

 {
   "name": "prettier-plugin-jsdoc",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "A Prettier plugin to format JSDoc comments.",
@@ -5,0 +5,0 @@ "private": false,

README.md

@@ -185,17 +185,17 @@ [![NPM](https://nodei.co/npm/prettier-plugin-jsdoc.png)](https://nodei.co/npm/prettier-plugin-jsdoc/)
 
-| Key                               | type                              | Default   | description                                                                               |
-| :-------------------------------- | :-------------------------------- | :-------- | ----------------------------------------------------------------------------------------- |
-| jsdocSpaces                       | Number                            | 1         |
-| jsdocDescriptionWithDot           | Boolean                           | false     |
-| jsdocDescriptionTag               | Boolean                           | false     |
-| jsdocVerticalAlignment            | Boolean                           | false     |
-| jsdocKeepUnParseAbleExampleIndent | Boolean                           | false     |
-| jsdocCommentLineStrategy          | ("singleLine","multiline","keep") | true      |
-| jsdocCapitalizeDescription        | Boolean                           | true      |
-| jsdocSeparateReturnsFromParam     | Boolean                           | false     | Add an space between last @param and @returns                                             |
-| jsdocSeparateTagGroups            | Boolean                           | false     | Add an space between tag groups                                                           |
-| jsdocPreferCodeFences             | Boolean                           | false     | Always fence code blocks (surround them by triple backticks)                              |
-| tsdoc                             | Boolean                           | false     |
-| jsdocPrintWidth                   | Number                            | undefined | If You don't set value to jsdocPrintWidth, the printWidth will be use as jsdocPrintWidth. |
-| jsdocLineWrappingStyle            | String                            | "greedy"  | "greedy": Lines wrap as soon as they reach the print width                                |
+| Key                               | type                              | Default     | description                                                                               |
+| :-------------------------------- | :-------------------------------- | :---------- | ----------------------------------------------------------------------------------------- |
+| jsdocSpaces                       | Number                            | 1           |
+| jsdocDescriptionWithDot           | Boolean                           | false       |
+| jsdocDescriptionTag               | Boolean                           | false       |
+| jsdocVerticalAlignment            | Boolean                           | false       |
+| jsdocKeepUnParseAbleExampleIndent | Boolean                           | false       |
+| jsdocCommentLineStrategy          | ("singleLine","multiline","keep") | "singleLine |
+| jsdocCapitalizeDescription        | Boolean                           | true        |
+| jsdocSeparateReturnsFromParam     | Boolean                           | false       | Add an space between last @param and @returns                                             |
+| jsdocSeparateTagGroups            | Boolean                           | false       | Add an space between tag groups                                                           |
+| jsdocPreferCodeFences             | Boolean                           | false       | Always fence code blocks (surround them by triple backticks)                              |
+| tsdoc                             | Boolean                           | false       |
+| jsdocPrintWidth                   | Number                            | undefined   | If You don't set value to jsdocPrintWidth, the printWidth will be use as jsdocPrintWidth. |
+| jsdocLineWrappingStyle            | String                            | "greedy"    | "greedy": Lines wrap as soon as they reach the print width                                |
 
@@ -202,0 +202,0 @@ Full up to date list and description of options can be found in Prettier help. First install plugin then run Prettier with "--help" option.

New alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Fixed alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

221514

0.2%

Lines of code

3060

0.03%

Worsened metrics

Number of low supply chain risk alerts

12

9.09%

No dependency changes