chore: add rules.pkgName

packages/metascraper-amazon/src/index.js

@@ -60,5 +60,7 @@ module.exports = () => {
 
   rules.test = ({ url }) => test(url)
 
+  rules.pkgName = 'metascraper-amazon'
+
   return rules
 }

packages/metascraper-audio/src/index.js

@@ -78,7 +78,7 @@ const _getIframe = (url, $, { src }) =>
   loadIframe(url, $.load(`<iframe src="${src}"></iframe>`))
 
 module.exports = ({ getIframe = _getIframe } = {}) => {
-  return {
+  const rules = {
     audio: audioRules.concat(
       async ({ htmlDom: $, url }) => {
         const srcs = [
@@ -110,4 +110,8 @@ module.exports = ({ getIframe = _getIframe } = {}) => {
       }
     )
   }
+
+  rules.pkgName = 'metascraper-audio'
+
+  return rules
 }

packages/metascraper-author/src/index.js

@@ -24,27 +24,33 @@ const strict = rule => $ => {
   return REGEX_STRICT.test(value) && value
 }
 
-module.exports = () => ({
-  author: [
-    toAuthor($jsonld('author.name')),
-    toAuthor($jsonld('brand.name')),
-    toAuthor($ => $('meta[name="author"]').attr('content')),
-    toAuthor($ => $('meta[property="article:author"]').attr('content')),
-    toAuthor($ => $filter($, $('[itemprop*="author" i] [itemprop="name"]'))),
-    toAuthor($ => $filter($, $('[itemprop*="author" i]'))),
-    toAuthor($ => $filter($, $('[rel="author"]'))),
-    strict(toAuthor($ => $filter($, $('a[class*="author" i]')))),
-    strict(toAuthor($ => $filter($, $('[class*="author" i] a')))),
-    strict(toAuthor($ => $filter($, $('a[href*="/author/" i]')))),
-    toAuthor($ => $filter($, $('a[class*="screenname" i]'))),
-    strict(toAuthor($ => $filter($, $('[class*="author" i]')))),
-    strict(
-      toAuthor($ =>
-        $filter($, $('[class*="byline" i]'), el => {
-          const value = $filter.fn(el)
-          return !date(value) && value
-        })
+module.exports = () => {
+  const rules = {
+    author: [
+      toAuthor($jsonld('author.name')),
+      toAuthor($jsonld('brand.name')),
+      toAuthor($ => $('meta[name="author"]').attr('content')),
+      toAuthor($ => $('meta[property="article:author"]').attr('content')),
+      toAuthor($ => $filter($, $('[itemprop*="author" i] [itemprop="name"]'))),
+      toAuthor($ => $filter($, $('[itemprop*="author" i]'))),
+      toAuthor($ => $filter($, $('[rel="author"]'))),
+      strict(toAuthor($ => $filter($, $('a[class*="author" i]')))),
+      strict(toAuthor($ => $filter($, $('[class*="author" i] a')))),
+      strict(toAuthor($ => $filter($, $('a[href*="/author/" i]')))),
+      toAuthor($ => $filter($, $('a[class*="screenname" i]'))),
+      strict(toAuthor($ => $filter($, $('[class*="author" i]')))),
+      strict(
+        toAuthor($ =>
+          $filter($, $('[class*="byline" i]'), el => {
+            const value = $filter.fn(el)
+            return !date(value) && value
+          })
+        )
       )
-    )
-  ]
-})
+    ]
+  }
+
+  rules.pkgName = 'metascraper-author'
+
+  return rules
+}

packages/metascraper-clearbit/src/index.js

@@ -43,8 +43,12 @@ module.exports = opts => {
   const clearbit = createClearbit(opts)
   const getClearbit = composeRule(($, url) => clearbit(parseUrl(url).domain))
 
-  return {
+  const rules = {
     logo: getClearbit({ from: 'logo' }),
     publisher: getClearbit({ from: 'name', to: 'publisher' })
   }
+
+  rules.pkgName = 'metascraper-clearbit'
+
+  return rules
 }

packages/metascraper-date/src/index.js

@@ -43,17 +43,19 @@ module.exports = (
     dateModified: false
   }
 ) => {
-  const result = {
+  const rules = {
     date: dateModifiedRules().concat(datePublishedRules(), dateRules())
   }
 
   if (datePublished) {
-    result.datePublished = datePublishedRules()
+    rules.datePublished = datePublishedRules()
   }
 
   if (dateModified) {
-    result.dateModified = dateModifiedRules()
+    rules.dateModified = dateModifiedRules()
   }
 
-  return result
+  rules.pkgName = 'metascraper-date'
+
+  return rules
 }

packages/metascraper-description/src/index.js

@@ -5,7 +5,7 @@ const { $jsonld, toRule, description } = require('@metascraper/helpers')
 module.exports = opts => {
   const toDescription = toRule(description, opts)
 
-  return {
+  const rules = {
     description: [
       toDescription($ => $('meta[property="og:description"]').attr('content')),
       toDescription($ => $('meta[name="twitter:description"]').attr('content')),
@@ -18,4 +18,8 @@ module.exports = opts => {
       toDescription($jsonld('description'))
     ]
   }
+
+  rules.pkgName = 'metascraper-description'
+
+  return rules
 }

packages/metascraper-feed/src/index.js

@@ -5,11 +5,15 @@ const { toRule, url } = require('@metascraper/helpers')
 const toUrl = toRule(url)
 
 module.exports = () => {
-  return {
+  const rules = {
     feed: [
       toUrl($ => $('link[type="application/rss+xml"]').attr('href')),
       toUrl($ => $('link[type="application/feed+json"]').attr('href')),
       toUrl($ => $('link[type="application/atom+xml"]').attr('href'))
     ]
   }
+
+  rules.pkgName = 'metascraper-feed'
+
+  return rules
 }

packages/metascraper-iframe/src/index.js

@@ -25,6 +25,8 @@ module.exports = ({ gotOpts } = {}) => {
 
   rules.test = ({ url, htmlDom }) => test(url, htmlDom)
 
+  rules.pkgName = 'metascraper-iframe'
+
   return rules
 }
 

packages/metascraper-image/src/index.js

@@ -6,22 +6,28 @@ const toImage = toRule(image)
 
 const getSrc = el => el.attr('src')
 
-module.exports = () => ({
-  image: [
-    toImage($ => $('meta[property="og:image:secure_url"]').attr('content')),
-    toImage($ => $('meta[property="og:image:url"]').attr('content')),
-    toImage($ => $('meta[property="og:image"]').attr('content')),
-    toImage($ => $('meta[name="twitter:image:src"]').attr('content')),
-    toImage($ => $('meta[property="twitter:image:src"]').attr('content')),
-    toImage($ => $('meta[name="twitter:image"]').attr('content')),
-    toImage($ => $('meta[property="twitter:image"]').attr('content')),
-    toImage($ => $('meta[itemprop="image"]').attr('content')),
-    toImage($jsonld('image.0.url')),
-    toImage($jsonld('image.url')),
-    toImage($jsonld('image')),
-    toImage($ => $filter($, $('article img[src]'), getSrc)),
-    toImage($ => $filter($, $('#content img[src]'), getSrc)),
-    toImage($ => $('img[alt*="author" i]').attr('src')),
-    toImage($ => $('img[src]:not([aria-hidden="true"])').attr('src'))
-  ]
-})
+module.exports = () => {
+  const rules = {
+    image: [
+      toImage($ => $('meta[property="og:image:secure_url"]').attr('content')),
+      toImage($ => $('meta[property="og:image:url"]').attr('content')),
+      toImage($ => $('meta[property="og:image"]').attr('content')),
+      toImage($ => $('meta[name="twitter:image:src"]').attr('content')),
+      toImage($ => $('meta[property="twitter:image:src"]').attr('content')),
+      toImage($ => $('meta[name="twitter:image"]').attr('content')),
+      toImage($ => $('meta[property="twitter:image"]').attr('content')),
+      toImage($ => $('meta[itemprop="image"]').attr('content')),
+      toImage($jsonld('image.0.url')),
+      toImage($jsonld('image.url')),
+      toImage($jsonld('image')),
+      toImage($ => $filter($, $('article img[src]'), getSrc)),
+      toImage($ => $filter($, $('#content img[src]'), getSrc)),
+      toImage($ => $('img[alt*="author" i]').attr('src')),
+      toImage($ => $('img[src]:not([aria-hidden="true"])').attr('src'))
+    ]
+  }
+
+  rules.pkgName = 'metascraper-image'
+
+  return rules
+}

packages/metascraper-instagram/src/index.js

@@ -48,5 +48,7 @@ module.exports = () => {
 
   rules.test = ({ url }) => test(url)
 
+  rules.pkgName = 'metascraper-instagram'
+
   return rules
 }

packages/metascraper-lang/src/index.js

@@ -4,10 +4,16 @@ const { lang, toRule } = require('@metascraper/helpers')
 
 const toLang = toRule(lang)
 
-module.exports = () => ({
-  lang: [
-    toLang($ => $('meta[property="og:locale"]').attr('content')),
-    toLang($ => $('meta[itemprop="inLanguage"]').attr('content')),
-    toLang($ => $('html').attr('lang'))
-  ]
-})
+module.exports = () => {
+  const rules = {
+    lang: [
+      toLang($ => $('meta[property="og:locale"]').attr('content')),
+      toLang($ => $('meta[itemprop="inLanguage"]').attr('content')),
+      toLang($ => $('html').attr('lang'))
+    ]
+  }
+
+  rules.pkgName = 'metascraper-lang'
+
+  return rules
+}

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

@@ -237,7 +237,7 @@ module.exports = ({
     withGoogle
   })
   const rootFavicon = createRootFavicon({ getLogo, withRootFavicon })
-  return {
+  const rules = {
     logo: [
       toLogo(async ($, url) => {
         const sizes = getSizes($, sizeSelectors, url)
@@ -251,6 +251,10 @@ module.exports = ({
       rootFavicon
     ].filter(Boolean)
   }
+
+  rules.pkgName = 'metascraper-logo-favicon'
+
+  return rules
 }
 
 module.exports.google = google

packages/metascraper-logo/src/index.js

@@ -20,7 +20,7 @@ module.exports = ({ filter } = {}) => {
 
   const toLogo = toRule(mapper)
 
-  return {
+  const rules = {
     logo: [
       toLogo($ => $('meta[property="og:logo"]').attr('content')),
       toLogo($ => $('meta[itemprop="logo"]').attr('content')),
@@ -35,4 +35,8 @@ module.exports = ({ filter } = {}) => {
       toLogo($ => toLogoUrl($, 'logo'))
     ]
   }
+
+  rules.pkgName = 'metascraper-logo'
+
+  return rules
 }

packages/metascraper-media-provider/src/index.js

@@ -136,7 +136,7 @@ const getDescription = ({ description }) => descriptionFn(description)
 module.exports = (opts = {}) => {
   const getMedia = createGetMedia(opts)
 
-  return {
+  const rules = {
     audio: async ({ url }) => getAudio(await getMedia(url)),
     author: async ({ url }) => getAuthor(await getMedia(url)),
     date: async ({ url }) => getDate(await getMedia(url)),
@@ -147,6 +147,10 @@ module.exports = (opts = {}) => {
     title: async ({ url }) => getTitle(await getMedia(url)),
     video: async ({ url }) => getVideo(await getMedia(url))
   }
+
+  rules.pkgName = 'metascraper-media-provider'
+
+  return rules
 }
 
 module.exports.getAudio = getAudio

packages/metascraper-publisher/src/index.js

@@ -14,35 +14,45 @@ const getFromTitle = (text, regex = REGEX_TITLE) => {
   return result
 }
 
-module.exports = () => ({
-  publisher: [
-    toPublisher($jsonld('publisher.name')),
-    toPublisher($ => $('meta[property="og:site_name"]').attr('content')),
-    toPublisher($ => $('meta[name*="application-name" i]').attr('content')),
-    toPublisher($ => $('meta[name*="app-title" i]').attr('content')),
-    toPublisher($ => $('meta[property*="app_name" i]').attr('content')),
-    toPublisher($ => $('meta[name="publisher" i]').attr('content')),
-    toPublisher($ => $('meta[name="twitter:app:name:iphone"]').attr('content')),
-    toPublisher($ =>
-      $('meta[property="twitter:app:name:iphone"]').attr('content')
-    ),
-    toPublisher($ => $('meta[name="twitter:app:name:ipad"]').attr('content')),
-    toPublisher($ =>
-      $('meta[property="twitter:app:name:ipad"]').attr('content')
-    ),
-    toPublisher($ =>
-      $('meta[name="twitter:app:name:googleplay"]').attr('content')
-    ),
-    toPublisher($ =>
-      $('meta[property="twitter:app:name:googleplay"]').attr('content')
-    ),
-    toPublisher($ => $filter($, $('#logo'))),
-    toPublisher($ => $filter($, $('.logo'))),
-    toPublisher($ => $filter($, $('a[class*="brand" i]'))),
-    toPublisher($ => $('[class*="logo" i] a img[alt]').attr('alt')),
-    toPublisher($ => $('[class*="logo" i] img[alt]').attr('alt')),
-    toPublisher($ => $filter($, $('title'), el => getFromTitle($filter.fn(el))))
-  ]
-})
+module.exports = () => {
+  const rules = {
+    publisher: [
+      toPublisher($jsonld('publisher.name')),
+      toPublisher($ => $('meta[property="og:site_name"]').attr('content')),
+      toPublisher($ => $('meta[name*="application-name" i]').attr('content')),
+      toPublisher($ => $('meta[name*="app-title" i]').attr('content')),
+      toPublisher($ => $('meta[property*="app_name" i]').attr('content')),
+      toPublisher($ => $('meta[name="publisher" i]').attr('content')),
+      toPublisher($ =>
+        $('meta[name="twitter:app:name:iphone"]').attr('content')
+      ),
+      toPublisher($ =>
+        $('meta[property="twitter:app:name:iphone"]').attr('content')
+      ),
+      toPublisher($ => $('meta[name="twitter:app:name:ipad"]').attr('content')),
+      toPublisher($ =>
+        $('meta[property="twitter:app:name:ipad"]').attr('content')
+      ),
+      toPublisher($ =>
+        $('meta[name="twitter:app:name:googleplay"]').attr('content')
+      ),
+      toPublisher($ =>
+        $('meta[property="twitter:app:name:googleplay"]').attr('content')
+      ),
+      toPublisher($ => $filter($, $('#logo'))),
+      toPublisher($ => $filter($, $('.logo'))),
+      toPublisher($ => $filter($, $('a[class*="brand" i]'))),
+      toPublisher($ => $('[class*="logo" i] a img[alt]').attr('alt')),
+      toPublisher($ => $('[class*="logo" i] img[alt]').attr('alt')),
+      toPublisher($ =>
+        $filter($, $('title'), el => getFromTitle($filter.fn(el)))
+      )
+    ]
+  }
+
+  rules.pkgName = 'metascraper-publisher'
+
+  return rules
+}
 
 module.exports.getFromTitle = getFromTitle

packages/metascraper-readability/src/index.js

@@ -22,11 +22,15 @@ const readability = memoizeOne((url, html) => {
 const getReadbility = composeRule(($, url) => readability(url, $.html()))
 
 module.exports = () => {
-  return {
+  const rules = {
     author: getReadbility({ from: 'byline', to: 'author' }),
     description: getReadbility({ from: 'excerpt', to: 'description' }),
     lang: getReadbility({ from: 'lang' }),
     publisher: getReadbility({ from: 'siteName', to: 'publisher' }),
     title: getReadbility({ from: 'title' })
   }
+
+  rules.pkgName = 'metascraper-readability'
+
+  return rules
 }