TSC icon indicating copy to clipboard operation
TSC copied to clipboard

CLI tools behind a Nodejs namespace

Open danielleadams opened this issue 3 years ago • 23 comments

Not sure if this is the right place for this issue, so I am happy to move it. I opened it here because it affects multiple tools in the Node.js org.

Since the installation instructions on the Node.js tooling (ie. https://github.com/nodejs/node-core-utils, https://github.com/nodejs/changelog-maker, etc) recommend a global install, should these be put under a Node.js scope on the npm registry such as @nodejs/<packagename>?

It establishes a level of trust in the published packages ("I know this came from the Node org"), and it will hopefully help contributors avoid accidental installations of similarly named packages.

Docs: https://docs.npmjs.com/cli/v8/using-npm/scope

danielleadams avatar Feb 25 '22 03:02 danielleadams

Perhaps they should also recommend using npx instead, since global installs are widely discouraged in the community.

ljharb avatar Feb 25 '22 03:02 ljharb

@ljharb yeah, we should probably do both

danielleadams avatar Feb 25 '22 03:02 danielleadams

I like the idea of using namespace but would rather not use @nodejs, as that might encourage project specific tools to be used externally, which is not recommended. Something like @nodejs-dev maybe?

mmarchini avatar Feb 26 '22 21:02 mmarchini

Or maybe even something more specific like @nodejs-dev-internal ?

mhdawson avatar Feb 28 '22 16:02 mhdawson

I'm ok to use an org/scope but not @nodejs. I'm ok with @nodejs-dev but I think @nodejs-core is more explicit in intent.

mcollina avatar Mar 02 '22 13:03 mcollina

I like @nodejs-core or @node-core.

node-core-utils could be renamed to @node-core/utils

targos avatar Mar 02 '22 13:03 targos

@node-core/utils has a nice sound.

mcollina avatar Mar 02 '22 13:03 mcollina

+1 for @node-core

it looks like the scope is currently being squatted but if someone opens a ticket with npm support (shouldn't be me) I can look into getting us access

MylesBorins avatar Mar 02 '22 22:03 MylesBorins

@MylesBorins created this ticket - https://support.github.com/ticket/personal/0/2095597

mhdawson avatar Apr 05 '23 16:04 mhdawson

I think that was me that squatted on it shortly after we discussed initially. Never got around to moving this forward, but I can unsquat so we can use it.

danielleadams avatar Apr 07 '23 21:04 danielleadams

Relative to the thread I just opened on admin (https://github.com/nodejs/admin/issues/794) I like the idea of dev-related stuff being published under a different scope than public stuff.

Ethan-Arrowood avatar May 09 '23 19:05 Ethan-Arrowood

Making a plan to solve this with @danielleadams .

Ethan-Arrowood avatar May 10 '23 23:05 Ethan-Arrowood

I just received notification that node-core was transferred to the nodejs-foundation account. We can now start publishing packages in that namespace.

mhdawson avatar May 16 '23 00:05 mhdawson

Do we have @nodejs too? I don't think its been decided yet what the external scope will be, but i think that one was shared during collab summit

Ethan-Arrowood avatar May 16 '23 16:05 Ethan-Arrowood

Right now we have node, node-core and pkgjs

mhdawson avatar May 16 '23 17:05 mhdawson

@danielleadams now that we have node-core what are the next steps and does this still need to be on the TSC agenda.

mhdawson avatar May 31 '23 15:05 mhdawson

@mhdawson I think we need to merge https://github.com/nodejs/admin/pull/795 too + make the public facing scope happen

Ethan-Arrowood avatar Jun 01 '23 15:06 Ethan-Arrowood

Discussed in meeting today. Those in attenance agreed should be ok to start migrating packages to the node-core namespace as we have the namespace and no objections have been raised.

mhdawson avatar Jun 07 '23 19:06 mhdawson

I'm glad to see @node-core was approved. Can y'all discuss another scope for public facing modules next? Thank you! RE: https://github.com/nodejs/admin/issues/794

Ethan-Arrowood avatar Sep 13 '23 21:09 Ethan-Arrowood