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.
yarn gen --project ember --version 4.12.0 --build --install
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.
updated highlight.js from ^10.4.1 to ^11.7.0
updated marked from ^0.7.0 to ^4.3.0
Fixed Async Issues
the generate-local command now directly invokes main vs running yarn via execa. This ensures that crashes are correctly reported, they weren't before.
various promise spaghetti has been refactored to async/await and a few things that could race before were made linear (the for ... 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 than 50 would not be saved into the json-docs.
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.
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.jsfrom^10.4.1to^11.7.0markedfrom^0.7.0to^4.3.0Fixed Async Issues
generate-localcommand now directly invokesmainvs runningyarnviaexeca. This ensures that crashes are correctly reported, they weren't before.async/awaitand a few things that could race before were made linear (thefor ... ofchange). 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
idlonger than50would not be saved into the json-docs.https://github.com/ember-learn/ember-jsonapi-docs/blob/d25d94a1ee4db5c4048aa84d994a674a0061b09b/lib/save-document.js#L21-L23
This led to the module
@ember-data/experimental-preview-typesnot 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.