Update build process for ES6

.eslintrc.js

@@ -0,0 +1,59 @@
+module.exports = {
+    parserOptions: {
+        ecmaVersion: 6,
+        sourceType: "module",
+        ecmaFeatures: {
+        }
+    },
+    env: {
+        browser: true,
+        node: true,
+    },
+    extends: ["eslint:recommended", "google"],
+    rules: {
+        // rules we've always adhered to
+        "max-len": ["error", {
+            code: 90,
+            ignoreComments: true,
+        }],
+        curly: ["error", "multi-line"],
+
+        // loosen jsdoc requirements a little
+        "require-jsdoc": ["error", {
+            require: {
+                FunctionDeclaration: false,
+            }
+        }],
+        "valid-jsdoc": ["error", {
+            requireParamDescription: false,
+            requireReturn: false,
+            requireReturnDescription: false,
+        }],
+
+        // rules we do not want from eslint-recommended
+        "no-console": ["off"],
+        "no-constant-condition": ["off"],
+        "no-empty": ["error", { "allowEmptyCatch": true }],
+
+        // rules we do not want from the google styleguide
+        "object-curly-spacing": ["off"],
+        "spaced-comment": ["off"],
+
+        // in principle we prefer single quotes, but life is too short
+        quotes: ["off"],
+
+        // rules we'd ideally like to adhere to, but the current
+        // code does not (in most cases because it's still ES5)
+        // we set these to warnings, and assert that the number
+        // of warnings doesn't exceed a given threshold
+        "no-var": ["warn"],
+        "comma-dangle": ["warn"],
+        "brace-style": ["warn"],
+        "prefer-rest-params": ["warn"],
+        "prefer-spread": ["warn"],
+        "one-var": ["warn"],
+        "padded-blocks": ["warn"],
+        "no-extend-native": ["warn"],
+        "camelcase": ["warn"],
+    }
+}

jenkins.sh

