Deploy PR #1431 preview

docs-preview-1431/assets/search-worker.js

@@ -0,0 +1,298 @@
+const isWordBoundary = (char) =>
+  /[A-Z]/.test(char) || /[-_\/.]/.test(char) || /\s/.test(char);
+
+const isCaseTransition = (prev, curr) => {
+  const prevIsUpper = prev.toLowerCase() !== prev;
+  const currIsUpper = curr.toLowerCase() !== curr;
+  return (
+    prevIsUpper && currIsUpper && prev.toLowerCase() !== curr.toLowerCase()
+  );
+};
+
+const findBestSubsequenceMatch = (query, target) => {
+  const n = query.length;
+  const m = target.length;
+
+  if (n === 0 || m === 0) return null;
+
+  const positions = [];
+
+  const memo = new Map();
+  const key = (qIdx, tIdx, gap) => `${qIdx}:${tIdx}:${gap}`;
+
+  const findBest = (qIdx, tIdx, currentGap) => {
+    if (qIdx === n) {
+      return { done: true, positions: [...positions], gap: currentGap };
+    }
+
+    const memoKey = key(qIdx, tIdx, currentGap);
+    if (memo.has(memoKey)) {
+      return memo.get(memoKey);
+    }
+
+    let bestResult = null;
+
+    for (let i = tIdx; i < m; i++) {
+      if (target[i] === query[qIdx]) {
+        positions.push(i);
+        const gap = qIdx === 0 ? 0 : i - positions[positions.length - 2] - 1;
+        const newGap = currentGap + gap;
+
+        if (newGap > m) {
+          positions.pop();
+          continue;
+        }
+
+        const result = findBest(qIdx + 1, i + 1, newGap);
+        positions.pop();
+
+        if (result && (!bestResult || result.gap < bestResult.gap)) {
+          bestResult = result;
+          if (result.gap === 0) break;
+        }
+      }
+    }
+
+    memo.set(memoKey, bestResult);
+    return bestResult;
+  };
+
+  const result = findBest(0, 0, 0);
+  if (!result) return null;
+
+  const consecutive = (() => {
+    let c = 1;
+    for (let i = 1; i < result.positions.length; i++) {
+      if (result.positions[i] === result.positions[i - 1] + 1) {
+        c++;
+      }
+    }
+    return c;
+  })();
+
+  return {
+    positions: result.positions,
+    consecutive,
+    score: calculateMatchScore(query, target, result.positions, consecutive),
+  };
+};
+
+const calculateMatchScore = (query, target, positions, consecutive) => {
+  const n = positions.length;
+  const m = target.length;
+
+  if (n === 0) return 0;
+
+  let score = 1.0;
+
+  const startBonus = (m - positions[0]) / m;
+  score += startBonus * 0.5;
+
+  let gapPenalty = 0;
+  for (let i = 1; i < n; i++) {
+    const gap = positions[i] - positions[i - 1] - 1;
+    if (gap > 0) {
+      gapPenalty += Math.min(gap / m, 1.0) * 0.3;
+    }
+  }
+  score -= gapPenalty;
+
+  const consecutiveBonus = consecutive / n;
+  score += consecutiveBonus * 0.3;
+
+  let boundaryBonus = 0;
+  for (let i = 0; i < n; i++) {
+    const char = target[positions[i]];
+    if (i === 0 || isWordBoundary(char)) {
+      boundaryBonus += 0.05;
+    }
+    if (i > 0) {
+      const prevChar = target[positions[i - 1]];
+      if (isCaseTransition(prevChar, char)) {
+        boundaryBonus += 0.03;
+      }
+    }
+  }
+  score = Math.min(1.0, score + boundaryBonus);
+
+  const lengthPenalty = Math.abs(query.length - n) / Math.max(query.length, m);
+  score -= lengthPenalty * 0.2;
+
+  return Math.max(0, Math.min(1.0, score));
+};
+
+const fuzzyMatch = (query, target) => {
+  const lowerQuery = query.toLowerCase();
+  const lowerTarget = target.toLowerCase();
+
+  if (lowerQuery.length === 0) return null;
+  if (lowerTarget.length === 0) return null;
+
+  if (lowerTarget === lowerQuery) {
+    return 1.0;
+  }
+
+  if (lowerTarget.includes(lowerQuery)) {
+    const ratio = lowerQuery.length / lowerTarget.length;
+    return 0.8 + ratio * 0.2;
+  }
+
+  const match = findBestSubsequenceMatch(lowerQuery, lowerTarget);
+  if (!match) {
+    return null;
+  }
+
+  return Math.min(1.0, match.score);
+};
+
+self.onmessage = function (e) {
+  const { messageId, type, data } = e.data;
+
+  const respond = (type, data) => {
+    self.postMessage({ messageId, type, data });
+  };
+
+  const respondError = (error) => {
+    self.postMessage({
+      messageId,
+      type: "error",
+      error: error.message || String(error),
+    });
+  };
+
+  try {
+    if (type === "tokenize") {
+      const text = typeof data === "string" ? data : "";
+      const words = text.toLowerCase().match(/\b[a-zA-Z0-9_-]+\b/g) || [];
+      const tokens = words.filter((word) => word.length > 2);
+      const uniqueTokens = Array.from(new Set(tokens));
+      respond("tokens", uniqueTokens);
+    } else if (type === "search") {
+      const { query, limit = 10 } = data;
+
+      if (!query || typeof query !== "string") {
+        respond("results", []);
+        return;
+      }
+
+      const rawQuery = query.toLowerCase();
+      const text = typeof query === "string" ? query : "";
+      const words = text.toLowerCase().match(/\b[a-zA-Z0-9_-]+\b/g) || [];
+      const searchTerms = words.filter((word) => word.length > 2);
+
+      let documents = [];
+      if (typeof data.documents === "string") {
+        documents = JSON.parse(data.documents);
+      } else if (Array.isArray(data.documents)) {
+        documents = data.documents;
+      } else if (typeof data.transferables === "string") {
+        documents = JSON.parse(data.transferables);
+      }
+
+      if (!Array.isArray(documents) || documents.length === 0) {
+        respond("results", []);
+        return;
+      }
+
+      const useFuzzySearch = rawQuery.length >= 3;
+
+      if (searchTerms.length === 0 && rawQuery.length < 3) {
+        respond("results", []);
+        return;
+      }
+
+      const pageMatches = new Map();
+
+      // Pre-compute lower-case strings for each document
+      const processedDocs = documents.map((doc, docId) => {
+        const title = typeof doc.title === "string" ? doc.title : "";
+        const content = typeof doc.content === "string" ? doc.content : "";
+
+        return {
+          docId,
+          doc,
+          lowerTitle: title.toLowerCase(),
+          lowerContent: content.toLowerCase(),
+        };
+      });
+
+      // First pass: Score pages with fuzzy matching
+      processedDocs.forEach(({ docId, doc, lowerTitle, lowerContent }) => {
+        let match = pageMatches.get(docId);
+        if (!match) {
+          match = { doc, pageScore: 0, matchingAnchors: [] };
+          pageMatches.set(docId, match);
+        }
+
+        if (useFuzzySearch) {
+          const fuzzyTitleScore = fuzzyMatch(rawQuery, lowerTitle);
+          if (fuzzyTitleScore !== null) {
+            match.pageScore += fuzzyTitleScore * 100;
+          }
+
+          const fuzzyContentScore = fuzzyMatch(rawQuery, lowerContent);
+          if (fuzzyContentScore !== null) {
+            match.pageScore += fuzzyContentScore * 30;
+          }
+        }
+
+        // Token-based exact matching
+        searchTerms.forEach((term) => {
+          if (lowerTitle.includes(term)) {
+            match.pageScore += lowerTitle === term ? 20 : 10;
+          }
+          if (lowerContent.includes(term)) {
+            match.pageScore += 2;
+          }
+        });
+      });
+
+      // Second pass: Find matching anchors
+      pageMatches.forEach((match) => {
+        const doc = match.doc;
+        if (
+          !doc.anchors ||
+          !Array.isArray(doc.anchors) ||
+          doc.anchors.length === 0
+        ) {
+          return;
+        }
+
+        doc.anchors.forEach((anchor) => {
+          if (!anchor || !anchor.text) return;
+
+          const anchorText = anchor.text.toLowerCase();
+          let anchorMatches = false;
+
+          if (useFuzzySearch) {
+            const fuzzyScore = fuzzyMatch(rawQuery, anchorText);
+            if (fuzzyScore !== null && fuzzyScore >= 0.4) {
+              anchorMatches = true;
+            }
+          }
+
+          if (!anchorMatches) {
+            searchTerms.forEach((term) => {
+              if (anchorText.includes(term)) {
+                anchorMatches = true;
+              }
+            });
+          }
+
+          if (anchorMatches) {
+            match.matchingAnchors.push(anchor);
+          }
+        });
+      });
+
+      const results = Array.from(pageMatches.values())
+        .filter((m) => m.pageScore > 5)
+        .sort((a, b) => b.pageScore - a.pageScore)
+        .slice(0, limit);
+
+      respond("results", results);
+    }
+  } catch (error) {
+    respondError(error);
+  }
+};

