Skip to content

Fix typos, support the @notes tag, and make Prettier a peer dep#22

Merged
homer0 merged 11 commits intomainfrom
next
Mar 23, 2025
Merged

Fix typos, support the @notes tag, and make Prettier a peer dep#22
homer0 merged 11 commits intomainfrom
next

Conversation

@homer0
Copy link
Owner

@homer0 homer0 commented Mar 23, 2025

What does this PR do?

  • Fixes @note tag not handled correctly #21 by adding support for the @notes tag.
  • Fixes Add some installation instructions #20 by describing the installation process in the README and linking back to the Prettier's official docs.
  • Fixes a ton of typos in the comments, and some on function names (that's why this is breaking).
  • For some reason, prettier was both a dev and prod dependency; I removed it from the prod dependencies and added it as a peer dep.

How should it be tested manually?

pnpm run lint:all && pnpm test

homer0 added 11 commits March 23, 2025 00:14
BREAKING CHANGE: If the plugin is being extended, the tag property
`descriptionParagrah` has been fixed and it's now
`descriptionParagraph`.
BREAKING CHANGE: If the plugin is being extended, the utility function
for TS types `getFormater` has been fixed and it's now `getFormatter`.
BREAKING CHANGE: If the plugin is being extended, the utility methods
`renderTagsInlines` and `tryToRenderTagsInColums` have been fixed
and they are now `renderTagsInLines` and `tryToRenderTagsInColumns`.
BREAKING CHANGE: prettier has been moved from prod dependency to peer
dependency, so you'll have to add it to your own package.json, if
if you didn't have it already.
@homer0 homer0 merged commit a0e3a2b into main Mar 23, 2025
6 checks passed
@homer0 homer0 deleted the next branch March 23, 2025 01:09
@github-actions
Copy link

🎉 This PR is included in version 10.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

@note tag not handled correctly Add some installation instructions

1 participant