Issue #72 -- Add a Linter

.editorconfig

@@ -0,0 +1,33 @@
+# https://editorconfig.org
+# Editor Config for WebMemex
+# Download an extension for editor config to allow your IDE
+# to follow the rules of the project
+
+# Used to indicate the file is in root of the project
+root = true
+
+# Styling applicable to all forms of files
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+end_of_line = lf
+charset = utf-8
+
+# Styling applicable to the file extension given
+[*.js, *.jsx]
+# This is due to the fact that github allows only 119 columns of space to view
+max_line_length = 119
+
+[*.json]
+indent_size = 2
+
+# Ignore all the styles due to uglify
+[*.min.js]
+indent_style = ignore
+insert_final_newline = ignore
+
+[Makefile]
+indent_style = tab

.eslintignore

@@ -0,0 +1 @@
+extension/

.eslintrc.json

@@ -0,0 +1,59 @@
+{
+    "env": {
+        "browser": true,
+        "webextensions": true
+    },
+    "extends": [
+        "plugin:import/recommended",
+        "plugin:import/react",
+        "plugin:promise/recommended",
+        "plugin:react/recommended",
+        "standard",
+        "standard-react"
+    ],
+    "settings": {
+        "import/resolver": {
+            "node": {
+                "extensions": [
+                    ".js",
+                    ".jsx"
+                ],
+                "moduleDirectory": [
+                    "node_modules",
+                    "."
+                ]
+            }
+        }
+    },
+    "plugins": [
+        "standard",
+        "import",
+        "promise",
+        "react"
+    ],
+    "parserOptions": {
+    	"sourceType": "module",
+	    "ecmaFeatures": {
+	        "jsx": true
+	    }
+  	},
+    "rules":{
+    	"comma-dangle": ["error", "always-multiline"],
+        "indent": ["error", 4, { "SwitchCase": 1 }],
+        "react/jsx-indent": ["error", 4],
+        "react/jsx-indent-props": ["error", 4],
+        "no-multiple-empty-lines": ["error", { "max": 2, "maxEOF": 0 }],
+        "no-unused-vars": "warn",
+        "space-before-function-paren": "off",
+        "operator-linebreak": ["error", "before"],
+        "import/no-mutable-exports": "error",
+        "import/unambiguous": "off",
+        "promise/avoid-new": "off",
+        "react/jsx-filename-extension": "error",
+        "react/prefer-stateless-function": "warn",
+        "react/sort-comp": "warn",
+        "react/jsx-max-props-per-line": [1, { "when": "multiline" }],
+        "react/no-unused-prop-types": "warn",
+        "react/prop-types": "off"
+    }
+}

gulpfile.babel.js

