fix: ensure ember-data works properly #119
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Docs Generation Changes
resolves #117
partially resolves #118 by enabling work arounds
note, with this change you must explicitly opt-in to install and build of docs locally.
If you don't opt in you will get whatever docs build was last built in that project, which for local purposes like this is typically preferred anyway.
Docs Parsing Changes
Updated Parser
Updated the parser to resolve several issues with EmberData docs not being correctly parsed. I've manually reviewed all EmberData documentation and this has no ill-effects. We should also review the Ember documentation.
highlight.js
from^10.4.1
to^11.7.0
marked
from^0.7.0
to^4.3.0
Fixed Async Issues
generate-local
command now directly invokesmain
vs runningyarn
viaexeca
. This ensures that crashes are correctly reported, they weren't before.async/await
and a few things that could race before were made linear (thefor ... of
change). This generally enabled errors to surface instead of getting lost. We also seem to always complete the docs build now, before if an error occurred we would see "success" but not actual have an updated asset or see an error.Fixed Bug
There was a bug in which documentation with an
id
longer than50
would not be saved into the json-docs.ember-jsonapi-docs/lib/save-document.js
Lines 21 to 23 in d25d94a
This led to the module
@ember-data/experimental-preview-types
not being built properly. I've utilized the code comment to improve the heuristic to capture whatever case this was originally here for (sounds like no one knows?) so that EmberData's docs will correctly build.