Help needed: Typescript typings

[joaodasilva]

Window.js should include type declaractions for Typescript in its source checkout. These declarations should cover the existing APIs:

https://windowjs.org/doc/

Looking for experienced Typescript developers that could help get this started in a way that integrates well with projects that use Typescript.

[hamish-milne]

Hi there! This project looks super interesting and I'd love to help out. I'll see what I can put together for the above.

Rough plan:

• Clarify the ES version support (2021, from a quick test of the build)
• Copy the canvas API from the DOM library, pare down as needed
• Everything else, infer from the docs and the source code
• Add some sort of smoke test, just to check it all matches up.

Ideally these would be in an npm package; once the API is stable you might consider adding it to DefinitelyTyped under @types/window or something.

Unrelated, but webpack should work out of the box with this. I'll play around and maybe write a quickstart guide for it.

[hamish-milne]

Here we are: #38

It even has the auto-documentation! I haven't added any tests or CI integration yet, but if you like the general feel of TypeDoc I could add it in. I'm not quite sure how it'll work with github pages (presumably we push it to a separate branch/repo?). There's also the question of theming; it supports custom CSS, and there's a number of custom themes as well.

[joaodasilva]

Thanks for the PR, I think we could put it in (just asked some questions about follow-up work).

The GitHub Pages are built automatically from the main branch. It took quite a while to set up, so I don't want to break that now :-) They don't use a theme, I just hardcoded some CSS to make the pages look alright (e.g. witness the terrible layouts on mobile...)

What do you mean by auto-documentation?

Re CI integration: I think we should have a workflow to just verify that the types are syntactically correct.

[hamish-milne]

(for spectators: we continued most of this conversation in the PR)

A simple workflow to check that the syntax is correct would be npm install ; npx tsc, within the types folder. I'd add it but I don't have workflow permissions :)

[joaodasilva]

Can you run workflows in a fork?

I think PRs should be able to trigger workflows. The typescript PR didn't because it didn't touch the sources.

I'd like to highlight that #38 was the first external contribution to Window.js :-) Thanks for that!

[joaodasilva]

Added a workflow with those commands in 7889178. Works as advertised! :-)

Here's a workflow run:

https://github.com/windowjs/windowjs/actions/runs/1698955603

This should now run on PRs and pushes that modify the types.