@@ -27,14 +27,14 @@ const files = [
         entries: ['./src/overview/main.jsx'],
         output: 'overview.js',
         destination: './extension/overview',
-        cssOutput: 'style.css'
+        cssOutput: 'style.css',
     },
     {
         entries: ['./src/options/main.jsx'],
         output: 'options.js',
         destination: './extension/options',
-        cssOutput: 'style.css'
-    }
+        cssOutput: 'style.css',
+    },
 ]
 
 const browserifySettings = {
@@ -44,23 +44,23 @@ const browserifySettings = {
 }
 
 function createBundle({entries, output, destination, cssOutput},
-                      {watch=false, production=false}) {
+                      {watch = false, production = false}) {
     let b = watch
         ? watchify(browserify({...watchify.args, ...browserifySettings, entries}))
             .on('update', bundle)
         : browserify({...browserifySettings, entries})
     b.transform(babelify)
     b.transform(envify({
-        NODE_ENV: production ? 'production' : 'development'
+        NODE_ENV: production ? 'production' : 'development',
     }), {global: true})
 
-    if(cssOutput) {
+    if (cssOutput) {
         b.plugin(cssModulesify, {
             global: true,
             output: path.join(destination, cssOutput),
             postcssBefore: [
-                cssnext
-            ]
+                cssnext,
+            ],
         })
     }
 
@@ -71,10 +71,10 @@ function createBundle({entries, output, destination, cssOutput},
     function bundle() {
         let startTime = new Date().getTime()
         b.bundle()
-            .on('error', error=>console.error(error.message))
+            .on('error', error => console.error(error.message))
             .pipe(source(output))
             .pipe(buffer())
-            .pipe(production ? uglify({output: {ascii_only:true}}) : identity())
+            .pipe(production ? uglify({output: {ascii_only: true}}) : identity())
             .pipe(gulp.dest(destination))
             .on('end', () => {
                 let time = (new Date().getTime() - startTime) / 1000

package.json

@@ -11,7 +11,9 @@
     "build": "gulp build",
     "watch": "gulp watch",
     "fx-run": "web-ext -s extension run",
-    "fx-build": "npm run build-prod && web-ext -s extension -a dist/firefox build"
+    "fx-build": "npm run build-prod && web-ext -s extension -a dist/firefox build",
+    "lint": "eslint --ext js,jsx .",
+    "lint-fix": "eslint --ext js,jsx --fix ."
   },
   "dependencies": {
     "babel-runtime": "^6.23.0",
@@ -48,6 +50,13 @@
     "babelify": "^7.3.0",
     "browserify": "^13.1.1",
     "css-modulesify": "^0.27.1",
+    "eslint": "^3.18.0",
+    "eslint-config-standard": "^7.1.0",
+    "eslint-config-standard-react": "^4.3.0",
+    "eslint-plugin-import": "^2.2.0",
+    "eslint-plugin-promise": "^3.5.0",
+    "eslint-plugin-react": "^6.10.3",
+    "eslint-plugin-standard": "^2.1.1",
     "gulp": "^3.9.1",
     "gulp-identity": "^0.1.0",
     "gulp-uglify": "^2.0.1",

src/activity-logger/background/index.js

@@ -3,9 +3,9 @@ import maybeLogPageVisit from './log-page-visit'
 // Listen for navigations to log them and analyse the pages.
 browser.webNavigation.onCommitted.addListener(({url, tabId, frameId}) => {
     // Ignore pages loaded in frames, it is usually noise.
-    if (frameId !== 0)
+    if (frameId !== 0) {
         return
+    }
 
     maybeLogPageVisit({url, tabId})
-
 })

src/activity-logger/background/log-page-visit.js

@@ -1,5 +1,6 @@
-import { generateVisitDocId, isWorthRemembering } from '..'
+import db from 'src/pouchdb'
 import { reidentifyOrStorePage } from 'src/page-storage/store-page'
+import { generateVisitDocId, isWorthRemembering } from '..'
 
 
 // Store the visit in PouchDB.
@@ -19,10 +20,10 @@ export default async function maybeLogPageVisit({
     tabId,
     url,
 }) {
-
     // First check if we want to log this page (hence the 'maybe' in the name).
-    if (!isWorthRemembering({url}))
+    if (!isWorthRemembering({url})) {
         return
+    }
 
     // The time to put in documents.
     const timestamp = new Date().getTime()

src/activity-logger/index.js

@@ -14,7 +14,7 @@ const convertAnyTimestampedDocId = docuri.route(':type/:timestamp/:nonce')
 export const getTimestamp = doc =>
     Number.parseInt(convertAnyTimestampedDocId(doc._id).timestamp)
 
-export function generateVisitDocId({timestamp, nonce}={}) {
+export function generateVisitDocId({timestamp, nonce} = {}) {
     const date = timestamp ? new Date(timestamp) : new Date()
     return convertVisitDocId({
         timestamp: date.getTime(),

src/background.js

@@ -14,7 +14,7 @@ browser.browserAction.onClicked.addListener(() => {
 })
 
 browser.commands.onCommand.addListener(command => {
-    if (command === "openOverview") {
+    if (command === 'openOverview') {
         openOverview()
     }
 })

src/browser-history/background/import-history.js

@@ -13,7 +13,7 @@ import { generatePageDocId } from 'src/page-storage'
 async function getHistoryItems({
     startTime = 0,
     endTime,
-}={}) {
+} = {}) {
     const historyItems = await browser.history.search({
         text: '',
         maxResults: 9999999,
@@ -88,8 +88,7 @@ function convertHistoryToPagesAndVisits({
                 const referringVisitDocId = referringVisitDoc._id
                 // Add a reference to the visit document.
                 visitDoc.referringVisit = {_id: referringVisitDocId}
-            }
-            else {
+            } else {
                 // Apparently the referring visit is not present in the history.
                 // We can just pretend that there was no referrer.
             }
@@ -98,15 +97,15 @@ function convertHistoryToPagesAndVisits({
     // Return the new docs.
     return {
         pageDocs,
-        visitDocs: Object.values(visitDocs) // we can forget the old ids now
+        visitDocs: Object.values(visitDocs), // we can forget the old ids now
     }
 }
 
 // Pulls the full browser history into the database.
 export default async function importHistory({
     startTime,
     endTime,
-}={}) {
+} = {}) {
     // Get the full history: both the historyItems and visitItems.
     console.time('import history')
     const historyItems = await getHistoryItems({startTime, endTime})
@@ -148,6 +147,6 @@ export async function getOldestVisitTimestamp() {
 export async function getHistoryStats() {
     const historyItems = await getHistoryItems()
     return {
-        quantity: historyItems.length
+        quantity: historyItems.length,
     }
 }

src/dev/redux-devtools-component.jsx

@@ -0,0 +1,17 @@
+import React from 'react'
+
+import { createDevTools } from 'redux-devtools'
+import LogMonitor from 'redux-devtools-log-monitor'
+import DockMonitor from 'redux-devtools-dock-monitor'
+
+const DevTools = createDevTools(
+    <DockMonitor
+        toggleVisibilityKey='ctrl-shift-L'
+        changePositionKey='ctrl-alt-shift-L'
+        defaultIsVisible={false}
+    >
+        <LogMonitor />
+    </DockMonitor>
+)
+
+export default DevTools