Skip to content

Revise Packaging.md#173

Open
k2d222 wants to merge 6 commits into
mainfrom
k2d222-patch-5
Open

Revise Packaging.md#173
k2d222 wants to merge 6 commits into
mainfrom
k2d222-patch-5

Conversation

@k2d222

@k2d222 k2d222 commented Dec 19, 2025

Copy link
Copy Markdown
Contributor

It's time to un-draft Packaging.md

@k2d222 k2d222 marked this pull request as ready for review February 28, 2026 13:26
@k2d222

k2d222 commented Feb 28, 2026

Copy link
Copy Markdown
Contributor Author

no time or interest to finish this, but it's already an improvement to the exitsing file. OK to merge?

Comment thread Packaging.md Outdated
Comment thread Packaging.md Outdated
Comment thread Packaging.md

@mighdoll mighdoll left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It'll be good to get this in! sorry for forgetting about it and glad you're pushing it forward. lmk if you want help on any of the minor edits, I can make more specific text proposals if needed.

Comment thread Packaging.md Outdated
Comment thread Packaging.md Outdated
Comment thread Packaging.md Outdated

(TODO: unification with param const?)

If two packages in the dependency tree are [semver-compatible](https://semver.org/), npm or Cargo will likely unify them, meaning it will include only one version of the package in its output (often the highest semver-compatible version available).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we might say that users are doing this unification. i.e. users of npm and cargo may unify them.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I see, the point is that package managers will sometimes unify by default. I think that's the default for npm, though the rules are overridable and expectations vary on whether indirect dependencies are unified. (AFAIR by default pnpm doesn't unify indirect dependencies, but npm might still do that)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lemme know if the current revision clarifies.

Comment thread Packaging.md Outdated
Comment thread Packaging.md Outdated
Comment thread Packaging.md Outdated
Comment thread Packaging.md Outdated
* Add the `_wgsl` suffix to the name: `mypackage_wgsl`.
* Use snake_case (underscores to separate words): `my_great_package_wgsl`.
* If your package is part of a larger project, or produced by a company, you can prefix it with that name: `mycompany_mypackage_wgsl`.
* For [wesl-js] specifically, you can use the common naming convention `@mycompany/mypackage_wgsl`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we might add a note here that package names with @ and - and / are sanitized for use in WESL:
"@scope/my-package" => import scope__my_package::...

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know the exact sanitization rules in -js, so I added vague footnote

apply revisions
@k2d222 k2d222 requested review from mighdoll and stefnotch July 7, 2026 15:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

3 participants