Skip to content

Latest commit

 

History

History
340 lines (216 loc) · 22.1 KB

CHANGELOG.md

File metadata and controls

340 lines (216 loc) · 22.1 KB

9.0.0 (2024-04-09)

Bug Fixes

  • consider jsdocIgnoreTags when calculating lengths (515e3a5)
  • update dependencies (0623001)

Features

  • implement jsdocIgnoreTags (55b96db)

BREAKING CHANGES

  • For those extending the plugin, getLengthsData now requires the plugin options to be sent as a second parameter.

8.0.0 (2023-10-02)

Bug Fixes

BREAKING CHANGES

  • Node 16 is not longer supported. Node 18.17 is the minimum required version now.

7.0.3 (2023-07-22)

Bug Fixes

  • move return tag to tags with desc as name (1dc8632)
  • move todo to the tags without desc (6805ba0)
  • track tags that cannot be converted into sentences (1d4167b)

7.0.2 (2023-07-19)

Bug Fixes

7.0.1 (2023-07-18)

Bug Fixes

  • trigger standalone deploy (61c0e74)

7.0.0 (2023-07-16)

Bug Fixes

BREAKING CHANGES

  • This plugin now uses Prettier v3

6.0.5 (2023-06-18)

Note: Version bump only for package @homer0/prettier-plugin-jsdoc

6.0.4 (2023-06-18)

Nothing changed in this version, I just messed up the commits.

6.0.3 (2023-06-18)

Bug Fixes

  • update ramda .of syntax (0f97cd4)

6.0.2 (2023-03-05)

Bug Fixes

  • monorepo: update all dependencies (032fdf1)

6.0.1 (2023-01-28)

Bug Fixes

  • include 'return' as tag with name as desc (eab45ee)

6.0.0 (2022-12-27)

Bug Fixes

  • monorepo: drop Yarn (1023bd3)
  • monorepo: drop Node 14 support (05683de)
  • monorepo: update all dependencies (cb9731c)

BREAKING CHANGES

  • monorepo: Node 14 is not longer supported. Node 16 is the minimum required version now.

5.1.6 (2022-12-23)

Bug Fixes

  • avoid handling keys as str literals (63ca69d)
  • detect tags' names on a different line (53d15f3)

5.1.5 (2022-10-22)

Bug Fixes

5.1.4 (2022-07-12)

Bug Fixes

  • monorepo: force publish unpublished tags (30fafee)

5.1.3 (2022-07-12)

Bug Fixes

  • monorepo: update all dependencies (032fdf1)

5.1.2 (2022-06-26)

Bug Fixes

  • properly detect when to use columns (502ca4b)

5.1.1 (2022-04-25)

Note: Version bump only for package @homer0/prettier-plugin-jsdoc

5.1.0 (2022-04-25)

Bug Fixes

  • force space between tag name and type (3d94fff)

Features

  • add exp support for blocks without tags (32810ed)

5.0.0 (2022-03-17)

Bug Fixes

  • monorepo: drop Node 12 support (99e878e)
  • update dependencies (e56b749)

BREAKING CHANGES

  • monorepo: Node 12 is not longer supported. Node 14 is the minimum required version now.

4.0.6 (2021-10-17)

Bug Fixes

4.0.5 (2021-08-19)

Bug Fixes

4.0.4 (2021-08-07)

Note: Version bump only for package @homer0/prettier-plugin-jsdoc

4.0.3 (2021-08-02)

Reverts

  • comment-parser doesn't include cjs export, so pinning for now (f5d44a3)

4.0.2 (2021-08-02)

Bug Fixes

  • use comment-parser cjs file (9097e23)

4.0.1 (2021-07-25)

Bug Fixes

  • prevent formatting issues with string literals (f28beff)

4.0.0 (2021-04-11)

Bug Fixes

  • monorepo: drop support for Node 10 (d038b63)

BREAKING CHANGES

  • monorepo: The monorepo and the packages no longer support Node 10.

3.0.1 (2021-03-21)

Bug Fixes

  • add support for the remarks tag (fb2835f)
  • only add period when is not URL and ends with a letter (d97d458)
  • prevent formatting issues with Markdown tables (0e3df30)

3.0.0 (2021-03-07)

Bug Fixes

  • update dependencies (3ffd22e)
  • guard against missing options on createParser (1d56fa2)
  • move the example tag order to the end (f8a3c97)
  • update syntax for comment parser (735d2ed)

