Merge pull request #102 from kaimallea/dev-things

Apply styling and linting

Author: kaimallea

.eslintrc.js

@@ -0,0 +1,13 @@
+module.exports = {
+  env: {
+    commonjs: true,
+    es2021: true,
+    node: true,
+    mocha: true,
+  },
+  extends: ['eslint:recommended', 'prettier'],
+  parserOptions: {
+    ecmaVersion: 12,
+  },
+  rules: {},
+};

.prettierignore

@@ -0,0 +1,2 @@
+node_modules
+package-lock.json

.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": true
+}

README.md

@@ -16,7 +16,7 @@ Upload a single image:
 imgur cat.png
 ```
 
-Upload multiple images ([globbing](http://en.wikipedia.org/wiki/Glob_(programming)) supported):
+Upload multiple images ([globbing](<http://en.wikipedia.org/wiki/Glob_(programming)>) supported):
 
 ```bash
 imgur cat.png cats.gif cats23.jpg
@@ -103,20 +103,20 @@ imgur.getClientId();
 
 // Saving to disk. Returns a promise.
 // NOTE: path is optional. Defaults to ~/.imgur
-imgur.saveClientId(path)
-    .then(function () {
-        console.log('Saved.');
-    })
-    .catch(function (err) {
-        console.log(err.message);
-    });
-
+imgur
+  .saveClientId(path)
+  .then(function () {
+    console.log('Saved.');
+  })
+  .catch(function (err) {
+    console.log(err.message);
+  });
 
 // Loading from disk
 // NOTE: path is optional. Defaults to ~/.imgur
-imgur.loadClientId(path)
-    .then(imgur.setClientId);
+imgur.loadClientId(path).then(imgur.setClientId);
 ```
+
 #### Dealing with API URL:
 
 In order to change the API Url say Mashape URL, use setAPIUrl(MashapeURL)
@@ -130,9 +130,10 @@ imgur.setAPIUrl('https://api.imgur.com/3/');
 //Getting
 imgur.getAPIUrl();
 ```
+
 #### Dealing with Mashape Key
 
-Requests to the Mashape URL expects a X-Mashape-Key: MashapeKey header. 
+Requests to the Mashape URL expects a X-Mashape-Key: MashapeKey header.
 Set Mashape Key by using setMashapeKey(MashapeKey) method.
 Note: Defaults to process.env.IMGUR_MASHAPE_KEY
 
