search

PrismarineJS / prismarine-contribute

What is PrismarineJS and how to contribute
15 stars 3 forks source link

should we use typescript in more modules ? #7

Open rom1504 opened 1 year ago

rom1504 commented 1 year ago

This has been discussed many times and the consensus is NO:

rom1504 commented 1 year ago

There are some existing TS modules such as https://github.com/PrismarineJS/mineflayer-collectblock though

rom1504 commented 1 year ago

Let's vote here. Should we try to convert some modules to typescript, for example prismarine-block and prismarine-item ? If yes vote with up thumb, no with down thumb

Pandapip1 commented 9 months ago

The only point I've seen against TS is the following:

My opinion is still that it's bad as it encourages big projects instead of small well defined packages - @rom1504 (https://github.com/PrismarineJS/flying-squid/issues/323#issuecomment-1885406986)

This isn't true. You can use any package structure that JS can. TS is just a superset of JS features that, when compiled, is compatible with JS.

It's extremely useful if you know how to use it. I'm not sure what we can count as proof, I run another project that is on ts and it saves me a lot of time so I can implement things faster. Let's see a pr... - @zardoy (https://github.com/PrismarineJS/flying-squid/issues/323#issuecomment-1885663467)

This. This. And this. If you haven't tried TS yet and have been using only vanilla JS, spend a day using it. It changes nothing, yet it changes everything. I would wax lyrical for hours about how much better TS is than JS, but I don't think that's particularly productive in this context.

But yea. Compile-time errors are just better than runtime errors. And it's not hard to use TS. And it's hard not to use TS.

rom1504 commented 9 months ago

Please send one project using typescript that does not look like a java project

Pandapip1 commented 9 months ago

Please send one project using typescript that does not look like a java project

How is that an argument against TS? Having a well-structured project hardly seems like a negative to me. But if you insist:

https://github.com/ethereum/eip-review-bot

rom1504 commented 9 months ago

We are doing a project structure in PrismarineJS that is very different from the java style. That is on purpose and has been working pretty well. Doing small packages with a flat API and organization rather than having many different levels of API with a single huge monolith.

This is important to take into account when choosing technology for PrismarineJS

rom1504 commented 9 months ago

https://github.com/ethereum/eip-review-bot looks ok but it has no doc nor example so it cannot be used as is

Pandapip1 commented 9 months ago

Doing small packages with a flat API and organization rather than having many different levels of API with a single huge monolith.

Oh, you mean that. That's entirely possible with TS, but is just not the way it's usually done. There's no reason why it can't be done.

https://github.com/ethereum/eip-review-bot looks ok but it has no doc nor example so it cannot be used as is

I'd be very surprised if any of the code from that project of mine would make it into PrismarineJS.

zardoy commented 9 months ago

Does that full TS flying squid fork look like Java project? Also p web client along with the p viewer inside is using ts efficiently. It wasn't big effort to add it to p viewer since ts plays nice with classes but allowed me to catch many bugs

rom1504 commented 9 months ago

I'd be very surprised if any of the code from that project of mine would make it into PrismarineJS.

That makes sense. I was just commenting on the fact that this may not be the best example of a TS project

rom1504 commented 9 months ago

Does that full TS flying squid fork look like Java project?

This one is a direct translation to TS so no, the structure seems fine. It's not super clear to me how the TS helps there but feel free to open a PR and let's discuss specifics there

Pandapip1 commented 9 months ago

FWIW I'm currently converting prismarine-auth to typescript. In the process of converting, typescript threw an error that directly pointed to a bug, which I was able to immediately fix. This has happened twice so far. If the project had been TS from the beginning, those bugs wouldn't have ever existed!!!!

Pandapip1 commented 9 months ago

I just saw the following points. I'd like to quickly discuss:

it does not improve code much for PrismarineJS style code

The point of TS is that it doesn't affect the code at all.

it increases complexity for new contributors

This could be considered to be true for inexperienced contributors unfamilliar with TS syntax. However, it significantly decreases complexity for downstream users AND decreases complexity for more experienced contributors.

SilkePilon commented 9 months ago

This could be considered to be true for inexperienced contributors unfamilliar with TS syntax. However, it significantly decreases complexity for downstream users AND decreases complexity for more experienced contributors.

so why make it harder for new contributors to help with the project. Having yet another layer of learning Typescript isn’t going to help. The only different will be that some users who know typescript will have a bit better contribution experience. This doesn’t say i hate typescript, in fact i like it and uses it regularly. I don’t think its good to have 2 types of languages for 1 “project”. Using more typescript will eventually split the project in 2. Typescript can be a good option but only if we fully switch to it in all repository’s

Pandapip1 commented 9 months ago

so why make it harder for new contributors to help with the project

Sorry to be terse, but -- did you actually read my comment? I explicitly said: "However, it significantly decreases complexity for downstream users AND decreases complexity for more experienced contributors."

I don’t think its good to have 2 types of languages for 1 “project”. Using more typescript will eventually split the project in 2. Typescript can be a good option but only if we fully switch to it in all repository’s

I agree in one sense - I would rather that prismarine use 100% typescript. However, I disagree that this will cause fragmentation. TS and JS are interoperable.

SilkePilon commented 9 months ago

Sorry to be terse, but -- did you actually read my comment? I explicitly said: "However, it significantly decreases complexity for downstream users AND decreases complexity for more experienced contributors."

I agree that typescript is better and probably better for documentation but having 2 different languages is still weird. I know that JS and TS can be used together but I think a 100% or 0% is better. https://youtu.be/5ChkQKUzDCs?si=Kb2Nd8KoulTGVGlS I think this video explains it better than i do

Pandapip1 commented 9 months ago

I've seen that video. But the crucial thing is that turbo is still keeping its .d.ts files. I also disagree with the maintainer's point that a compile step that alerts you of errors is bad. I'd rather fix a dozen clearly benign but clearly indicated type errors than try to fix a single obscure error caused by an incorrect type

SilkePilon commented 9 months ago

@rom1504 what do you think about this?