surreal icon indicating copy to clipboard operation
surreal copied to clipboard

Releases to NPM

Open korverdev opened this issue 1 year ago • 4 comments

I'd love to see this package made available on NPM. Unfortunately, my company is very particular about always downloading dependencies off NPM and outright bans other sources, so if this was possible, it would help a lot for to drive adoption on my team.

korverdev avatar Sep 11 '24 18:09 korverdev

There's at least one person who I don't believe is affiliated with this project who's taken it on themselves to publish this project, but it's fallen out of date and I would have security concerns using an NPM package that isn't endorsed by the people behind the library.

korverdev avatar Sep 11 '24 18:09 korverdev

that's me btw :)

i haven't used it recently so i really never even realized it was out of date 🫠

stag-enterprises avatar Sep 19 '24 23:09 stag-enterprises

First party distribution on NPM is planned for the next release, assuming no gotchas. Thanks for trying out the project!

gnat avatar Oct 13 '24 08:10 gnat

Thanks, @gnat! Looking forward to the release.

This will also enable us to consume the library via WebJars in the Java ecosystem. WebJars automatically bundles up NPM dependencies in a format consumable via the dependency management used in that ecosystem.

tl;dr: Happy user

frederikb avatar Nov 13 '24 18:11 frederikb

Official automated NPM releases are now available at https://www.npmjs.com/package/@geenat/surreal

Enjoy !!

gnat avatar Jul 20 '25 20:07 gnat

Thanks @gnat, appreciated!

You might want to add that information to the respective section in the README.md as well?

Also, the published NPM package still contains some unnecessary files in my opinion.

Image

You should be able to exclude those by switching to a whitelist approach in the package.json of including only certain files:

{
  // …
  "files": [
    "surreal.js",
    "README.md",
    "LICENSE"
  ]
}

frederikb avatar Jul 21 '25 06:07 frederikb

Done @frederikb thank you for the great suggestion!

gnat avatar Jul 21 '25 09:07 gnat