Fix ESLint errors and enforce ESLint rules by default (#332)

* Turn indentation rule on as a warning.

* Fix some lint errors.

* Enforce ESLint rules by default.

* Address comments.

Author: jianjunz

scripts/Gruntfile.js

@@ -263,5 +263,5 @@ window.L = L;\n\
   grunt.registerTask('pack', ['browserify:dist', 'concat:rest', 'uglify:dist', 'copy:dist', 'string-replace', 'compress:dist', 'jsdoc:dist']);
   grunt.registerTask('dev', ['browserify:dev', 'connect:server']);
   grunt.registerTask('debug', ['browserify:dev']);
-  grunt.registerTask('default', ['pack']);
+  grunt.registerTask('default', ['check', 'pack']);
 };

src/.eslintrc.json

@@ -13,6 +13,7 @@
       "ignorePattern": "The above copyright notice and this permission notice shall be included in all",
       // Some lines for JSDoc is longer than 80.
       "ignoreComments": true
-    }]
+    }],
+    "indent": ["warn"]
   }
 }

src/sdk/base/codec.js

@@ -34,7 +34,8 @@ export class AudioCodecParameters {
      * @member {string} name
      * @memberof Owt.Base.AudioCodecParameters
      * @instance
-     * @desc Name of a codec. Please use a value in Owt.Base.AudioCodec. However, some functions do not support all the values in Owt.Base.AudioCodec.
+     * @desc Name of a codec. Please a value in Owt.Base.AudioCodec. However,
+     * some functions do not support all the values in Owt.Base.AudioCodec.
      */
     this.name = name;
     /**
@@ -105,7 +106,8 @@ export class VideoCodecParameters {
      * @member {string} name
      * @memberof Owt.Base.VideoCodecParameters
      * @instance
-     * @desc Name of a codec. Please use a value in Owt.Base.VideoCodec. However, some functions do not support all the values in Owt.Base.AudioCodec.
+     * @desc Name of a codec.Please a value in Owt.Base.AudioCodec.However,
+       some functions do not support all the values in Owt.Base.AudioCodec.
      */
     this.name = name;
     /**

src/sdk/base/event.js

@@ -42,7 +42,9 @@ export const EventDispatcher = function() {
 
   /**
    * @function addEventListener
-   * @desc This function registers a callback function as a handler for the corresponding event. It's shortened form is on(eventType, listener). See the event description in the following table.
+   * @desc This function registers a callback function as a handler for the
+   * corresponding event. It's shortened form is on(eventType, listener). See
+   * the event description in the following table.
    * @instance
    * @memberof Owt.Base.EventDispatcher
    * @param {string} eventType Event string.
@@ -136,7 +138,8 @@ export class MessageEvent extends OwtEvent {
      * @member {string} to
      * @instance
      * @memberof Owt.Base.MessageEvent
-     * @desc Values could be "all", "me" in conference mode, or undefined in P2P mode..
+     * @desc Values could be "all", "me" in conference mode, or undefined in
+     * P2P mode.
      */
     this.to = init.to;
   }

src/sdk/base/mediaformat.js

