Skip to content
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.

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

consider qualifying common module names #57

Open
tayloraswift opened this issue Jan 22, 2025 · 0 comments
Open

consider qualifying common module names #57

tayloraswift opened this issue Jan 22, 2025 · 0 comments

Comments

@tayloraswift
Copy link

tayloraswift commented Jan 22, 2025

this library currently uses a number of common module names:

  • DOM
  • SVG
  • FileSystem
  • WebSockets

DOM and SVG are likely to be used by renderers, FileSystem by file system utilities, and WebSockets with networking libraries.

this library doesn’t really implement SVG, it implements manipulating SVG from JavaScript. so i think JavaScriptSVG or SVG_JavaScript is a better name for that module. and so forth for the other three modules.

this can be sort of avoided today using Module Aliases, but that makes it hard to discuss the library in documentation when using automated linking tools. for example, we might want to write a tutorial over at Swift on Server articles about the client and server sides of a WebAssembly application, and colliding module names would make it challenging to write such an article.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant