Merge branch 'release/3.0.0'

Author: andrewbrooke

.eslintrc.js

@@ -73,7 +73,7 @@ module.exports = {
         "id-blacklist": "error",
         "id-length": "off",
         "id-match": "error",
-        "indent": "off",
+        "indent": ["error", 4],
         "init-declarations": "off",
         "jsx-quotes": "error",
         "key-spacing": "error",
@@ -152,12 +152,7 @@ module.exports = {
         "no-new-require": "error",
         "no-new-wrappers": "error",
         "no-octal-escape": "error",
-        "no-param-reassign": [
-            "error",
-            {
-                "props": false
-            }
-        ],
+        "no-param-reassign": "off",
         "no-path-concat": "error",
         "no-plusplus": [
             "error",
@@ -183,7 +178,7 @@ module.exports = {
         "no-shadow-restricted-names": "error",
         "no-spaced-func": "error",
         "no-sync": "error",
-        "no-tabs": "off",
+        "no-tabs": "error",
         "no-template-curly-in-string": "error",
         "no-ternary": "off",
         "no-throw-literal": "error",

CHANGELOG.md

@@ -0,0 +1,32 @@
+## 3.0.0
+
+- Changed method signatures
+- Updated ESLint rules
+- Added CHANGELOG
+
+## 2.1.0
+
+- Added methods to get language data with username
+
+## 2.0.1
+
+- Fixed Regenerator Runtime error with older versions of Node.JS
+
+## 2.0.0
+
+- Syntactic sugar
+
+## 1.2.0
+
+- getCommitLanguages returns commit count per language
+- Configured Babel for Building
+- Replaced Promises with Async/Await
+
+## 1.1.0
+
+- Linting
+- Rewrote promises
+
+## 1.0.0
+
+- First public release

README.md

@@ -14,31 +14,46 @@ Import `const langGetter = require('github-lang-getter');`
 
 Return the language makeup of a user's repositories, in bytes
 
-The numbers returned by these methods reflect the number of bytes committed by all contributors.
+NOTE: The numbers returned by these methods reflect the number of bytes committed by all contributors.
 
 ```
-var visibility = 'all'; // can be all, public, or private
 var token = 'YOUR-ACCESS-TOKEN'; // https://github.com/settings/tokens
-langGetter.getRepoLanguages(visibility, token).then((result) => {
+langGetter.getRepoLanguages(token).then((result) => {
     console.log(result);
 }).catch((err) => {
     console.log(err);
 });
 ```
 
-or
+For `getRepoLanguages`, you can also supply an optional second parameter to specify the `visibility` and `affiliation` of repositories to find.
+NOTE: Both `visibility` and `affiliation` are optional.
 
 ```
-var username = 'YOUR-USERNAME';
 var token = 'YOUR-ACCESS-TOKEN'; // https://github.com/settings/tokens
-langGetter.getRepoLanguagesByUsername(username, token).then((result) => {
+var options = {
+    visibility: 'all' // 'all', 'public', or 'private'
+    affiliation: ['owner'] // combination of 'owner', 'collaborator', and 'organization_member'
+};
+langGetter.getRepoLanguages(token, options).then((result) => {
     console.log(result);
 }).catch((err) => {
     console.log(err);
 });
 ```
 
-Returns an object like
+You can also use `getRepoLanguagesByUsername` to query for another user's language makeup.
+
+```
+var username = 'GITHUB-USERNAME';
+var token = 'YOUR-ACCESS-TOKEN'; // https://github.com/settings/tokens
+langGetter.getRepoLanguagesByUsername(token, username).then((result) => {
+    console.log(result);
+}).catch((err) => {
+    console.log(err);
+});
+```
+
+The above methods return an object similar to the following:
 
 ```
 {
@@ -52,31 +67,46 @@ Returns an object like
 
 Return the language makeup of a user's commits, in bytes
 
-The numbers returned by these methods reflect the number of bytes only committed by the user.
+NOTE: The numbers returned by these methods reflect the number of bytes only committed by the user.
 
 ```
-var visibility = 'all'; // can be all, public, or private
 var token = 'YOUR-ACCESS-TOKEN'; // https://github.com/settings/tokens
-langGetter.getCommitLanguages(visibility, token).then((result) => {
+langGetter.getCommitLanguages(token).then((result) => {
     console.log(result);
 }).catch((err) => {
     console.log(err);
 });
 ```
 
-or
+For `getCommitLanguages`, you can also supply an optional second parameter to specify the `visibility` and `affiliation` of repositories to find.
+NOTE: Both `visibility` and `affiliation` are optional.
+
+```
+var token = 'YOUR-ACCESS-TOKEN'; // https://github.com/settings/tokens
+var options = {
+    visibility: 'all' // 'all', 'public', or 'private'
+    affiliation: ['owner'] // combination of 'owner', 'collaborator', and 'organization_member'
+};
+langGetter.getCommitLanguages(token, options).then((result) => {
+    console.log(result);
+}).catch((err) => {
+    console.log(err);
+});
+```
+
+You can also use `getCommitLanguagesByUsername` to query for another user's language makeup.
 
 ```
 var username = 'YOUR-USERNAME';
 var token = 'YOUR-ACCESS-TOKEN'; // https://github.com/settings/tokens
-langGetter.getCommitLanguagesByUsername(username, token).then((result) => {
+langGetter.getCommitLanguagesByUsername(token, username).then((result) => {
     console.log(result);
 }).catch((err) => {
     console.log(err);
 });
 ```
 
-Returns an object like
+The above methods return an object similar to the following:
 
 ```
 {
@@ -130,11 +160,14 @@ Bug fixes and new features are encouraged, feel free to fork and make a pull req
 - Follow the ESLint rules set in .eslintrc.js
 - Add Mocha tests for new functionality
 
+## CHANGELOG
+
+[View changes here](CHANGELOG.md)
+
 ## TODOS
 
 - Improve API calls to prevent Github rate limit errors
 - Find a way to exclude bytes in files that are a result of build processes
-- Add methods to get language stats by Github username (only for public repos)
 
 ## License
 

examples/examples.js

@@ -1,28 +1,34 @@
 const langGetter = require('../src/index');
 
 // Return the language makeup of a user's repositories, in bytes
-langGetter.getRepoLanguages('all', 'YOUR-ACCESS-TOKEN').then((result) => {
+langGetter.getRepoLanguages('YOUR-ACCESS-TOKEN', {
+    visibility: 'all',
+    affiliation: ['owner', 'collaborator']
+}).then((result) => {
     console.log(result);
 }).catch((err) => {
     console.log(err);
 });
 
 // Return the language makeup of a user's repositories, in bytes
-langGetter.getRepoLanguagesByUsername('YOUR-USERNAME', 'YOUR-ACCESS-TOKEN').then((result) => {
+langGetter.getRepoLanguagesByUsername('YOUR-ACCESS-TOKEN', 'GITHUB-USERNAME').then((result) => {
     console.log(result);
 }).catch((err) => {
     console.log(err);
 });
 
 // Return the language makeup of a user's commits, in bytes
-langGetter.getCommitLanguages('all', 'YOUR-ACCESS-TOKEN').then((result) => {
+langGetter.getCommitLanguages('YOUR-ACCESS-TOKEN', {
+    visibility: 'all',
+    affiliation: ['owner', 'collaborator']
+}).then((result) => {
     console.log(result);
 }).catch((err) => {
     console.log(err);
 });
 
 // Return the language makeup of a user's commits, in bytes
-langGetter.getCommitLanguagesByUsername('YOUR-USERNAME', 'YOUR-ACCESS-TOKEN').then((result) => {
+langGetter.getCommitLanguagesByUsername('YOUR-ACCESS-TOKEN', 'GITHUB-USERNAME').then((result) => {
     console.log(result);
 }).catch((err) => {
     console.log(err);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "github-lang-getter",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "description": "Gets a Github user's programming language distribution across repositories and commits",
   "main": "./dist/index.js",
   "scripts": {