v2.0.0 has a ⭐Promise API⭐ and 🌠more features🌠

lacymorrow · Feb 27, 2018 · 1ae0648 · 1ae0648
1 parent 4b0bdd5
commit 1ae0648
Show file tree

Hide file tree

Showing 7 changed files with 554 additions and 173 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,222 @@
+{
+    "parserOptions": {
+        "ecmaVersion": 2017,
+        "ecmaFeatures": {
+            "experimentalObjectRestSpread": true,
+            "jsx": true
+        },
+        "sourceType": "module"
+    },
+
+    "env": {
+        "browser": true,
+        "es6": true,
+        "node": true
+    },
+
+    "plugins": [],
+
+    "globals": {
+        "window": true,
+        "define": true,
+        "process": true,
+        "document": true,
+        "navigator": true
+    },
+
+    "rules": {
+        "accessor-pairs": "warn",
+        "arrow-spacing": ["error", { "before": true, "after": true }],
+        "block-spacing": ["error", "always"],
+        "brace-style": ["error", "1tbs", { "allowSingleLine": true }],
+        "camelcase": ["warn", { "properties": "always" }],
+        "comma-dangle": [
+            "error",
+            {
+                "arrays": "never",
+                "objects": "never",
+                "imports": "never",
+                "exports": "never",
+                "functions": "never"
+            }
+        ],
+        "comma-spacing": ["error", { "before": false, "after": true }],
+        "comma-style": ["error", "last"],
+        "constructor-super": "warn",
+        "curly": ["error", "multi-line"],
+        "dot-location": ["error", "property"],
+        "eol-last": "warn",
+        "eqeqeq": ["error", "always", { "null": "ignore" }],
+        "func-call-spacing": ["error", "never"],
+        "generator-star-spacing": ["error", { "before": true, "after": true }],
+        "handle-callback-err": ["warn", "^(err|error)$"],
+        "indent": ["error", "tab"],
+        "key-spacing": ["error", { "beforeColon": false, "afterColon": true }],
+        "keyword-spacing": ["error", { "before": true, "after": true }],
+        "new-cap": ["error", { "newIsCap": true, "capIsNew": false }],
+        "new-parens": "error",
+        "no-array-constructor": "error",
+        "no-caller": "error",
+        "no-class-assign": "error",
+        "no-compare-neg-zero": "error",
+        "no-cond-assign": "error",
+        "no-const-assign": "error",
+        "no-constant-condition": ["error", { "checkLoops": false }],
+        "no-control-regex": "error",
+        "no-debugger": "error",
+        "no-delete-var": "error",
+        "no-dupe-args": "error",
+        "no-dupe-class-members": "error",
+        "no-dupe-keys": "error",
+        "no-duplicate-case": "error",
+        "no-duplicate-imports": "error",
+        "no-empty-character-class": "error",
+        "no-empty-pattern": "error",
+        "no-eval": "error",
+        "no-ex-assign": "error",
+        "no-extend-native": "warn",
+        "no-extra-bind": "error",
+        "no-extra-boolean-cast": "warn",
+        "no-extra-parens": ["error", "functions"],
+        "no-fallthrough": "warn",
+        "no-floating-decimal": "error",
+        "no-func-assign": "error",
+        "no-global-assign": "error",
+        "no-implied-eval": "error",
+        "no-inner-declarations": ["error", "functions"],
+        "no-invalid-regexp": "error",
+        "no-irregular-whitespace": "error",
+        "no-iterator": "error",
+        "no-label-var": "error",
+        "no-labels": ["error", { "allowLoop": false, "allowSwitch": false }],
+        "no-lone-blocks": "error",
+        "no-mixed-operators": [
+            "error",
+            {
+                "groups": [
+                    ["==", "!=", "===", "!==", ">", ">=", "<", "<="],
+                    ["&&", "||"],
+                    ["in", "instanceof"]
+                ],
+                "allowSamePrecedence": true
+            }
+        ],
+        "no-mixed-spaces-and-tabs": "error",
+        "no-multi-spaces": "error",
+        "no-multi-str": "error",
+        "no-multiple-empty-lines": ["error", { "max": 1, "maxEOF": 1 }],
+        "no-new": "error",
+        "no-new-func": "error",
+        "no-new-object": "error",
+        "no-new-require": "error",
+        "no-new-symbol": "error",
+        "no-new-wrappers": "error",
+        "no-obj-calls": "error",
+        "no-octal": "error",
+        "no-octal-escape": "error",
+        "no-path-concat": "error",
+        "no-proto": "error",
+        "no-redeclare": "error",
+        "no-regex-spaces": "warn",
+        "no-return-assign": ["error", "except-parens"],
+        "no-return-await": "error",
+        "no-self-assign": "error",
+        "no-self-compare": "error",
+        "no-sequences": "error",
+        "no-shadow-restricted-names": "error",
+        "no-sparse-arrays": "error",
+        "no-tabs": "off",
+        "no-template-curly-in-string": "error",
+        "no-this-before-super": "error",
+        "no-throw-literal": "error",
+        "no-trailing-spaces": "error",
+        "no-undef": "error",
+        "no-undef-init": "error",
+        "no-unexpected-multiline": "warn",
+        "no-unmodified-loop-condition": "error",
+        "no-unneeded-ternary": ["error", { "defaultAssignment": false }],
+        "no-unreachable": "error",
+        "no-unsafe-finally": "error",
+        "no-unsafe-negation": "error",
+        "no-unused-expressions": [
+            "error",
+            {
+                "allowShortCircuit": true,
+                "allowTernary": true,
+                "allowTaggedTemplates": true
+            }
+        ],
+        "no-unused-vars": [
+            "error",
+            { "vars": "all", "args": "none", "ignoreRestSiblings": true }
+        ],
+        "no-use-before-define": [
+            "error",
+            { "functions": true, "classes": true, "variables": true }
+        ],
+        "no-useless-call": "error",
+        "no-useless-computed-key": "error",
+        "no-useless-constructor": "error",
+        "no-useless-escape": "error",
+        "no-useless-rename": "error",
+        "no-useless-return": "error",
+        "no-whitespace-before-property": "error",
+        "no-with": "error",
+        "object-property-newline": [
+            "error",
+            { "allowMultiplePropertiesPerLine": true }
+        ],
+        "one-var": ["error", { "initialized": "never" }],
+        "operator-linebreak": [
+            "error",
+            "after",
+            { "overrides": { "?": "before", ":": "before" } }
+        ],
+        "padded-blocks": [
+            "error",
+            { "blocks": "always", "switches": "always", "classes": "always" }
+        ],
+        "prefer-promise-reject-errors": "error",
+        "quotes": [
+            "error",
+            "single",
+            { "avoidEscape": true, "allowTemplateLiterals": true }
+        ],
+        "rest-spread-spacing": ["error", "never"],
+        "semi": ["warn", "never"],
+        "semi-spacing": ["error", { "before": false, "after": true }],
+        "space-before-blocks": ["error", "always"],
+        "space-before-function-paren": ["error", "always"],
+        "space-in-parens": ["error", "always"],
+        "space-infix-ops": "error",
+        "space-unary-ops": ["error", { "words": true, "nonwords": false }],
+        "spaced-comment": [
+            "error",
+            "always",
+            {
+                "line": { "markers": ["*package", "!", "/", ",", "="] },
+                "block": {
+                    "balanced": true,
+                    "markers": [
+                        "*package",
+                        "!",
+                        ",",
+                        ":",
+                        "::",
+                        "flow-include"
+                    ],
+                    "exceptions": ["*"]
+                }
+            }
+        ],
+        "symbol-description": "error",
+        "template-curly-spacing": ["error", "never"],
+        "template-tag-spacing": ["error", "never"],
+        "unicode-bom": ["error", "never"],
+        "use-isnan": "error",
+        "valid-typeof": ["error", { "requireStringLiterals": true }],
+        "wrap-iife": ["error", "any", { "functionPrototypeMethods": true }],
+        "yield-star-spacing": ["error", "both"],
+        "yoda": ["error", "never"]
+    }
+}
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,4 @@
 .fuse*