docs-preview-1431/quirks.html

@@ -0,0 +1,157 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Known Issues and Quirks</title>
+     
+    
+    <script>
+      // Apply sidebar state immediately to prevent flash
+      (function () {
+        try {
+          if (localStorage.getItem("sidebar-collapsed") === "true") {
+            document.documentElement.classList.add("sidebar-collapsed");
+          }
+        } catch (e) {
+          // localStorage unavailable
+        }
+      })();
+    </script>
+    <link rel="stylesheet" href="assets/style.css" />
+    <script defer src="assets/main.js"></script>
+    
+    <script>
+      window.searchNamespace = window.searchNamespace || {};
+      window.searchNamespace.rootPath = "";
+    </script>
+    <script defer src="assets/search.js"></script>
+    
+  </head>
+  <body>
+    <div class="container">
+      <header>
+        <div class="header-left">
+          <h1 class="site-title">
+            <a href="index.html">NVF</a>
+          </h1>
+
+          <nav class="header-nav">
+  <ul>
+    <li >
+      <a href="options.html">Options</a>
+    </li>
+    
+    <li><a href="search.html">Search</a></li>
+    
+  </ul>
+</nav>
+
+        </div>
+        
+        <div class="search-container">
+          <input type="text" id="search-input" placeholder="Search..." />
+          <div id="search-results" class="search-results"></div>
+        </div>
+        
+      </header>
+
+      <div class="layout">
+        <div class="sidebar-toggle" aria-label="Toggle sidebar">
+          <svg
+            xmlns="http://www.w3.org/2000/svg"
+            viewBox="0 0 24 24"
+            width="24"
+            height="24"
+          >
+            <path d="M15.41 7.41L14 6l-6 6 6 6 1.41-1.41L10.83 12z"></path>
+          </svg>
+        </div>
+        <nav class="sidebar">
+          <details class="sidebar-section" data-section="docs" open>
+            <summary>Documents</summary>
+            <div class="sidebar-section-content">
+              <ul>
+                <li><a href="index.html">Introduction</a></li>
+<li><a href="configuring.html">Configuring nvf</a></li>
+<li><a href="hacking.html">Hacking nvf</a></li>
+<li><a href="tips.html">Helpful Tips</a></li>
+<li><a href="quirks.html">Known Issues and Quirks</a></li>
+<li><a href="release-notes.html">Release Notes</a></li>
+<li><a href="search.html">Search</a></li>
+
+              </ul>
+            </div>
+          </details>
+
+          <details class="sidebar-section" data-section="toc" open>
+            <summary>Contents</summary>
+            <div class="sidebar-section-content">
+              <ul class="toc-list">
+                <li><a href="#ch-known-issues-quirks">Known Issues and Quirks</a>
+<ul><li><a href="#ch-quirks-nodejs">NodeJS</a>
+<ul><li><a href="#sec-eslint-plugin-prettier">eslint-plugin-prettier</a>
+</ul><li><a href="#ch-bugs-suggestions">Bugs &amp; Suggestions</a>
+</li></ul></li>
+              </ul>
+            </div>
+          </details>
+        </nav>
+
+        <main class="content"><html><head></head><body><h1 id="ch-known-issues-quirks">Known Issues and Quirks</h1>
+<p>At times, certain plugins and modules may refuse to play nicely with your setup,
+be it a result of generating Lua from Nix, or the state of packaging. This page,
+in turn, will list any known modules or plugins that are known to misbehave, and
+possible workarounds that you may apply.</p>
+<h2 id="ch-quirks-nodejs">NodeJS</h2>
+<h3 id="sec-eslint-plugin-prettier">eslint-plugin-prettier</h3>
+<p>When working with NodeJS, which is <em>obviously</em> known for its meticulous
+standards, most things are bound to work as expected but some projects, tools
+and settings may fool the default configurations of tools provided by <strong>nvf</strong>.</p>
+<p>If <a href="https://github.com/prettier/eslint-plugin-prettier">eslint-plugin-prettier</a> or similar is included, you might get a situation
+where your Eslint configuration diagnoses your formatting according to its own
+config (usually <code>.eslintrc.js</code>). The issue there is your formatting is made via
+prettierd.</p>
+<p>This results in auto-formatting relying on your prettier configuration, while
+your Eslint configuration diagnoses formatting "issues" while it's
+<a href="https://prettier.io/docs/en/comparison.html">not supposed to</a>. In the end, you get discrepancies between what your editor
+does and what it wants.</p>
+<p>Solutions are:</p>
+<ol>
+<li>Don't add a formatting config to Eslint, instead separate Prettier and
+Eslint.</li>
+<li>PR the repo in question to add an ESLint formatter, and configure <strong>nvf</strong> to
+use it.</li>
+</ol>
+<h2 id="ch-bugs-suggestions">Bugs &amp; Suggestions</h2>
+<p>Some quirks are not exactly quirks, but bugs in the module system. If you notice
+any issues with <strong>nvf</strong>, or this documentation, then please consider reporting
+them over at the <a href="https://github.com/notashelf/nvf/issues">issue tracker</a>. Issues tab, in addition to the
+<a href="https://github.com/notashelf/nvf/discussions">discussions tab</a> is a good place as any to request new features.</p>
+<p>You may also consider submitting bug fixes, feature additions and upstreamed
+changes that you think are critical over at the <a href="https://github.com/notashelf/nvf/pulls">pull requests tab</a>.</p>
+</body></html></main>
+      </div>
+
+      <aside class="page-toc">
+        <nav class="page-toc-nav">
+          <h3>On this page</h3>
+          <ul class="page-toc-list">
+            <li><a href="#ch-known-issues-quirks">Known Issues and Quirks</a>
+<ul><li><a href="#ch-quirks-nodejs">NodeJS</a>
+<ul><li><a href="#sec-eslint-plugin-prettier">eslint-plugin-prettier</a>
+</ul><li><a href="#ch-bugs-suggestions">Bugs &amp; Suggestions</a>
+</li></ul></li>
+          </ul>
+        </nav>
+      </aside>
+
+      <footer>
+  <p>Generated with ndg</p>
+</footer>
+
+    </div>
+
+    
+  </body>
+</html>

