Make Module Documentation Available #1281
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Change how tabs are loaded to allow the passing of the ReactDOM to tabs
Updating tests to fit the tab file syntax
Fixed lodash memoization
eslint formatting
js-slang can now load documentation for modules to display them in the prompts used by the ace editor
Ran eslint
Added support for module variables' documentation
Ran eslint
The generated documentation will now more closely follow the format as given by the builtins
Ran eslint
Built documentations are now formatted appropriately and do not need to be parsed by js-slang
Added failure message for when documentation fails to load
Makes no sense for tabs to be edited every time they are loaded.
Fixed tests
If there are errors while loading documentation, the user won't constantly get lagged out by js-slang trying to reach the module server again and again
Pull Request Test Coverage Report for Build 3068335363
💛 - Coveralls |
This was referenced Aug 6, 2022
|
This pull request introduces 1 alert when merging 3e7c274 into ed3b88d - view on LGTM.com new alerts:
|
If you try using namespace imports with fullJS it won't lag your editor with errors anymore
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
With reference to this PR, there are two changes to js-slang:
Added a new
loadModuleDocsfunction. Currently, unlike the other load functions, this function returnsnulland logs to the console if there are errors loading the documentation instead of throwing that error. This is to prevent a request being made to the modules server every time the user presses a key in the editor, resulting in significant lag.Raw tab files are no longer processed by js-slang. Instead, they are evaluated directly and passed to the frontend. The corresponding tests have been modified.
Also made the documentation for some of the name parsing code a bit clearer.