Skip to content

Publish to JSR alongside NPM #1792

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
Open
flevi29 opened this issue Dec 3, 2024 · 3 comments · May be fixed by #1841
Open

Publish to JSR alongside NPM #1792

flevi29 opened this issue Dec 3, 2024 · 3 comments · May be fixed by #1841
Labels
documentation Improvements or additions to documentation enhancement New feature or request maintenance Issue about maintenance (CI, tests, refacto...)

Comments

@flevi29
Copy link
Collaborator

flevi29 commented Dec 3, 2024 •
edited
Loading

Why JSR

  • https://jsr.io/docs/why
  • primarily because it is the default registry for deno, but also it's striving to be (and already is a superset of) the replacement for npm with the goal of supporting every runtime equally
  • secondarily, because it auto-generates documentation, easily switchable between versions, this way we wouldn't need typedoc and additional build step for it and configuration https://jsr.io/docs/writing-docs
    • we should also replace the lengthy README.md documentation with a link to the superior JSR page, but really we should already be doing this with the typedoc docs on github pages
  • it also builds everything from TypeScript source files, so we wouldn't need any build step, at least not for JSR, in theory, still need to experiment with this
@flevi29 flevi29 added documentation Improvements or additions to documentation enhancement New feature or request maintenance Issue about maintenance (CI, tests, refacto...) labels Dec 3, 2024
@flevi29 flevi29 changed the title Publish to JSR Publish to JSR alongside NPM Dec 3, 2024
@curquiza
Copy link
Member

curquiza commented Dec 3, 2024

Hello @flevi29
Thanks for opening the issue.
I would rather we wait for more feedback from the community, before doing it. It's important we implement it when it's a real need from users to avoid adding too much maintenance on our side (we are a small team)

So thank you for having opened the issue, it starts the discussion with the community. If you are a user and reading this issue, if you need this, feel free to interact here and raise your voice here ✋

@flevi29
Copy link
Collaborator Author

flevi29 commented Dec 3, 2024

I'd argue the overall maintenance requirements would stay the same, it's mostly a replacement for typedoc for us, even though it's so much more. The end user will be unaffected for the most part, with the added ability to pull this package from JSR as well. Our build step wouldn't need to bother with documentation anymore. Of course I'm just floating the idea.

Supabase and Hono are already on JSR and they're pretty big players:
https://deno.com/blog/supabase-on-jsr
https://deno.com/blog/hono-on-jsr

We could be another "early" -ish supporter, with little to no technical debt and no real cons, as far as I see it, probably even future proof.

This was referenced Dec 6, 2024
Open
Closed
@flevi29 flevi29 linked a pull request Jan 28, 2025 that will close this issue
Open
3 tasks
@flevi29
Copy link
Collaborator Author

flevi29 commented May 11, 2025 •
edited
Loading

Another huge addition to JSR: https://deno.com/blog/openai-on-jsr

JSR is natively supported now by pnpm and yarn:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request maintenance Issue about maintenance (CI, tests, refacto...)
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Publish to JSR alongside NPM flevi29/meilisearch-js
2 participants
@curquiza @flevi29