docs-preview-1431/search.html

@@ -0,0 +1,140 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>NVF - Search</title>
+     
+    
+    <script>
+      // Apply sidebar state immediately to prevent flash
+      (function () {
+        try {
+          if (localStorage.getItem("sidebar-collapsed") === "true") {
+            document.documentElement.classList.add("sidebar-collapsed");
+          }
+        } catch (e) {
+          // localStorage unavailable
+        }
+      })();
+    </script>
+    <link rel="stylesheet" href="assets/style.css" />
+    <script defer src="assets/main.js"></script>
+    <script>
+      window.searchNamespace = window.searchNamespace || {};
+      window.searchNamespace.rootPath = "";
+    </script>
+    <script defer src="assets/search.js"></script>
+  </head>
+  <body>
+    <div class="container">
+      <header>
+        <div class="header-left">
+          <h1 class="site-title">
+            <a href="index.html">NVF</a>
+          </h1>
+        </div>
+        <nav class="header-nav">
+  <ul>
+    <li >
+      <a href="options.html">Options</a>
+    </li>
+    
+    <li><a href="search.html">Search</a></li>
+    
+  </ul>
+</nav>
+
+        <div class="search-container">
+          <input
+            type="search"
+            id="search-input"
+            placeholder="Search..."
+            aria-label="Search"
+            autocomplete="off"
+          />
+          <div
+            id="search-results"
+            class="search-results"
+            role="region"
+            aria-live="polite"
+            aria-label="Search results"
+          ></div>
+        </div>
+      </header>
+
+      <div class="layout">
+        <div class="sidebar-toggle" aria-label="Toggle sidebar">
+          <svg
+            xmlns="http://www.w3.org/2000/svg"
+            viewBox="0 0 24 24"
+            width="24"
+            height="24"
+          >
+            <path d="M15.41 7.41L14 6l-6 6 6 6 1.41-1.41L10.83 12z"></path>
+          </svg>
+        </div>
+        <nav id="sidebar" class="sidebar">
+          <div class="docs-nav">
+            <h2>Documents</h2>
+            <ul>
+              <li><a href="index.html">Introduction</a></li>
+<li><a href="configuring.html">Configuring nvf</a></li>
+<li><a href="hacking.html">Hacking nvf</a></li>
+<li><a href="tips.html">Helpful Tips</a></li>
+<li><a href="quirks.html">Known Issues and Quirks</a></li>
+<li><a href="release-notes.html">Release Notes</a></li>
+<li><a href="search.html">Search</a></li>
+
+            </ul>
+          </div>
+
+          <div class="toc">
+            <h2>Contents</h2>
+            <ul class="toc-list">
+              
+            </ul>
+          </div>
+        </nav>
+
+        <main class="content">
+          <h1>Search</h1>
+          <div class="search-page">
+            <div class="search-form">
+              <input
+                type="search"
+                id="search-page-input"
+                placeholder="Search..."
+                aria-label="Search"
+                autocomplete="off"
+                autofocus
+              />
+            </div>
+            <div class="search-keyboard-hints" role="note" aria-label="Keyboard shortcuts">
+              <span class="hint-item"><kbd>↑</kbd> <kbd>↓</kbd> to navigate</span>
+              <span class="hint-item"><kbd>Enter</kbd> to select</span>
+              <span class="hint-item"><kbd>Esc</kbd> to clear</span>
+            </div>
+            <div
+              id="search-page-results"
+              class="search-page-results"
+              role="region"
+              aria-live="polite"
+              aria-label="Search results"
+            ></div>
+          </div>
+          <div class="footnotes-container">
+            <!-- Footnotes will be appended here -->
+          </div>
+        </main>
+      </div>
+
+      <footer>
+  <p>Generated with ndg</p>
+</footer>
+
+    </div>
+
+    
+  </body>
+</html>