Add autocompletion support (source-academy#501)

* Add loose parser

* Add documentation

- Add python script to parse jsdoc html to json
- Export documentation
- Add styles for autocompletion

* Finish autocomplete (#3)

* Add traversal call to index
* Finish autocomplete
* Use upstream loose parser
* Minor refactor
Co-authored-by: Cara Leong <[email protected]>

* Regenerate docs

* Add tests for autocomplete feature (#4)

* Fix empty array bug

* Add simple tests

* Fix for loop declaration bug

* More tests

* Fixed lint errors

Co-authored-by: Shaowei Chen <[email protected]>

* Add documentation for concurrent source 3

Co-authored-by: Cara Leong <[email protected]>
Co-authored-by: martin-henz <[email protected]>

README.rst

@@ -77,11 +77,13 @@ in the library sources. The libraries are in repository ``cadet-frontend``, whic
 is assumed to be located in ``../cadet-frontend``, from the root of this repo.
 The command
 ``yarn jsdoc``
-makes the documentation available in folder
+makes the documentation available in folder and updates the jsons for documentation displayed in the `cadet-frontend`.
 ``doc/jsdoc/libraries/``.
 The script `jsdoc` provides an installation command to deploy the documentation via `scp` on a server:
 ``yarn jsdoc install``
 
+To update documentation displayed in autocomplete on the frontend, `js-slang` version needs to be bumped and `cadet-frontend` needs to be updated to use the new version. To add additional source versions or external libraries, the `targets` specified in `updateAutocompleteDocs.py` as well as the exported object in `src/editors/ace/docTooltip` need to be updated.
+
 Testing
 -------
 
@@ -99,7 +101,7 @@ Error messages
 
 To enable verbose messages, have the statement ``"enable verbose";`` as the first line of your code.
 
-There are two main kinds of error messages: those that occur at runtime and those that occur at parse time. 
+There are two main kinds of error messages: those that occur at runtime and those that occur at parse time.
 The first can be found in interpreter-errors.ts, while the second can be found in rules/.
 
 Each error subclass will have explain() and elaborate(). Displaying the error will always cause the first to be
@@ -120,5 +122,5 @@ A common issue when developing modifications to js-slang is how to test it using
   $ cd js-slang
   $ yarn build
   $ cp -r dist ../cadet-frontend/node_modules/js-slang
-  
+
 Then start frontend and the new js-slang will be used.

docs/jsdoc/templates/template/tmpl/container.tmpl

@@ -145,7 +145,9 @@
         <h3 class="subsection-title">Constants</h3> <!-- changed from >Members< by MH -->
 
         <?js members.forEach(function(p) { ?>
-            <?js= self.partial('members.tmpl', p) ?>
+            <div class="constant-entry">
+                <?js= self.partial('members.tmpl', p) ?>
+            </div>
         <?js }); ?>
     <?js } ?>
 
@@ -156,7 +158,9 @@
         <h3 class="subsection-title">Functions</h3>  <!-- changed by MH on 1/7/2019, was Methods -->
 
         <?js methods.forEach(function(m) { ?>
-            <?js= self.partial('method.tmpl', m) ?>
+            <div class="function-entry">
+                <?js= self.partial('method.tmpl', m) ?>
+            </div>
         <?js }); ?>
     <?js } ?>
 

docs/source/CONCURRENCY/global.html

@@ -104,7 +104,8 @@ <h2></h2>
         <h3 class="subsection-title">Functions</h3>  <!-- changed by MH on 1/7/2019, was Methods -->
 
 
-
+            <div class="function-entry">
+
 
 
 
@@ -260,8 +261,10 @@ <h5>Returns:</h5>
 
 
 
+            </div>
 
-
+            <div class="function-entry">
+
 
 
 
@@ -420,8 +423,10 @@ <h5>Returns:</h5>
 
 
 
+            </div>
 
-
+            <div class="function-entry">
+
 
 
 
@@ -578,6 +583,7 @@ <h5>Returns:</h5>
 
 
 
+            </div>
 
 
 
@@ -602,7 +608,7 @@ <h3>Predeclared names</h3><ul><li><a href="global.html#clear">clear</a></li><li>
 <footer>
   generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.5.5</a> from
   <a href="https://github.com/source-academy/js-slang">Github repository js-slang</a>
-  on Sun Mar 29 2020 14:25:23 GMT+0800 (Singapore Standard Time)
+  on Tue Apr 07 2020 00:43:01 GMT+0800 (Singapore Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/source/CONCURRENCY/index.html

@@ -73,7 +73,7 @@ <h3>Predeclared names</h3><ul><li><a href="global.html#clear">clear</a></li><li>
 <footer>
   generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.5.5</a> from
   <a href="https://github.com/source-academy/js-slang">Github repository js-slang</a>
-  on Sun Mar 29 2020 14:25:23 GMT+0800 (Singapore Standard Time)
+  on Tue Apr 07 2020 00:43:01 GMT+0800 (Singapore Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>