Remove autoload

Author: Kikobeats

README.md

@@ -131,116 +131,12 @@ Rules work as fallback between them:
 
 **metascraper** do that until finish all the rule or find the first rule that resolves the value.
 
-## Loading rules
-
-When you call **metascraper** in your code, a set of [core rules](#core-rules) are loaded by default.
-
-Although these rules are sufficient for most cases, **metascraper** was designed to be easy to adapt and load more or custom rules set.
-
-We provide two approach for do that.
-
-### Configuration file
-
-This consists in declaring a configuration file that contains the names of the rule sets corresponding to npm packages that **metascraper** will be load automagically.
-
-The configuration file could be declared via:
-
-- A `.metascraperrc` file, written in YAML or JSON, with optional extensions: **.yaml**, **.yml**, **.json** and **.js**.
-- A `metascraper.config.js` file that exports an object.
-- A **metascraper** key in your `package.json` file.
-
-The configuration file will be resolved starting from the location of the file being formatted, and searching up the file tree until a config file is (or isn't) found.
-
-The order of rules are loaded are important: Just the first rule that resolve the value will be applied.
-
-#### Basic Configuration
-
-Declared an **array** of **rules**, specifying each rule as **string** name of the module to load.
-
-##### JSON
-
-```json
-// .metascraperrc
-{
-  "rules": [
-    "metascraper-author",
-    "metascraper-date",
-    "metascraper-description",
-    "metascraper-image",
-    "metascraper-lang",
-    "metascraper-logo",
-    "metascraper-publisher",
-    "metascraper-title",
-    "metascraper-url"
-  ]
-}
-```
-
-##### YAML
-
-```yaml
-#  .metascraperrc
-rules:  
-  - metascraper-author
-  - metascraper-date
-  - metascraper-description
-  - metascraper-image
-  - metascraper-lang
-  - metascraper-logo
-  - metascraper-publisher
-  - metascraper-title
-  - metascraper-url
-```
-
-#### Advanced Configuration
-
-Additionally, you can pass specific configuration per module using a **object** declaration:
-
-##### JSON
-
-```json
-// .metascraperrc
-{
-  "rules": [
-    "metascraper-author",
-    "metascraper-date",
-    "metascraper-description",
-    "metascraper-image",
-    "metascraper-lang",
-    "metascraper-logo",
-    {"metascraper-clearbit-logo": {
-    "format": "jpg"
-    }},
-    "metascraper-publisher",
-    "metascraper-title",
-    "metascraper-url"
-  ]
-}
-```
-
-##### YAML
-
-```yaml
-# .metascraperrc
-rules:
-  - metascraper-author
-  - metascraper-date
-  - metascraper-description
-  - metascraper-image
-  - metascraper-lang
-  - metascraper-clearbit-logo:
-      format: jpg
-  - metascraper-publisher
-  - metascraper-title
-  - metascraper-url
-```
-
-### Constructor
+## Usage
 
-If you need more control, you can load the rules set calling directly the metascraper constructor [`.load`](#metascraperloadrules):
+**metascraper** exports a constructors that need to be initalized providing a collection of rules set to load:
 
 ```js
-const metascraper = require('metascraper').load([
+const metascraper = require('metascraper')([
   require('metascraper-author')(),
   require('metascraper-date')(),
   require('metascraper-description')(),
@@ -255,25 +151,17 @@ const metascraper = require('metascraper').load([
 
 Again, the order of rules are loaded are important: Just the first rule that resolve the value will be applied.
 
-Use the first parameter to pass custom options if you need it:
+Use the first parameter to pass custom options specific per each rules set:
 
 ```js
-const metascraper = require('metascraper').load([
+const metascraper = require('metascraper')([
   require('metascraper-clearbit-logo')({
     size: 256,
     format: 'jpg'
   })
 ])
 ```
 
-Using this way you are not limited to load just npm modules as rules set. For example, you can load a custom file of rules:
-
-```js
-const metascraper = require('metascraper').load([
-  require('./my-custom-rules-file')()
-])
-```
-
 ## Rules
 
 ?> Can't find a rules set that you want? Let's [open an issue](https://github.com/microlinkhq/metascraper/issues/new) to create it.
@@ -368,7 +256,7 @@ Type: `Array`
 
 You can pass additional rules on execution time. These rules will be merged with your loaded rules.
 
-### metascraper.load(rules)
+### metascraper([rules])
 
 Create a new **metascraper** instance declaring the rules set to be used explicitly.
 

packages/metascraper-amazon/package.json

@@ -41,6 +41,9 @@
     "test": "NODE_PATH=.. TZ=UTC NODE_ENV=test nyc mocha test"
   },
   "license": "MIT",
+  "peerDependencies": {
+    "metascraper": "^3"
+  },
   "standard": {
     "env": [
       "mocha"

packages/metascraper-amazon/test/index.js

@@ -9,7 +9,7 @@ const fs = require('fs')
 
 const readFile = promisify(fs.readFile)
 
-const metascraper = require('metascraper').load([
+const metascraper = require('metascraper')([
   require('metascraper-amazon')(),
   require('metascraper-author')(),
   require('metascraper-date')(),
@@ -25,16 +25,21 @@ const metascraper = require('metascraper').load([
 describe('metascraper-amazon', () => {
   describe('amazon.co.uk', () => {
     it('product url', async () => {
-      const html = await readFile(resolve(__dirname, 'fixtures/amazon-co-uk/product-url.html'))
-      const url = 'https://www.amazon.co.uk/Vegetable-Perfection-tasty-recipes-shoots/dp/1849757097/ref=asap_bc?ie=UTF8'
+      const html = await readFile(
+        resolve(__dirname, 'fixtures/amazon-co-uk/product-url.html')
+      )
+      const url =
+        'https://www.amazon.co.uk/Vegetable-Perfection-tasty-recipes-shoots/dp/1849757097/ref=asap_bc?ie=UTF8'
       const meta = omit(await metascraper({ html, url }), ['date'])
       snapshot(meta)
     })
   })
 
   describe('amazon.com', () => {
     it('ansi url', async () => {
-      const html = await readFile(resolve(__dirname, 'fixtures/amazon-com/ansi-url.html'))
+      const html = await readFile(
+        resolve(__dirname, 'fixtures/amazon-com/ansi-url.html')
+      )
       const url = 'https://www.amazon.com/gp/product/B0057OC5O8/'
       const metadata = await metascraper({ html, url })
 
@@ -44,8 +49,11 @@ describe('metascraper-amazon', () => {
     })
 
     it('product url', async () => {
-      const html = await readFile(resolve(__dirname, 'fixtures/amazon-com/product-url.html'))
-      const url = 'https://www.amazon.com/The-Whole-Truth-Shaw-Book-ebook/dp/B0011UCPM4/ref=pd_zg_rss_ts_b_17_6?ie=UTF8&tag=recomshop-22'
+      const html = await readFile(
+        resolve(__dirname, 'fixtures/amazon-com/product-url.html')
+      )
+      const url =
+        'https://www.amazon.com/The-Whole-Truth-Shaw-Book-ebook/dp/B0011UCPM4/ref=pd_zg_rss_ts_b_17_6?ie=UTF8&tag=recomshop-22'
       const metadata = await metascraper({ html, url })
 
       // omit date because it is non deterministic
@@ -56,8 +64,11 @@ describe('metascraper-amazon', () => {
 
   describe('amazon.es', () => {
     it('product url', async () => {
-      const html = await readFile(resolve(__dirname, 'fixtures/amazon-es/product-url.html'))
-      const url = 'https://www.amazon.es/aspirador-Excellence-Programable-limpieza-Silencioso/dp/B01MUGXRT9'
+      const html = await readFile(
+        resolve(__dirname, 'fixtures/amazon-es/product-url.html')
+      )
+      const url =
+        'https://www.amazon.es/aspirador-Excellence-Programable-limpieza-Silencioso/dp/B01MUGXRT9'
       const metadata = await metascraper({ html, url })
 
       // omit date because it is non deterministic

packages/metascraper-author/package.json

@@ -31,5 +31,8 @@
   "scripts": {
     "test": "exit 0"
   },
-  "license": "MIT"
+  "license": "MIT",
+  "peerDependencies": {
+    "metascraper": "^3"
+  }
 }

packages/metascraper-clearbit-logo/package.json

@@ -20,6 +20,9 @@
     "clearbit",
     "metascraper"
   ],
+  "dependencies": {
+    "got": "~9.0.0"
+  },
   "devDependencies": {
     "mocha": "latest",
     "nyc": "latest",
@@ -36,12 +39,12 @@
     "test": "NODE_PATH=.. TZ=UTC NODE_ENV=test nyc mocha test"
   },
   "license": "MIT",
+  "peerDependencies": {
+    "metascraper": "^3"
+  },
   "standard": {
     "env": [
       "mocha"
     ]
-  },
-  "dependencies": {
-    "got": "~9.0.0"
   }
 }

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

@@ -2,7 +2,7 @@
 
 const should = require('should')
 
-const metascraper = require('metascraper').load([
+const metascraper = require('metascraper')([
   require('metascraper-author')(),
   require('metascraper-date')(),
   require('metascraper-description')(),

packages/metascraper-date/package.json

@@ -31,5 +31,8 @@
   "scripts": {
     "test": "exit 0"
   },
-  "license": "MIT"
+  "license": "MIT",
+  "peerDependencies": {
+    "metascraper": "^3"
+  }
 }

packages/metascraper-description/package.json

@@ -31,5 +31,8 @@
   "scripts": {
     "test": "exit 0"
   },
-  "license": "MIT"
+  "license": "MIT",
+  "peerDependencies": {
+    "metascraper": "^3"
+  }
 }

packages/metascraper-image/package.json

@@ -30,5 +30,8 @@
   "scripts": {
     "test": "exit 0"
   },
-  "license": "MIT"
+  "license": "MIT",
+  "peerDependencies": {
+    "metascraper": "^3"
+  }
 }

packages/metascraper-lang/package.json

@@ -19,7 +19,6 @@
     "lodash": "~4.17.10"
   },
   "devDependencies": {
-    "metascraper": "latest",
     "mocha": "latest",
     "nyc": "latest",
     "should": "latest",
@@ -36,6 +35,9 @@
     "test": "NODE_PATH=.. TZ=UTC NODE_ENV=test nyc mocha test"
   },
   "license": "MIT",
+  "peerDependencies": {
+    "metascraper": "^3"
+  },
   "standard": {
     "env": [
       "mocha"