Merge pull request #13 from cmontella/add/console-and-file

Document console and file watchers

Author: cmontella

_layouts/default.html

@@ -71,6 +71,8 @@ <h1><img alt="EVE" src="https://witheve.github.io/assets/images/wordmark.svg" />
                                         <li><a href="/v0.3/handbook/libraries/stdlib/#canvas">Canvas</a></li>
                                         <li><a href="/v0.3/handbook/libraries/stdlib/#ui">UI</a></li>
                                         <li><a href="/v0.3/handbook/libraries/stdlib/#system">System</a></li>
+                                        <li><a href="/v0.3/handbook/libraries/stdlib/#file">File</a></li>
+                                        <li><a href="/v0.3/handbook/libraries/stdlib/#console">Console</a></li>
 
                                     </ul>
                                 </li>

v0.3/handbook/libraries/stdlib.md

@@ -1436,18 +1436,15 @@ The system library provides various system-level utilities for Eve.
     <td>
       <code>
 Commits a timer that ticks every 1000 milliseconds
-
 ```
 commit
   [#system/timer resolution: 1000]
 ```
 
 Displays the current time
-
 ```
 search
   [#system/timer hour minute second]
-
 bind
   [#ui/text text: "{{hour}}:{{minute}}:{{second}}"]
 ```
@@ -1456,4 +1453,175 @@ bind
   </tr>
 </table>
 
+## File
+
+A library for accessing the filesystem. This library only works when Eve is run in headless mode.
+
+<table class="libitem">
+  <tr>
+    <td colspan="2">
+      <b>#file/read</b> - read the specified file
+    </td>
+  </tr>
+
+  <tr>
+    <td>
+      <ul>
+        <li><strong>path</strong> - The path of the file to be read.</li>
+        <li><strong>encoding</strong> - (optional) - The encoding of the file. The default is utf-8.</li>
+        <li><strong>error</strong> - (optional) - If an error is encountered when attempting to read the file, it will be stored here as a #file/error.</li>
+        <li><strong>contents</strong> - The contents of the file. This attribute will have a value once the entire contents of the file are read.</li>
+      </ul>
+    </td>
+    <td>
+      <code>
+Read a file
+```
+commit
+  [#file/read #my-file path: "test-file.txt"]
+```
+
+Display the contents of the file
+```
+search
+  [#my-file contents]
+commit
+  [#console/log text: contents]
+```
+      </code>
+    </td>
+  </tr>
+</table>
+
+<table class="libitem">
+  <tr>
+    <td colspan="2">
+      <b>#file/read</b> - read the specified file
+    </td>
+  </tr>
+
+  <tr>
+    <td>
+      <ul>
+        <li><strong>path</strong> - The path of the file to be written.</li>
+        <li><strong>encoding</strong> - (optional) - The encoding of the file. The default is utf-8.</li>
+        <li><strong>contents</strong> - The string that will be written to the file</li>
+        <li><strong>error</strong> - (optional) - If an error is encountered when attempting to read the file, it will be stored here as a #file/error.</li>
+        <li><strong>#file/complete</strong> - When the contents are written successfully, the record will be tagged #file/complete.</li>
+      </ul>
+    </td>
+    <td>
+      <code>
+```
+commit
+  [#file/write path: "test-file.txt" contents: "This will be in the file"]
+```
+      </code>
+    </td>
+  </tr>
+</table>
+
+<table class="libitem">
+  <tr>
+    <td colspan="2">
+      <b>#file/error</b> - stores information relating to file access errors
+    </td>
+  </tr>
+
+  <tr>
+    <td>
+      <ul>
+        <li><strong>code</strong> - The error code</li>
+        <li><strong>message</strong> - The error message</li>
+      </ul>
+    </td>
+    <td>
+      <code>
+```
+search
+  [#file/read path error: [code: "ENOENT"]]
+commit
+  [#console/error text: "Could not file file {{path}}"]
+```
+      </code>
+    </td>
+  </tr>
+</table>
+
+## Console
+
+Write text to the console
+
+<table class="libitem">
+  <tr>
+    <td colspan="2">
+      <b>#console/log</b> - write info to the console
+    </td>
+  </tr>
+
+  <tr>
+    <td>
+      <ul>
+        <li><strong>text</strong> - The text to write to the console. Text will also be written to stdout.</li>
+      </ul>
+    </td>
+    <td>
+      <code>
+```
+commit
+  [#console/log text: "Hello world!"]
+```
+      </code>
+    </td>
+  </tr>
+</table>
+
+<table class="libitem">
+  <tr>
+    <td colspan="2">
+      <b>#console/warn</b> - write a warning to the console
+    </td>
+  </tr>
+
+  <tr>
+    <td>
+      <ul>
+        <li><strong>text</strong> - The text to write to the console.</li>
+      </ul>
+    </td>
+    <td>
+      <code>
+```
+commit
+  [#console/warn text: "Memory is running low."]
+```
+      </code>
+    </td>
+  </tr>
+</table>
+
+<table class="libitem">
+  <tr>
+    <td colspan="2">
+      <b>#console/error</b> - write an error to the console.
+    </td>
+  </tr>
+
+  <tr>
+    <td>
+      <ul>
+        <li><strong>text</strong> - The text to write to the console. Text will also be written to stderr.</li>
+      </ul>
+    </td>
+    <td>
+      <code>
+```
+commit
+  [#console/error text: "Access is Denied"]
+```
+      </code>
+    </td>
+  </tr>
+</table>
+
 {% endraw %}