Draft: Port demos to TypeScript by vixalien · Pull Request #201 · workbenchdev/demos

vixalien · 2024-08-12T16:28:41Z

This is my attempt to porting demos from javascript to workbench.

Groundwork

All files were renamed from .js to .ts. I will be running the TypeScript compiler (with tsc) to fix demo files as we go.
I added a simple README.typescript.md showing basic instructions on how I generated the types
I added a tsconfig.json file
I compiled and included all the types in workbench-types

Future tasks

Don't include all the typescript definitions here. They should probably live in another repo. They are only included here so that I can easily check the validity of the demos I have ported so far.
Ensure CI is run for .ts files
Add a simple script that will generate the types for us. Probably similar to https://github.com/vixalien/gi-typescript-definitions/blob/main/generate_types_in_flatpak.sh

Ported demos

vixalien · 2024-08-20T16:15:16Z

To work with this version of the demos while hacking on Workbench, you can bind mount it. For example,

sudo mount --bind /path/to/cloned/demos /path/to/Worbench

vixalien · 2024-09-03T17:24:14Z

Currently all the demos are ported 🥳. However, some demos have // @ts-expect-error directives where the types generated have some issue or another. I have tried to create relevant issues upstream and link to them, but a longer term strategy may be need.

Now it's time for rebase, and working on other steps.

UrtsiSantsi · 2024-10-31T03:45:52Z

@vixalien Why do you use get_object<Type>("name") in some places and get_object("name") as Type in others? Shouldn't we use get_object<Type>("name") everywhere?

vixalien · 2024-10-31T03:50:44Z

Yeah we should use that everywhere. I used the former method when I was getting started on this, since I didn't know the latter was possible.

UrtsiSantsi · 2024-10-31T04:29:25Z

I'll add a commit tomorrow, if you don't beat me to it.

vixalien · 2024-10-31T11:40:53Z

@sonnyp I have been brought to the attention of ts-blank-space which looks like it might be useful for getting reliable stack traces.

vixalien · 2024-10-31T13:00:08Z

I'm currently working towards enabling strict mode in TS. This will catch more errors, but also makes the code look a bit more complex, because there are more null assertions.

@JumpLink you might be interested to look at all the ts-expect-errors we have in the Changes tab so as to help improve ts-for-gir.

UrtsiSantsi · 2024-10-31T23:04:29Z

@vixalien I fixed all the places I could find, that were still not using the generic get_object. But I didn't test it 😅

vixalien · 2024-11-01T00:02:46Z

I had already pushed the changes and you force pushed the branch 🙈🙊

UrtsiSantsi · 2024-11-01T03:18:53Z

@vixalien I didn't do a force push. According to GitHub I added the commits - "UrtsiSantsi added 12 commits", "UrtsiSantsi added 28 commits", while when you force pushed earlier it is "vixalien force-pushed the wip/vixalien/typescript branch from e41f55e to aeea1bf".

