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

[WebAPI] Implement Import Maps #16150

Closed
5 of 7 tasks
Tracked by #281
Rumyra opened this issue May 17, 2022 · 12 comments
Closed
5 of 7 tasks
Tracked by #281

[WebAPI] Implement Import Maps #16150

Rumyra opened this issue May 17, 2022 · 12 comments
Assignees
Labels
Content:WebAPI Web API docs fx release archive A closed issue relating to firefox release notes for developers.

Comments

@Rumyra
Copy link
Collaborator

Rumyra commented May 17, 2022

Acceptance Criteria

  • The listed features are documented sufficiently on MDN
  • BCD is updated
  • Interactive example and data repos are updated if appropriate
  • The content has been reviewed as needed

For folks helping with Firefox related documentation

  • Set bugs to dev-doc-complete
  • Add entry to Firefox release notes if feature is enabled in release
    or
  • Add entry to Firefox experimental features page if feature is not yet enabled in release

Features to document

This is an experimental feature, but will still need documenting, so best to get ahead.

Related Gecko bugs

https://bugzilla.mozilla.org/show_bug.cgi?id=1688879

@Rumyra Rumyra added Content:JS JavaScript docs Firefox 102 labels May 17, 2022
@github-actions github-actions bot added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label May 17, 2022
@Rumyra Rumyra removed the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label May 17, 2022
@hamishwillee
Copy link
Collaborator

@Rumyra Looking at the recent discussions on this and the code it looks like:

  1. Spec https://wicg.github.io/import-maps/ and here https://github.com/WICG/import-maps#readme
  2. This is behind a pref dom.importMaps.enabled and disabled by default for FF102
  3. The spec is not really standardised. According to the thread there is a lot of churn.
  4. External import maps not yet supported: External import maps support WICG/import-maps#235

So this probably isn't something for 102. I'm also not certain I am sufficiently expert.
Suggest we ask dev team when they think it might be stable enough to document, park this until then, and in the meantime see if we can seek help for documenting. Thoughts?

@Rumyra
Copy link
Collaborator Author

Rumyra commented May 20, 2022

Yeh that sounds like a good plan @hamishwillee - I'll come back and revisit this issue when I check the release project next week 👍

@Rumyra
Copy link
Collaborator Author

Rumyra commented Jun 27, 2022

https://bugzilla.mozilla.org/show_bug.cgi?id=1775424 related - still seems early days tho so I'm going to put this in the backlog for now (just as there are lots of issues for 103 which take higher priority)

@Josh-Cena
Copy link
Member

Question: since this is a web feature instead of a JS feature (the ECMA spec does not specify how module specifiers should be resolved; it's entirely host-specific), should this be triaged as a web API documentation instead?

@teoli2003 teoli2003 added Content:WebAPI Web API docs and removed Content:JS JavaScript docs labels Jul 6, 2022
@teoli2003
Copy link
Member

Label fixed: https://wicg.github.io/import-maps/ It is indeed not part of the language itself.

@Rumyra Rumyra changed the title [JS] Implement Import Maps [WebAPI] Implement Import Maps Jul 7, 2022
@hamishwillee hamishwillee self-assigned this Nov 7, 2022
@hamishwillee
Copy link
Collaborator

I'm not entirely sure how to structure this yet. The feature is implemented using an inline script element with type="importmap" so it is relatively easy to understand where compatibility information should go.

However there really isn't enough space under the script element under the type attribute to capture a faction of the nuances/use cases here. I think I'll probably need to have an "HTML script import map page" or "Script importing in HTML" page. That will be useful in any case for linking from docs like JavaScript modules to show the specific differences in browser environments.

Advice welcome.

@hamishwillee
Copy link
Collaborator

hamishwillee commented Nov 15, 2022

@Rumyra
Copy link
Collaborator Author

Rumyra commented Nov 15, 2022

So giving a brief overview - yes I think we should have something of a guide on import maps. The JS module guide does include stuff about <script> and as guides simply can not abide by one technology that might be a relevant place (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules)

However this guide is very long 🤔 - I can catch up with you about this when you've also given it some thought @hamishwillee :)

@hamishwillee
Copy link
Collaborator

All done bar the reviews - we've iterated once so I think fairly close now. I'll move to done but there might be some final tidy up.

@hamishwillee
Copy link
Collaborator

Phew! All done.

@Rumyra
Copy link
Collaborator Author

Rumyra commented Dec 19, 2022

Phew for you! Thanks @hamishwillee

@Rumyra Rumyra closed this as completed Dec 19, 2022
@hamishwillee
Copy link
Collaborator

Too right!

@Josh-Cena Josh-Cena added the fx release archive A closed issue relating to firefox release notes for developers. label Jun 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebAPI Web API docs fx release archive A closed issue relating to firefox release notes for developers.
Projects
Archived in project
Development

No branches or pull requests

4 participants