initialize

Author: Asghar

.eslintrc.json

@@ -0,0 +1,11 @@
+{
+    "extends": "standard",
+    "env": {
+      "browser": true,
+      "node": true,
+      "mocha": true
+    },
+    "rules": {
+      "camelcase": "off"
+    }
+}

.gitignore

@@ -0,0 +1 @@
+node_modules

index.js

@@ -0,0 +1,27 @@
+const commentParser = require('comment-parser');
+
+const parseFile = file => new Promise((resolve,reject)=>{
+    commentParser.file(file, (err,result)=>err ? reject(err) : resolve(result));
+})
+
+parseFile('./sample.js').then(c=> {
+    let all = Object.values(c).reduce((result,item)=>{
+        if (!item.tags.some(i=>i.tag==='socket.io-doc')) return result;
+        let category = item.tags.find(i=>i.tag==='tag');
+        category=category ? category.name : 'uncategorized';
+
+        let transformed = item.tags.reduce((r,t)=>{
+            (t.tag === 'listen' || t.tag ==='emit') && (r={...r,action:t.tag, event: t.name});
+            t.tag==='example' && (r={...r, example: t.name.replace(/\n|\r/g, "")+t.description.replace(/\n|\r/g, "")});
+            return r;
+        },{
+            category,
+            description:item.description || null
+        });
+        result.push(transformed);
+        return result;
+    },[]);
+
+    console.log(all);
+}).catch(e=>console.error(e));
+

package-lock.json

@@ -0,0 +1,28 @@
+{
+  "name": "socketio-doc",
+  "version": "1.0.0",
+  "description": "Socket.io inline document generator.",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cybercoder/socketio-doc.git"
+  },
+  "keywords": [
+    "socket.io",
+    "doc",
+    "comment"
+  ],
+  "author": "cybercoder",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/cybercoder/socketio-doc/issues"
+  },
+  "homepage": "https://github.com/cybercoder/socketio-doc#readme",
+  "dependencies": {
+    "comment-parser": "^0.7.6",
+    "showdown": "^1.9.1"
+  }
+}

package.json

@@ -0,0 +1,28 @@
+/**
+ * @api asghar.com
+ */
+
+/**
+ * Singleline or multiline description text. Line breaks are preserved111.
+ * @socket.io-doc
+ * @emit send send a message
+ * @tag Messaging
+ * @data {object}
+ * @example
+ * {
+ *   "id": 1,
+ *   "title": 5
+ * }
+ */
+
+
+ /**
+ * Singleline or multiline description text. Line breaks are preserved.
+ * @socket.io-doc
+ * @listen onReceive receive
+ * @tag Messaging
+ * @data {object}
+ * @example 5
+ */
+
+ console.log()