@drowlink/aeo-linter-core 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +72 -0
- package/package.json +3 -2
package/README.md
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# @drowlink/aeo-linter-core
|
|
2
|
+
|
|
3
|
+
> The agnostic core engine and audit pipeline for **Answer Engine Optimization (AEO/GEO)** and **RAG readiness**, built on the **Google Lighthouse architecture**.
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/@drowlink/aeo-linter-core)
|
|
6
|
+
[](https://www.typescriptlang.org/)
|
|
7
|
+
[](https://opensource.org/licenses/MIT)
|
|
8
|
+
|
|
9
|
+
Part of the [aeo-audit-linter](https://github.com/DrowLink/aeo-audit-linter) project.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## 📦 Installation
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install @drowlink/aeo-linter-core
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## 🚀 Quick Usage
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import {
|
|
25
|
+
Runner,
|
|
26
|
+
HtmlReporter,
|
|
27
|
+
TerminalReporter,
|
|
28
|
+
defaultConfig
|
|
29
|
+
} from '@drowlink/aeo-linter-core';
|
|
30
|
+
|
|
31
|
+
async function main() {
|
|
32
|
+
// Run the 3-phase audit pipeline
|
|
33
|
+
const report = await Runner.run('https://example.com', {
|
|
34
|
+
config: defaultConfig,
|
|
35
|
+
onProgress: (phase, msg) => console.log(`[${phase.toUpperCase()}] ${msg}`)
|
|
36
|
+
});
|
|
37
|
+
|
|
38
|
+
console.log(`Overall AEO Score: ${report.overallScore} / 100`);
|
|
39
|
+
|
|
40
|
+
// Generate formatted Terminal report with ANSI colors
|
|
41
|
+
console.log(TerminalReporter.generate(report));
|
|
42
|
+
|
|
43
|
+
// Generate self-contained interactive HTML dashboard
|
|
44
|
+
const html = HtmlReporter.generate(report);
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
main();
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
## 🏛️ Architecture (Lighthouse Pattern)
|
|
53
|
+
|
|
54
|
+
- **Gatherers (`core/gather`)**: Extract raw typed artifacts (`RobotsTxt`, `JSONLD`, `HttpHeaders`, `HeadingsHierarchy`, `ContentChunks`, `DirectAnswers`).
|
|
55
|
+
- **Audits (`core/audits`)**: Pure deterministic functions that evaluate artifacts and return `{ score, displayValue, details }`.
|
|
56
|
+
- **Aggregator (`core/runner/aggregator`)**: Calculates weighted category scores and global AEO score (0–100).
|
|
57
|
+
- **Reporters (`core/report`)**: Terminal and interactive SVG gauge HTML dashboards.
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## 🎯 Categories
|
|
62
|
+
|
|
63
|
+
- `ai-accessibility`: Evaluates permissions for AI bots (`GPTBot`, `PerplexityBot`, `ClaudeBot`, `Google-Extended`, etc.) and `X-Robots-Tag`.
|
|
64
|
+
- `structured-data`: Validates JSON-LD syntax and presence of RAG schemas (`FAQPage`, `HowTo`, `Article`, `sameAs`).
|
|
65
|
+
- `content-chunking`: Verifies H1-H3 hierarchy, semantic tags (`<main>`, `<article>`, `<section>`), and embedding token density.
|
|
66
|
+
- `direct-answer-density`: Measures conciseness (30–60 words) and direct definitions answering key user queries.
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
## 📄 License
|
|
71
|
+
|
|
72
|
+
MIT © [DrowLink](https://github.com/DrowLink/aeo-audit-linter)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@drowlink/aeo-linter-core",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Core engine and audit pipeline for AEO/GEO linter (Lighthouse architecture)",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
@@ -26,7 +26,8 @@
|
|
|
26
26
|
"prepublishOnly": "npm run build"
|
|
27
27
|
},
|
|
28
28
|
"files": [
|
|
29
|
-
"dist"
|
|
29
|
+
"dist",
|
|
30
|
+
"README.md"
|
|
30
31
|
],
|
|
31
32
|
"repository": {
|
|
32
33
|
"type": "git",
|