Merge pull request #41 from georgejecook/feature/updateToUseLatestRoo…

…ibosC Feature/update to use latest rooibos c
rokucommunity · Apr 25, 2019 · 2fdf84f · 2fdf84f
2 parents 0f3c12b + 1e9f8f4
commit 2fdf84f
Show file tree

Hide file tree

Showing 17 changed files with 1,186 additions and 1,698 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,20 @@
 # Rooibos CHANGELOG
 
+## 2.1.3
+
+### Added
+
+### Changed
+
+ - improves documentation, explaining how to use rooibos-preprocessor from gulp/js toolchains
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+
 ## 2.1.2
 
 ### Added

diff --git a/docs/Rooibos.brs.html b/docs/Rooibos.brs.html
@@ -122,7 +122,7 @@ <h1 class="page-title">Rooibos.brs</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 21 2019 20:05:44 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Apr 25 2019 18:06:17 GMT-0500 (-05) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Rooibos_BaseTestSuite.brs.html b/docs/Rooibos_BaseTestSuite.brs.html
@@ -2003,7 +2003,7 @@ <h1 class="page-title">Rooibos_BaseTestSuite.brs</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 21 2019 20:05:44 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Apr 25 2019 18:06:17 GMT-0500 (-05) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Rooibos_CommonUtils.brs.html b/docs/Rooibos_CommonUtils.brs.html
@@ -598,7 +598,7 @@ <h1 class="page-title">Rooibos_CommonUtils.brs</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 21 2019 20:05:44 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Apr 25 2019 18:06:17 GMT-0500 (-05) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Rooibos_ItemGenerator.brs.html b/docs/Rooibos_ItemGenerator.brs.html
@@ -273,7 +273,7 @@ <h1 class="page-title">Rooibos_ItemGenerator.brs</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 21 2019 20:05:44 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Apr 25 2019 18:06:17 GMT-0500 (-05) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Rooibos_TestRunner.brs.html b/docs/Rooibos_TestRunner.brs.html
@@ -415,7 +415,7 @@ <h1 class="page-title">Rooibos_TestRunner.brs</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 21 2019 20:05:44 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Apr 25 2019 18:06:17 GMT-0500 (-05) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/index.html b/docs/index.html
@@ -57,7 +57,7 @@
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 21 2019 20:05:44 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Apr 25 2019 18:06:17 GMT-0500 (-05) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/index.md b/docs/index.md
@@ -71,9 +71,47 @@ Rooibos is intentionally simple to work with. You simply copy in the `rooibosDis
 
 **For an example of how to use rooibos with gulp, see the gulpfile.ts in this project, which is used to run the framework unit tests.**
 
-### RooibosC
+### rooibos-preprocessor
+
+To get the best performance and test flexibility, rooibos leverages a typescript preprocessor, named [rooibos-preprocessor](https://github.com/georgejecook/rooibosPreprocessor), which prepares some files which get sideloaded with your tests. 
+
+### From javascript/typescript/node
+
+#### Gulp typescript example
+
+The following working gulpfile can be found in my [roku MVVM spike](https://github.com/georgejecook/rokuNavSpike/tree/feature/viewModels); but the process is as follows.
+
+ - `npm install rooibos-preprocessor --save-dev`
+ - Add the following to the top of gulpfile.ts `import { RooibosProcessor } from "rooibos-preprocessor";`
+ - Create a task to process your files, with the desired regex replacements, such as:
+
+ ```
+ export function addDevLogs(cb) {
+  let config: BurpConfig = {
+    "sourcePath": "build/.roku-deploy-staging",
+    // "sourcePath": "build/wtf",
+    "globPattern": "**/*.brs",
+    "replacements": [
+      {
+        "regex": "(^.*(logInfo|logError|logVerbose|logDebug)\\((\\s*\"))",
+        "replacement": "$1#FullPath# "
+      },
+      {
+        "regex": "(^.*(logMethod)\\((\\s*\"))",
+        "replacement": "$1#FullPath# "
+      }
+    ]
+  }
+  const processor = new BurpProcessor(config);
+  processor.processFiles();
+  cb();
+}
+```
+
+
+#### CLI usage
 
-To get the best performance and test flexibility, rooibos leverages a typescript preprocessor, named [rooibosC](https://github.com/georgejecook/rooibosPreprocessor), which prepares some files which get sideloaded with your tests. Simply: `npm install -g rooibos-preprocessor`
+You can also use rooibos-preprocessor from the command line, by installing it globally. i.e `npm install -g rooibos-preprocessor`. The CLI app is vcalled `rooibos`
 
 Then call `rooibosC -h` to check the install worked and see the help menu.
 

diff --git a/docs/module-BaseTestSuite.html b/docs/module-BaseTestSuite.html
@@ -12420,7 +12420,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 21 2019 20:05:44 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Apr 25 2019 18:06:17 GMT-0500 (-05) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-CommonUtils.html b/docs/module-CommonUtils.html
@@ -5062,7 +5062,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 21 2019 20:05:44 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Apr 25 2019 18:06:17 GMT-0500 (-05) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-ItemGenerator.html b/docs/module-ItemGenerator.html
@@ -1442,7 +1442,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 21 2019 20:05:44 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Apr 25 2019 18:06:17 GMT-0500 (-05) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-TestRunner.html b/docs/module-TestRunner.html
@@ -651,7 +651,7 @@ <h4 class="name" id="Run"><span class="type-signature"></span>Run<span class="si
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 21 2019 20:05:44 GMT-0500 (-05) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Apr 25 2019 18:06:17 GMT-0500 (-05) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>