BREAKING CHANGES

  • The example tag order has been changed to a lower position. This change was made in order to fix a bug in which TypeScript would detect 'any' if the tag was before param, property and template. This is breaking because saving a file with this change would cause possible unrelated blocks to change.

2.0.0 (2021-01-25)

Bug Fixes

  • move the example tag order to the end (f8a3c97)
  • update dependencies (3ffd22e)
  • update syntax for comment parser (735d2ed)

BREAKING CHANGES

  • The example tag order has been changed to a lower position. This change was made in order to fix a bug in which TypeScript would detect 'any' if the tag was before param, property and template. This is breaking because saving a file with this change would cause possible unrelated blocks to change.

1.1.2 (2020-11-28)

Bug Fixes

  • include publishConfig and fix the format of the repository property (6b1856b)

1.1.1 (2020-11-05)

Bug Fixes

1.1.0 (2020-11-05)

Bug Fixes

  • add a function to replace adjacent regexps (4c6069f)
  • add an extra case when joining props (9489967)
  • add missing alias (7b6ded3)
  • add missing function to validate tags (8a8bc18)
  • add support for empty example tags (0f58b54)
  • add synonym for the @example tag (fd75310)
  • avoid formatting examples into sentences (4f3d162)
  • avoid transforming URLs into sentences (93a5da1)
  • calculate printWidth on sub formatters (b38a14a)
  • consider objects complex types (40ee872)
  • correct typos on the options (e662134)
  • don't allow more than one empty line (d032687)
  • format access tag from the main formatter (419518b)
  • format type with Prettier on format step (778d366)
  • get the supported languages from Prettier (88e8ab0)
  • make formatDescription a curried fn (69cfac5)
  • make the constants into fns (d5c7e85)
  • make the function to prepare types work with tags (2c4b0cd)
  • move app into fns (86e8ba8)
  • move each function to its own file (53822a3)
  • move names to a new line when the type is too long (791e5e4)
  • move providers load to another fn (36025fa)
  • move the dots function to utils (c111d54)
  • preserve case when adding/removing dot (8b71413)
  • properly handle one word descriptions (c873f63)
  • properly render example tags (7c736a4)
  • remove ifElse (404061d)
  • rename the container functions (e554338)
  • render unformatted examples (192afb8)
  • stop assuming there's a trailing star (d56e1f9)
  • support multiline types (2efd010)
  • transform sentences on tags that use name (410cc6f)
  • use name and description columns for special tags (53819ce)

Features

  • add fn to format access tag (85d60b7)
  • add function that applies the tags formatters (20d8811)
  • add function that applies the types formatters (7828864)
  • add function that fixes descriptions (41952ab)
  • add function to create language definitions (1e93e0f)
  • add function to create the Prettier parser (aabf2cb)
  • add function to format arrays (4719eef)
  • add function to format descriptions (b6e8017)
  • add function to format examples (d005cd0)
  • add function to format objects (c6a5d3b)
  • add function to format string literals (587d0f1)
  • add function to format TS types (e4766a2)
  • add function to prepare all tags (5812fd6)
  • add function to prepare complex types (2a14e24)
  • add function to prepare tag names (4011836)
  • add function to render comment lines (a1e4206)
  • add function to render example tags (3e9cd9d)
  • add function to render tag in columns (6db0bf0)
  • add function to render tag in one line (51724b0)
  • add function to sort tags (3d26343)
  • add function to split text lines (ad81486)
  • add function to trim tags properties (f36904e)
  • add languages' definitions (61d0941)
  • add option to add a separator line on @example (99ac641)
  • add option to disable the plugin (406b28d)
  • add option to disable the plugin when extended (2dcb2db)
  • add plugin main file (6f4a66b)
  • add rule to ignore consistent columns (1573db8)
  • add support for multiline names (31563c6)
  • allow inline comments (f386566)
  • define the plugin options (eadcc0e)
  • detect examples' captions (b7a29b1)
  • expose the container (d7dc8ef)
  • function to format arrays ramdification (b4ea963)
  • function to format descriptions ramdification (cb38bb1)
  • function to format string literals ramdification (a692445)
  • function to split text lines ramdification (20b8111)
  • implement multiline types on the render (d525a48)
  • respect new lines (11e3d5c)
  • setup package (866a7e9)
  • transform descriptions into sentences (f067ce7)
  • use a dependency injection container (633f6de)