Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(helpers): standardize helpers interface #288

Merged
merged 5 commits into from
May 3, 2023

Conversation

lihbr
Copy link
Member

@lihbr lihbr commented May 2, 2023

Types of changes

  • Chore (a non-breaking change which is related to package maintenance)
  • Bug fix (a non-breaking change which fixes an issue)
  • New feature (a non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Description

Resolves: #283

Checklist:

  • My change requires an update to the official documentation.
  • All TSDoc comments are up-to-date and new ones have been added where necessary.
  • All new and existing tests are passing.

@lihbr lihbr requested a review from angeloashmore May 2, 2023 14:41
Copy link
Member

@angeloashmore angeloashmore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! I think there are a few places we could tidy up, but I'll leave it up to you to decide if it's possible.

src/helpers/asHTML.ts Outdated Show resolved Hide resolved
src/helpers/asHTML.ts Outdated Show resolved Hide resolved
src/helpers/asHTML.ts Show resolved Hide resolved
src/helpers/asHTML.ts Show resolved Hide resolved
src/helpers/asLink.ts Show resolved Hide resolved
src/helpers/asText.ts Show resolved Hide resolved
test/helpers-asHTML.test.ts Show resolved Hide resolved
@lihbr
Copy link
Member Author

lihbr commented May 3, 2023

Alright, got the overload to work, it seems to work better than in my memory, we should now get clean overloads, thanks for suggesting to dig into that.

Overloads on VSCode

image
image
image
image

May I just ask you to double-check that everything looks alright on Vim too? If yes, then feel free to hit merge ☺️

@angeloashmore
Copy link
Member

Looks perfect in Vim! Nice work on the overloads. Being able to use @deprecated is a nice touch. I just wish tsserver would display the deprecation message, but this is still good.

@angeloashmore angeloashmore merged commit 59f84ed into v7 May 3, 2023
@lihbr lihbr deleted the refactor/standardize-helpers-interface branch May 3, 2023 21:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants