,

Why the Svelte 4.0 codebase is transitioning to JSDoc: An Explanation from Rich 🤔

Posted by






Rich on Svelte 4.0 Codebase Moving to JSDoc

Rich on Svelte 4.0 Codebase Moving to JSDoc

Recently, there has been a lot of buzz surrounding the decision to move the Svelte 4.0 codebase to JSDoc. Rich Harris, the creator of Svelte, has provided some insight into this decision and why it is beneficial for the future of the project.

According to Rich, the move to JSDoc was a natural progression for the Svelte codebase. JSDoc is a popular tool for documenting JavaScript code, and it provides a standardized way to annotate and document code. This will make it easier for developers to understand and contribute to the Svelte codebase, as well as improving the overall quality and maintainability of the project.

Additionally, JSDoc will allow for better integration with tools and services that rely on standardized code documentation. This includes code editors, IDEs, and automated documentation generators. By using JSDoc, the Svelte team aims to make it easier for developers to work with the codebase and to streamline the development process.

Overall, the move to JSDoc for the Svelte 4.0 codebase is a strategic decision that will benefit both the developers and the community. It will improve the accessibility and understandability of the codebase, while also setting the project up for future success and growth.

As Svelte continues to evolve and gain popularity in the world of web development, it is important to make these kinds of proactive decisions to ensure that the project remains a strong and viable option for developers.

Rich and the Svelte team are confident that the move to JSDoc will be a positive step for the project, and they are excited to see the impact it will have on the future of Svelte development.


0 0 votes
Article Rating
36 Comments
Oldest
Newest Most Voted
Inline Feedbacks
View all comments
dan
dan
7 months ago

Why can't you fiddle with TS library in your node_modules? I mean you can change the distribution JS files still right? And if needed you need to change the .d.ts files too, yes that's a bit of a pain.

rutabega
7 months ago

Weird timing – JS is about to get TS-compatible syntax, so you'll no longer need a compilation step…

Erick Moya
7 months ago

I am really suspecting Svelte is dropping TS in favor of "native" types, as it is being worked on in the javascript proposal.

Chill Potato
7 months ago

You can fiddle with the code if you’re building with Deno! 😮

Kenny Salter
7 months ago

Thankyou, thankyou, thankyou long live JS! r.i.p. Ts

Yerenzter
7 months ago

I love SvelteJS because I can use either Vanilla HTML, JS & CSS code or either Svelte's built-in keywords which I increase my creativity.

fdg
fdg
7 months ago

I like jsdoc honestly, makes maintaining code easier but that's just me because i also write Elixir backend and it being dynamic language Elixir uses ExDoc to which is similar to jsdoc

Victor Noguera
7 months ago

How do you reuse a JSDoc type definition? Do you type it again?

Mr.guaxinim
7 months ago

Svelte is so beautiful, i really appreciate your job

Black Hole Moon
7 months ago

I expect many people will continue to use TS in their actual applications, but for library development, this approach makes, like… 1000000x more sense.

Harald Ndb.
7 months ago

Now i love Svelte even more.

—
7 months ago

I'm sold on Svelte 👏

Abiodun Dacosta
7 months ago

Simply put: a genius you are sir!..
"Benefits of the types safety, and non of the drawbacks, beacuse its just Javascript"…
😌

Graham Perry
7 months ago

I hate types in javascript so much. It's just there for lazy devs that what the IDE to type for them.

Rumble
7 months ago

Using Sveltekit for the first time to build something and I gotta say I'm not impressed with how types are handled. It tries to infer a bunch of stuff instead of allowing me to annotate my code. There's probably a good way to do it but so far it's a pain.

Ahmed Talal
7 months ago

Agreed

Felds Liscia
7 months ago

Whatever the Messiah says, I guess…

zummon
7 months ago

i've also been thinking – javascript is less code than typescript. i was about to use typescript but still not

driedpotatoes
7 months ago

“non standard” … my brother, TS is the modern standard.

Christobar
7 months ago

Good lord I've been saying this for years. TS is overkill as a method to help document code in an IDE, and adds a massive level of overhead.