Add METASCRAPER_CWD tests and documentation

Closes #52

README.md

@@ -312,6 +312,15 @@ It is used for resolve relative links that can be present in the HTML markup.
 
 it can be used as fallback field for different rules as well.
 
+## Environment Variables
+
+### METASCRAPER_CWD
+
+Type: `String` <br/>
+Default: `process.cwd()`
+
+This variable is used to determine where starting search for a configuration object.
+
 ## Comparison
 
 To give you an idea of how accurate **metascraper** is, here is a comparison of similar libraries:

packages/metascraper-amazon/test/index.js

@@ -15,13 +15,13 @@ let metascraper
 describe('metascraper-amazon', () => {
   before(() => {
     clearModule('metascraper')
-    process.env.METASCRAPER_CONFIG_CWD = __dirname
+    process.env.METASCRAPER_CWD = __dirname
     metascraper = require('metascraper')
   })
 
   after(() => {
     clearModule('metascraper')
-    delete process.env.METASCRAPER_CONFIG_CWD
+    delete process.env.METASCRAPER_CWD
   })
 
   describe('amazon.co.uk', () => {

packages/metascraper-clearbit-logo/test/index.js

@@ -6,12 +6,12 @@ const snapshot = require('snap-shot')
 describe('metascraper clearbit logo', () => {
   before(() => {
     clearModule.all()
-    process.env.METASCRAPER_CONFIG_CWD = __dirname
+    process.env.METASCRAPER_CWD = __dirname
   })
 
   after(() => {
     clearModule.all()
-    delete process.env.METASCRAPER_CONFIG_CWD
+    delete process.env.METASCRAPER_CWD
   })
 
   it('if logo is not present, fallback to clearbit logo API', async () => {

packages/metascraper-logo-favicon/test/index.js

@@ -12,12 +12,12 @@ const readFile = promisify(fs.readFile)
 describe('metascraper amazon integration', () => {
   before(() => {
     clearModule.all()
-    process.env.METASCRAPER_CONFIG_CWD = __dirname
+    process.env.METASCRAPER_CWD = __dirname
   })
 
   after(() => {
     clearModule.all()
-    delete process.env.METASCRAPER_CONFIG_CWD
+    delete process.env.METASCRAPER_CWD
   })
 
   describe('metascraper logo favicon', () => {

packages/metascraper-soundcloud/test/index.js

@@ -13,13 +13,13 @@ let metascraper
 describe('metascraper-soundcloud', () => {
   before(() => {
     clearModule('metascraper')
-    process.env.METASCRAPER_CONFIG_CWD = __dirname
+    process.env.METASCRAPER_CWD = __dirname
     metascraper = require('metascraper')
   })
 
   after(() => {
     clearModule('metascraper')
-    delete process.env.METASCRAPER_CONFIG_CWD
+    delete process.env.METASCRAPER_CWD
   })
 
   it('song', async () => {

packages/metascraper-youtube/test/index.js

@@ -13,13 +13,13 @@ let metascraper
 describe('metascraper-youtube', () => {
   before(() => {
     clearModule('metascraper')
-    process.env.METASCRAPER_CONFIG_CWD = __dirname
+    process.env.METASCRAPER_CWD = __dirname
     metascraper = require('metascraper')
   })
 
   after(() => {
     clearModule('metascraper')
-    delete process.env.METASCRAPER_CONFIG_CWD
+    delete process.env.METASCRAPER_CWD
   })
 
   it('youtube video', async () => {

packages/metascraper/src/load-rules.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const cwd = process.env.METASCRAPER_CONFIG_CWD || process.cwd()
+const cwd = process.env.METASCRAPER_CWD || process.cwd()
 const config = require('cosmiconfig')('metascraper').load(cwd)
 const resolveFrom = require('resolve-from')
 

packages/metascraper/test/unit/load-rules/config/index.js

@@ -0,0 +1,29 @@
+'use strict'
+
+const clearModule = require('clear-module')
+const should = require('should')
+
+let metascraper
+
+describe('load rules', () => {
+  before(() => {
+    clearModule('metascraper')
+    process.env.METASCRAPER_CWD = __dirname
+    metascraper = require('../../../..')
+  })
+
+  after(() => {
+    clearModule('metascraper')
+    delete process.env.METASCRAPER_CWD
+  })
+
+  it('based on a configuration file', 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=jpg'
+    )
+  })
+})

packages/metascraper/test/unit/load-rules/config/metascraper.config.js

@@ -0,0 +1,17 @@
+module.exports = {
+  rules: [
+    'metascraper-author',
+    'metascraper-date',
+    'metascraper-description',
+    'metascraper-image',
+    'metascraper-logo',
+    {
+      'metascraper-clearbit-logo': {
+        format: 'jpg'
+      }
+    },
+    'metascraper-publisher',
+    'metascraper-title',
+    'metascraper-url'
+  ]
+}

packages/metascraper/test/unit/load-rules/pkg/index.js

@@ -0,0 +1,29 @@
+'use strict'
+
+const clearModule = require('clear-module')
+const should = require('should')
+
+let metascraper
+
+describe('load rules', () => {
+  before(() => {
+    clearModule('metascraper')
+    process.env.METASCRAPER_CWD = __dirname
+    metascraper = require('../../../..')
+  })
+
+  after(() => {
+    clearModule('metascraper')
+    delete process.env.METASCRAPER_CWD
+  })
+
+  it('based on a package file', 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=jpg'
+    )
+  })
+})

packages/metascraper/test/unit/load-rules/pkg/package.json

@@ -0,0 +1,19 @@
+{
+  "metascraper": {
+    "rules": [
+      "metascraper-author",
+      "metascraper-date",
+      "metascraper-description",
+      "metascraper-image",
+      "metascraper-logo",
+      {
+        "metascraper-clearbit-logo": {
+          "format": "jpg"
+        }
+      },
+      "metascraper-publisher",
+      "metascraper-title",
+      "metascraper-url"
+    ]
+  }
+}

packages/metascraper/test/unit/load-rules/rc/.metascraperrc

@@ -0,0 +1,15 @@
+{
+  "rules": [
+    "metascraper-author",
+    "metascraper-date",
+    "metascraper-description",
+    "metascraper-image",
+    "metascraper-logo",
+    {"metascraper-clearbit-logo": {
+      "format": "jpg"
+    }},
+    "metascraper-publisher",
+    "metascraper-title",
+    "metascraper-url"
+  ]
+}

packages/metascraper/test/unit/load-rules/rc/index.js

@@ -0,0 +1,29 @@
+'use strict'
+
+const clearModule = require('clear-module')
+const should = require('should')
+
+let metascraper
+
+describe('load rules', () => {
+  before(() => {
+    clearModule('metascraper')
+    process.env.METASCRAPER_CWD = __dirname
+    metascraper = require('../../../..')
+  })
+
+  after(() => {
+    clearModule('metascraper')
+    delete process.env.METASCRAPER_CWD
+  })
+
+  it('based on a rc file', 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=jpg'
+    )
+  })
+})