Update and lint the bajeebers out of the project

Author: Mark Moffat

.eslintignore

@@ -1 +1,4 @@
-./locales/*.js
+./locales/*.js
+/public/javascripts/**/*.js
+/locales/**/*.js
+/public/stylesheets/**/*.css

.eslintrc.json

@@ -2,7 +2,8 @@
     "extends": "standard",
     "plugins": [
         "standard",
-        "promise"
+        "promise",
+        "extra-rules"
     ],
     "parserOptions": {
         "ecmaVersion": 2017
@@ -26,6 +27,7 @@
         "space-unary-ops"  : 2,
         "no-undef": 1,
         "no-unused-vars": 1,
+        "extra-rules/no-commented-out-code": "warn",
         "keyword-spacing": [
             "error", { 
                 "before": false, "after": false, "overrides": {

app.js

@@ -71,7 +71,7 @@ handlebars = handlebars.create({
                 app_context = '/' + app_context;
             }
             if(keywords){
-                let array = keywords.split(','); let links = '';
+                const array = keywords.split(','); let links = '';
                 for(let i = 0; i < array.length; i++){
                     if(array[i].trim() !== ''){
                         links += '<a href="' + app_context + '/search/' + array[i].trim() + '">' + array[i].trim() + '</a> <span class="keywordSeporator">|</span> ';
@@ -270,7 +270,7 @@ if(app_context !== ''){
 
 // catch 404 and forward to error handler
 app.use((req, res, next) => {
-    let err = new Error('Not Found');
+    const err = new Error('Not Found');
     err.status = 404;
     next(err);
 });
@@ -357,32 +357,32 @@ if(config.settings.database.type === 'embedded'){
     });
 }
 
-function exitHandler(options, err) {
-    if (options.cleanup) {
+function exitHandler(options, err){
+    if(options.cleanup){
         console.log('clean');
         if(config.settings.database.type !== 'embedded'){
             app.db.close();
         }
     }
-    if (err) {
+    if(err){
         console.log(err.stack);
     }
-    if (options.exit) {
+    if(options.exit){
         process.exit();
     }
 }
 
-//do something when app is closing
-process.on('exit', exitHandler.bind(null,{cleanup:true}));
+// do something when app is closing
+process.on('exit', exitHandler.bind(null, { cleanup: true }));
 
-//catches ctrl+c event
-process.on('SIGINT', exitHandler.bind(null, {exit:true}));
+// catches ctrl+c event
+process.on('SIGINT', exitHandler.bind(null, { exit: true }));
 
 // catches "kill pid" (for example: nodemon restart)
-process.on('SIGUSR1', exitHandler.bind(null, {exit:true}));
-process.on('SIGUSR2', exitHandler.bind(null, {exit:true}));
+process.on('SIGUSR1', exitHandler.bind(null, { exit: true }));
+process.on('SIGUSR2', exitHandler.bind(null, { exit: true }));
 
-//catches uncaught exceptions
-process.on('uncaughtException', exitHandler.bind(null, {exit:true}));
+// catches uncaught exceptions
+process.on('uncaughtException', exitHandler.bind(null, { exit: true }));
 
 module.exports = app;

bin/uglify.js

@@ -1,7 +1,7 @@
-var uglifycss = require('uglifycss');
-var uglifyjs = require('uglify-js');
-var path = require('path');
-var fs = require('fs');
+const uglifycss = require('uglifycss');
+const uglifyjs = require('uglify-js');
+const path = require('path');
+const fs = require('fs');
 
 // css files
 uglifyFile('public/stylesheets/style.css', 'css');
@@ -21,14 +21,14 @@ uglifyFile('public/javascripts/codemirror.inline-attachment.js', 'js');
 
 function uglifyFile(filename, type){
     if(type === 'css'){
-        var cssfileContents = fs.readFileSync(filename, 'utf8');
-        var cssUglified = uglifycss.processString(cssfileContents);
-        var cssMiniFilename = filename.substring(0, filename.length - 4) + '.min.' + type;
+        const cssfileContents = fs.readFileSync(filename, 'utf8');
+        const cssUglified = uglifycss.processString(cssfileContents);
+        const cssMiniFilename = filename.substring(0, filename.length - 4) + '.min.' + type;
         fs.writeFileSync(cssMiniFilename, cssUglified, 'utf8');
     }
     if(type === 'js'){
-        var rawCode = fs.readFileSync(filename, 'utf8');
-        var jsUglified = uglifyjs.minify(rawCode, {
+        const rawCode = fs.readFileSync(filename, 'utf8');
+        const jsUglified = uglifyjs.minify(rawCode, {
             compress: {
                 dead_code: true,
                 global_defs: {
@@ -37,7 +37,7 @@ function uglifyFile(filename, type){
             }
         });
 
-        var jsMiniFilename = filename.substring(0, filename.length - 3) + '.min.' + type;
+        const jsMiniFilename = filename.substring(0, filename.length - 3) + '.min.' + type;
         fs.writeFileSync(jsMiniFilename, jsUglified.code, 'utf8');
     }
 }

data/mongodbUpgrade.js

@@ -8,13 +8,13 @@
 // There are no duplication checks in place. Please only run this script once.
 // ** IMPORTANT **
 
-var Nedb = require('nedb');
-var mongodb = require('mongodb');
-var async = require('async');
-var path = require('path');
-var common = require('../routes/common');
-var config = common.read_config();
-var ndb;
+const Nedb = require('nedb');
+const mongodb = require('mongodb');
+const async = require('async');
+const path = require('path');
+const common = require('../routes/common');
+const config = common.read_config();
+let ndb;
 
 // check for DB config
 if(!config.settings.database.connection_string){
@@ -23,18 +23,18 @@ if(!config.settings.database.connection_string){
 }
 
 // Connect to the MongoDB database
-mongodb.connect(config.settings.database.connection_string, {}, function(err, mdb){
+mongodb.connect(config.settings.database.connection_string, {}, (err, mdb) => {
     if(err){
-        console.log("Couldn't connect to the Mongo database");
+        console.log('Couldn\'t connect to the Mongo database');
         console.log(err);
         process.exit(1);
     }
 
     console.log('Connected to: ' + config.settings.database.connection_string);
     console.log('');
 
-    insertKB(mdb, function(KBerr, report){
-        insertUsers(mdb, function(Usererr, report){
+    insertKB(mdb, (KBerr, report) => {
+        insertUsers(mdb, (Usererr, report) => {
             if(KBerr || Usererr){
                 console.log('There was an error upgrading to MongoDB. Check the console output');
             }else{
@@ -46,17 +46,17 @@ mongodb.connect(config.settings.database.connection_string, {}, function(err, md
 });
 
 function insertKB(db, callback){
-    var collection = db.collection('kb');
+    const collection = db.collection('kb');
     console.log(path.join(__dirname, 'kb.db'));
     ndb = new Nedb(path.join(__dirname, 'kb.db'));
-    ndb.loadDatabase(function (err){
+    ndb.loadDatabase((err) => {
         if(err){
             console.error('Error while loading the data from the NeDB database');
             console.error(err);
             process.exit(1);
         }
 
-        ndb.find({}, function (err, docs){
+        ndb.find({}, (err, docs) => {
             if(docs.length === 0){
                 console.error('The NeDB database contains no data, no work required');
                 console.error('You should probably check the NeDB datafile path though!');
@@ -66,7 +66,7 @@ function insertKB(db, callback){
             }
 
             console.log('Inserting articles into MongoDB...');
-            async.each(docs, function (doc, cb){
+            async.each(docs, (doc, cb) => {
                 console.log('Article inserted: ' + doc.kb_title);
 
                 // check for permalink. If it is not set we set the old NeDB _id to the permalink to stop links from breaking.
@@ -77,8 +77,8 @@ function insertKB(db, callback){
                 // delete the old ID and let MongoDB generate new ones
                 delete doc._id;
 
-                collection.insert(doc, function (err){ return cb(err); });
-            }, function (err){
+                collection.insert(doc, (err) => { return cb(err); });
+            }, (err) => {
                 if(err){
                     console.log('An error happened while inserting data');
                     callback(err, null);
@@ -93,16 +93,16 @@ function insertKB(db, callback){
 };
 
 function insertUsers(db, callback){
-    var collection = db.collection('users');
+    const collection = db.collection('users');
     ndb = new Nedb(path.join(__dirname, 'users.db'));
-    ndb.loadDatabase(function (err){
+    ndb.loadDatabase((err) => {
         if(err){
             console.error('Error while loading the data from the NeDB database');
             console.error(err);
             process.exit(1);
         }
 
-        ndb.find({}, function (err, docs){
+        ndb.find({}, (err, docs) => {
             if(docs.length === 0){
                 console.error('The NeDB database contains no data, no work required');
                 console.error('You should probably check the NeDB datafile path though!');
@@ -112,14 +112,14 @@ function insertUsers(db, callback){
             }
 
             console.log('Inserting users into MongoDB...');
-            async.each(docs, function (doc, cb){
+            async.each(docs, (doc, cb) => {
                 console.log('User inserted: ' + doc.user_email);
 
                 // delete the old ID and let MongoDB generate new ones
                 delete doc._id;
 
-                collection.insert(doc, function (err){ return cb(err); });
-            }, function (err){
+                collection.insert(doc, (err) => { return cb(err); });
+            }, (err) => {
                 if(err){
                     console.error('An error happened while inserting user data');
                     callback(err, null);
@@ -132,5 +132,3 @@ function insertUsers(db, callback){
         });
     });
 };
-
-

locales/en.js

@@ -180,5 +180,8 @@
 	"dsdsds is not defined": "dsdsds is not defined",
 	"dfdfd": "dfdfd",
 	"url.URL.parse is not a function": "url.URL.parse is not a function",
-	"A user with that email does not exist.": "A user with that email does not exist."
+	"A user with that email does not exist.": "A user with that email does not exist.",
+	"Visible state": "Visible state",
+	"Public": "Public",
+	"Private": "Private"
 }