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

Suggestion: consistent package names on NPM #1458

Open
njlr opened this issue May 12, 2020 · 9 comments
Open

Suggestion: consistent package names on NPM #1458

njlr opened this issue May 12, 2020 · 9 comments

Comments

@njlr
Copy link

njlr commented May 12, 2020

One of the off-putting things about Koa vs other solutions is that it isn't clear which NPM packages are maintained by the Koa authors and which are community efforts. I would like to stick to official Koa packages to get some degree of assurance.

It would be great if these packages had a common naming scheme on NPM.

My suggestion would be to follow the @koa/router package:

  • Koa main package koa
  • Router @koa/router
  • Body Parser @koa/bodyparser
  • Static @koa/static
  • etc...

This convention is already used by Babel.

@njlr
Copy link
Author

njlr commented Jun 1, 2020

Who has the access required to do this?

@niftylettuce
Copy link
Contributor

I can try to look at this once I'm done with other major projects.

@yanickrochon
Copy link
Contributor

yanickrochon commented Aug 24, 2020

Out of curisosity, why having the main package outside of the @koa namespace?

import koa from 'koa';
import router from '@koa/router';

Why not having everything within the namespace?

import koa from '@koa/core';   // or '@koa/app'
import router from '@koa/router';

This is what other projects, for example Material UI, and Babel, etc. do.

@niftylettuce
Copy link
Contributor

Yes I know. It would be nice. Time is a constraint, as are developers that actually know how to publish and semver release.
We're also not funded by Facebook or Google.

@yanickrochon
Copy link
Contributor

@niftylettuce I totally agree. But this issue should be tied with the 3.0 roadmap. In that sense, some group should be formed and assignments made with ETAs. There are over 200 contributors to this project, so surely a dozen could spare a few hours and everything could happen by the end of this year.

That sounds reasonable to me.

@niftylettuce
Copy link
Contributor

I don't think you can put an ETA on open-source software unless you financially sponsor and routinely follow up. Like I said, I will try to dedicate time in the near future to this. I highly doubt others would have the time.

@niftylettuce
Copy link
Contributor

niftylettuce commented Aug 24, 2020

There also has to be an enforced mirroring concept, where koa-something gets mirrored to @koa/something for at least 1 semver major version, then deprecated afterwards. I've been doing this with koa-router and @koa/router since I finally got hold of it on npm after this debacle https://news.ycombinator.com/item?id=19156707.

@miwnwski
Copy link
Member

There also has to be an enforced mirroring concept, where koa gets mirrored to @koa/app (or whatever we name it)

I wrote about this in the 3.0 issue, I would really love for Koa npm package to just stay as "koa".

@niftylettuce
Copy link
Contributor

niftylettuce commented Aug 24, 2020

There also has to be an enforced mirroring concept, where koa gets mirrored to @koa/app (or whatever we name it)

I wrote about this in the 3.0 issue, I would really love for Koa npm package to just stay as "koa".

Yeah, we'll definitely stick with just koa I'm sure for the main package. The issue though is that npm still doesn't let you share a package ownership with an organization. I've written to them about this countless times. If anyone else wants to voice their thoughts with npm to add this feature, please email support@npmjs.com.

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

4 participants