@@ -143,137 +144,144 @@ imgur.setMashapeKey(https://imgur-apiv3.p.mashape.com/);
 //Getting
 imgur.getMashapeKey()
 ```
+
 #### Dealing with credentials:
 
 For when you want to upload images to an account.
 
 ```javascript
 // Setting
 imgur.setCredentials('[email protected]', 'password', 'aCs53GSs4tga0ikp');
-
 ```
 
 #### Uploading files; globbing supported:
 
 ```javascript
 // A single image
-imgur.uploadFile('/home/kai/kittens.png')
-    .then(function (json) {
-        console.log(json.data.link);
-    })
-    .catch(function (err) {
-        console.error(err.message);
-    });
+imgur
+  .uploadFile('/home/kai/kittens.png')
+  .then(function (json) {
+    console.log(json.data.link);
+  })
+  .catch(function (err) {
+    console.error(err.message);
+  });
 
 // All jpegs in a specific folder
 // to an album you own
 var albumId = 'F8KTV';
-imgur.uploadFile('/home/kai/*.jpg', albumId)
-    .then(function (json) {
-        console.log(json.data.link);
-    })
-    .catch(function (err) {
-        console.error(err.message);
-    });
+imgur
+  .uploadFile('/home/kai/*.jpg', albumId)
+  .then(function (json) {
+    console.log(json.data.link);
+  })
+  .catch(function (err) {
+    console.error(err.message);
+  });
 
 // Multiple image types from home folder
-imgur.uploadFile('~/*.(jpg|png|gif)')
-    .then(function(json) {
-        console.log(json.data.link);
-    })
-    .catch(function (err) {
-        console.error(err.message);
-    });
+imgur
+  .uploadFile('~/*.(jpg|png|gif)')
+  .then(function (json) {
+    console.log(json.data.link);
+  })
+  .catch(function (err) {
+    console.error(err.message);
+  });
 ```
+
 #### Searching images within the gallery:
 
-The first argument should be a query to search and it's the only required option. The second argument is optional params to sort your query by. 
+The first argument should be a query to search and it's the only required option. The second argument is optional params to sort your query by.
 
 - `sort` - Accepts 'time', 'viral', or 'top' as a value. Defaults to top.
 - `dateRange` - Accepts 'day', 'week', 'month', 'year', or 'all' as a value. Defaults to all.
 - `page` - Accepts an integer (e.g. 1, 2, 3, 4) as a value. Defaults to 1.
 
-Search returns an object with the query response as an array of objects that include an image's ID, title, description, views, etc.. and the params you sent with the request. 
+Search returns an object with the query response as an array of objects that include an image's ID, title, description, views, etc.. and the params you sent with the request.
 
 ```javascript
 var query = 'cats';
-var optionalParams = {sort: 'top', dateRange: 'week', page: 1}
-imgur.search(query, optionalParams)
-    .then(function(json) {
-        console.log(json);
-    })
-    .catch(function (err) {
-        console.error(err);
-    });
-
+var optionalParams = { sort: 'top', dateRange: 'week', page: 1 };
+imgur
+  .search(query, optionalParams)
+  .then(function (json) {
+    console.log(json);
+  })
+  .catch(function (err) {
+    console.error(err);
+  });
 ```
 
 #### Fetching image data:
 
 ```javascript
 var kittenPic = 'mbgq7nd';
-imgur.getInfo(kittenPic)
-    .then(function(json) {
-        console.log(json);
-    })
-    .catch(function (err) {
-        console.error(err.message);
-    });
-
+imgur
+  .getInfo(kittenPic)
+  .then(function (json) {
+    console.log(json);
+  })
+  .catch(function (err) {
+    console.error(err.message);
+  });
 ```
 
 #### Fetching album data:
 
 ```javascript
 var kittenAlbum = 'mbgq7nd';
-imgur.getAlbumInfo(kittenAlbum)
-    .then(function(json) {
-        console.log(json);
-    })
-    .catch(function (err) {
-        console.error(err.message);
-    });
-
+imgur
+  .getAlbumInfo(kittenAlbum)
+  .then(function (json) {
+    console.log(json);
+  })
+  .catch(function (err) {
+    console.error(err.message);
+  });
 ```
 
 #### Creating an album:
 
 ```javascript
-imgur.createAlbum()
-    .then(function(json) {
-        console.log(json);
-    })
-    .catch(function (err) {
-        console.error(err.message);
-    });
-
+imgur
+  .createAlbum()
+  .then(function (json) {
+    console.log(json);
+  })
+  .catch(function (err) {
+    console.error(err.message);
+  });
 ```
 
 #### Uploading URLs of images hosted elsewhere:
 
 ```javascript
 // Include http(s) when specifying URLs
-imgur.uploadUrl('https://octodex.github.com/images/topguntocat.png')
-    .then(function (json) {
-        console.log(json.data.link);
-    })
-    .catch(function (err) {
-        console.error(err.message);
-    });
+imgur
+  .uploadUrl('https://octodex.github.com/images/topguntocat.png')
+  .then(function (json) {
+    console.log(json.data.link);
+  })
+  .catch(function (err) {
+    console.error(err.message);
+  });
 ```
 
 #### Uploading Base-64 encoded images:
 
 ```javascript
-var imgurFavicon = 'iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAmUlEQVQ4je2TsQ3CMBBFnxMa08WR2IQKJskIUNwMZAcYwWIQMs65JCUpEEIYW4pJy6v+6e6+/hVnnGsAzsCBMi7AsbbW/rIMsAU2xrnmkeruuzW7zgIw+JGbv6fGQpWzfy3HOsJlDQY/AlCv3jpF9oS5ZBOICKoB1YCIlCdQDR9127qyBHP5Gyw3CBXPr/qi709JHXE1S995AsqoJu8x78GsAAAAAElFTkSuQmCC';
-
-imgur.uploadBase64(imgurFavicon)
-    .then(function (json) {
-        console.log(json.data.link);
-    })
-    .catch(function (err) {
-        console.error(err.message);
-    });
+var imgurFavicon =
+  'iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAmUlEQVQ4je2TsQ3CMBBFnxMa08WR2IQKJskIUNwMZAcYwWIQMs65JCUpEEIYW4pJy6v+6e6+/hVnnGsAzsCBMi7AsbbW/rIMsAU2xrnmkeruuzW7zgIw+JGbv6fGQpWzfy3HOsJlDQY/AlCv3jpF9oS5ZBOICKoB1YCIlCdQDR9127qyBHP5Gyw3CBXPr/qi709JHXE1S995AsqoJu8x78GsAAAAAElFTkSuQmCC';
+
+imgur
+  .uploadBase64(imgurFavicon)
+  .then(function (json) {
+    console.log(json.data.link);
+  })
+  .catch(function (err) {
+    console.error(err.message);
+  });
 ```
 
 #### Uploading multiple images:
@@ -283,14 +291,14 @@ Upload an array of images of the desired upload type ('File', 'Url', 'Base64').
 Returns an array of images (imgur image data).
 
 ```javascript
-imgur.uploadImages(images, uploadType /*, albumId */)
-    .then(function(images) {
-        console.log(images);
-    })
-    .catch(function (err) {
-        console.error(err.message);
-    });
-
+imgur
+  .uploadImages(images, uploadType /*, albumId */)
+  .then(function (images) {
+    console.log(images);
+  })
+  .catch(function (err) {
+    console.error(err.message);
+  });
 ```
 
 #### Uploading an album:
@@ -302,30 +310,31 @@ Returns an object with the album data and an array of images { data: {...}, imag
 The third parameter is an optional fail safe, meaning if the array of images is empty or invalid, it will not fail, but returns an object with empty data and empty images.
 
 ```javascript
-imgur.uploadAlbum(images, uploadType /*, failSafe */)
-    .then(function(album) {
-        console.log(album.data, album.images);
-    })
-    .catch(function (err) {
-        console.error(err.message);
-    });
-
+imgur
+  .uploadAlbum(images, uploadType /*, failSafe */)
+  .then(function (album) {
+    console.log(album.data, album.images);
+  })
+  .catch(function (err) {
+    console.error(err.message);
+  });
 ```
 
 #### Deleting anonymous uploads
 
 Delete an image based on the deletehash(generated during the image upload)
 
 ```javascript
-imgur.deleteImage(deletehash)
-    .then(function(status) {
-        console.log(status);  
-    })
-    .catch(function(err) {
-        console.error(err.message);
-    });
+imgur
+  .deleteImage(deletehash)
+  .then(function (status) {
+    console.log(status);
+  })
+  .catch(function (err) {
+    console.error(err.message);
+  });
 ```
 
 ## License
 
-#### MIT
+#### MIT