chore: actually the linter during build; fix accumulated code style violations

Author: clayreimann

.eslintrc

@@ -0,0 +1,36 @@
+---
+   extends:
+      - eslint:recommended
+      - google
+   parserOptions:
+      ecmaVersion: 6
+      sourceType: module
+   rules:
+      arrow-parens: [error, always]
+      eqeqeq: error
+      guard-for-in: error
+      indent: [error, 3, {SwitchCase: 1}]
+      max-len: [error, {code: 120, ignoreTrailingComments: true}]
+      no-bitwise: warn
+      no-extend-native: error
+      no-useless-constructor: off
+      no-var: error
+      padded-blocks: off
+      quotes: [error, single, {avoidEscape: true}]
+      require-jsdoc:
+         - error
+         - require:
+            FunctionDeclaration: false
+            ClassDeclaration: true
+            MethodDefinition: true
+      spaced-comment: error
+      valid-jsdoc: [error, {requireParamDescription: true}]
+
+   env:
+      es6: true
+      node: true
+      browser: true
+   # globals:
+   #    require: false
+   #    define: false
+   #    escape: false

.eslintrc.yaml

@@ -1,35 +1,26 @@
 import gulp from 'gulp';
-import jscs from 'gulp-jscs';
 import eslint from 'gulp-eslint';
-import stylish from 'gulp-jscs-stylish';
-
 import babel from 'gulp-babel';
 import rename from 'gulp-rename';
 
 import browserify from 'browserify';
 import buffer from 'vinyl-buffer';
 import del from 'del';
-import path from 'path';
-import {Promise}  from 'es6-promise';
 import source from 'vinyl-source-stream';
 import sourcemaps from 'gulp-sourcemaps';
 import uglify from 'gulp-uglify';
 
 const ALL_SOURCES = [
-   path.join(__dirname, '/*.js'),
-   path.join(__dirname, '/src/*.js'),
-   path.join(__dirname, '/test/*.js')
+   '*.js',
+   'lib/*.js',
+   'test/*.js'
 ];
 
 gulp.task('lint', function() {
-   const opts = {
-      base: './'
-   };
-   return gulp.src(ALL_SOURCES, opts)
+   return gulp.src(ALL_SOURCES)
       .pipe(eslint())
-      .pipe(jscs())
-      .pipe(stylish.combineWithHintResults())
-      .pipe(stylish())
+      .pipe(eslint.format())
+      .pipe(eslint.failAfterError())
       ;
 });
 

.jscsrc

