Publish as package for Deno, Node, and the browser

[dslmeinte]

Involves:

• Defining what to expose in src/index.ts
• Publish as Deno package - see https://deno.land/[email protected]/advanced/publishing
• Setting up bundling with e.g. https://esbuild.github.io/ for NPM
  • Bundle to dist/ which also contains NPM metadata?
  • See also https://deno.land/[email protected]/advanced/publishing/dnt

This issue replaces issues #1 and #5.

[alessiostalla]

I've tried using the NPM package in the browser with several shims, but it doesn't seem possible right now. The deno-shim package requires and uses many Node APIs. In particular, now I'm stuck at

mainModule.js:8 Uncaught TypeError: (0 , url_1.pathToFileURL) is not a function
    at ../node_modules/@deno/shim-deno/dist/deno/stable/variables/mainModule.js (mainModule.js:8:1)
    at options.factory (react refresh:6:1)
    at __webpack_require__ (bootstrap:24:1)
    at fn (hot module replacement:62:1)
    at ../node_modules/@deno/shim-deno/dist/deno/stable/variables.js (variables.js:37:1)
    at options.factory (react refresh:6:1)
    at __webpack_require__ (bootstrap:24:1)
    at fn (hot module replacement:62:1)
    at ../node_modules/@deno/shim-deno/dist/deno/stable/functions/chdir.js (chdir.js:10:1)
    at options.factory (react refresh:6:1)

b/c the "url" package doesn't include Node's pathToFileURL function.

The main problem seems to be that Deno's Node shim is monolithic and uses all sorts of Node APIs, which doesn't play nice with the browser.

[dslmeinte]

What APIs is the code really using? Only the test code uses filesystem-related APIs, right? Maybe we can split off all test code to a separate directory? That would mean that the tests also mimic the “use as library/package” situation more.

[alessiostalla]

parse uses the Deno XML module which in turn uses fs, etc.
I think "dnt" is already taking care of separating the tests from the production code.
Funny that my spell-checker insists correcting "dnt" to "don't" 🤣

[dslmeinte]

Ironic that something (XML parsing) that should be really very portable is an obstacle to portability now...

We can also separate out the parsing-part of the Ecore-importer, keeping just the types that an XML parser is supposed to return, with the remark that the XML parser currently used is compatible with that. What do you think?

[alessiostalla]

Yes, we could try that and see if it improves.

…

On Thu, 16 Mar 2023 at 11:56, Meinte Boersma ***@***.***> wrote: Ironic that something (XML parsing) that should be really very portable is an obstacle to portability now... We can also separate out the parsing-part of the Ecore-importer, keeping just the types that an XML parser is supposed to return, with the remark that the XML parser currently used is compatible with that. What do you think? — Reply to this email directly, view it on GitHub <#9 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAHV3NUBYPOXZ5VEU7R6BK3W4LWWHANCNFSM6AAAAAATI5N2IE> . You are receiving this because you commented.Message ID: ***@***.***>

[dslmeinte]

OK, I'll try and do that first, then.

By the way: how do you check whether the package works in the browser? Can we integrate that into this repository?

[alessiostalla]

Currently, I have another project where I manually add the Lioncore dependency and open a demo page in a browser. That could be automated, I think.

[dslmeinte]

If you have some time and opportunity, it'd be great (“stallar” even 😄) if you could add that!

[dslmeinte]

I split off the test code and its dependency management to a separate directory in this branch: https://github.com/LIonWeb-org/lioncore-typescript/tree/node-compatibility

Can you check whether that'd already solve some of the problems? The next step would probably be to modify build_npm.ts to not “drag in” any test dependency, right?

[alessiostalla]

A stalla is a farm animal shed, so "stallar" doesn't sound that nice lol 🤣
I'll try that!

[dslmeinte]

Depends on the shed! 😆 (Incidentally: in Dutch “stal” means the same thing, including the derogatory association.)

[alessiostalla]

Cool!
Your branch appears to be solving the problem, yay! At least I can instantiate a node and obtain a Concept. We'll see going forward what's there to be added/removed in the module's exports.

[dslmeinte]

OK, I'll just merge that branch into main, and see whether the integration tests have a problem.

[dslmeinte]

Done, and fixed integration test setup as well. I'm closing this issue. Follow-up improvements can be associated with other issues.

[ftomassetti]

Very happy about this one!