meodp 0.0.6 → 0.0.8

package/README.md

@@ -43,3 +43,4 @@ lychee 是一个使用 Rust 编写的快速检测链接的命令行。
 ## TODO
 
 - [ ] 文件下载
+- [ ] HTML 报告

package/dist/cli/index.cjs

@@ -1,29 +1,184 @@
 'use strict';
 
-const process = require('node:process');
+const process$1 = require('node:process');
 const c12 = require('c12');
 const consola = require('consola');
 const utils = require('consola/utils');
 const yargs = require('yargs');
 const helpers = require('yargs/helpers');
 require('playwright');
-const config = require('../shared/meodp.c2959ba5.cjs');
+const index = require('../shared/meodp.6b19529e.cjs');
 require('node:path');
 require('strip-ansi');
 require('winston');
 require('p-queue');
-require('date-fns');
-require('fs-extra');
+require('lowdb/node');
+const path = require('path');
+const process = require('process');
+const fs = require('fs-extra');
+const markdownTable = require('markdown-table');
 require('cli-progress');
 require('cli-progress/lib/options.js');
 require('cli-progress/lib/format-bar.js');
 require('cli-progress/lib/format-time.js');
+require('date-fns');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
 
-const process__default = /*#__PURE__*/_interopDefaultCompat(process);
+const process__default$1 = /*#__PURE__*/_interopDefaultCompat(process$1);
 const consola__default = /*#__PURE__*/_interopDefaultCompat(consola);
 const yargs__default = /*#__PURE__*/_interopDefaultCompat(yargs);
