How are we going to import `@node-core/ui-components`?

[avivkeller]

npm does not support importing packages from subdirectories of git repositories.

According to npm/npm#2974 (comment):

This isn't something that the npm CLI team is interested in adding to the tool.

There are third-party solutions like GitPkg that allow this functionality in npm, but I'm not sure we should rely on a third-party tool to handle imports–lest something bad happen.

However, both Yarn (although, yarn requires the website to also use yarn) and pnpm do support this, so we could convert this repository to use one of them instead.

This would also require any project that runs api-docs-tooling use the same package manager (i.e. pnpm dlx instead of npx for execution).

Reference: nodejs/nodejs.org#7401 (comment)

[AugustinMauroy]

Why not publish ui-components ?

[avivkeller]

That's an option, but I feel like we are going to be constantly updating that package, so it might be easier to keep it imported from the repository.

[AugustinMauroy]

That's an option, but I feel like we are going to be constantly updating that package, so it might be easier to keep it imported from the repository.

With a CD it's just a git tag to create no needed to create a changelog

[avivkeller]

Personally, I'm in favor of adopting support for pnpm

"@node-core/ui-components": "github:nodejs/nodejs.org#main&path:packages/ui-components"

However, I think we should get more opinions before making any decision.

[flakey5]

This would also require any project that runs api-docs-tooling use the same package manager (i.e. pnpm dlx instead of npx for execution).

Would that interfere with us using node --run for nodejs/node#57343?

[avivkeller]

No, we'd just change the npm installation step to a pnpm installation step, but let's cross that bridge if we get to it.

node --run is package manager ambiguous.

[AugustinMauroy]

No, we'd just change the npm installation step to a pnpm installation step, but let's cross that bridge if we get to it.

node --run is package manager ambiguous.

it's mean we will need pnpm in node core ?

[avivkeller]

We wouldn't need to depend on it, we would just have to assume the user has it installed, which isn't ideal, but every one of our options has a drawback.

• Switching package managers has the drawbacks of requiring Node.js doc-builders and linters to have it installed

• Publishing to npm has the drawback of needing to setup a publishing automation, and not control versions by commit

• Using a third party tool has the drawback of being a third party tool

• We could also require the user to clone the website, and include like a local file, but that has the drawback of requiring the user to clone the website. (Example: https://stackoverflow.com/a/39195334)

[ovflowd]

I think we should publish the package, but not necessarily npm. It can be as an GitHub artifact. https://docs.github.com/en/packages/quickstart

[avivkeller]

It can be as an GitHub artifact.

That could work. Once the ui-components library lands, I'll make a CI/CD pipeline for uploading it to the GitHub packages registry.

I'm gonna leave this issue open until then, just in case anything changes.

[ovflowd]

It can be as an GitHub artifact.

That could work. Once the ui-components library lands, I'll make a CI/CD pipeline for uploading it to the GitHub packages registry.

I'm gonna leave this issue open until then, just in case anything changes.

Are you merging the PR today?

[avivkeller]

Yes, I don't think anyone else is going to object in the next hour, so I'm merge it now, but I'm going to add a workflow in a second PR, in case it needs a revert, we don't need to revert the entire UI package

[avivkeller]

We need to verify that Node.js can publish to the @node-core Github packages scope, otherwise, we might need to publish to npm. I know we control that scope on npm, but I'm not sure if we control it on Github Packages, I feel like we only control @nodejs (as that's the organization scope).

Edit: We do not control the @node-core scope (See https://github.com/orgs/community/discussions/52267#discussioncomment-5554918).

We have a few options:

1. Publish to npm, where we do control the @node-core scope
2. Rename the package to @nodejs/ui-components, and publish to Github Packages
3. Make an @node-core organization, and publish there (but I don't think that's the best idea)
4. All of the original options