CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

1.3.1 (2025-01-03)

Bug Fixes

• add package manager (ffafd40)
• provide correct types path in conditional exports (#222) (7a884b6)

1.2.0 (2023-12-22)

Features

• add jsdocTagsOrder (9f637aa)

1.1.1 (2023-10-07)

Bug Fixes

• export Options to better assist type checking for .prettierrc.js (#210) (77cf7af)

1.1.0 (2023-10-06)

Features

• jsdocCommentLineStrategy (c4e4db5)

1.0.5 (2023-10-05)

Bug Fixes

• long union type (4f9ba4c)
• new line between Default is (9fbbe53)
• wrong remove intention, make unexpected issue (de71607)

1.0.4 (2023-10-05)

1.0.3 (2023-10-04)

Bug Fixes

• add new line to unknown tag (cdbf931)
• new line after item list (98c42fe)

1.0.2 (2023-09-09)

Bug Fixes

• default type format (08f834e)
• description start with markdown (9129957)

1.0.1 (2023-07-19)

1.0.0 (2023-07-19)

Features

• support prettier v3 (#195) (5a816c9)

Bug Fixes

• tag group (afd080b)

0.4.2 (2022-08-24)

Bug Fixes

• ignore esm module in rollup external (9fa0474), closes /github.com/hosseinmd/prettier-plugin-jsdoc/issues/173#issuecomment-1222503231

0.4.1 (2022-08-24)

Features

• add option for wrapping strategy (#172) (3181f69)

0.3.37 (2022-04-11)

Bug Fixes

• default tag type bug (#160) (11ef0c5), closes #159 #159 #159

0.3.36 (2022-04-01)

Bug Fixes

• link definition (de27bd7), closes /github.com/hosseinmd/prettier-plugin-jsdoc/issues/158#issuecomment-1085504308

0.3.35 (2022-03-31)

Bug Fixes

• link reference (dd08855)
• use esm module (28ac56e)

0.3.34 (2022-03-30)

Bug Fixes

• jsdocParser option (3c2df88)

0.3.33 (2022-03-25)

Features

• add rollup script for compile to mjs (8783637)
• support block quote (db0b07e)

Bug Fixes

• not capitalizing pre formated tags (b5beeb7)
• optional type without name (b14397c)
• tag @file capitalization (dc76b72), closes /github.com/hosseinmd/prettier-plugin-jsdoc/issues/143#issuecomment-1014096745

0.3.32 (2022-03-24)

Features

• add rollup script for compile to mjs (8783637)
• support block quote (db0b07e)

Bug Fixes

• optional type without name (b14397c)
• tag @file capitalization (dc76b72), closes /github.com/hosseinmd/prettier-plugin-jsdoc/issues/143#issuecomment-1014096745

0.3.31 (2022-03-12)

Bug Fixes

• add a package description (#141) (b2f142f)
• add jsdocPreferCodeFences documentation to README. (#146) (06ac97e)
• clean published files (#140) (a77e0f7)
• do not try to format tables found in code blocks (#145) (dd9e1dc)
• ensure formatting matches Prettier markdown formatter (#147) (f735b18)
• line breaks inside jsdoc link synonyms (#149) (092f409)

0.3.30 (2021-11-07)

Bug Fixes

• support being called as a built-in parser (#138) (5bb0cd8)

0.3.29 (2021-11-05)

Features

• add jsdocAddDefaultToDescription (c3fb168)

0.3.28 (2021-11-05)

Features

• add jsdocSeparateTagGroups (d46e7f9)

0.3.27 (2021-11-05)

Features

• add jsx tsx css less sass html yaml to markdown support (ef00318)

0.3.26 (2021-11-05)

Bug Fixes

• markdown image link (bf2da59)

0.3.25 (2021-11-05)

Features

• add option to turn off capitalization (#127) (03e74ab)

Bug Fixes

• new prettier bug (5f70c1c)
• typo in readme (#129) (170c56c)

0.3.24 (2021-09-02)

Bug Fixes

• don't replace defaultvalue because of tsdoc (6eabd15)

0.3.23 (2021-06-10)

Features

• add jsdocSeparateReturnsFromParam (1b3eb01)

0.3.22 (2021-05-01)

Bug Fixes

• don't replace nonwhitespace characters (033ce15)

0.3.21 (2021-04-27)

Features

• add jsdocPrintWidth to options (6fb1897)
• add support break by backslash (4f4cd07)

Bug Fixes

• example: unexpected new line (11267c7)
• Add empty line after list (74c1b65)
• compatibility with other plugins (bfc9c39)
• jsdocParser option is deprecated (17b5fbf), closes /github.com/hosseinmd/prettier-plugin-jsdoc/issues/10#issuecomment-815148264
• line breaks inside jsdoc link (86bb75c)
• remark tsdoc format (4e46c4f)
• remove blank space before of backtick (6dd64e4), closes /github.com/hosseinmd/prettier-plugin-jsdoc/issues/107#issuecomment-825267537
• resolve parser of plugins (bd9be19)

0.3.20 (2021-04-23)

Bug Fixes

• line breaks inside jsdoc link (86bb75c)
• remark tsdoc format (4e46c4f)
• remove blank space before of backtick (6dd64e4), closes /github.com/hosseinmd/prettier-plugin-jsdoc/issues/107#issuecomment-825267537
• resolve parser of plugins (bd9be19)

0.3.19 (2021-04-15)

Features

• add jsdocPrintWidth to options (6fb1897)
• add support break by backslash (4f4cd07)

Bug Fixes

• Add empty line after list (74c1b65)
• jsdocParser option is deprecated (17b5fbf), closes /github.com/hosseinmd/prettier-plugin-jsdoc/issues/10#issuecomment-815148264

0.3.18 (2021-04-02)

Bug Fixes

• compatibility with other plugins (bfc9c39)
• resolve parser of plugins (bd9be19)

0.3.17 (2021-03-31)

Bug Fixes

• add @default as pre formated description (5683e3e)

0.3.16 (2021-03-30)

Features

• add typeParam (af3a0e2)

Bug Fixes

• nested list in description (15a57ad)
• unstable sorting (f8afb27)
• unwanted space between tags (6771c62)

0.3.15 (2021-03-29)

Features

• refactor description formater (#96) (d9603af)

0.3.14 (2021-03-23)

Features

• add @borrows @namespace @license @module (2a377f2)
• add jsdocSingleLineComment to options (f755db1)
• format indented code block (b5d8c9f)
• support markdown tables (635299a)
• support tsdoc (4213aed)

Bug Fixes

• long single word in description (18ba560)

0.3.13 (2021-03-04)

Features

• add @borrows @namespace @license @module (2a377f2)
• add jsdocSingleLineComment to options (f755db1)
• format indented code block (b5d8c9f)
• support tsdoc (4213aed)

0.3.12 (2021-02-21)

Features

• add @remarks and @privateRemarks (40cbe4b)
• add ignore to tags, synonyms hidden (905f735)
• use prettier options to example indentation (8d96fd7)

Bug Fixes

• bold text by stars (306218b)
• format all tags descriptions (cb815f0)
• sort params order without name (5337018)
• sort params order without name (5da7a26)

0.3.10 (2021-02-13)

Features

• fix function params order (2524413)
• imporved tag order (#52) (00675e2)
• support stars paragraphs (1a9aa02)

Bug Fixes

• in block code (c864ba0)

• add to dot to non-English descriptions (6445702)
• better trimming + refactor (9350ee7)
• bug in tags order (1331861)
• indentation and printWidth fix (#56) (8361d95)
• jsdocDescriptionWithDot with germany words (041c882)
• jsdocKeepUnParseAbleExampleIndent (8f18200)
• maxWidth of lines (5f807ce)
• tags description indentation (b9c343f)
• wrong yarn command (389f404)
• wrong yarn command (0b9f468)
• description: # in text mistaken for heading (d9a5617)
• description: description start underscores (3b8bf02)
• description: empty lines (7d89a66)
• separate [@typedef](https://github.com/typedef) and [@callback](https://github.com/callback) (dfc78b4)
• windows EOL now supported (4220471)

0.3.9 (2021-02-03)

Features

• type-formatter: support rest parameters (9952ab8)
• modernize nullable types (cf31411)
• parser: do not remove default values (36f500d)

Bug Fixes

• parser: jsdoc check (d9ce819)
• * to any work with strings now (95bb610)
• dash lines (33df06d)
• incorrect Array type transformation (3aab697)
• nested arrays + missing prefix (7b4eec6)
• wrong license in package.json (0db143b)
• parser: mordern array transformation (43aa632)
• parser: optional parameter type (01d442a)
• parser: tag type correction (6dc67c7)

0.3.8 (2021-01-27)

Bug Fixes

• do not lower-case unrecognized jsdoc tags (9a3c04e)

0.3.6 (2021-01-14)

0.3.5 (2021-01-12)

Bug Fixes

• keep empty line comments (e083299)

0.3.4 (2021-01-08)

Bug Fixes

• add category to nameless tags (c602823)
• add printWidth to description markdown (754031f)
• add space to examples where accent symbol used (fd10ff1)
• bug paraghrap with number in start of description (23297b8)
• codes in description (2aecefd)
• example print width (a4d0d5e)

0.3.0 (2021-01-06)

Features

• support markdown as desscription formatter (2c14daf)

Bug Fixes

• markdown # in description (0f7e9eb)
• remove empty comments (3b7473e)
• support desscription with dash (87a27a6)

0.2.14 (2021-01-06)

Features

• support markdown as desscription formatter (2c14daf)

Bug Fixes

• markdown # in description (0f7e9eb)
• remove empty comments (3b7473e)
• support desscription with dash (87a27a6)

0.2.13 (2020-12-29)

Bug Fixes

• incorrect comment format (1ac43d1)

0.2.12 (2020-12-25)

Bug Fixes

• don't capitalize links (9e5e10e)
• format json example (e5a7d59)
• since tag (da13c7c)

0.2.11 (2020-12-25)

Bug Fixes

• since tag (da13c7c)

0.2.9 (2020-12-23)

Bug Fixes

• not working for multi line union types (#17) (fee81f6)

0.2.8 (2020-12-19)

Bug Fixes

• the "caption" should place behind the tag of "example" (#15) (b8d6e34)

0.2.7 (2020-12-17)

Bug Fixes

• an error with long description word (1cbe866)
• prettier (b9b89ad)