My changes are on top of your changes - you fixed the case where the pattern get_object("name") as Type; was used, but missed the cases where get_object("name); was used without any type and that is what I fixed. Can you check again?

vixalien · 2024-11-01T08:59:48Z

but missed the cases where get_object("name); was used without any type and that is what I fixed.

Oh, I see. I actually left out those cases, but I was just being lazy 😆. Thanks!

I will need to rebase them so that we have a singular commit for each file. i.e. "port: Camera", "port: Welcome" etc... but don't worry about it.

I've also gone and enabled strict mode, which now causes a few more errors to pop in. You can run tsc in the root of the repo to see the issues.

sonnyp · 2024-11-01T10:41:59Z

@vixalien don't worry about commit history, I'll squash everything when merging

Individual commits won't be helpful.

sonnyp · 2024-11-01T10:58:35Z

Don't include all the typescript definitions here. They should probably live in another repo. They are only included here so that I can easily check the validity of the demos I have ported so far.

They should be in Workbench since that's the runtime.

Add a simple script that will generate the types for us. Probably similar to https://github.com/vixalien/gi-typescript-definitions/blob/main/generate_types_in_flatpak.sh

Ditto

Ensure CI is run for .ts files

👍

@sonnyp I have been brought to the attention of ts-blank-space which looks like it might be useful for getting reliable stack traces.

This looks interesting for “compiling” ts files before running.

But we still need a solution to compile ts files to js for humans.

sonnyp · 2024-11-01T11:00:17Z

But we still need a solution to compile ts files to js for humans.

Actually we could also use ts-blank-space and simplify process the result with prettier.

UrtsiSantsi · 2024-11-02T00:36:50Z

I think we should leave java script as a language option:

It is shorter and simpler than type script, which is good for a demos
Supporting both will require little effort

vixalien · 2024-11-02T11:47:01Z

They should be in Workbench since that's the runtime.

Add a simple script that will generate the types for us. Probably similar to vixalien/gi-typescript-definitions@main/generate_types_in_flatpak.sh

Ditto

Sure. I'll work on it next.

sonnyp · 2024-11-12T13:28:34Z

@UrtsiSantsi that's the idea 👍

vixalien · 2025-01-28T11:00:29Z

With GJS now supporting sourcemaps, there is no need for ts-blank-space. I will just go through with finishing the port of the demos, then move the typescript file generation script to Workbench.

JumpLink · 2025-03-06T18:56:31Z

Can you still use any help here?

vixalien · 2025-03-08T15:25:06Z

Can you still use any help here?

Not much, really. I'm going to rebase this PR and add types for the other demos.

Since you're the types guy, you can check the demos I marked with a warning emoji (⚠️). These files have an issue which required me to use /// @ts-expect-error, and I would like to eliminate all of these type mismatches if possible.

Done using `find src/ -name "*.js" -exec sh -c 'mv "$0" "${0%.js}.ts"' {} \;`

included in-tree for now. might need to look for long-lasting solution

vixalien · 2025-03-08T15:39:17Z

Yeah, I think what's next for this is to figure out how to use these types in Workbench:

Generate the typescript in Workbench, at build time?? Refer to: https://github.com/vixalien/gi-typescript-definitions/blob/main/generate_types.sh and https://github.com/vixalien/gi-typescript-definitions/blob/main/generate_types_in_flatpak.sh
Ensure CI works for typescript files https://github.com/workbenchdev/Workbench/blob/main/src/cli/main.js#L288
Build the typescript files in Workbench at build time to JavaScript

sonnyp · 2025-03-08T18:58:26Z

Generate the typescript in Workbench, at build time??

Yes 👍

Ensure CI works for typescript files

I can take care of that if you like

Build the typescript files in Workbench at build time to JavaScript

Did we find a solution to compile to reasonable JavaScript? As in keep variable names and so on
For formatting we can simply pass the files through biome or prettier (I can take care of that)

vixalien · 2025-03-08T21:32:21Z

Did we find a solution to compile to reasonable JavaScript? As in keep variable names and so on

Not sure. If I remember, you have suggested we use babel in the past. We can also use other build tools such as esbuild, then prettify the output. (esbuild eats empty lines, though)

sonnyp · 2025-03-10T12:02:13Z

https://babeljs.io/docs/babel-plugin-transform-typescript should do the trick 👍

vixalien · 2025-03-10T13:11:46Z

Okay, I would say now the ball is now in your hands

See also #201 --------- Co-authored-by: Angelo Verlain <geoangercola@gmail.com>

sonnyp · 2025-03-11T17:03:17Z

I have partially merged this e4b515e

vixalien mentioned this pull request Aug 20, 2024
Draft: Switch to ts-for-gir for TypeScript definitions workbenchdev/Workbench#979
Draft
4 tasks

vixalien force-pushed the wip/vixalien/typescript branch from a00b394 to c341532Compare September 3, 2024 17:25

vixalien force-pushed the wip/vixalien/typescript branch from c341532 to e41f55eCompare October 31, 2024 11:37

vixalien force-pushed the wip/vixalien/typescript branch from e41f55e to aeea1bfCompare October 31, 2024 11:46

sonnyp force-pushed the main branch from 6ff8c7b to 6b86bd9Compare November 1, 2024 10:36

sonnyp mentioned this pull request Nov 12, 2024
TypeScript support workbenchdev/Workbench#870
Open
11 tasks

vixalien added 4 commits March 8, 2025 17:28

chore: rename all .js files to .ts
5c61d75
Done using `find src/ -name "*.js" -exec sh -c 'mv "$0" "${0%.js}.ts"' {} \;`

chore: add README.typescript.md
38d7aa4

feat: add tsconfig
318a353

chore: add generated types
e1c3acb
included in-tree for now. might need to look for long-lasting solution

UrtsiSantsi added 19 commits March 8, 2025 17:28

Use generic get_object
681fc6d

Use generic get_object
901f8b1

Use generic get_object
e1b3b0a

Use generic get_object
5bd43ce

Use generic get_object
bea52b8

Use generic get_object
6882a0c

Use generic get_object
266f33e

Use generic get_object
5b1d2ae

Use generic get_object
59ae29b

Use generic get_object
e23e347

Use generic get_object
78e99ec

Use generic get_object
5c9f45f

Use generic get_object
c8e798d

Use generic get_object
c533e28

Use generic get_object
d493f50

Use generic get_object
c2d46c5

Use generic get_object
cbcbac2

Use generic get_object
7567893

Use generic get_object
bd68229

vixalien force-pushed the wip/vixalien/typescript branch from 4555635 to bd68229Compare March 8, 2025 15:29

sonnyp mentioned this pull request Mar 11, 2025
Add TypeScript types and port Welcome demo #227
Merged

sonnyp added a commit that referenced this pull request Mar 11, 2025
Add TypeScript types and port Welcome demo (#227)
e4b515e
See also #201 --------- Co-authored-by: Angelo Verlain <geoangercola@gmail.com>

Merge branch 'main' into wip/vixalien/typescript
544713e

sonnyp mentioned this pull request Mar 24, 2025
Fix TypeScript typechecking not working workbenchdev/Workbench#1002
Open

Uh oh!

Conversation

vixalien commented Aug 12, 2024• edited by sonnyp Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Groundwork

Future tasks

Ported demos

Uh oh!

vixalien commented Aug 20, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vixalien commented Sep 3, 2024

Uh oh!

UrtsiSantsi commented Oct 31, 2024

Uh oh!

vixalien commented Oct 31, 2024

Uh oh!

UrtsiSantsi commented Oct 31, 2024

Uh oh!

vixalien commented Oct 31, 2024

Uh oh!

vixalien commented Oct 31, 2024

Uh oh!

UrtsiSantsi commented Oct 31, 2024

Uh oh!

vixalien commented Nov 1, 2024

Uh oh!

UrtsiSantsi commented Nov 1, 2024

Uh oh!

vixalien commented Nov 1, 2024

Uh oh!

sonnyp commented Nov 1, 2024

Uh oh!

sonnyp commented Nov 1, 2024

Uh oh!

sonnyp commented Nov 1, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

UrtsiSantsi commented Nov 2, 2024

Uh oh!

vixalien commented Nov 2, 2024

Uh oh!

sonnyp commented Nov 12, 2024

Uh oh!

vixalien commented Jan 28, 2025

Uh oh!

JumpLink commented Mar 6, 2025

Uh oh!

vixalien commented Mar 8, 2025

Uh oh!

vixalien commented Mar 8, 2025

Uh oh!

sonnyp commented Mar 8, 2025

Uh oh!

vixalien commented Mar 8, 2025

Uh oh!

sonnyp commented Mar 10, 2025

Uh oh!

vixalien commented Mar 10, 2025

Uh oh!

sonnyp commented Mar 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

vixalien commented Aug 12, 2024•
edited by sonnyp
Loading

vixalien commented Aug 20, 2024•
edited
Loading

sonnyp commented Nov 1, 2024•
edited
Loading