search

TehShrike / noddity

It's a blog, it's a wiki, it's a fast CMS!
56 stars 29 forks source link

Create an npm scope for Noddity? #29

Open sundarj opened 8 years ago

sundarj commented 8 years ago

Think it could be nicer to do something like require('@noddity/butler') rather than have an individual noddity-butler package.

What say you?

https://docs.npmjs.com/getting-started/scoped-packages

saibotsivad commented 8 years ago

I haven't used scoped packages yet, but it looks like they are scoped by username, so it'd either be require('@tehshrike/butler') or you'd have to make a new npm user noddity to make that one work.

TehShrike commented 8 years ago

I'm attracted to the idea. It does feel a bit dirty to be publishing all these modules to npm that are so narrowly scoped ("a module that solves this Noddity-specific problem"). I'm not very familiar with the concept of scoped npm modules though. This makes sense to me, I would like to learn more about what scoped modules signal to the community.

This is potentially related to the idea of creating a Github organization for Noddity.

sundarj commented 8 years ago

I don't think it's limited to usernames - the @username in the docs in just an example afaict - see https://docs.npmjs.com/misc/scope

ArtskydJ commented 8 years ago

I support the idea of creating a Github organization for Noddity.

(I don't have much of an opinion about scoping the npm packages.)

spacetag commented 8 years ago

:+1:

TehShrike commented 8 years ago

I think the main advantage of an npm scope would be the same idea as a Github org - the ability to add core contributors who could push changes to the repo/package manager without having to add them to every individual module.

It's not a big deal right now since I think the only people with enough experience in the repos to make sense to have push access are @ArtskydJ and me, but it's still something to keep in mind.

Another benefit to a Github org is the ability for people to easily see all the "official" modules in the ecosystem. This mostly matters for potential contributors, since the only thing an end-user really needs to know about is how to install the cli.

Once there is support for optional modules, and a static generator, maybe a Github org would be a good way to identify such official modules in addition to documentation on the website?

For npm scoping, I worry that the scoping would add a bit of friction to people who would want to install official modules to use them. npm install noddity-installer is natural to people in the node world, while npm install @noddity/installer does look different from usual to people who haven't been using private packages.

spacetag commented 8 years ago

Yeah 'npm install @noddity/installer' may be a bit unusual.

+1 on "Another benefit to a Github org is the ability for people to easily see all the "official" modules in the ecosystem." I would make an github organization for that very reason.

On Tue, Dec 29, 2015 at 1:31 PM, Josh Duff notifications@github.com wrote:

I think the main advantage of an npm scope would be the same idea as a Github org - the ability to add core contributors who could push changes to the repo/package manager without having to add them to every individual module.

It's not a big deal right now since I think the only people with enough experience in the repos to make sense to have push access are @ArtskydJ https://github.com/ArtskydJ and me, but it's still something to keep in mind.

Another benefit to a Github org is the ability for people to easily see all the "official" modules in the ecosystem. This mostly matters for potential contributors, since the only thing an end-user really needs to know about is how to install the cli http://noddity.com/#!/post/install.md.

Once there is support for optional modules, and a static generator, maybe a Github org would be a good way to identify such official modules in addition to documentation on the website?

For npm scoping, I worry that the scoping would add a bit of friction to people who would want to install official modules to use them. npm install noddity-installer is natural to people in the node world, while npm install @noddity/installer does look different from usual to people who haven't been using private packages.

— Reply to this email directly or view it on GitHub https://github.com/TehShrike/noddity/issues/29#issuecomment-167860657.

TehShrike commented 8 years ago

There are other ways to accomplish showing people all the official modules, though - right now there's the webapp's readme, but a new page for that purpose could be made on noddity.com.

ArtskydJ commented 8 years ago

It's a bit silly, but I see a Github org for a project, the project looks more "official" (imo)...

It's nice to have all the modules in one place. Then you can view all the open issues for an organization, because sometimes you can't find an open issue. You forget if you opened the issue in, noddity, noddity-butler, or noddity-retrieval perhaps.

I agree with the npm organization adding friction. But I think something like this would work:

Install

Install with npm:

npm install @noddity/installer

(Why the @ and /?)

ArtskydJ commented 8 years ago

Since there is currently not a github org for noddity, this might be helpful:

All noddity-related issues

TehShrike commented 7 years ago

So at this point I'm down with setting up a Github org so that Noddity repos can all be managed with the same permissions and I don't have to think about whether or not the upstream repo is on my or @ArtskydJ's account.

I don't know if using npm scoped packages would accomplish the same thing on npm's side, though.