social microformats updated

Author: SilentImp

package-lock.json

@@ -1,11 +1,18 @@
 {
   "name": "@frontender-magazine/builder",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "build an article from url",
-  "main": "index.js",
+  "main": "source/index.js",
   "scripts": {
     "precommit": "lint-staged",
-    "lint": "eslint --color -f stylish --fix ./source/linttest/*.jsx"
+    "lint": "eslint --color -f stylish --fix ./source/linttest/*.jsx",
+    "postversion": "git push && git push --tags",
+    "major": "npm version major && npm publish --tag latest --access public",
+    "minor": "npm version minor && npm publish --tag latest --access public",
+    "patch": "npm version patch && npm publish --tag latest --access public",
+    "dopreminor": "npm version preminor && npm publish --tag next --access public",
+    "dopremajor": "npm version premajor && npm publish --tag next --access public",
+    "doprepatch": "npm version prepatch && npm publish --tag next --access public"
   },
   "repository": {
     "type": "git",
@@ -73,6 +80,7 @@
     "joi": "^14.3.1",
     "jsdom": "^16.2.2",
     "keyword-extractor": "0.0.19",
+    "open-graph-scraper": "^3.6.2",
     "path": "^0.12.7",
     "prettier": "^2.0.5",
     "pretty": "^2.0.0",

package.json

@@ -3,12 +3,14 @@ const path = require('path');
 const fs = require('fs');
 const { flatten } = require('array-flatten');
 
-// console.log(flatten);
-
-// process.exit(0);
-
 dotenv.config();
 
+// eslint-disable-next-line no-unused-vars
+const logger = (name) => {
+  console.log(name);
+  return name;
+};
+
 /**
  * ArticleBuilder
  * @class
@@ -66,20 +68,20 @@ class ArticleBuilder {
     };
     let plugins = this.pluginCollector(path.resolve('./source/plugins'));
     // eslint-disable-next-line import/no-dynamic-require, global-require
-    plugins = plugins.map(uri => (require(uri)));
+    plugins = plugins.map((uri) => (require(uri)));
 
-    await flatten(this.stages
+    return flatten(this.stages
       // remove stages we should skip
-      .filter(stage => (!this.skip.stages.includes(stage)))
+      .filter((stage) => (!this.skip.stages.includes(stage)))
       // map stages to plugins array
-      .map(stage => plugins
+      .map((stage) => plugins
       // filter plugin that have no functions for this stage
-        .filter(plugin => ((plugin[stage] !== undefined) && (typeof plugin[stage] === 'function')))
+        .filter((plugin) => ((plugin[stage] !== undefined) && (typeof plugin[stage] === 'function')))
       // filter plugin we need to skip
         .filter((plugin) => {
           const { meta: { name } } = plugin;
           return (this.skip.plugins.find(
-            skippedPlugin => (
+            (skippedPlugin) => (
               (
                 skippedPlugin.name === name
                   && skippedPlugin.stages === undefined
@@ -99,8 +101,9 @@ class ArticleBuilder {
         .sort((pluginA, pluginB) => (
           pluginA.meta.dependency.includes(pluginB.meta.name)
             ? 1 : -1))
+        // .map(logger)
       // map plugins to functions
-        .map(plugin => (plugin[stage]))))
+        .map((plugin) => (plugin[stage]))))
       .reduce(async (state, plugin) => {
         const resolvedState = await state;
         return plugin(resolvedState);
@@ -109,9 +112,32 @@ class ArticleBuilder {
 }
 
 // (async () => {
+//   const builder = new ArticleBuilder();
+//   builder.skip.stages = [
+//     'github:before',
+//     'github',
+//     'github:after',
+//   ];
+//   builder.skip.plugins = [
+//     { name: 'codepenTransform' },
+//     { name: 'codepenTransformIFrame' },
+//     { name: 'createREADME' },
+//     { name: 'downloadImages' },
+//     { name: 'writeMarkdown' },
+//     { name: 'TMPDir' },
+//     { name: 'initGithub' },
+//     { name: 'uploadToRepo' },
+//     { name: 'createRepo' },
+//     { name: 'createREADME' },
+//     { name: 'createCard' },
+//   ];
+
 //   try {
-//     const builder = new ArticleBuilder();
-//     await builder.create('https://www.smashingmagazine.com/2020/05/convince-others-against-dark-patterns/');
+//     const result = await builder.create('https://increment.com/frontend/a-users-guide-to-css-variables/');
+//     // console.log(result);
+//     console.log(result.tags);
+//     console.log(result.mercury[0].author);
+//     console.log(result.openGraph);
 //   } catch (error) {
 //     console.log(error);
 //   }

source/index.js

@@ -25,7 +25,7 @@ module.exports = {
    * @throw {Error} - if some dependencies not met
    */
   dependencyCheck: (stack = [], dependency = [], name = null) => {
-    const error = dependency.find(plugin => (!stack.includes(plugin)));
+    const error = dependency.find((plugin) => (!stack.includes(plugin)));
     if (error !== undefined) throw new Error(`Dependencies ${name ? `of ${name}` : ''} not met: ${error}`);
   },
 
@@ -36,6 +36,6 @@ module.exports = {
    */
   domainCheck: (url, domain) => {
     const currentDomain = /https?:\/\/(?<domain>[^/\\]+)/ig.exec(url);
-    return currentDomain && (domain === currentDomain[1]);
+    return (domain === null) || (currentDomain && (currentDomain[1].includes(domain)));
   },
 };

source/libs/PluginBase.js

@@ -30,7 +30,6 @@ module.exports = deepmerge(pluginBase, {
    * @return {object} - modified article state
    */
   after: (unmodified) => {
-    return unmodified;
     const {
       meta: {
         name,
@@ -52,7 +51,7 @@ module.exports = deepmerge(pluginBase, {
       stack: [],
       ...unmodified,
     };
-    if (domainCheck(url, domain)) return unmodified;
+    if (!domainCheck(url, domain)) return unmodified;
     dependencyCheck(stack, [...dependency, `${name}:before`]);
     const articleDIR = path.resolve(TMP_DIR_NAME, slug);
     rimraf.sync(articleDIR);
@@ -88,8 +87,7 @@ module.exports = deepmerge(pluginBase, {
       stack: [],
       ...unmodified,
     };
-
-    if (domainCheck(url, domain)) return unmodified;
+    if (!domainCheck(url, domain)) return unmodified;
     dependencyCheck(stack, dependency, name);
 
     const articleDIR = path.resolve(TMP_DIR_NAME, slug);

source/plugins/TMPDir/TMPDir.js

@@ -0,0 +1,64 @@
+const deepmerge = require('deepmerge');
+const pluginBase = require('../../libs/PluginBase');
+const TagExtractor = require('../../libs/TagExtractor');
+
+/**
+ * @typedef {object} PluginMeta
+ * @property {string} name - plugin name
+ * @property {string[]} dependency - array of plugins that we need to run first
+ * @property {boolean} async - function return Promise?
+ */
+
+/**
+ * @namespace
+ * @typedef {object} Plugin
+ * @property {PluginMeta} meta - plugins mata data
+ * @property {function} before - plugin function
+ */
+module.exports = deepmerge(pluginBase, {
+  meta: {
+    name: 'alistapart.com',
+    dependency: ['createMarkdown', 'domain', 'getTags'],
+    domain: 'alistapart.com',
+  },
+
+  /**
+   * create README.md file
+   * @param {object} unmodified - current article sate
+   * @return {object} - modified article state
+   */
+  [['mutation:after']]: async (unmodified) => {
+    const {
+      meta: {
+        name,
+        dependency,
+        domain,
+      },
+      dependencyCheck,
+      domainCheck,
+    } = module.exports;
+    const {
+      url,
+      stack,
+      domain: domainName,
+      dom: { original },
+      mercury: [page],
+    } = unmodified;
+    const modified = {
+      tags: [],
+      stack: [],
+      ...unmodified,
+    };
+    const {
+      tags,
+    } = modified;
+
+    if (!domainCheck(url, domain)) return unmodified;
+    dependencyCheck(stack, dependency, name);
+    const extractedTags = [...original.window.document.querySelectorAll('.cat-links a')].map((element) => element.innerHTML);
+    modified.tags = [...extractedTags, domainName];
+    page.author = original.window.document.querySelector('.author.vcard[itemprop="author"] [itemprop="name"]').innerHTML;
+    modified.stack.push(name);
+    return modified;
+  },
+});

source/plugins/alistapart.com/alistapart.com.js

@@ -49,7 +49,7 @@ module.exports = deepmerge(pluginBase, {
         mercury,
       },
     } = modified;
-    if (domainCheck(url, domain)) return unmodified;
+    if (!domainCheck(url, domain)) return unmodified;
     dependencyCheck(stack, dependency, name);
 
     Array.from(mercury.window.document.querySelectorAll('[class*="disqus"],[class*="dsq-"],[id*="disqus"]'))