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

Add name and short_name descriptions #60

Closed
xeenon opened this issue Aug 20, 2021 · 3 comments
Closed

Add name and short_name descriptions #60

xeenon opened this issue Aug 20, 2021 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@xeenon
Copy link
Collaborator

xeenon commented Aug 20, 2021

Add some prose for the name and short_name manifest keys.

@xeenon xeenon added the documentation Improvements or additions to documentation label Aug 20, 2021
@xeenon xeenon self-assigned this Aug 20, 2021
xeenon added a commit to xeenon/webextensions that referenced this issue Aug 20, 2021
@dotproto
Copy link
Member

I was looking at the name property yesterday and noticed that MDN notes "Google Chrome and Microsoft Edge restrict the name length to 45 characters." It appears that both Chromium and Firefox allow actually allow arbitrary length strings, but CWS and AMO do not allow names longer than 45 characters. I did not test other stores or browsers.

In #24, @twschiller suggested that when specifying the manifest we should "also consider any relevant web store factors." Should we note in the specification that name length is limited to 45 characters?

@dotproto
Copy link
Member

Should we note in the specification that name length is limited to 45 characters?

I was originally inlined to say no, as browsers allow longer strings. As I've been considering this, though, it is a practical limit of the ecosystem and therefore something that extension authors need to be cognizant of. Going back to the Priority of Constituencies, it seems like a requirement worth documenting.

@ariasuni
Copy link
Contributor

MDN also advise to not go over 12 characters for short_name.

Maybe we could add a note, or a «The name value should be kept under 45 characters.»? At least I don’t think it needs in the current PR, we could think about it and add what we want later.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants