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

Rename the main file more meaningful #76

Open
pvnr0082t opened this issue Dec 10, 2016 · 6 comments
Open

Rename the main file more meaningful #76

pvnr0082t opened this issue Dec 10, 2016 · 6 comments

Comments

@pvnr0082t
Copy link

Hi @mariocasciaro ,
I'm a member of cdnjs, we want to host this library.
Because I found that the main file is index.js, I'd like to discuss if it's possible to name the filename with meaningful name like object-path.js.
Thank you.

cdnjs/cdnjs#9559

@mariocasciaro
Copy link
Owner

Hi @pvnr0082t , could you please elaborate the reason for the renaming?

@pvnr0082t
Copy link
Author

@mariocasciaro It's just a suggestion for better naming scheme and it will let users easily know what files they include. If you still want to use index.js, that's okay. It's up to you. 😄

@mariocasciaro
Copy link
Owner

Sure, I'll take it in consideration. I'll work on it after the holiday season ;)

@gerhardcit
Copy link

@mariocasciaro , will you get to this? I requested object-path to be included in cdnjs.

@mariocasciaro
Copy link
Owner

@gerhardcit It's a delicate change that could break people's code. I need to think this through. This will probably need a major version bump.

@englishextra
Copy link

englishextra commented Nov 22, 2020

You know the saying, "if the mountain won't come to Muhammad...". The mountain of npm libraries are using index.js and it won't move to meaningful, semantic names. CDNJS should adapt to that, there's too much hassle to negotiate every single repo to be renamed. Plus, some of CDNJS competitors (Rawgit for example) are already serving all libraries, no matter with meaningful names or with index.js.

See: https://cdn.rawgit.com/mariocasciaro/object-path/99d9d300/index.js it's served no problem.

Why can't CDNJS do that too?

I wonder what was the reason of writing this comment.

Meaningful name will significantly ease finding all say object-path.js with file explorer and then drag those to your VC/ST editor. That's just one reason. In gulp.js it's also helpful having human readable library names. Since there's no convention in where the main file should reside (dist/src/libs or just /) and what its name should be, it's up to community to vote for renaming.

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