ember-learn / ember-learn/ember-cli-addon-docs
Ember Data is a secret dependency breaking consumers of ec-addon-docs
- Lingua principale
- JavaScript
- Stelle
- 172
- Fork
- 142
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
It's marked as a `peerDependency`, but it is required for ec-addon-docs to run properly. If the consuming project does not have `ember-data` in its package.json, ec-addon-docs breaks and throws an error, and the docs will not render. However, we can't specify it as a dependency within ec-addon-docs, either.
Addons do not ship with ember-data by default, as it is not part of the addon blueprint. Most addons don't have a need to install it either, as most addons won't be doing any data fetching. So, we cannot count on ember-data to be present in order to ship a working experience to users of this project.
There are three possible solutions which could be used in conjunction with one another:
1) Update the documentation for ec-addon-docs to explicitly ask users to install ember-data as part of the setup guide.
2) Add ember-data to the blueprint so that installing ec-addon-docs ensures ember-data is also installed, when using `ember install`
3) Use version checker to have addon-docs throw an error if a valid version of ember-data (currently 3.0+) is not present in the consuming addon.
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Inizia con la guida alla configurazione di ec-addon-docs, il blueprint dell’addon e gli entry point per il controllo della versione indicati nell’issue. Confronta i tre approcci proposti e conferma come l’installazione dell’addon e il rendering della documentazione gestiscono attualmente ember-data. Il lavoro è completato quando l’approccio scelto è implementato e i consumer ricevono un’esperienza di documentazione funzionante oppure un errore chiaro relativo a una versione valida.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript
- Ambito
- documentation, tooling
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100