Add flaws check / fix to cli

- add flaws check to validate
- add flaws command

Author: fiji-flo

build/flaws.js

@@ -315,6 +315,8 @@ async function fixFixableFlaws(doc, options, document) {
 
   let newRawHTML = document.rawHTML;
 
+  const phrasing = options.fixFlawsDryRun ? "Would fix" : "Fixed";
+
   const loud = options.fixFlawsDryRun || options.fixFlawsVerbose;
 
   // Any 'macros' of type "MacroRedirectedLinkError"...
@@ -333,7 +335,7 @@ async function fixFixableFlaws(doc, options, document) {
       if (loud) {
         console.log(
           chalk.grey(
-            `Fixed macro ${chalk.white.bold(
+            `${phrasing} (${flaw.id}) macro ${chalk.white.bold(
               flaw.macroSource
             )} to ${chalk.white.bold(newMacroSource)}`
           )
@@ -357,7 +359,7 @@ async function fixFixableFlaws(doc, options, document) {
     if (loud) {
       console.log(
         chalk.grey(
-          `Fixed broken_link ${chalk.white.bold(
+          `${phrasing} (${flaw.id}) broken_link ${chalk.white.bold(
             flaw.href
           )} to ${chalk.white.bold(flaw.suggestion)}`
         )
@@ -379,7 +381,7 @@ async function fixFixableFlaws(doc, options, document) {
     // flaw, but this time actually make the mutation.
     newRawHTML = newRawHTML.replace(flaw.html, flaw.suggestion);
     if (loud) {
-      console.log(chalk.grey(`Fixed pre_with_html`));
+      console.log(chalk.grey(`${phrasing} (${flaw.id}) pre_with_html`));
     }
   }
 
@@ -429,9 +431,9 @@ async function fixFixableFlaws(doc, options, document) {
     if (loud) {
       console.log(
         chalk.grey(
-          `Fixed image ${chalk.white.bold(flaw.src)} to ${chalk.white.bold(
-            newSrc
-          )}`
+          `${phrasing} (${flaw.id}) image ${chalk.white.bold(
+            flaw.src
+          )} to ${chalk.white.bold(newSrc)}`
         )
       );
     }
@@ -440,10 +442,10 @@ async function fixFixableFlaws(doc, options, document) {
   // Finally, summarized what happened...
   if (newRawHTML !== document.rawHTML) {
     // It changed the raw HTML of the source. So deal with this.
-    if (options.fixFlawsDryRun) {
+    if (options.fixFlawsDryRun && options.fixFlawsVerbose) {
       console.log(
         chalk.yellow(
-          `Would have modified "${document.fileInfo.path}", if this was not a dry run.`
+          `Would modify "${document.fileInfo.path}" from fixable flaws.`
         )
       );
     } else {

build/index.js

@@ -212,7 +212,7 @@ async function buildDocument(document, documentOptions = {}) {
                 flaw.redirectInfo.suggested
               )
             : null;
-          const id = `macro_flaw${i}`;
+          const id = `macro${i}`;
           return Object.assign({ id, fixable, suggestion }, flaw);
         });
       }

docs/cli-tool.md

@@ -52,3 +52,7 @@ Run basic validation for a document (only verifies the slug for now).
 
 Open a preview of a given slug in your browser. This depends on a running
 dev-server (`yarn start`).
+
+### flaws
+
+Show and optionally fix fixable flaws for a given slug.

testing/tests/destructive.test.js

@@ -93,7 +93,7 @@ describe("fixing flaws", () => {
       ),
     }).toString();
 
-    const regexPattern = /Would have modified "(.*)", if this was not a dry run/g;
+    const regexPattern = /Would modify "(.*)"./g;
     const dryRunNotices = stdout
       .split("\n")
       .filter((line) => regexPattern.test(line));

tool/cli.js

@@ -9,6 +9,7 @@ const path = require("path");
 
 const { DEFAULT_LOCALE, VALID_LOCALES } = require("../libs/constants");
 const { Redirect, Document, buildURL } = require("../content");
+const { buildDocument } = require("../build");
 
 const PORT = parseInt(process.env.SERVER_PORT || "5000");
 
@@ -202,8 +203,28 @@ program
   .action(
     tryOrExit(async ({ args }) => {
       const { slug, locale } = args;
-      Document.validate(slug, locale);
-      console.log(chalk.green("✓ All seems fine"));
+      let okay = true;
+      const document = Document.findByURL(buildURL(locale, slug));
+      const { doc } = await buildDocument(document);
+
+      if (doc.flaws) {
+        const flaws = Object.values(doc.flaws)
+          .map((a) => a.length || 0)
+          .reduce((a, b) => a + b);
+        console.log(chalk.red(`Found ${flaws} flaws.`));
+        okay = false;
+      }
+      try {
+        Document.validate(slug, locale);
+      } catch (e) {
+        console.log(chalk.red(e));
+        okay = false;
+      }
+      if (okay) {
+        console.log(chalk.green("✓ All seems fine"));
+      } else {
+        console.log(chalk.red("✗ Found some issues"));
+      }
     })
   )
 
@@ -219,6 +240,40 @@ program
       const url = `http://localhost:${PORT}${buildURL(locale, slug)}`;
       await open(url);
     })
+  )
+
+  .command("flaws", "Find (and fix) flaws in a document")
+  .argument("<slug>", "Slug of the document in question")
+  .argument("[locale]", "Locale", {
+    default: DEFAULT_LOCALE,
+    validator: [...VALID_LOCALES.values()],
+  })
+  .option("-y, --yes", "Assume yes", { default: false })
+  .action(
+    tryOrExit(async ({ args, options }) => {
+      const { slug, locale } = args;
+      const { yes } = options;
+      const document = Document.findByURL(buildURL(locale, slug));
+      const { doc } = await buildDocument(document, {
+        fixFlaws: true,
+        fixFlawsDryRun: true,
+      });
+
+      const flaws = Object.values(doc.flaws)
+        .map((a) => a.filter((f) => f.fixable).length || 0)
+        .reduce((a, b) => a + b);
+      const { run } = yes
+        ? true
+        : await prompts({
+            type: "confirm",
+            message: `Proceed fixing ${flaws} flaws?`,
+            name: "run",
+            initial: true,
+          });
+      if (run) {
+        buildDocument(document, { fixFlaws: true, fixFlawsVerbose: true });
+      }
+    })
   );
 
 program.run();