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.

Sign up for GitHub

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

Jump to bottom

enhancement/issue 193 WCC types #194

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

enhancement/issue 193 WCC types #194

wants to merge 2 commits into from

Conversation

thescientist13
Copy link
Member

@thescientist13 thescientist13 commented Feb 20, 2025 •
edited
Loading

Related Issue

resolves #193

Summary of Changes

  1. Add type definitions for renderFromHTML and renderToString
  2. Add basic type checking for CI (applied some low-handing fruit recommendations)
  3. Update package.json to export types and adopt exports field (will consider this a breaking change)

TODO

  1. refine metadata type (and types field?) - https://merry-caramel-524e61.netlify.app/docs/#metadata
    • default values
    • required vs optional
  2. Do we need to expose any types via package.json?
    • metadata as a type?
  3. (nice to have / good first issue) had to add a number of @ts-ignores since a lot of the AST related work threw TS errors

@thescientist13 thescientist13 added chore enhancement Improvement to existing functionality labels Feb 20, 2025
@thescientist13 thescientist13 self-assigned this Feb 20, 2025
@thescientist13 thescientist13 added the question Further information is requested label Feb 20, 2025
@thescientist13 thescientist13 marked this pull request as ready for review February 20, 2025 03:35
thescientist13
thescientist13 commented Feb 20, 2025
View reviewed changes
src/index.d.ts
}
}]

// async function renderToString(elementURL, wrappingEntryTag = true, props = {}) {
Copy link
Member Author

Choose a reason for hiding this comment

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

Can delete this comment

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

@briangrider briangrider Awaiting requested review from briangrider

Assignees

@thescientist13 thescientist13

Labels
breaking chore enhancement Improvement to existing functionality question Further information is requested
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Provide types for WCC
1 participant
@thescientist13