Add possibility to load rules from config file

Use default rules as fallback

Author: Kikobeats

packages/metascraper/package.json

@@ -57,6 +57,7 @@
   "dependencies": {
     "@metascraper/helpers": "~0.0.0",
     "cheerio": "~1.0.0-rc.2",
+    "cosmiconfig": "~3.1.0",
     "lodash": "~4.17.4",
     "sanitize-html": "~1.16.1"
   },
@@ -78,5 +79,10 @@
     "coveralls": "nyc report --reporter=text-lcov | coveralls",
     "test": "TZ=UTC NODE_ENV=test nyc mocha test"
   },
-  "license": "MIT"
+  "license": "MIT",
+  "standard": {
+    "env": [
+      "mocha"
+    ]
+  }
 }

packages/metascraper/src/index.js

@@ -3,21 +3,13 @@
 const { isUrl } = require('@metascraper/helpers')
 const { isEmpty } = require('lodash')
 
+const loadRules = require('./load-rules')
 const loadHTML = require('./load-html')
 const getData = require('./get-data')
 
-const rules = [
-  require('metascraper-author'),
-  require('metascraper-date'),
-  require('metascraper-description'),
-  require('metascraper-image'),
-  require('metascraper-logo'),
-  require('metascraper-publisher'),
-  require('metascraper-title'),
-  require('metascraper-url')
-]
-
 module.exports = async ({ url, html } = {}) => {
+  const rules = await loadRules()
+
   if (!isUrl(url)) throw new TypeError('You need to provide a valid url.')
   if (isEmpty(html)) {
     throw new TypeError('You need to provide a valid HTML markup.')

packages/metascraper/src/load-rules.js

@@ -0,0 +1,18 @@
+'use strict'
+
+const config = require('cosmiconfig')('metascraper').load(process.cwd())
+
+module.exports = () =>
+  Promise.resolve(config).then(
+    configFile =>
+      configFile || [
+        require('metascraper-author'),
+        require('metascraper-date'),
+        require('metascraper-description'),
+        require('metascraper-image'),
+        require('metascraper-logo'),
+        require('metascraper-publisher'),
+        require('metascraper-title'),
+        require('metascraper-url')
+      ]
+  )

packages/metascraper/test/unit/interface.js

@@ -21,12 +21,11 @@ it('html is required', async () => {
   }
 })
 
-// it('plugins support', async () => {
-//   const metascraper = createMetascraper({ plugins: [clearbitLogo] })
-//   const url = 'https://facebook.com'
-//   const html = '<div></div>'
-//   const meta = await metascraper({ url, html })
-//   should(meta.logo).be.equal(
-//     'https://logo.clearbit.com/facebook.com?size=128&format=png'
-//   )
-// })
+it('loading custom rules', async () => {
+  const url = 'https://facebook.com'
+  const html = '<div></div>'
+  const meta = await metascraper({ url, html })
+  should(meta.logo).be.equal(
+    'https://logo.clearbit.com/facebook.com?size=128&format=png'
+  )
+})