@@ -4,6 +4,7 @@
  * @license    Licensed under {@link https://spdx.org/licenses/BSD-3-Clause-Clear.html BSD-3-Clause-Clear}.
  *             Github.js is freely distributable.
  */
+/* eslint valid-jsdoc: ["error", {"requireReturnDescription": false}] */
 
 import Gist from './Gist';
 import User from './User';
@@ -51,6 +52,7 @@ class GitHub {
    /**
     * Create a new Organization wrapper
     * @param {string} organization - the name of the organization
+    * @param {string} foo - this
     * @return {Organization}
     */
    getOrganization(organization) {
@@ -99,9 +101,15 @@ class GitHub {
     * @return {Markdown}
     */
    getMarkdown() {
-       return new Markdown(this.__auth, this.__apiBase);
+      return new Markdown(this.__auth, this.__apiBase);
    }
 
+   /**
+    * Computes the full repository name
+    * @param {string} user - the username (or the full name)
+    * @param {string} repo - the repository name, must not be passed if `user` is the full name
+    * @return {string} the repository's full name
+    */
    _getFullName(user, repo) {
       let fullname = user;
 

gulpfile.babel.js

@@ -52,7 +52,7 @@ class Issue extends Requestable {
     * @return {Promise} - the promise for the http request
     */
    listIssueComments(issue, cb) {
-      return this._request('GET', `/repos/${this.__repository}/issues/${issue}/comments`, null, cb); // jscs:ignore
+      return this._request('GET', `/repos/${this.__repository}/issues/${issue}/comments`, null, cb);
    }
 
    /**
@@ -63,7 +63,7 @@ class Issue extends Requestable {
     * @return {Promise} - the promise for the http request
     */
    getIssueComment(id, cb) {
-      return this._request('GET', `/repos/${this.__repository}/issues/comments/${id}`, null, cb); // jscs:ignore
+      return this._request('GET', `/repos/${this.__repository}/issues/comments/${id}`, null, cb);
    }
 
    /**
@@ -75,7 +75,7 @@ class Issue extends Requestable {
     * @return {Promise} - the promise for the http request
     */
    createIssueComment(issue, comment, cb) {
-      return this._request('POST', `/repos/${this.__repository}/issues/${issue}/comments`, {body: comment}, cb); // jscs:ignore
+      return this._request('POST', `/repos/${this.__repository}/issues/${issue}/comments`, {body: comment}, cb);
    }
 
    /**
@@ -87,7 +87,7 @@ class Issue extends Requestable {
     * @return {Promise} - the promise for the http request
     */
    editIssueComment(id, comment, cb) {
-      return this._request('PATCH', `/repos/${this.__repository}/issues/comments/${id}`, {body: comment}, cb); // jscs:ignore
+      return this._request('PATCH', `/repos/${this.__repository}/issues/comments/${id}`, {body: comment}, cb);
    }
 
    /**
@@ -98,7 +98,7 @@ class Issue extends Requestable {
     * @return {Promise} - the promise for the http request
     */
    deleteIssueComment(id, cb) {
-      return this._request('DELETE', `/repos/${this.__repository}/issues/comments/${id}`, null, cb); // jscs:ignore
+      return this._request('DELETE', `/repos/${this.__repository}/issues/comments/${id}`, null, cb);
    }
 
    /**

lib/GitHub.js

@@ -24,7 +24,7 @@ class Markdown extends Requestable {
    /**
     * Render html from Markdown text.
     * @see https://developer.github.com/v3/markdown/#render-an-arbitrary-markdown-document
-    * @param {Object} options
+    * @param {Object} options - conversion options
     * @param {string} [options.text] - the markdown text to convert
     * @param {string} [options.mode=markdown] - can be either `markdown` or `gfm`
     * @param {string} [options.context] - repository name if mode is gfm

lib/Issue.js

@@ -19,7 +19,7 @@ class Organization extends Requestable {
     */
    constructor(organization, auth, apiBase) {
       super(auth, apiBase);
-      this.__name =  organization;
+      this.__name = organization;
    }
 
    /**
@@ -58,7 +58,7 @@ class Organization extends Requestable {
    /**
     * List the users who are members of the company
     * @see https://developer.github.com/v3/orgs/members/#members-list
-    * @param {object} options
+    * @param {object} options - filtering options
     * @param {string} [options.filter=all] - can be either `2fa_disabled` or `all`
     * @param {string} [options.role=all] - can be one of: `all`, `admin`, or `member`
     * @param {Requestable.callback} [cb] - will receive the list of users

lib/Markdown.js

@@ -8,7 +8,9 @@
 
 import Requestable from './Requestable';
 import Utf8 from 'utf8';
-import {Base64} from 'js-base64';
+import {
+   Base64
+} from 'js-base64';
 import debug from 'debug';
 const log = debug('github:repository');
 
@@ -154,7 +156,7 @@ class Repository extends Requestable {
    /**
     * List the commits on a repository, optionally filtering by path, author or time range
     * @see https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
-    * @param {Object} [options]
+    * @param {Object} [options] - the filtering options for commits
     * @param {string} [options.sha] - the SHA or branch to start from
     * @param {string} [options.path] - the path to search on
     * @param {string} [options.author] - the commit author
@@ -221,26 +223,34 @@ class Repository extends Requestable {
       return this._request('POST', `/repos/${this.__fullname}/git/blobs`, postBody, cb);
    }
 
+   /**
+    * Get the object that represents the provided content
+    * @param {string|Buffer|Blob} content - the content to send to the server
+    * @return {Object} the representation of `content` for the GitHub API
+    */
    _getContentObject(content) {
       if (typeof content === 'string') {
          log('contet is a string');
          return {
             content: Utf8.encode(content),
             encoding: 'utf-8'
          };
+
       } else if (typeof Buffer !== 'undefined' && content instanceof Buffer) {
          log('We appear to be in Node');
          return {
             content: content.toString('base64'),
             encoding: 'base64'
          };
+
       } else if (typeof Blob !== 'undefined' && content instanceof Blob) {
          log('We appear to be in the browser');
          return {
             content: Base64.encode(content),
             encoding: 'base64'
          };
-      } else {
+
+      } else { // eslint-disable-line
          log(`Not sure what this content is: ${typeof content}, ${JSON.stringify(content)}`);
          throw new Error('Unknown content passed to postBlob. Must be string or Buffer (node) or Blob (web)');
       }
@@ -258,8 +268,8 @@ class Repository extends Requestable {
     */
    updateTree(baseTreeSHA, path, blobSHA, cb) {
       let newTree = {
-         'base_tree': baseTreeSHA,
-         'tree': [{
+         base_tree: baseTreeSHA, // eslint-disable-line
+         tree: [{
             path: path,
             sha: blobSHA,
             mode: '100644',
@@ -279,7 +289,10 @@ class Repository extends Requestable {
     * @return {Promise} - the promise for the http request
     */
    createTree(tree, baseSHA, cb) {
-      return this._request('POST', `/repos/${this.__fullname}/git/trees`, {tree, base_tree: baseSHA}, cb); // jscs:ignore
+      return this._request('POST', `/repos/${this.__fullname}/git/trees`, {
+         tree,
+         base_tree: baseSHA // eslint-disable-line
+      }, cb);
    }
 
    /**
@@ -315,7 +328,10 @@ class Repository extends Requestable {
     * @return {Promise} - the promise for the http request
     */
    updateHead(ref, commitSHA, force, cb) {
-      return this._request('PATCH', `/repos/${this.__fullname}/git/refs/${ref}`, {sha: commitSHA, force: force}, cb);
+      return this._request('PATCH', `/repos/${this.__fullname}/git/refs/${ref}`, {
+         sha: commitSHA,
+         force: force
+      }, cb);
    }
 
    /**
@@ -371,7 +387,9 @@ class Repository extends Requestable {
     */
    getContents(ref, path, raw, cb) {
       path = path ? `${encodeURI(path)}` : '';
-      return this._request('GET', `/repos/${this.__fullname}/contents/${path}`, {ref}, cb, raw);
+      return this._request('GET', `/repos/${this.__fullname}/contents/${path}`, {
+         ref
+      }, cb, raw);
    }
 
    /**
@@ -411,7 +429,10 @@ class Repository extends Requestable {
       return this.getRef(`heads/${oldBranch}`)
          .then((response) => {
             let sha = response.data.object.sha;
-            return this.createRef({sha, ref: `refs/heads/${newBranch}`}, cb);
+            return this.createRef({
+               sha,
+               ref: `refs/heads/${newBranch}`
+            }, cb);
          });
    }
 
@@ -502,33 +523,33 @@ class Repository extends Requestable {
    }
 
    /**
-    * Change all references in a repo from old_path to new_path
+    * Change all references in a repo from oldPath to new_path
     * @param {string} branch - the branch to carry out the reference change, or the default branch if not specified
-    * @param {string} old_path - original path
-    * @param {string} new_path - new reference path
+    * @param {string} oldPath - original path
+    * @param {string} newPath - new reference path
     * @param {Function} cb - will receive the commit in which the move occurred
     * @return {Promise} - the promise for the http request
     */
-   move(branch, old_path, new_path, cb) {
+   move(branch, oldPath, newPath, cb) {
       return this.getRef(`heads/${branch}`)
          .then((response) => {
             return this.getTree(`${response.data.object.sha}?recursive=true`)
                .then((response) => {
-                  var _resp = response;
+                  let _resp = response;
                   response.data.tree.forEach((ref) => {
-                     if (ref.path === old_path) {
-                        ref.path = new_path;
+                     if (ref.path === oldPath) {
+                        ref.path = newPath;
                      }
                      if (ref.type === 'tree') {
                         delete ref.sha;
                      }
                   });
                   return this.createTree(response.data.tree).then(
                      (response) => {
-                       return this.commit(_resp.data.sha, response.data.sha, `Renamed '${old_path}' to '${new_path}'`)
-                          .then((response) => {
-                             return this.updateHead(`heads/${branch}`, response.data.sha, true, cb);
-                          });
+                        return this.commit(_resp.data.sha, response.data.sha, `Renamed '${oldPath}' to '${newPath}'`)
+                           .then((response) => {
+                              return this.updateHead(`heads/${branch}`, response.data.sha, true, cb);
+                           });
                      }
                   );
                });
@@ -542,7 +563,7 @@ class Repository extends Requestable {
     * @param {string} path - the path for the file
     * @param {string} content - the contents of the file
     * @param {string} message - the commit message
-    * @param {Object} [options]
+    * @param {Object} [options] - commit options
     * @param {Object} [options.author] - the author of the commit
     * @param {Object} [options.commiter] - the committer
     * @param {boolean} [options.encode] - true if the content should be base64 encoded