Move structured data testing into HTML validate plugin framework #155
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,176 @@ | ||||||
| import { Rule } from "html-validate"; | ||||||
| import { execSync } from "child_process"; | ||||||
| import fs from "fs"; | ||||||
| import path from "path"; | ||||||
|
|
||||||
| export default class StructuredDataRule extends Rule { | ||||||
| documentation() { | ||||||
| return { | ||||||
| description: "Validate JSON-LD structured data using structured-data-testing-tool", | ||||||
| url: "https://github.com/fulldecent/github-pages-template/#structured-data", | ||||||
| }; | ||||||
| } | ||||||
|
|
||||||
| setup() { | ||||||
| this.on("tag:ready", this.tagReady.bind(this)); | ||||||
| } | ||||||
|
|
||||||
| tagReady({ target }) { | ||||||
| if (target.tagName === "script") { | ||||||
| const type = target.getAttribute("type")?.value; | ||||||
|
|
||||||
| // Only process script tags with type="application/ld+json" | ||||||
| if (type === "application/ld+json") { | ||||||
| this.validateJsonLd(target); | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| validateJsonLd(scriptElement) { | ||||||
| // Try to read the file content directly and extract the script | ||||||
| if (scriptElement.location && scriptElement.location.filename) { | ||||||
| try { | ||||||
| const fileContent = fs.readFileSync(scriptElement.location.filename, "utf8"); | ||||||
| const lines = fileContent.split("\n"); | ||||||
|
|
||||||
| // Find script tag boundaries | ||||||
| let startLine = -1; | ||||||
| let endLine = -1; | ||||||
| let inScript = false; | ||||||
|
|
||||||
| for (let i = 0; i < lines.length; i++) { | ||||||
| const line = lines[i]; | ||||||
| if (line.includes('<script type="application/ld+json">')) { | ||||||
| startLine = i + 1; // Start after the opening tag | ||||||
| inScript = true; | ||||||
| } else if (inScript && line.includes("</script>")) { | ||||||
| endLine = i; | ||||||
| break; | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| if (startLine >= 0 && endLine >= 0) { | ||||||
| const scriptContent = lines.slice(startLine, endLine).join("\n").trim(); | ||||||
|
|
||||||
| if (scriptContent) { | ||||||
| this.testStructuredData(scriptContent, scriptElement); | ||||||
| return; | ||||||
| } | ||||||
| } | ||||||
| } catch (error) { | ||||||
| this.report({ | ||||||
| node: scriptElement, | ||||||
| message: `Error reading file for structured data validation: ${error.message}`, | ||||||
| }); | ||||||
| return; | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| this.report({ | ||||||
| node: scriptElement, | ||||||
| message: "JSON-LD script tag is empty or cannot be read", | ||||||
| }); | ||||||
| } | ||||||
|
|
||||||
| testStructuredData(content, scriptElement) { | ||||||
| // Create a temporary HTML file with just this JSON-LD script | ||||||
| const tempDir = "/tmp"; | ||||||
|
There was a problem hiding this comment. Hardcoded |
||||||
| const tempFileName = `structured-data-${Date.now()}-${Math.random().toString(36).substr(2, 9)}.html`; | ||||||
|
There was a problem hiding this comment. Use
Suggested change
|
||||||
| const tempFilePath = path.join(tempDir, tempFileName); | ||||||
|
|
||||||
| try { | ||||||
| // Create minimal HTML with just the JSON-LD script | ||||||
| const tempHtml = `<!DOCTYPE html> | ||||||
| <html> | ||||||
| <head> | ||||||
| <title>Structured Data Test</title> | ||||||
| </head> | ||||||
| <body> | ||||||
| <script type="application/ld+json"> | ||||||
| ${content} | ||||||
| </script> | ||||||
| </body> | ||||||
| </html>`; | ||||||
|
|
||||||
| fs.writeFileSync(tempFilePath, tempHtml); | ||||||
|
|
||||||
| // Run structured-data-testing-tool on the temporary file | ||||||
| const result = execSync(`yarn dlx structured-data-testing-tool --file "${tempFilePath}"`, { | ||||||
|
There was a problem hiding this comment. The |
||||||
| encoding: "utf8", | ||||||
| stdio: "pipe", | ||||||
| }); | ||||||
|
|
||||||
| // Check for errors in the output | ||||||
| if (result.includes("Error in jsonld parse")) { | ||||||
| // Extract the specific parse error message | ||||||
| const errorMatch = result.match(/Error in jsonld parse - (.+)/); | ||||||
| const errorDetail = errorMatch ? errorMatch[1] : "Unknown parse error"; | ||||||
| this.report({ | ||||||
| node: scriptElement, | ||||||
| message: `JSON-LD parse error: ${errorDetail}`, | ||||||
|
|
||||||
| }); | ||||||
| } else if (result.includes("Failed:") && !result.includes("Failed: 0")) { | ||||||
| // Extract failed test count and any test details | ||||||
| const failedMatch = result.match(/Failed: (\d+)/); | ||||||
| const failedCount = failedMatch ? failedMatch[1] : "some"; | ||||||
|
|
||||||
| // Try to extract specific test failure information | ||||||
| const testFailures = []; | ||||||
| const lines = result.split("\n"); | ||||||
| let inTestSection = false; | ||||||
|
|
||||||
| for (const line of lines) { | ||||||
| if (line.includes("Tests")) { | ||||||
| inTestSection = true; | ||||||
| continue; | ||||||
| } | ||||||
| if (line.includes("Statistics")) { | ||||||
| inTestSection = false; | ||||||
| break; | ||||||
| } | ||||||
| if (inTestSection && line.includes("✗")) { | ||||||
| testFailures.push(line.trim()); | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| let message = `Structured data validation failed: ${failedCount} test(s) failed`; | ||||||
| if (testFailures.length > 0) { | ||||||
| message += ` (${testFailures.join(", ")})`; | ||||||
| } | ||||||
|
|
||||||
| this.report({ | ||||||
| node: scriptElement, | ||||||
| message: message, | ||||||
| }); | ||||||
| } | ||||||
| // Note: We don't report warnings as errors, only actual failures | ||||||
| } catch (error) { | ||||||
| // Extract more specific error information | ||||||
| let errorMessage = error.message; | ||||||
|
|
||||||
| // If there's stdout/stderr, try to extract useful information | ||||||
| if (error.stdout && error.stdout.includes("Error in jsonld parse")) { | ||||||
| const errorMatch = error.stdout.match(/Error in jsonld parse - (.+)/); | ||||||
| const parseError = errorMatch ? errorMatch[1] : "Unknown parse error"; | ||||||
| errorMessage = `JSON-LD parse error: ${parseError}`; | ||||||
| } else if (error.stderr) { | ||||||
| // Use stderr if available for more detailed error info | ||||||
| errorMessage = error.stderr.trim() || errorMessage; | ||||||
| } | ||||||
|
|
||||||
| this.report({ | ||||||
| node: scriptElement, | ||||||
| message: `Structured data testing error: ${errorMessage}`, | ||||||
|
|
||||||
| }); | ||||||
| } finally { | ||||||
| // Clean up temporary file | ||||||
| try { | ||||||
| if (fs.existsSync(tempFilePath)) { | ||||||
| fs.unlinkSync(tempFilePath); | ||||||
| } | ||||||
| } catch (cleanupError) { | ||||||
| // Ignore cleanup errors | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good, if this is the actual result