ember-fastboot/ember-cli-fastboot

Update the docs on the third-party-dependencies section to describe dynamic import method

Open

#921 opened on Jun 7, 2023

View on GitHub
 (0 comments) (1 reaction) (0 assignees)JavaScript (853 stars) (163 forks)batch import
good first issue

Description

The docs for third party dependencies describes a rather old technique that involves automatically wrapping your vendor libs in a "fastboot guard". This method a) won't work for anything that is using ember-auto-import and b) won't work in a broccoli-free embroider build

We should update this section to describe the fact that you can use dynamic imports inline with your code that has a fastboot guard on it. This is idiomatic in terms of the wider JS community i.e. don't import things that you know won't work in your environment

Contributor guide

Tech stack
javascript
Domain
documentationfrontend
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Ember.js basicsJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Update the Third Party Dependencies section of the Fastboot docs (addon author guide) to describe dynamic imports with a fastboot guard. The current documentation describes an outdated technique. See the existing guide at https://ember fastboot.com/docs/addon author guide#third party dependencies. No linked PRs or comments. The change is purely documentation.