@@ -5,7 +5,8 @@
 'use strict';
 /**
  * @class AudioSourceInfo
- * @classDesc Source info about an audio track. Values: 'mic', 'screen-cast', 'file', 'mixed'.
+ * @classDesc Source info about an audio track. Values: 'mic', 'screen-cast',
+ * 'file', 'mixed'.
  * @memberOf Owt.Base
  * @readonly
  * @enum {string}
@@ -19,7 +20,8 @@ export const AudioSourceInfo = {
 
 /**
  * @class VideoSourceInfo
- * @classDesc Source info about a video track. Values: 'camera', 'screen-cast', 'file', 'mixed'.
+ * @classDesc Source info about a video track. Values: 'camera', 'screen-cast',
+ * 'file', 'mixed'.
  * @memberOf Owt.Base
  * @readonly
  * @enum {string}
@@ -33,7 +35,8 @@ export const VideoSourceInfo = {
 
 /**
  * @class TrackKind
- * @classDesc Kind of a track. Values: 'audio' for audio track, 'video' for video track, 'av' for both audio and video tracks.
+ * @classDesc Kind of a track. Values: 'audio' for audio track, 'video' for
+ * video track, 'av' for both audio and video tracks.
  * @memberOf Owt.Base
  * @readonly
  * @enum {string}

src/sdk/base/mediastream-factory.js

@@ -115,21 +115,26 @@ export class StreamConstraints {
 // eslint-disable-next-line require-jsdoc
 function isVideoConstrainsForScreenCast(constraints) {
   return (typeof constraints.video === 'object' && constraints.video.source ===
-    MediaFormatModule.VideoSourceInfo.SCREENCAST);
+      MediaFormatModule.VideoSourceInfo.SCREENCAST);
 }
 
 /**
  * @class MediaStreamFactory
- * @classDesc A factory to create MediaStream. You can also create MediaStream by yourself.
+ * @classDesc A factory to create MediaStream. You can also create MediaStream
+ * by yourself.
  * @memberof Owt.Base
  */
 export class MediaStreamFactory {
   /**
    * @function createMediaStream
    * @static
-   * @desc Create a MediaStream with given constraints. If you want to create a MediaStream for screen cast, please make sure both audio and video's source are "screen-cast".
+   * @desc Create a MediaStream with given constraints. If you want to create a
+   * MediaStream for screen cast, please make sure both audio and video's source
+   * are "screen-cast".
    * @memberof Owt.Base.MediaStreamFactory
-   * @return {Promise<MediaStream, Error>} Return a promise that is resolved when stream is successfully created, or rejected if one of the following error happened:
+   * @return {Promise<MediaStream, Error>} Return a promise that is resolved
+   * when stream is successfully created, or rejected if one of the following
+   * error happened:
    * - One or more parameters cannot be satisfied.
    * - Specified device is busy.
    * - Cannot obtain necessary permission or operation is canceled by user.

src/sdk/base/publication.js

@@ -137,7 +137,8 @@ export class Publication extends EventDispatcher {
     /**
      * @function stop
      * @instance
-     * @desc Stop certain publication. Once a subscription is stopped, it cannot be recovered.
+     * @desc Stop certain publication. Once a subscription is stopped, it cannot
+     * be recovered.
      * @memberof Owt.Base.Publication
      * @returns {undefined}
      */
@@ -174,7 +175,8 @@ export class Publication extends EventDispatcher {
 /**
  * @class PublishOptions
  * @memberOf Owt.Base
- * @classDesc PublishOptions defines options for publishing a Owt.Base.LocalStream.
+ * @classDesc PublishOptions defines options for publishing a
+ * Owt.Base.LocalStream.
  */
 export class PublishOptions {
   // eslint-disable-next-line require-jsdoc

src/sdk/base/stream.js

@@ -2,10 +2,11 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
+/* global MediaStream */
+
 'use strict';
-import {OwtEvent} from './event.js';
 import * as Utils from './utils.js';
-import {EventDispatcher} from './event.js';
+import {EventDispatcher, OwtEvent} from './event.js';
 
 // eslint-disable-next-line require-jsdoc
 function isAllowedValue(obj, allowedValues) {
@@ -18,9 +19,12 @@ function isAllowedValue(obj, allowedValues) {
  * @memberOf Owt.Base
  * @classDesc Information of a stream's source.
  * @constructor
- * @description Audio source info or video source info could be undefined if a stream does not have audio/video track.
- * @param {?string} audioSourceInfo Audio source info. Accepted values are: "mic", "screen-cast", "file", "mixed" or undefined.
- * @param {?string} videoSourceInfo Video source info. Accepted values are: "camera", "screen-cast", "file", "mixed" or undefined.
+ * @description Audio source info or video source info could be undefined if
+ * a stream does not have audio/video track.
+ * @param {?string} audioSourceInfo Audio source info. Accepted values are:
+ * "mic", "screen-cast", "file", "mixed" or undefined.
+ * @param {?string} videoSourceInfo Video source info. Accepted values are:
+ * "camera", "screen-cast", "file", "mixed" or undefined.
  */
 export class StreamSourceInfo {
   // eslint-disable-next-line require-jsdoc
@@ -98,7 +102,8 @@ export class Stream extends EventDispatcher {
  * @extends Owt.Base.Stream
  * @constructor
  * @param {MediaStream} stream Underlying MediaStream.
- * @param {Owt.Base.StreamSourceInfo} sourceInfo Information about stream's source.
+ * @param {Owt.Base.StreamSourceInfo} sourceInfo Information about stream's
+ * source.
  * @param {object} attributes Custom attributes of the stream.
  */
 export class LocalStream extends Stream {
@@ -163,14 +168,17 @@ export class RemoteStream extends Stream {
      * @member {Owt.Base.PublicationSettings} settings
      * @instance
      * @memberof Owt.Base.RemoteStream
-     * @desc Original settings for publishing this stream. This property is only valid in conference mode.
+     * @desc Original settings for publishing this stream. This property is only
+     * valid in conference mode.
      */
     this.settings = undefined;
     /**
      * @member {Owt.Conference.SubscriptionCapabilities} extraCapabilities
      * @instance
      * @memberof Owt.Base.RemoteStream
-     * @desc Extra capabilities remote endpoint provides for subscription. Extra capabilities don't include original settings. This property is only valid in conference mode.
+     * @desc Extra capabilities remote endpoint provides for subscription. Extra
+     * capabilities don't include original settings. This property is only valid
+     * in conference mode.
      */
     this.extraCapabilities = undefined;
   }

src/sdk/conference/channel.js

@@ -3,7 +3,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 /* eslint-disable require-jsdoc */
-/* global Promise */
+/* global Promise, RTCPeerConnection */
 
 'use strict';
 
@@ -24,7 +24,8 @@ import * as SdpUtils from '../base/sdputils.js';
 
 /**
  * @class ConferencePeerConnectionChannel
- * @classDesc A channel for a connection between client and conference server. Currently, only one stream could be tranmitted in a channel.
+ * @classDesc A channel for a connection between client and conference server.
+ * Currently, only one stream could be tranmitted in a channel.
  * @hideconstructor
  * @private
  */
@@ -53,7 +54,8 @@ export class ConferencePeerConnectionChannel extends EventDispatcher {
 
   /**
    * @function onMessage
-   * @desc Received a message from conference portal. Defined in client-server protocol.
+   * @desc Received a message from conference portal. Defined in client-server
+   * protocol.
    * @param {string} notification Notification type.
    * @param {object} message Message received.
    * @private
@@ -79,8 +81,10 @@ export class ConferencePeerConnectionChannel extends EventDispatcher {
 
   publish(stream, options, videoCodecs) {
     if (options === undefined) {
-      options = {audio: !!stream.mediaStream.getAudioTracks().length, video: !!stream
-          .mediaStream.getVideoTracks().length};
+      options = {
+        audio: !!stream.mediaStream.getAudioTracks().length,
+        video: !!stream.mediaStream.getVideoTracks().length,
+      };
     }
     if (typeof options !== 'object') {
       return Promise.reject(new TypeError('Options should be an object.'));
@@ -90,7 +94,8 @@ export class ConferencePeerConnectionChannel extends EventDispatcher {
         (this._isOwtEncodingParameters(options.audio) &&
          this._isRtpEncodingParameters(options.video))) {
       return Promise.reject(new ConferenceError(
-          'Mixing RTCRtpEncodingParameters and AudioEncodingParameters/VideoEncodingParameters is not allowed.'))
+          'Mixing RTCRtpEncodingParameters and ' +
+          'AudioEncodingParameters/VideoEncodingParameters is not allowed.'));
     }
     if (options.audio === undefined) {
       options.audio = !!stream.mediaStream.getAudioTracks().length;
@@ -203,13 +208,13 @@ export class ConferencePeerConnectionChannel extends EventDispatcher {
         if (mediaOptions.audio && stream.mediaStream.getAudioTracks().length >
           0) {
           const transceiverInit = {
-            direction: 'sendonly'
+            direction: 'sendonly',
           };
           if (this._isRtpEncodingParameters(options.audio)) {
             transceiverInit.sendEncodings = options.audio;
           }
-          const transceiver = this._pc.addTransceiver(stream.mediaStream.getAudioTracks()[0],
-            transceiverInit);
+          const transceiver = this._pc.addTransceiver(
+              stream.mediaStream.getAudioTracks()[0], transceiverInit);
 
           if (Utils.isFirefox()) {
             // Firefox does not support encodings setting in addTransceiver.
@@ -221,32 +226,36 @@ export class ConferencePeerConnectionChannel extends EventDispatcher {
         if (mediaOptions.video && stream.mediaStream.getVideoTracks().length >
           0) {
           const transceiverInit = {
-            direction: 'sendonly'
+            direction: 'sendonly',
           };
           if (this._isRtpEncodingParameters(options.video)) {
             transceiverInit.sendEncodings = options.video;
             this._videoCodecs = videoCodecs;
           }
-          const transceiver = this._pc.addTransceiver(stream.mediaStream.getVideoTracks()[0],
-            transceiverInit);
+          const transceiver = this._pc.addTransceiver(
+              stream.mediaStream.getVideoTracks()[0], transceiverInit);
 
           if (Utils.isFirefox()) {
             // Firefox does not support encodings setting in addTransceiver.
             const parameters = transceiver.sender.getParameters();
             parameters.encodings = transceiverInit.sendEncodings;
             setPromise = setPromise.then(
-              () => transceiver.sender.setParameters(parameters));
+                () => transceiver.sender.setParameters(parameters));
           }
         }
         return setPromise.then(() => offerOptions);
       } else {
-        if (mediaOptions.audio && stream.mediaStream.getAudioTracks().length > 0) {
-          for (const track of stream.mediaStream.getAudioTracks())
+        if (mediaOptions.audio &&
+            stream.mediaStream.getAudioTracks().length > 0) {
+          for (const track of stream.mediaStream.getAudioTracks()) {
             this._pc.addTrack(track, stream.mediaStream);
+          }
         }
-        if (mediaOptions.video && stream.mediaStream.getVideoTracks().length > 0) {
-          for (const track of stream.mediaStream.getVideoTracks())
+        if (mediaOptions.video &&
+            stream.mediaStream.getVideoTracks().length > 0) {
+          for (const track of stream.mediaStream.getVideoTracks()) {
             this._pc.addTrack(track, stream.mediaStream);
+          }
         }
         offerOptions.offerToReceiveAudio = false;
         offerOptions.offerToReceiveVideo = false;
@@ -351,7 +360,7 @@ export class ConferencePeerConnectionChannel extends EventDispatcher {
           framerate: options.video.frameRate,
           bitrate: options.video.bitrateMultiplier ? 'x'
               + options.video.bitrateMultiplier.toString() : undefined,
-          keyFrameInterval: options.video.keyFrameInterval
+          keyFrameInterval: options.video.keyFrameInterval,
         };
       }
       if (options.video.rid) {

src/sdk/conference/mixedstream.js

@@ -33,8 +33,8 @@ export class RemoteMixedStream extends StreamModule.RemoteStream {
 
     this.settings = StreamUtilsModule.convertToPublicationSettings(info.media);
 
-    this.extraCapabilities = StreamUtilsModule
-      .convertToSubscriptionCapabilities(info.media);
+    this.extraCapabilities =
+        StreamUtilsModule.convertToSubscriptionCapabilities(info.media);
   }
 }