[student-libraries] Expose functions, comments, and parameters from the JSInterpreter #30853
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
jmkulwik
changed the title
ajpal
reviewed
Sep 20, 2019
|
|
||
| let comments = []; | ||
| let options = { | ||
| onComment: (isBlockComment, text, startLocation, endLocation) => { |
There was a problem hiding this comment.
How/when is this option used? Is it https://github.com/code-dot-org/JS-Interpreter/blob/master/acorn.js#L81? Might be helpful to include a comment explaining since it's not immediately obvious what this is for.
jmkulwik
force-pushed
the
prod-libraries-s3
branch
from
83176ae
to
906991d
Compare
epeach
reviewed
Sep 27, 2019
| @@ -245,6 +246,78 @@ export default class JSInterpreter { | |||
| } | |||
| } | |||
|
|
|||
| /** | |||
| * Builds a list of objects that contain all metadata about any functions in | |||
| * the gived code string. Each object in the returned list has the following | |||
epeach
reviewed
Sep 27, 2019
| @@ -245,6 +246,78 @@ export default class JSInterpreter { | |||
| } | |||
| } | |||
|
|
|||
| /** | |||
| * Builds a list of objects that contain all metadata about any functions in | |||
| * the gived code string. Each object in the returned list has the following | |||
There was a problem hiding this comment.
Can we use the @return tag to be consistent with our commenting style and include the expected type for the returned object?
| @@ -7,6 +7,79 @@ import JSInterpreter from '@cdo/apps/lib/tools/jsinterpreter/JSInterpreter'; | |||
| describe('The JSInterpreter class', function() { | |||
| var jsInterpreter; | |||
|
|
|||
| describe('static function getFunctionsAndMetadata', () => { | |||
ajpal
approved these changes
Sep 27, 2019
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.
Added functionality to the JSInterpreter to parse student code for functions along with their comments and parameters.
For a sample of what student comments could look like, see this project: https://studio.code.org/projects/applab/TUd7VzCGUL5pVK-LqRLi-9Z1xtw-R-KinEDnVeA2pag/edit
This pairs with this PR in the JSInterpreter library: code-dot-org/JS-Interpreter#32
This is in preparation for the student-libraries feature described in this spec: https://docs.google.com/document/d/1VxMmdHdIeBWCXKofkjEy9MuWcrzeEW3Zt-Ir8pINYdA/edit