-.DS*
+.DS*
+
+package-lock.json
diff --git a/README.md b/README.md
@@ -15,25 +15,28 @@ $ npm install --save movie-art
 ## Usage
 
 ```js
-
 var movieArt = require('movie-art');
 
+// Basic usage
 movieArt('Oceans Eleven', function (err, url) {
     console.log(url);
     //=> http://path/to/oceans_eleven_poster.jpg
 });
 
-movieArt('Oceans Eleven', '1960', function (err, url) {
+// Usage with landscape orientation backdrop
+movieArt('Oceans Eleven', {landscape: true}, function (err, url) {
     console.log(url);
-    //=> http://path/to/oceans_eleven_poster_1960.jpg
+    //=> http://path/to/oceans_eleven_backdrop.jpg
 });
 
-movieArt('Oceans Eleven', '1960', 'w92', function (err, url) {
+// Usage with size and year options
+movieArt('Oceans Eleven', {year: '1960', size: 'w92'}, function (err, url) {
     console.log(url);
     //=> http://path/to/oceans_eleven_poster_1960_small.jpg
 });
 
-movieArt('Star Trek: The Original Series', null, null,'tv', function (err, url) {
+// Query television art
+movieArt('Star Trek: The Original Series', {type: 'tv'}, function (err, url) {
     console.log(url);
     //=> http://path/to/star_trek_the_original_series_poster.jpg
 });
@@ -42,7 +45,7 @@ movieArt('Star Trek: The Original Series', null, null,'tv', function (err, url)
 
 ## API
 
-### movieArt(movie [, year ] [, size ] [, type ], callback)
+### movieArt(movie [, options] [, callback])
 
 #### movie
 
@@ -52,14 +55,19 @@ Type: `string`
 Movie to search for.
 
 
+#### callback(err, url)
+
+
+### Options
+
+A JavaScript object with the following properties
+
 #### year
 
 Type: `string` 
 
 Optional movie year.
 
-#### callback(err, url)
-
 
 #### size
 
@@ -70,14 +78,19 @@ Call `movieArt(function(e){console.log(e);});` or run the CLI command with no ar
 
 *possible values at time of writing:* `w92`, `w154`, `w185`, `w342`, `w500`, `w780`, `original`
 
+
 #### type
 
 Type: `string`
 
 The type of request: either `tv` or `movie`. Defaults to `movie`.
 
 
-#### callback(err, url)
+#### landscape
+
+Type: `boolean`
+
+Returns a wider, landscape orientation backdrop if true
 
 
 ## CLI
@@ -94,11 +107,17 @@ $ npm install --global movie-art
 $ movie-art --help
 
 Usage
-  $ movie-art movie [year] [size]
+  $ movie-art movie [year] [size] [type] [landscape]
+
+Options
+  --year,      -y  Release date year
+  --size,      -s  Possible values: [w92, w154, w185, w342, w500, w780, original]
+  --type,      -t  Possible values: [tv, movie] 
+  --landscape, -l  Return wider backdrop image if true
 
 Example
-  $ movie-art 'Oceans Eleven' 1960 w92
-  http://path/to/oceans_eleven_poster_1960_small.jpg
+  $ movie-art 'Oceans Eleven' --year 1960  --size w92
+  //=> http://path/to/oceans_eleven_poster_1960_small.jpg
 ```