+const path__default = /*#__PURE__*/_interopDefaultCompat(path);
+const process__default = /*#__PURE__*/_interopDefaultCompat(process);
+const fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+
+const successIcon = '<font color="green">\u2714</font>';
+const errorIcon = '<font color="red">\u2716</font>';
+function getCheckStatusEmoji(checkStatus) {
+  switch (checkStatus) {
+    case "passed":
+      return "\u2705";
+    case "failed":
+      return "\u274C";
+    case "timeout":
+      return "\u23F0";
+    case "ignored":
+      return "\u{1F47B}";
+    case "goto":
+      return "\u{1F517}";
+    case "pending":
+      return "\u23F3";
+    default:
+      return "";
+  }
+}
+function getErrorMdContent(sites) {
+  const errorSites = Object.entries(sites).filter(([key, value]) => {
+    return ["failed", "timeout"].includes(value.checkStatus);
+  });
+  if (!errorSites.length) {
+    return "No error found.";
+  }
+  let md = "";
+  for (const [key, value] of errorSites) {
+    md += `- [${value.name || value.url}](${value.url})
+`;
+    for (const link of value.links) {
+      if (link.checkStatus === "passed") {
+        continue;
+      }
+      const statusInfo = link.statusText ? `${link.statusCode} ${link.statusText}` : link.statusCode;
+      md += `  - [${statusInfo}] <${link.url}>
+`;
+      for (const req of link.requests) {
+        if (req.failed) {
+          if (req.statusCode) {
+            const statusInfo2 = req.statusText ? `${req.statusCode} ${req.statusText}` : req.statusCode;
+            md += `    - [${statusInfo2}] <${req.url}>
+`;
+          } else {
+            md += `    - [\u23F0 TIMEOUT] <${req.url}>
+`;
+          }
+        }
+      }
+    }
+  }
+  return md;
+}
+async function generateContentFromSiteData(site) {
+  let md = "";
+  const successLength = site.links.filter((link) => link.checkStatus === "passed").length;
+  const failedLength = site.links.filter((link) => link.checkStatus === "failed").length;
+  const timeoutLength = site.links.filter((link) => link.checkStatus === "timeout").length;
+  const summary = `
+> \u{1F517} Links ${site.links.length} | ${successIcon} ${successLength} Passed | ${errorIcon} ${failedLength} Failed | \u23F0 ${timeoutLength} Timeout | \u{1F47B} ${site.ignored.length} Ignored
+
+`;
+  md += summary;
+  const siteArr = [
+    ["", "CheckInfo", "Duration", "URL"]
+  ];
+  site.links?.forEach((link) => {
+    let checkStr = getCheckStatusEmoji(link.checkStatus);
+    let checkInfo = [
+      "<span>**" + link.total + " Requests**</span><br>"
+    ];
+    if (link.success) {
+      checkInfo.push('<font color="green">\u2714</font> ' + link.success);
+    }
+    if (link.failed) {
+      checkInfo.push(errorIcon + " " + link.failed);
+    }
+    if (link.timeout) {
+      checkInfo.push("\u23F0 " + link.timeout);
+    }
+    if (link.ignored) {
+      checkInfo.push("\u{1F47B} " + link.ignored);
+    }
+    (link.statusText ? `${link.statusCode} ${link.statusText}` : link.statusCode).toString();
+    siteArr.push([
+      checkStr,
+      checkInfo.join(" "),
+      // statusStr,
+      link.duration ? `${link.duration}ms` : "",
+      `[${link.url}](${link.url})`
+    ]);
+  });
+  md += markdownTable.markdownTable(siteArr, {
+    align: ["l", "l", "r", "l"]
+  });
+  md += "\n";
+  return md;
+}
+async function outputMarkdown(options = {
+  /**
+   * Show config in markdown
+   */
+  showConfig: false
+}) {
+  const db = await index.createLowDB();
+  await db.read();
+  const rootDir = process__default.cwd();
+  const mdPath = path__default.resolve(rootDir, "logs/meodp/report.md");
+  await fs__default.ensureFile(mdPath);
+  let mdContent = "# MEODP Report\n";
+  if (options.showConfig) {
+    mdContent += `
+<details>
+<summary>Config</summary>
+
+\`\`\`json
+${JSON.stringify(db.data.config, null, 2)}
+\`\`\`
+
+</details>
+`;
+  }
+  mdContent += `
+## Errors
+
+${getErrorMdContent(db.data.sites)}
+`;
+  mdContent += "## Sites\n";
+  for (const [key, value] of Object.entries(db.data.sites)) {
+    const site = value;
+    mdContent += `
+### ${getCheckStatusEmoji(site.checkStatus)} [${site.name || site.url}](${site.url})
+`;
+    mdContent += await generateContentFromSiteData(value);
+  }
+  await fs__default.writeFile(mdPath, mdContent);
+  consola__default.success(`${utils.colors.cyan("Report Markdown File:")} ${utils.colors.gray(mdPath)}`);
+}
+
+async function output(type = "md") {
+  switch (type) {
+    case "md":
+      await outputMarkdown();
+      break;
+  }
+}
 
 function commonOptions(args) {
   return args.positional("root", {
@@ -38,31 +193,46 @@ consola__default.level = 3;
 function debug(name, ...args) {
   consola__default.debug(utils.colors.dim(name), ...args);
 }
-const cli = yargs__default(helpers.hideBin(process__default.argv)).scriptName("meodp").usage("$0 \u68C0\u6D4B\u94FE\u63A5").command(
+const cli = yargs__default(helpers.hideBin(process__default$1.argv)).scriptName("meodp").usage("$0 \u68C0\u6D4B\u94FE\u63A5").command(
   "* [root]",
   "Run MEODP to check links",
   (args) => commonOptions(args),
   async (argv) => {
     debug("argv", argv);
-    const { root = process__default.cwd() } = argv;
-    const { config: config$1, configFile } = await c12.loadConfig({
+    const { root = process__default$1.cwd() } = argv;
+    const { config, configFile } = await c12.loadConfig({
       cwd: root,
       name: "meodp",
-      defaultConfig: config.defaultMEODPConfig
+      defaultConfig: index.defaultMEODPConfig
     });
-    await config.MEODP.init(config$1);
-    debug("config", config$1);
-    config.MEODP.logger.info(`\u{1F6E0}\uFE0F  Config File: ${configFile}`);
-    config.MEODP.config = config$1;
-    config.MEODP.configFile = configFile || "";
-    config.MEODP.logger.start("\u{1F310} Start checking links...");
+    await index.MEODP.init(config);
+    debug("config", config);
+    index.MEODP.logger.info(`\u{1F6E0}\uFE0F  Config File: ${configFile}`);
+    index.MEODP.config = config;
+    index.MEODP.configFile = configFile || "";
+    index.MEODP.logger.start("\u{1F310} Start checking links...");
     const startTime = Date.now();
-    await config.runByConfig(config$1);
+    await index.runByConfig(config);
     const endTime = Date.now();
     const duration = endTime - startTime;
     console.log();
-    config.MEODP.logger.success(`All done! in ${utils.colors.yellow(duration / 1e3)}s.`);
-    process__default.exit(0);
+    index.MEODP.logger.success(`All done! in ${utils.colors.yellow(duration / 1e3)}s.`);
+    console.log();
+    consola__default.start("\u{1F680}  Start exporting Markdown Report...");
+    await output(argv.type);
+    process__default$1.exit(0);
+  }
+).command(
+  "export [root]",
+  "Export MEODP Report",
+  (args) => commonOptions(args).option("type", {
+    alias: "t",
+    describe: "Export type",
+    choices: ["html", "md"],
+    default: "md"
+  }),
+  async (argv) => {
+    await output(argv.type);
   }
 ).alias("h", "help").alias("v", "version").showHelpOnFail(false).help();
 function run() {

package/dist/cli/index.mjs

@@ -1,21 +1,173 @@
-import process from 'node:process';
+import process$1 from 'node:process';
 import { loadConfig } from 'c12';
 import consola from 'consola';
 import { colors } from 'consola/utils';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import 'playwright';
-import { h as defaultMEODPConfig, M as MEODP, r as runByConfig } from '../shared/meodp.9c5df07b.mjs';
+import { j as createLowDB, h as defaultMEODPConfig, M as MEODP, r as runByConfig } from '../shared/meodp.b58178b8.mjs';
 import 'node:path';
 import 'strip-ansi';
 import 'winston';
 import 'p-queue';
-import 'date-fns';
-import 'fs-extra';
+import 'lowdb/node';
+import path from 'path';
+import process from 'process';
+import fs from 'fs-extra';
+import { markdownTable } from 'markdown-table';
 import 'cli-progress';
 import 'cli-progress/lib/options.js';
 import 'cli-progress/lib/format-bar.js';
 import 'cli-progress/lib/format-time.js';
+import 'date-fns';
+
+const successIcon = '<font color="green">\u2714</font>';
+const errorIcon = '<font color="red">\u2716</font>';
+function getCheckStatusEmoji(checkStatus) {
+  switch (checkStatus) {
+    case "passed":
+      return "\u2705";
+    case "failed":
+      return "\u274C";
+    case "timeout":
+      return "\u23F0";
+    case "ignored":
+      return "\u{1F47B}";
+    case "goto":
+      return "\u{1F517}";
+    case "pending":
+      return "\u23F3";
+    default:
+      return "";
+  }
+}
+function getErrorMdContent(sites) {
+  const errorSites = Object.entries(sites).filter(([key, value]) => {
+    return ["failed", "timeout"].includes(value.checkStatus);
+  });
+  if (!errorSites.length) {
+    return "No error found.";
+  }
+  let md = "";
+  for (const [key, value] of errorSites) {
+    md += `- [${value.name || value.url}](${value.url})
+`;
+    for (const link of value.links) {
+      if (link.checkStatus === "passed") {
+        continue;
+      }
+      const statusInfo = link.statusText ? `${link.statusCode} ${link.statusText}` : link.statusCode;
+      md += `  - [${statusInfo}] <${link.url}>
+`;
+      for (const req of link.requests) {
+        if (req.failed) {
+          if (req.statusCode) {
+            const statusInfo2 = req.statusText ? `${req.statusCode} ${req.statusText}` : req.statusCode;
+            md += `    - [${statusInfo2}] <${req.url}>
+`;
+          } else {
+            md += `    - [\u23F0 TIMEOUT] <${req.url}>
+`;
+          }
+        }
+      }
+    }
+  }
+  return md;
+}
+async function generateContentFromSiteData(site) {
+  let md = "";
+  const successLength = site.links.filter((link) => link.checkStatus === "passed").length;
+  const failedLength = site.links.filter((link) => link.checkStatus === "failed").length;
+  const timeoutLength = site.links.filter((link) => link.checkStatus === "timeout").length;
+  const summary = `
+> \u{1F517} Links ${site.links.length} | ${successIcon} ${successLength} Passed | ${errorIcon} ${failedLength} Failed | \u23F0 ${timeoutLength} Timeout | \u{1F47B} ${site.ignored.length} Ignored
+
+`;
+  md += summary;
+  const siteArr = [
+    ["", "CheckInfo", "Duration", "URL"]
+  ];
+  site.links?.forEach((link) => {
+    let checkStr = getCheckStatusEmoji(link.checkStatus);
+    let checkInfo = [
+      "<span>**" + link.total + " Requests**</span><br>"
+    ];
+    if (link.success) {
+      checkInfo.push('<font color="green">\u2714</font> ' + link.success);
+    }
+    if (link.failed) {
+      checkInfo.push(errorIcon + " " + link.failed);
+    }
+    if (link.timeout) {
+      checkInfo.push("\u23F0 " + link.timeout);
+    }
+    if (link.ignored) {
+      checkInfo.push("\u{1F47B} " + link.ignored);
+    }
+    (link.statusText ? `${link.statusCode} ${link.statusText}` : link.statusCode).toString();
+    siteArr.push([
+      checkStr,
+      checkInfo.join(" "),
+      // statusStr,
+      link.duration ? `${link.duration}ms` : "",
+      `[${link.url}](${link.url})`
+    ]);
+  });
+  md += markdownTable(siteArr, {
+    align: ["l", "l", "r", "l"]
+  });
+  md += "\n";
+  return md;
+}
+async function outputMarkdown(options = {
+  /**
+   * Show config in markdown
+   */
+  showConfig: false
+}) {
+  const db = await createLowDB();
+  await db.read();
+  const rootDir = process.cwd();
+  const mdPath = path.resolve(rootDir, "logs/meodp/report.md");
+  await fs.ensureFile(mdPath);
+  let mdContent = "# MEODP Report\n";
+  if (options.showConfig) {
+    mdContent += `
+<details>
+<summary>Config</summary>
+
+\`\`\`json
+${JSON.stringify(db.data.config, null, 2)}
+\`\`\`
+
+</details>
+`;
+  }
+  mdContent += `
+## Errors
+
+${getErrorMdContent(db.data.sites)}
+`;
+  mdContent += "## Sites\n";
+  for (const [key, value] of Object.entries(db.data.sites)) {
+    const site = value;
+    mdContent += `
+### ${getCheckStatusEmoji(site.checkStatus)} [${site.name || site.url}](${site.url})
+`;
+    mdContent += await generateContentFromSiteData(value);
+  }
+  await fs.writeFile(mdPath, mdContent);
+  consola.success(`${colors.cyan("Report Markdown File:")} ${colors.gray(mdPath)}`);
+}
+
+async function output(type = "md") {
+  switch (type) {
+    case "md":
+      await outputMarkdown();
+      break;
+  }
+}
 
 function commonOptions(args) {
   return args.positional("root", {
@@ -30,13 +182,13 @@ consola.level = 3;
 function debug(name, ...args) {
   consola.debug(colors.dim(name), ...args);
 }
-const cli = yargs(hideBin(process.argv)).scriptName("meodp").usage("$0 \u68C0\u6D4B\u94FE\u63A5").command(
+const cli = yargs(hideBin(process$1.argv)).scriptName("meodp").usage("$0 \u68C0\u6D4B\u94FE\u63A5").command(
   "* [root]",
   "Run MEODP to check links",
   (args) => commonOptions(args),
   async (argv) => {
     debug("argv", argv);
-    const { root = process.cwd() } = argv;
+    const { root = process$1.cwd() } = argv;
     const { config, configFile } = await loadConfig({
       cwd: root,
       name: "meodp",
@@ -54,7 +206,22 @@ const cli = yargs(hideBin(process.argv)).scriptName("meodp").usage("$0 \u68C0\u6
     const duration = endTime - startTime;
     console.log();
     MEODP.logger.success(`All done! in ${colors.yellow(duration / 1e3)}s.`);
-    process.exit(0);
+    console.log();
+    consola.start("\u{1F680}  Start exporting Markdown Report...");
+    await output(argv.type);
+    process$1.exit(0);
+  }
+).command(
+  "export [root]",
+  "Export MEODP Report",
+  (args) => commonOptions(args).option("type", {
+    alias: "t",
+    describe: "Export type",
+    choices: ["html", "md"],
+    default: "md"
+  }),
+  async (argv) => {
+    await output(argv.type);
   }
 ).alias("h", "help").alias("v", "version").showHelpOnFail(false).help();
 function run() {

package/dist/index.cjs

@@ -1,25 +1,26 @@
 'use strict';
 
-const config = require('./shared/meodp.c2959ba5.cjs');
-require('consola');
-require('p-queue');
+const index = require('./shared/meodp.6b19529e.cjs');
 require('consola/utils');
 require('playwright');
 require('node:path');
 require('node:process');
-require('date-fns');
-require('fs-extra');
-require('strip-ansi');
-require('winston');
+require('consola');
+require('lowdb/node');
+require('p-queue');
 require('cli-progress');
 require('cli-progress/lib/options.js');
 require('cli-progress/lib/format-bar.js');
 require('cli-progress/lib/format-time.js');
+require('date-fns');
+require('fs-extra');
+require('strip-ansi');
+require('winston');
 
 async function checkSiteMap(urlItem) {
   const { url } = urlItem;
   const robotsUrl = new URL("/robots.txt", url).href;
-  const browser = await config.getBrowser();
+  const browser = await index.getBrowser();
   const page = await browser.newPage();
   await page.goto(robotsUrl);
   const text = await page.textContent("pre");
@@ -33,8 +34,8 @@ async function checkSiteMap(urlItem) {
     return elements.map((element) => element.textContent);
   });
   for (const link of links) {
-    if (link && !config.siteUrlMap.has(link)) {
-      config.siteUrlMap.set(link, {
+    if (link && !index.siteUrlMap.has(link)) {
+      index.siteUrlMap.set(link, {
         statusCode: 0,
         checkStatus: "pending"
       });
@@ -42,31 +43,32 @@ async function checkSiteMap(urlItem) {
   }
 }
 
-exports.LocalLog = config.LocalLog;
-exports.PQueueMap = config.PQueueMap;
-exports.checkLink = config.checkLink;
-exports.checkMEODPUrl = config.checkMEODPUrl;
-exports.checkSite = config.checkSite;
-exports.checkSiteUrl = config.checkSiteUrl;
-exports.checkUrlNomoduleAssets = config.checkUrlNomoduleAssets;
-exports.createMEODPLogger = config.createMEODPLogger;
-exports.createWinstonLogger = config.createWinstonLogger;
-exports.defaultMEODPConfig = config.defaultMEODPConfig;
-exports.defineConfig = config.defineConfig;
-exports.emojiMap = config.emojiMap;
-exports.formatArgs = config.formatArgs;
-exports.getBrowser = config.getBrowser;
-exports.getFormattedDataFromResponse = config.getFormattedDataFromResponse;
-exports.getFormattedDuration = config.getFormattedDuration;
-exports.getMEODPUrlItemInfo = config.getMEODPUrlItemInfo;
-exports.getSiteLinks = config.getSiteLinks;
-exports.isLink = config.isLink;
-exports.localLog = config.localLog;
-exports.logUrlItemInfo = config.logUrlItemInfo;
-exports.multiBar = config.multiBar;
-exports.parseUrlMap = config.parseUrlMap;
-exports.progressBarMap = config.progressBarMap;
-exports.registerPageEvents = config.registerPageEvents;
-exports.runByConfig = config.runByConfig;
-exports.siteUrlMap = config.siteUrlMap;
+exports.LocalLog = index.LocalLog;
+exports.PQueueMap = index.PQueueMap;
+exports.checkLink = index.checkLink;
+exports.checkMEODPUrl = index.checkMEODPUrl;
+exports.checkSite = index.checkSite;
+exports.checkSiteUrl = index.checkSiteUrl;
+exports.checkUrlNomoduleAssets = index.checkUrlNomoduleAssets;
+exports.createLowDB = index.createLowDB;
+exports.createMEODPLogger = index.createMEODPLogger;
+exports.createWinstonLogger = index.createWinstonLogger;
+exports.defaultMEODPConfig = index.defaultMEODPConfig;
+exports.defineConfig = index.defineConfig;
+exports.emojiMap = index.emojiMap;
+exports.formatArgs = index.formatArgs;
+exports.getBrowser = index.getBrowser;
+exports.getFormattedDataFromResponse = index.getFormattedDataFromResponse;
+exports.getFormattedDuration = index.getFormattedDuration;
+exports.getMEODPUrlItemInfo = index.getMEODPUrlItemInfo;
+exports.getSiteLinks = index.getSiteLinks;
+exports.isLink = index.isLink;
+exports.localLog = index.localLog;
+exports.logUrlItemInfo = index.logUrlItemInfo;
+exports.multiBar = index.multiBar;
+exports.parseUrlMap = index.parseUrlMap;
+exports.progressBarMap = index.progressBarMap;
+exports.registerPageEvents = index.registerPageEvents;
+exports.runByConfig = index.runByConfig;
+exports.siteUrlMap = index.siteUrlMap;
 exports.checkSiteMap = checkSiteMap;