Formatting changes to \!mdn to remove redundancy, unescape html entities

Author: Havvy

jshelp.js

@@ -4,12 +4,13 @@ const npminfo = Promise.promisify(npm.info, npm);
 const format = require('util').format;
 const inspect = require('util').inspect;
 const request = require('request');
+const unescape = require('lodash.unescape');
 
 module.exports = {
     init: function (client, imports) {
-        const ready = Promise.promisify(npm.load, npm)({});
+        const npm_ready = Promise.promisify(npm.load, npm)({});
 
-        ready.catch(function (err) {
+        npm_ready.catch(function (err) {
             client.error('Plugin-JSHelp', err.name);
             client.error('Plugin-JSHelp', err.stack);
         });
@@ -21,7 +22,7 @@ module.exports = {
                         return;
                     }
 
-                    return ready
+                    return npm_ready
                     .then(function () {
                         return new Promise(function (resolve, reject) {
                             npm.commands.info([command.args[0], 'name', 'description'], true, function (err, res) {
@@ -66,7 +67,15 @@ module.exports = {
                         });
                     })
                     .then(function (res) {
-                        return format('%s - %s', res.url, res.titleNoFormatting);
+                        // Turn > into >, ect.
+                        // Strip the " | MDN" from end of title.
+                        return {
+                            url: res.url, 
+                            title: unescape(res.titleNoFormatting.slice(0, -6))
+                        };
+                    })
+                    .then(function (res) {
+                        return format("%s - %s", res.url, res.title)
                     })
                     .catch(function (err) {
                         client.error('Plugin-JSHelp', err.name);

package.json

@@ -4,7 +4,7 @@
   "description": "JS Help Plugin for Tennu IRC Bot Framework",
   "main": "jshelp.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "mocha tests.js"
   },
   "repository": {
     "type": "git",
@@ -22,7 +22,12 @@
   "homepage": "https://github.com/Tennu/tennu-jshelp",
   "dependencies": {
     "bluebird": "^0.11.x",
+    "lodash.unescape": "^2.4.1",
     "npm": "^1.3.x",
     "request": "^2.33.0"
+  },
+  "devDependencies": {
+    "better-assert": "^1.0.2",
+    "mocha": "^2.1.0"
   }
 }

tests.js

@@ -0,0 +1,34 @@
+//const sinon = require('sinon');
+const assert = require('better-assert');
+// const equal = require('deep-eql');
+const inspect = require('util').inspect;
+const format = require('util').format;
+
+const debug = false;
+const logfn = debug ? console.log.bind(console) : function () {};
+
+const jshelp_plugin = require('./jshelp');
+const client = {
+    notice: logfn,
+    error: function err (pluginName, errorState) {
+        if (err.showedName !== true) {
+            logfn("Error: " + errorState);
+            err.showedName = true;
+            return;
+        }
+
+        logfn("Error: " + errorState);
+        assert(false);
+    }
+};
+
+describe("MDN -", function () {
+    it("Escapes common HTML entities", function () {
+        const jshelp = jshelp_plugin.init(client, {});
+        return jshelp.handlers["!mdn"]({args: ['HTML script']})
+        .then(function (output) {
+            logfn(format("'%s'", output));
+            assert(output === "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script - <script> - HTML (HyperText Markup Language)")
+        });
+    });
+});