fix: refine debug

Author: weareoutman

README.md

@@ -115,6 +115,15 @@ html[data-theme="dark"] {
 }
 ```
 
+## Trouble Shooting
+
+When building your docs project, Set the env `DEBUG=search-local:*` to enable [debug](https://github.com/visionmedia/debug) logs.
+
+```shell
+# In your docs project:
+DEBUG=search-local:* yarn build
+```
+
 ## Contributing
 
 See [contributing guide](CONTRIBUTING.md).

src/server/utils/debug.ts

@@ -0,0 +1,6 @@
+import createDebug from "debug";
+
+const debug = createDebug("search-local");
+export const debugVerbose = debug.extend("verbose");
+export const debugInfo = debug.extend("info");
+export const debugWarn = debug.extend("warn");

src/server/utils/parsePage.ts

@@ -1,13 +1,10 @@
 import { ParsedDocument } from "../../shared/interfaces";
+import { debugWarn } from "./debug";
 import { getCondensedText } from "./getCondensedText";
-import _debug from "debug";
-
-const debug = _debug("search-local");
 
 export function parsePage($: cheerio.Root, url: string): ParsedDocument {
   $("a[aria-hidden=true]").remove();
 
-  $("a[aria-hidden=true]").remove();
   let $pageTitle = $("h1").first();
   if ($pageTitle.length === 0) {
     $pageTitle = $("title");
@@ -17,8 +14,8 @@ export function parsePage($: cheerio.Root, url: string): ParsedDocument {
 
   const $main = $("main");
   if ($main.length === 0) {
-    debug(
-      "Page has no <main>, therefore no content was indexed for this page '%s'.",
+    debugWarn(
+      "page has no <main>, therefore no content was indexed for this page %o",
       url
     );
   }

src/server/utils/postBuildFactory.ts

@@ -1,38 +1,37 @@
 import fs from "fs";
 import path from "path";
 import util from "util";
-import _debug from "debug";
 import { ProcessedPluginOptions, PostBuildData } from "../../shared/interfaces";
 import { buildIndex } from "./buildIndex";
+import { debugInfo } from "./debug";
 import { processDocInfos } from "./processDocInfos";
 import { scanDocuments } from "./scanDocuments";
 
-const debug = _debug("search-local");
 const writeFileAsync = util.promisify(fs.writeFile);
 
 export function postBuildFactory(config: ProcessedPluginOptions) {
   return async function postBuild(buildData: PostBuildData): Promise<void> {
-    debug("Gathering documents");
+    debugInfo("gathering documents");
 
     const data = processDocInfos(buildData, config);
 
-    debug("Parsing documents");
+    debugInfo("parsing documents");
 
     // Give every index entry a unique id so that the index does not need to store long URLs.
     const allDocuments = await scanDocuments(data);
 
-    debug("Building index");
+    debugInfo("building index");
 
     const searchIndex = buildIndex(allDocuments, config);
 
-    debug("Writing index to disk");
+    debugInfo("writing index to disk");
 
     await writeFileAsync(
       path.join(buildData.outDir, "search-index.json"),
       JSON.stringify(searchIndex),
       { encoding: "utf8" }
     );
 
-    debug("Index written to disk, success!");
+    debugInfo("index written to disk successfully!");
   };
 }

src/server/utils/scanDocuments.ts

@@ -1,11 +1,11 @@
 import fs from "fs";
+import path from "path";
 import util from "util";
-import _debug from "debug";
 import { DocInfoWithFilePath, SearchDocument } from "../../shared/interfaces";
 import { parse } from "./parse";
+import { debugVerbose } from "./debug";
 
 const readFileAsync = util.promisify(fs.readFile);
-const debug = _debug("search-local");
 
 let nextDocId = 0;
 const getNextDocId = () => {
@@ -22,7 +22,12 @@ export async function scanDocuments(
 
   await Promise.all(
     DocInfoWithFilePathList.map(async ({ filePath, url, type }) => {
-      debug(`Parsing ${type} file ${filePath}`, { url });
+      debugVerbose(
+        `parsing %s file %o of %o`,
+        type,
+        path.relative(process.cwd(), filePath),
+        url
+      );
 
       const html = await readFileAsync(filePath, { encoding: "utf8" });
       const { pageTitle, sections } = parse(html, type, url);