feat: add output and template dir config

lib/AutoDocAgent.js

@@ -9,9 +9,16 @@ import {ejsTemplateDir, outputHtmlDir} from './constants'
 
 class AutoDocAgent extends Agent {
   docMetaCollection = []
+  outputDir = outputHtmlDir
+  templateDir = ejsTemplateDir
 
   constructor(app, options) {
     super(app, options);
+
+    if (options) {
+      this.outputDir = options.outputDir || outputHtmlDir
+      this.templateDir = options.templateDir || ejsTemplateDir
+    }
   }
 
   getDocMeta(method, url) {
@@ -20,20 +27,26 @@ class AutoDocAgent extends Agent {
   }
 
   // Render html file using ejs template engine
-  render(outputDir = outputHtmlDir, ejsOptions = {}) {
+  render(options, ejsOptions = {}) {
+    const { outputFilename } = options
+
+    // No output filename
+    if (!outputFilename) throw new Error('Please give an output html filename')
+
+    // ejs data
     const data = {
       docMetaCollection: this.docMetaCollection
     }
 
-    ejs.renderFile(path.join(ejsTemplateDir, 'index.ejs'), data, ejsOptions, (err, html) => {
-      if (err) {
-        throw err
-      }
+    // Render html with ejs template engine
+    ejs.renderFile(path.join(this.templateDir, 'index.ejs'), data, ejsOptions, (err, html) => {
+      if (err) throw err
+
+      // Create dir
+      if (!fs.existsSync(this.outputDir)) fs.mkdirSync(this.outputDir);
 
-      if (!fs.existsSync(outputDir)){
-        fs.mkdirSync(outputDir);
-      }
-      fs.writeFileSync(path.join(outputDir, 'index.html'), html)
+      // Output html file
+      fs.writeFileSync(path.join(this.outputDir, outputFilename), html)
     })
   }
 }

lib/autodoc/test.html

@@ -0,0 +1,57 @@
+<h1>Doc</h1>
+
+
+    <div>
+        <h2>Get all users</h2>
+        <p>Send a get request to get all users from the server</p>
+
+        <!-- Request -->
+        <h3>Request</h3>
+        <p>
+            <span>get</span>
+            <span>/?a=1&amp;b=2</span>
+        </p>
+        <p>Params: </p>
+        <pre>{
+	&#34;a&#34;: &#34;1&#34;,
+	&#34;b&#34;: &#34;2&#34;
+}</pre>
+        <p>Body: </p>
+        <pre></pre>
+
+        <!-- Response -->
+        <h3>Response</h3>
+        <p>Body: </p>
+        <pre>{
+	&#34;msg&#34;: &#34;get success&#34;,
+	&#34;code&#34;: 0
+}</pre>
+    </div>
+
+    <div>
+        <h2>Post a user</h2>
+        <p>Create a user and add it to the database</p>
+
+        <!-- Request -->
+        <h3>Request</h3>
+        <p>
+            <span>post</span>
+            <span>/?a=1&amp;b=2</span>
+        </p>
+        <p>Params: </p>
+        <pre>{
+	&#34;a&#34;: &#34;1&#34;,
+	&#34;b&#34;: &#34;2&#34;
+}</pre>
+        <p>Body: </p>
+        <pre>[object Object]</pre>
+
+        <!-- Response -->
+        <h3>Response</h3>
+        <p>Body: </p>
+        <pre>{
+	&#34;msg&#34;: &#34;post success&#34;,
+	&#34;code&#34;: 0
+}</pre>
+    </div>
+

test/AutoDocAgent.test.js

@@ -68,5 +68,5 @@ describe('AutoDocAgent', function () {
       })
   });
 
-  afterAll(() => agent.render())
+  afterAll(() => agent.render({ outputFilename: 'test.html' }))
 });