improvements

Author: oscarotero

.gitattributes

@@ -1 +1,9 @@
-* text=auto eol=lf
+* text=auto eol=lf
+
+/.editorconfig export-ignore
+/.gitattributes export-ignore
+/.gitignore export-ignore
+/.github export-ignore
+/.vscode export-ignore
+/test export-ignore
+/deno.json export-ignore

CHANGELOG.md

@@ -6,6 +6,12 @@ and this project try to adheres to [Semantic Versioning](https://semver.org/).
 Go to the `v2` branch to see the changelog of Lume 2.
 Go to the `v1` branch to see the changelog of Lume 1.
 
+## [3.1.2] - Unreleased
+### Fixed
+- Ensure console output for validate_html and seo plugins are after the build process.
+- Added missing tests for SEO plugin.
+- Added export-ignore paths to `.gitattributes`.
+
 ## [3.1.1] - 2025-10-20
 ### Added
 - Plugin `icons`: added [Ionicons catalog](https://ionic.io/ionicons)
@@ -295,6 +301,7 @@ Go to the `v1` branch to see the changelog of Lume 1.
 [#785]: https://github.com/lumeland/lume/issues/785
 [#789]: https://github.com/lumeland/lume/issues/789
 
+[3.1.2]: https://github.com/lumeland/lume/compare/v3.1.1...HEAD
 [3.1.1]: https://github.com/lumeland/lume/compare/v3.1.0...v3.1.1
 [3.1.0]: https://github.com/lumeland/lume/compare/v3.0.11...v3.1.0
 [3.0.11]: https://github.com/lumeland/lume/compare/v3.0.10...v3.0.11

plugins/seo.ts

@@ -62,12 +62,29 @@ export function SEO(userOptions?: Config) {
   const options = merge(defaults, userOptions);
 
   return (site: Lume.Site) => {
+    const reports: Map<string, ErrorMessage[]> = new Map();
+
     site.process(processSEO);
 
+    function output() {
+      // Output
+      const { output } = options;
+      if (typeof output === "function") {
+        output(reports);
+      } else if (typeof output === "string") {
+        outputFile(reports, output);
+      } else {
+        outputConsole(reports);
+      }
+    }
+
+    site.addEventListener("afterUpdate", output);
+    site.addEventListener("afterBuild", output);
+
     function processSEO() {
-      const pages = site.search.pages(options.query);
-      const reports: Map<string, ErrorMessage[]> = new Map();
+      reports.clear();
       refresh();
+      const pages = site.search.pages(options.query);
       for (const page of pages) {
         const errors = validatePage(
           page.page.document,
@@ -80,16 +97,6 @@ export function SEO(userOptions?: Config) {
         }
       }
 
-      // Output
-      const { output } = options;
-      if (typeof output === "function") {
-        output(reports);
-      } else if (typeof output === "string") {
-        outputFile(reports, output);
-      } else {
-        outputConsole(reports);
-      }
-
       const report = site.debugBar?.collection("SEO");
       if (report) {
         report.icon = "list-magnifying-glass";

plugins/validate_html.ts

@@ -50,36 +50,47 @@ export function validateHtml(userOptions?: Config) {
   });
 
   return (site: Lume.Site) => {
+    let reports: Report | undefined;
     site.process([".html"], processValidateHtml);
 
+    function output() {
+      if (!reports) {
+        return;
+      }
+
+      const { output } = options;
+      if (typeof output === "function") {
+        output(reports);
+      } else if (typeof output === "string") {
+        outputFile(reports, output);
+      } else if (output !== false) {
+        outputConsole(reports);
+      }
+    }
+
+    site.addEventListener("afterUpdate", output);
+    site.addEventListener("afterBuild", output);
+
     async function processValidateHtml(pages: Lume.Page[]) {
-      const reports: Set<Report> = new Set();
+      reports = undefined;
+      const pageReports: Set<Report> = new Set();
+
       for (const page of pages) {
         const report = await htmlvalidate.validateString(
           page.text,
           page.data.url,
         );
-        reports.add(report);
+        pageReports.add(report);
       }
 
-      const merged = Reporter.merge(Array.from(reports.values()));
-
-      // Output
-      const { output } = options;
-      if (typeof output === "function") {
-        output(merged);
-      } else if (typeof output === "string") {
-        outputFile(merged, output);
-      } else if (output !== false) {
-        outputConsole(merged);
-      }
+      reports = Reporter.merge(Array.from(pageReports.values()));
 
       const report = site.debugBar?.collection("HTML validator");
       if (report) {
         report.icon = "file-html";
         report.empty = "No HTML errors found! 🎉";
 
-        for (const result of merged.results) {
+        for (const result of reports.results) {
           report.items.push({
             title: result.filePath!,
             items: Array.from(result.messages).map((message) => {

tests/__snapshots__/seo.test.ts.snap

@@ -0,0 +1,13 @@
+export const snapshot = {};
+
+snapshot[`SEO plugin 1`] = `
+[
+  {
+    messages: [
+      "DESCRIPTION_MISSING",
+      "BODY_TOO_SHORT",
+    ],
+    url: "/",
+  },
+]
+`;

tests/assets/seo/index.vto

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>Document</title>
+</head>
+<body>
+  <h1>0</h1>
+</body>
+</html>

tests/seo.test.ts

@@ -0,0 +1,28 @@
+import { build, getSite } from "./utils.ts";
+import { assertSnapshot } from "../deps/snapshot.ts";
+import seo from "../plugins/seo.ts";
+
+Deno.test("SEO plugin", async (t) => {
+  const site = getSite({
+    src: "seo",
+  });
+
+  const result: { url: string; messages: string[] }[] = [];
+
+  site.use(seo({
+    output(reports) {
+      for (const [url, messages] of reports.entries()) {
+        result.push({
+          url,
+          messages: messages.map((msg) =>
+            typeof msg === "string" ? msg : msg.msg
+          ),
+        });
+      }
+    },
+  }));
+
+  await build(site);
+  result.sort((a, b) => a.url.localeCompare(b.url));
+  await assertSnapshot(t, result);
+});