@@ -14,13 +14,8 @@ function fail {
 
 npm test || fail "npm test finished with return code $?"
 
-jshint --reporter=checkstyle -c .jshint src spec > jshint.xml ||
-    fail "jshint finished with return code $?"
-
-gjslint --unix_mode --disable 0131,0211,0200,0222,0212 \
-        --max_line_length 90 \
-        -r src/ -r spec/ > gjslint.log ||
-    fail "gjslint finished with return code $?"
+npm run lint -- -f checkstyle > eslint.xml ||
+    fail "eslint finished with return code $?"
 
 # delete the old tarball, if it exists
 rm -f matrix-js-sdk-*.tgz

package.json

@@ -7,13 +7,12 @@
     "test": "istanbul cover --report cobertura --config .istanbul.yml -i \"lib/**/*.js\" jasmine-node -- spec --verbose --junitreport --captureExceptions",
     "check": "jasmine-node spec --verbose --junitreport --captureExceptions",
     "gendoc": "jsdoc -r lib -P package.json -R README.md -d .jsdoc",
-    "compile": "babel -s -d lib src",
     "start": "babel -s -w -d lib src",
-    "build": "jshint -c .jshint lib/ && rimraf dist && mkdir dist && browserify --exclude olm browser-index.js -o dist/browser-matrix.js --ignore-missing && uglifyjs -c -m -o dist/browser-matrix.min.js dist/browser-matrix.js",
+    "build": "babel -s -d lib src && rimraf dist && mkdir dist && browserify --exclude olm browser-index.js -o dist/browser-matrix.js --ignore-missing && uglifyjs -c -m -o dist/browser-matrix.min.js dist/browser-matrix.js",
     "dist": "npm run build",
     "watch": "watchify --exclude olm browser-index.js -o dist/browser-matrix-dev.js -v",
-    "lint": "jshint -c .jshint src spec && gjslint --unix_mode --disable 0131,0211,0200,0222,0212 --max_line_length 90 -r spec/ -r src/",
-    "prepublish": "npm run compile && git rev-parse HEAD > git-revision.txt"
+    "lint": "eslint --max-warnings 3480 src spec",
+    "prepublish": "npm run lint && npm run build && git rev-parse HEAD > git-revision.txt"
   },
   "repository": {
     "url": "https://github.com/matrix-org/matrix-js-sdk"
@@ -53,10 +52,11 @@
   "devDependencies": {
     "babel-cli": "^6.18.0",
     "babel-preset-es2015": "^6.18.0",
+    "eslint": "^3.13.1",
+    "eslint-config-google": "^0.7.1",
     "istanbul": "^0.3.13",
     "jasmine-node": "^1.14.5",
     "jsdoc": "^3.4.0",
-    "jshint": "^2.8.0",
     "rimraf": "^2.5.4",
     "uglifyjs": "^2.4.10",
     "watchify": "^3.2.1"

spec/.eslintrc.js

@@ -0,0 +1,5 @@
+module.exports = {
+    env: {
+        jasmine: true,
+    },
+}

spec/integ/matrix-client-crypto.spec.js

@@ -463,7 +463,7 @@ describe("MatrixClient crypto", function() {
     }
 
     beforeEach(function() {
-        test_utils.beforeEach(this);
+        test_utils.beforeEach(this); // eslint-disable-line no-invalid-this
 
         aliStorage = new sdk.WebStorageSessionStore(new test_utils.MockStorageApi());
         aliHttpBackend = new HttpBackend();

spec/integ/matrix-client-event-emitter.spec.js

@@ -10,7 +10,7 @@ describe("MatrixClient events", function() {
     var selfAccessToken = "aseukfgwef";
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         httpBackend = new HttpBackend();
         sdk.request(httpBackend.requestFn);
         client = sdk.createClient({

spec/integ/matrix-client-event-timeline.spec.js

@@ -100,7 +100,7 @@ describe("getEventTimeline support", function() {
     var client;
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         httpBackend = new HttpBackend();
         sdk.request(httpBackend.requestFn);
     });
@@ -221,7 +221,7 @@ describe("MatrixClient event timelines", function() {
     var client, httpBackend;
 
     beforeEach(function(done) {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         httpBackend = new HttpBackend();
         sdk.request(httpBackend.requestFn);
 
@@ -415,15 +415,14 @@ describe("MatrixClient event timelines", function() {
                     };
                 });
 
-            var tl0, tl2, tl3;
+            var tl0, tl3;
             client.getEventTimeline(timelineSet, EVENTS[0].event_id
             ).then(function(tl) {
                 expect(tl.getEvents().length).toEqual(1);
                 tl0 = tl;
                 return client.getEventTimeline(timelineSet, EVENTS[2].event_id);
             }).then(function(tl) {
                 expect(tl.getEvents().length).toEqual(1);
-                tl2 = tl;
                 return client.getEventTimeline(timelineSet, EVENTS[3].event_id);
             }).then(function(tl) {
                 expect(tl.getEvents().length).toEqual(1);

spec/integ/matrix-client-methods.spec.js

@@ -15,7 +15,7 @@ describe("MatrixClient", function() {
     var accessToken = "aseukfgwef";
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         httpBackend = new HttpBackend();
         store = new MatrixInMemoryStore();
 
@@ -363,7 +363,7 @@ describe("MatrixClient", function() {
 
                 assertObjectContains(res.chaz.dev2, {
                     verified: 0, // DeviceVerification.UNVERIFIED
-                    keys: { "ed25519:dev2" : ed25519key },
+                    keys: { "ed25519:dev2": ed25519key },
                     algorithms: ["2"],
                     unsigned: { "ghi": "def" },
                 });

spec/integ/matrix-client-opts.spec.js

@@ -53,7 +53,7 @@ describe("MatrixClient opts", function() {
     };
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         httpBackend = new HttpBackend();
     });
 

spec/integ/matrix-client-retrying.spec.js

@@ -14,7 +14,7 @@ describe("MatrixClient retrying", function() {
     var room;
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         httpBackend = new HttpBackend();
         sdk.request(httpBackend.requestFn);
         scheduler = new sdk.MatrixScheduler();

spec/integ/matrix-client-room-timeline.spec.js

@@ -101,7 +101,7 @@ describe("MatrixClient room timelines", function() {
     }
 
     beforeEach(function(done) {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         httpBackend = new HttpBackend();
         sdk.request(httpBackend.requestFn);
         client = sdk.createClient({

spec/integ/matrix-client-syncing.spec.js

@@ -18,7 +18,7 @@ describe("MatrixClient syncing", function() {
     var roomTwo = "!bar:localhost";
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         httpBackend = new HttpBackend();
         sdk.request(httpBackend.requestFn);
         client = sdk.createClient({

spec/integ/megolm.spec.js

@@ -61,7 +61,7 @@ function TestClient(userId, deviceId, accessToken) {
 /**
  * start the client, and wait for it to initialise.
  *
- * @param {object?} deviceQueryResponse  the list of our existing devices to return from
+ * @param {object?} existingDevices  the list of our existing devices to return from
  *    the /query request. Defaults to empty device list
  * @return {Promise}
  */
@@ -313,6 +313,9 @@ describe("megolm", function() {
     /**
      * Get the device keys for testOlmAccount in a format suitable for a
      * response to /keys/query
+     *
+     * @param {string} userId The user ID to query for
+     * @returns {Object} The fake query response
      */
     function getTestKeysQueryResponse(userId) {
         var testE2eKeys = JSON.parse(testOlmAccount.identity_keys());
@@ -346,6 +349,9 @@ describe("megolm", function() {
     /**
      * Get a one-time key for testOlmAccount in a format suitable for a
      * response to /keys/claim
+
+     * @param {string} userId The user ID to query for
+     * @returns {Object} The fake key claim response
      */
     function getTestKeysClaimResponse(userId) {
         testOlmAccount.generate_one_time_keys(1);
@@ -374,7 +380,7 @@ describe("megolm", function() {
     }
 
     beforeEach(function() {
-        test_utils.beforeEach(this);
+        test_utils.beforeEach(this); // eslint-disable-line no-invalid-this
 
         aliceTestClient = new TestClient(
             "@alice:localhost", "xzcvb", "akjgkrgjs"

spec/test-utils.js

@@ -28,7 +28,7 @@ module.exports.mock = function(constr, name) {
     result.jasmineToString = function() {
         return "mock" + (name ? " of " + name : "");
     };
-    for (var key in constr.prototype) { // jshint ignore:line
+    for (var key in constr.prototype) { // eslint-disable-line guard-for-in
         try {
             if (constr.prototype[key] instanceof Function) {
                 result[key] = jasmine.createSpy((name || "mock") + '.' + key);

spec/unit/content-repo.spec.js

@@ -6,7 +6,7 @@ describe("ContentRepo", function() {
     var baseUrl = "https://my.home.server";
 
     beforeEach(function() {
-        testUtils.beforeEach(this);
+        testUtils.beforeEach(this); // eslint-disable-line no-invalid-this
     });
 
     describe("getHttpUriForMxc", function() {

spec/unit/event-timeline.spec.js

@@ -15,7 +15,7 @@ describe("EventTimeline", function() {
     var timeline;
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
 
         // XXX: this is a horrid hack; should use sinon or something instead to mock
         var timelineSet = { room: { roomId: roomId }};

spec/unit/filter.spec.js

@@ -9,7 +9,7 @@ describe("Filter", function() {
     var filter;
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         filter = new Filter(userId);
     });
 

spec/unit/interactive-auth.spec.js

@@ -24,7 +24,7 @@ var MatrixError = sdk.MatrixError;
 
 describe("InteractiveAuth", function() {
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
     });
 
     it("should start an auth stage and complete it", function(done) {

spec/unit/matrix-client.spec.js

@@ -117,7 +117,7 @@ describe("MatrixClient", function() {
     }
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         jasmine.Clock.useMock();
         scheduler = jasmine.createSpyObj("scheduler", [
             "getQueueForEvent", "queueEvent", "removeEventFromQueue",

spec/unit/realtime-callbacks.spec.js

@@ -14,7 +14,7 @@ describe("realtime-callbacks", function() {
     }
 
     beforeEach(function() {
-        test_utils.beforeEach(this);
+        test_utils.beforeEach(this); // eslint-disable-line no-invalid-this
         clock.useMock();
         fakeDate = Date.now();
         callbacks.setNow(function() { return fakeDate; });
@@ -54,8 +54,8 @@ describe("realtime-callbacks", function() {
         it("should set 'this' to the global object", function() {
             var callback = jasmine.createSpy();
             callback.andCallFake(function() {
-                expect(this).toBe(global);
-                expect(this.console).toBeDefined();
+                expect(this).toBe(global); // eslint-disable-line no-invalid-this
+                expect(this.console).toBeDefined(); // eslint-disable-line no-invalid-this
             });
             callbacks.setTimeout(callback);
             tick(0);

spec/unit/room-member.spec.js

@@ -11,7 +11,7 @@ describe("RoomMember", function() {
     var member;
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         member = new RoomMember(roomId, userA);
     });
 

spec/unit/room-state.spec.js

@@ -11,7 +11,7 @@ describe("RoomState", function() {
     var state;
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         state = new RoomState(roomId);
         state.setStateEvents([
             utils.mkMembership({  // userA joined

spec/unit/room.spec.js

@@ -16,7 +16,7 @@ describe("Room", function() {
     var room;
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         room = new Room(roomId);
         // mock RoomStates
         room.oldState = room.getLiveTimeline()._startState =
@@ -1110,7 +1110,7 @@ describe("Room", function() {
     describe("tags", function() {
 
         function mkTags(roomId, tags) {
-            var content = { "tags" : tags };
+            var content = { "tags": tags };
             return new MatrixEvent({
                 content: content,
                 room_id: roomId,

spec/unit/scheduler.spec.js

@@ -1,4 +1,6 @@
-"use strict";
+// This file had a function whose name is all caps, which displeases eslint
+/* eslint new-cap: "off" */
+
 var q = require("q");
 var sdk = require("../..");
 var MatrixScheduler = sdk.MatrixScheduler;
@@ -18,7 +20,7 @@ describe("MatrixScheduler", function() {
     });
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         jasmine.Clock.useMock();
         scheduler = new MatrixScheduler(function(ev, attempts, err) {
             if (retryFn) {