Skip to content

Extension name requirements are not clear for the user #3352

Closed
gruehle opened this Issue Apr 5, 2013 · 6 comments

4 participants

@gruehle
Adobe Systems Incorporated member
gruehle commented Apr 5, 2013

I uploaded an extension with the name "HoverPreview" and it got rejected with an error stating "The extension package is invalid: HoverPreview is an invalid package name."

According to the npm docs, this should be a valid name.

It would be nice to show the naming rules in the error message, or at least a link to the docs.

@dangoor dangoor was assigned Apr 5, 2013
@njx
Adobe Systems Incorporated member
njx commented Apr 5, 2013

Low priority, sprint 23, to @dangoor

@dangoor
dangoor commented Apr 5, 2013

A year ago, isaacs (Node's benevolent dictator) said module names should be lower case, ideally.. He then apparently decided to enforce that.

The CommonJS package format specified lower case names. If I'm remembering the discussions correctly, the reason was to avoid problems with case insensitive file systems (since the package name is often used as a directory name). I'm sure there's a lengthy discussion in the CommonJS googlegroup archive about it...

This is why our package.json allows a title property that is displayed.

I totally agree about listing the naming requirements in the error message.

If it's okay with you, we could change the title of this issue to "Extension name requirements are not clear for the user" or something like that.

@gruehle
Adobe Systems Incorporated member
gruehle commented Apr 5, 2013

Agreed. Title updated.

@TomMalbran

What about renaming the extensions with uppercase letters to all lowercase letters, so that the extensions authors wouldn't need to rename their extensions?

@njx
Adobe Systems Incorporated member
njx commented Apr 6, 2013

This is about the name field in package.json, which is used as a unique id (not really intended to be a user-visible name). So it really needs to be consistent everywhere.

@njx njx referenced this issue in adobe/brackets-registry Apr 8, 2013
Merged

Clearer error explaining extension name requirements. #27

@njx
Adobe Systems Incorporated member
njx commented Apr 8, 2013

Closing since Glenn is out. Glenn, feel free to take a look at the revised message when you get back.

@njx njx closed this Apr 8, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.