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

Provide types for WCC #193

Open
thescientist13 opened this issue Feb 20, 2025 · 1 comment · May be fixed by #194
Open

Provide types for WCC #193

thescientist13 opened this issue Feb 20, 2025 · 1 comment · May be fixed by #194
Assignees
@thescientist13
Labels
0.17.0 chore documentation Improvements or additions to documentation enhancement Improvement to existing functionality
Milestone
1.0

Comments

@thescientist13
Copy link
Member

thescientist13 commented Feb 20, 2025 •
edited
Loading

Current State

It would be nice to (at least) have types for WCC's two main public APIs

  • renderToString
  • renderFromHTML

Desired State

Not proposing the project be written in TS, just that for those two APIs, at least JSDocs annotations should be added. Also, would we need to a types field to package.json?

In addition to providing some intellisense to users, a basic tsconfig.json could be added to the project to do some minimal type-checking during development / CI.

Additional Context

Greenwood is doing the same, and is considering making TS first party.
@thescientist13 thescientist13 added chore documentation Improvements or additions to documentation enhancement Improvement to existing functionality labels Feb 20, 2025
@thescientist13 thescientist13 self-assigned this Feb 20, 2025
@thescientist13 thescientist13 added this to the 1.0 milestone Feb 20, 2025
@thescientist13
Copy link
Member Author

@briangrider

Let me know if you have any thoughts here!

@thescientist13 thescientist13 linked a pull request Feb 20, 2025 that will close this issue
Open
3 tasks
@thescientist13 thescientist13 moved this from 🏗 In progress to 👀 In review in [Greenwood] Phase 10 - Ecosystem Compat Feb 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@thescientist13 thescientist13

Labels
0.17.0 chore documentation Improvements or additions to documentation enhancement Improvement to existing functionality
Projects
[Greenwood] Phase 10 - Ecosystem Compat
Status: 👀 In review
Milestone
1.0
Development

Successfully merging a pull request may close this issue.

enhancement/issue 193 WCC types ProjectEvergreen/wcc
1 participant
@thescientist13