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.

Sign up for GitHub

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

Jump to bottom

Document basic file structure #102

Merged
merged 1 commit into from
Oct 22, 2021
Merged

Document basic file structure #102

merged 1 commit into from
Oct 22, 2021

Conversation

oliverdunk
Copy link
Member

@oliverdunk oliverdunk commented Oct 12, 2021 •
edited by pr-preview bot
Loading

Adds basic documentation for the file structure of a WebExtension.

Resolves #64

Preview | Diff

@Jack-Works
Copy link

File names start with _ expected _locales are preserved by Chrome. If you have a _file.js, it will be rejected to load. I think we should document that.

@Rob--W
Copy link
Member

Rob--W commented Oct 14, 2021

Files/directories starting with _ do not have a special treatment in Firefox.

How about Safari?

While it makes sense to document the (widely?) supported _locales/ directory, it may not make as much sense to document something that is only restricted in one browser. It may however make sense to add a comment like "Names starting with _ are reserved for future use and should not be used by extensions."

@Rob--W Rob--W mentioned this pull request Oct 15, 2021
Merged
@zombie zombie merged commit 969d550 into w3c:main Oct 22, 2021
github-actions bot added a commit that referenced this pull request Oct 22, 2021
@oliverdunk @github-actions
Document basic file structure (#102)
17cedbd 
SHA: 969d550
Reason: push, by @zombie

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Rob--W Rob--W Rob--W approved these changes

@mukul-p mukul-p mukul-p approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Specify the hierarchy of files
5 participants
@oliverdunk @Jack-Works @Rob--W @mukul-p @zombie