afdocs 0.1.0

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.
Files changed (136) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +201 -0
  3. package/bin/afdocs.mjs +3 -0
  4. package/dist/checks/agent-discoverability/llms-txt-directive.d.ts +2 -0
  5. package/dist/checks/agent-discoverability/llms-txt-directive.d.ts.map +1 -0
  6. package/dist/checks/agent-discoverability/llms-txt-directive.js +17 -0
  7. package/dist/checks/agent-discoverability/llms-txt-directive.js.map +1 -0
  8. package/dist/checks/content-structure/markdown-code-fence-validity.d.ts +2 -0
  9. package/dist/checks/content-structure/markdown-code-fence-validity.d.ts.map +1 -0
  10. package/dist/checks/content-structure/markdown-code-fence-validity.js +17 -0
  11. package/dist/checks/content-structure/markdown-code-fence-validity.js.map +1 -0
  12. package/dist/checks/content-structure/section-header-quality.d.ts +2 -0
  13. package/dist/checks/content-structure/section-header-quality.d.ts.map +1 -0
  14. package/dist/checks/content-structure/section-header-quality.js +17 -0
  15. package/dist/checks/content-structure/section-header-quality.js.map +1 -0
  16. package/dist/checks/content-structure/tabbed-content-serialization.d.ts +2 -0
  17. package/dist/checks/content-structure/tabbed-content-serialization.d.ts.map +1 -0
  18. package/dist/checks/content-structure/tabbed-content-serialization.js +17 -0
  19. package/dist/checks/content-structure/tabbed-content-serialization.js.map +1 -0
  20. package/dist/checks/index.d.ts +22 -0
  21. package/dist/checks/index.d.ts.map +1 -0
  22. package/dist/checks/index.js +30 -0
  23. package/dist/checks/index.js.map +1 -0
  24. package/dist/checks/llms-txt/llms-txt-exists.d.ts +2 -0
  25. package/dist/checks/llms-txt/llms-txt-exists.d.ts.map +1 -0
  26. package/dist/checks/llms-txt/llms-txt-exists.js +107 -0
  27. package/dist/checks/llms-txt/llms-txt-exists.js.map +1 -0
  28. package/dist/checks/llms-txt/llms-txt-links-markdown.d.ts +2 -0
  29. package/dist/checks/llms-txt/llms-txt-links-markdown.d.ts.map +1 -0
  30. package/dist/checks/llms-txt/llms-txt-links-markdown.js +144 -0
  31. package/dist/checks/llms-txt/llms-txt-links-markdown.js.map +1 -0
  32. package/dist/checks/llms-txt/llms-txt-links-resolve.d.ts +2 -0
  33. package/dist/checks/llms-txt/llms-txt-links-resolve.d.ts.map +1 -0
  34. package/dist/checks/llms-txt/llms-txt-links-resolve.js +116 -0
  35. package/dist/checks/llms-txt/llms-txt-links-resolve.js.map +1 -0
  36. package/dist/checks/llms-txt/llms-txt-size.d.ts +2 -0
  37. package/dist/checks/llms-txt/llms-txt-size.d.ts.map +1 -0
  38. package/dist/checks/llms-txt/llms-txt-size.js +56 -0
  39. package/dist/checks/llms-txt/llms-txt-size.js.map +1 -0
  40. package/dist/checks/llms-txt/llms-txt-valid.d.ts +6 -0
  41. package/dist/checks/llms-txt/llms-txt-valid.d.ts.map +1 -0
  42. package/dist/checks/llms-txt/llms-txt-valid.js +89 -0
  43. package/dist/checks/llms-txt/llms-txt-valid.js.map +1 -0
  44. package/dist/checks/markdown-availability/content-negotiation.d.ts +2 -0
  45. package/dist/checks/markdown-availability/content-negotiation.d.ts.map +1 -0
  46. package/dist/checks/markdown-availability/content-negotiation.js +17 -0
  47. package/dist/checks/markdown-availability/content-negotiation.js.map +1 -0
  48. package/dist/checks/markdown-availability/markdown-url-support.d.ts +2 -0
  49. package/dist/checks/markdown-availability/markdown-url-support.d.ts.map +1 -0
  50. package/dist/checks/markdown-availability/markdown-url-support.js +17 -0
  51. package/dist/checks/markdown-availability/markdown-url-support.js.map +1 -0
  52. package/dist/checks/observability/cache-header-hygiene.d.ts +2 -0
  53. package/dist/checks/observability/cache-header-hygiene.d.ts.map +1 -0
  54. package/dist/checks/observability/cache-header-hygiene.js +17 -0
  55. package/dist/checks/observability/cache-header-hygiene.js.map +1 -0
  56. package/dist/checks/observability/llms-txt-freshness.d.ts +2 -0
  57. package/dist/checks/observability/llms-txt-freshness.d.ts.map +1 -0
  58. package/dist/checks/observability/llms-txt-freshness.js +17 -0
  59. package/dist/checks/observability/llms-txt-freshness.js.map +1 -0
  60. package/dist/checks/observability/markdown-content-parity.d.ts +2 -0
  61. package/dist/checks/observability/markdown-content-parity.d.ts.map +1 -0
  62. package/dist/checks/observability/markdown-content-parity.js +17 -0
  63. package/dist/checks/observability/markdown-content-parity.js.map +1 -0
  64. package/dist/checks/page-size/content-start-position.d.ts +2 -0
  65. package/dist/checks/page-size/content-start-position.d.ts.map +1 -0
  66. package/dist/checks/page-size/content-start-position.js +17 -0
  67. package/dist/checks/page-size/content-start-position.js.map +1 -0
  68. package/dist/checks/page-size/page-size-html.d.ts +2 -0
  69. package/dist/checks/page-size/page-size-html.d.ts.map +1 -0
  70. package/dist/checks/page-size/page-size-html.js +17 -0
  71. package/dist/checks/page-size/page-size-html.js.map +1 -0
  72. package/dist/checks/page-size/page-size-markdown.d.ts +2 -0
  73. package/dist/checks/page-size/page-size-markdown.d.ts.map +1 -0
  74. package/dist/checks/page-size/page-size-markdown.js +17 -0
  75. package/dist/checks/page-size/page-size-markdown.js.map +1 -0
  76. package/dist/checks/registry.d.ts +7 -0
  77. package/dist/checks/registry.d.ts.map +1 -0
  78. package/dist/checks/registry.js +20 -0
  79. package/dist/checks/registry.js.map +1 -0
  80. package/dist/checks/url-stability/http-status-codes.d.ts +2 -0
  81. package/dist/checks/url-stability/http-status-codes.d.ts.map +1 -0
  82. package/dist/checks/url-stability/http-status-codes.js +17 -0
  83. package/dist/checks/url-stability/http-status-codes.js.map +1 -0
  84. package/dist/checks/url-stability/redirect-behavior.d.ts +2 -0
  85. package/dist/checks/url-stability/redirect-behavior.d.ts.map +1 -0
  86. package/dist/checks/url-stability/redirect-behavior.js +17 -0
  87. package/dist/checks/url-stability/redirect-behavior.js.map +1 -0
  88. package/dist/cli/commands/check.d.ts +4 -0
  89. package/dist/cli/commands/check.d.ts.map +1 -0
  90. package/dist/cli/commands/check.js +38 -0
  91. package/dist/cli/commands/check.js.map +1 -0
  92. package/dist/cli/formatters/json.d.ts +3 -0
  93. package/dist/cli/formatters/json.d.ts.map +1 -0
  94. package/dist/cli/formatters/json.js +4 -0
  95. package/dist/cli/formatters/json.js.map +1 -0
  96. package/dist/cli/formatters/text.d.ts +3 -0
  97. package/dist/cli/formatters/text.d.ts.map +1 -0
  98. package/dist/cli/formatters/text.js +59 -0
  99. package/dist/cli/formatters/text.js.map +1 -0
  100. package/dist/cli/index.d.ts +2 -0
  101. package/dist/cli/index.d.ts.map +1 -0
  102. package/dist/cli/index.js +12 -0
  103. package/dist/cli/index.js.map +1 -0
  104. package/dist/constants.d.ts +36 -0
  105. package/dist/constants.d.ts.map +1 -0
  106. package/dist/constants.js +24 -0
  107. package/dist/constants.js.map +1 -0
  108. package/dist/helpers/config.d.ts +3 -0
  109. package/dist/helpers/config.d.ts.map +1 -0
  110. package/dist/helpers/config.js +25 -0
  111. package/dist/helpers/config.js.map +1 -0
  112. package/dist/helpers/index.d.ts +3 -0
  113. package/dist/helpers/index.d.ts.map +1 -0
  114. package/dist/helpers/index.js +3 -0
  115. package/dist/helpers/index.js.map +1 -0
  116. package/dist/helpers/vitest-runner.d.ts +23 -0
  117. package/dist/helpers/vitest-runner.d.ts.map +1 -0
  118. package/dist/helpers/vitest-runner.js +67 -0
  119. package/dist/helpers/vitest-runner.js.map +1 -0
  120. package/dist/http.d.ts +9 -0
  121. package/dist/http.d.ts.map +1 -0
  122. package/dist/http.js +49 -0
  123. package/dist/http.js.map +1 -0
  124. package/dist/index.d.ts +6 -0
  125. package/dist/index.d.ts.map +1 -0
  126. package/dist/index.js +5 -0
  127. package/dist/index.js.map +1 -0
  128. package/dist/runner.d.ts +4 -0
  129. package/dist/runner.d.ts.map +1 -0
  130. package/dist/runner.js +100 -0
  131. package/dist/runner.js.map +1 -0
  132. package/dist/types.d.ts +97 -0
  133. package/dist/types.d.ts.map +1 -0
  134. package/dist/types.js +2 -0
  135. package/dist/types.js.map +1 -0
  136. package/package.json +74 -0
package/dist/http.js ADDED
@@ -0,0 +1,49 @@
1
+ export function createHttpClient(options) {
2
+ let lastRequestTime = 0;
3
+ let activeRequests = 0;
4
+ async function waitForSlot() {
5
+ // Wait for concurrency slot
6
+ while (activeRequests >= options.maxConcurrency) {
7
+ await new Promise((resolve) => setTimeout(resolve, 50));
8
+ }
9
+ // Enforce delay between requests
10
+ const now = Date.now();
11
+ const elapsed = now - lastRequestTime;
12
+ if (elapsed < options.requestDelay) {
13
+ await new Promise((resolve) => setTimeout(resolve, options.requestDelay - elapsed));
14
+ }
15
+ }
16
+ return {
17
+ async fetch(url, reqOptions) {
18
+ await waitForSlot();
19
+ activeRequests++;
20
+ lastRequestTime = Date.now();
21
+ try {
22
+ const controller = new AbortController();
23
+ const timeout = setTimeout(() => controller.abort(), options.requestTimeout);
24
+ const response = await globalThis.fetch(url, {
25
+ method: reqOptions?.method ?? 'GET',
26
+ headers: reqOptions?.headers,
27
+ redirect: reqOptions?.redirect ?? 'follow',
28
+ signal: reqOptions?.signal ?? controller.signal,
29
+ });
30
+ clearTimeout(timeout);
31
+ // Check for Retry-After header
32
+ const retryAfter = response.headers.get('Retry-After');
33
+ if (response.status === 429 && retryAfter) {
34
+ const delaySec = parseInt(retryAfter, 10);
35
+ if (!isNaN(delaySec) && delaySec > 0 && delaySec <= 60) {
36
+ await new Promise((resolve) => setTimeout(resolve, delaySec * 1000));
37
+ activeRequests--;
38
+ return this.fetch(url, reqOptions);
39
+ }
40
+ }
41
+ return response;
42
+ }
43
+ finally {
44
+ activeRequests--;
45
+ }
46
+ },
47
+ };
48
+ }
49
+ //# sourceMappingURL=http.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"http.js","sourceRoot":"","sources":["../src/http.ts"],"names":[],"mappings":"AAQA,MAAM,UAAU,gBAAgB,CAAC,OAAqC;IACpE,IAAI,eAAe,GAAG,CAAC,CAAC;IACxB,IAAI,cAAc,GAAG,CAAC,CAAC;IAEvB,KAAK,UAAU,WAAW;QACxB,4BAA4B;QAC5B,OAAO,cAAc,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YAChD,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;QAC1D,CAAC;QAED,iCAAiC;QACjC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,MAAM,OAAO,GAAG,GAAG,GAAG,eAAe,CAAC;QACtC,IAAI,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;YACnC,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,YAAY,GAAG,OAAO,CAAC,CAAC,CAAC;QACtF,CAAC;IACH,CAAC;IAED,OAAO;QACL,KAAK,CAAC,KAAK,CAAC,GAAW,EAAE,UAA+B;YACtD,MAAM,WAAW,EAAE,CAAC;YACpB,cAAc,EAAE,CAAC;YACjB,eAAe,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAE7B,IAAI,CAAC;gBACH,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;gBACzC,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;gBAE7E,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC,GAAG,EAAE;oBAC3C,MAAM,EAAE,UAAU,EAAE,MAAM,IAAI,KAAK;oBACnC,OAAO,EAAE,UAAU,EAAE,OAAO;oBAC5B,QAAQ,EAAE,UAAU,EAAE,QAAQ,IAAI,QAAQ;oBAC1C,MAAM,EAAE,UAAU,EAAE,MAAM,IAAI,UAAU,CAAC,MAAM;iBAChD,CAAC,CAAC;gBAEH,YAAY,CAAC,OAAO,CAAC,CAAC;gBAEtB,+BAA+B;gBAC/B,MAAM,UAAU,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;gBACvD,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,UAAU,EAAE,CAAC;oBAC1C,MAAM,QAAQ,GAAG,QAAQ,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;oBAC1C,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,QAAQ,GAAG,CAAC,IAAI,QAAQ,IAAI,EAAE,EAAE,CAAC;wBACvD,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC;wBACrE,cAAc,EAAE,CAAC;wBACjB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;oBACrC,CAAC;gBACH,CAAC;gBAED,OAAO,QAAwB,CAAC;YAClC,CAAC;oBAAS,CAAC;gBACT,cAAc,EAAE,CAAC;YACnB,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC"}
@@ -0,0 +1,6 @@
1
+ export type { CheckResult, CheckStatus, CheckContext, CheckOptions, CheckFunction, CheckDefinition, RunnerOptions, ReportResult, AgentDocsConfig, DiscoveredFile, SizeThresholds, } from './types.js';
2
+ export { DEFAULT_OPTIONS, DEFAULT_THRESHOLDS, CATEGORIES } from './constants.js';
3
+ export { createContext, runChecks } from './runner.js';
4
+ export { createHttpClient } from './http.js';
5
+ export { getAllChecks, getCheck, getChecksSorted, extractMarkdownLinks } from './checks/index.js';
6
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,YAAY,EACV,WAAW,EACX,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,eAAe,EACf,aAAa,EACb,YAAY,EACZ,eAAe,EACf,cAAc,EACd,cAAc,GACf,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjF,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC"}
package/dist/index.js ADDED
@@ -0,0 +1,5 @@
1
+ export { DEFAULT_OPTIONS, DEFAULT_THRESHOLDS, CATEGORIES } from './constants.js';
2
+ export { createContext, runChecks } from './runner.js';
3
+ export { createHttpClient } from './http.js';
4
+ export { getAllChecks, getCheck, getChecksSorted, extractMarkdownLinks } from './checks/index.js';
5
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjF,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC"}
@@ -0,0 +1,4 @@
1
+ import type { CheckContext, RunnerOptions, ReportResult } from './types.js';
2
+ export declare function createContext(baseUrl: string, options?: Partial<RunnerOptions>): CheckContext;
3
+ export declare function runChecks(baseUrl: string, options?: Partial<RunnerOptions>): Promise<ReportResult>;
4
+ //# sourceMappingURL=runner.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"runner.d.ts","sourceRoot":"","sources":["../src/runner.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAe,aAAa,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAmCzF,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,YAAY,CAe7F;AAED,wBAAsB,SAAS,CAC7B,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,GAC/B,OAAO,CAAC,YAAY,CAAC,CA0DvB"}
package/dist/runner.js ADDED
@@ -0,0 +1,100 @@
1
+ import { DEFAULT_OPTIONS } from './constants.js';
2
+ import { createHttpClient } from './http.js';
3
+ import { getChecksSorted } from './checks/registry.js';
4
+ /**
5
+ * Normalize dependsOn to the internal format: array of OR-groups.
6
+ * - `['a', 'b']` means a AND b (each is its own OR-group of 1)
7
+ * - `[['a', 'b']]` means a OR b (single OR-group with 2 options)
8
+ */
9
+ function normalizeDeps(deps) {
10
+ if (deps.length === 0)
11
+ return [];
12
+ if (typeof deps[0] === 'string') {
13
+ // Simple array: each element is a required dependency
14
+ return deps.map((d) => [d]);
15
+ }
16
+ return deps;
17
+ }
18
+ function checkDependenciesMet(deps, previousResults) {
19
+ const normalized = normalizeDeps(deps);
20
+ for (const orGroup of normalized) {
21
+ // At least one check in the OR-group must have passed
22
+ const anyPassed = orGroup.some((id) => {
23
+ const result = previousResults.get(id);
24
+ return result?.status === 'pass';
25
+ });
26
+ if (!anyPassed)
27
+ return false;
28
+ }
29
+ return true;
30
+ }
31
+ export function createContext(baseUrl, options) {
32
+ const merged = { ...DEFAULT_OPTIONS, ...options };
33
+ const url = new URL(baseUrl);
34
+ return {
35
+ baseUrl: baseUrl.replace(/\/$/, ''),
36
+ origin: url.origin,
37
+ previousResults: new Map(),
38
+ http: createHttpClient({
39
+ requestDelay: merged.requestDelay,
40
+ requestTimeout: merged.requestTimeout,
41
+ maxConcurrency: merged.maxConcurrency,
42
+ }),
43
+ options: merged,
44
+ };
45
+ }
46
+ export async function runChecks(baseUrl, options) {
47
+ const ctx = createContext(baseUrl, options);
48
+ const allChecks = getChecksSorted();
49
+ const checkIds = options?.checkIds;
50
+ const results = [];
51
+ for (const check of allChecks) {
52
+ // Filter by requested check IDs if provided
53
+ if (checkIds && checkIds.length > 0 && !checkIds.includes(check.id)) {
54
+ continue;
55
+ }
56
+ // Check dependencies
57
+ if (check.dependsOn.length > 0 && !checkDependenciesMet(check.dependsOn, ctx.previousResults)) {
58
+ const result = {
59
+ id: check.id,
60
+ category: check.category,
61
+ status: 'skip',
62
+ message: 'Skipped: dependency check did not pass',
63
+ dependsOn: normalizeDeps(check.dependsOn).flat(),
64
+ };
65
+ results.push(result);
66
+ ctx.previousResults.set(check.id, result);
67
+ continue;
68
+ }
69
+ try {
70
+ const result = await check.run(ctx);
71
+ results.push(result);
72
+ ctx.previousResults.set(check.id, result);
73
+ }
74
+ catch (err) {
75
+ const result = {
76
+ id: check.id,
77
+ category: check.category,
78
+ status: 'error',
79
+ message: `Check error: ${err instanceof Error ? err.message : String(err)}`,
80
+ };
81
+ results.push(result);
82
+ ctx.previousResults.set(check.id, result);
83
+ }
84
+ }
85
+ const summary = {
86
+ total: results.length,
87
+ pass: results.filter((r) => r.status === 'pass').length,
88
+ warn: results.filter((r) => r.status === 'warn').length,
89
+ fail: results.filter((r) => r.status === 'fail').length,
90
+ skip: results.filter((r) => r.status === 'skip').length,
91
+ error: results.filter((r) => r.status === 'error').length,
92
+ };
93
+ return {
94
+ url: baseUrl,
95
+ timestamp: new Date().toISOString(),
96
+ results,
97
+ summary,
98
+ };
99
+ }
100
+ //# sourceMappingURL=runner.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"runner.js","sourceRoot":"","sources":["../src/runner.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD;;;;GAIG;AACH,SAAS,aAAa,CAAC,IAA2B;IAChD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACjC,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;QAChC,sDAAsD;QACtD,OAAQ,IAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5C,CAAC;IACD,OAAO,IAAkB,CAAC;AAC5B,CAAC;AAED,SAAS,oBAAoB,CAC3B,IAA2B,EAC3B,eAAyC;IAEzC,MAAM,UAAU,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IACvC,KAAK,MAAM,OAAO,IAAI,UAAU,EAAE,CAAC;QACjC,sDAAsD;QACtD,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE;YACpC,MAAM,MAAM,GAAG,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACvC,OAAO,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC;QACnC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,SAAS;YAAE,OAAO,KAAK,CAAC;IAC/B,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,OAAe,EAAE,OAAgC;IAC7E,MAAM,MAAM,GAAG,EAAE,GAAG,eAAe,EAAE,GAAG,OAAO,EAAE,CAAC;IAClD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;IAE7B,OAAO;QACL,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;QACnC,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,eAAe,EAAE,IAAI,GAAG,EAAE;QAC1B,IAAI,EAAE,gBAAgB,CAAC;YACrB,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,cAAc,EAAE,MAAM,CAAC,cAAc;YACrC,cAAc,EAAE,MAAM,CAAC,cAAc;SACtC,CAAC;QACF,OAAO,EAAE,MAAM;KAChB,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,OAAe,EACf,OAAgC;IAEhC,MAAM,GAAG,GAAG,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5C,MAAM,SAAS,GAAG,eAAe,EAAE,CAAC;IACpC,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,CAAC;IAEnC,MAAM,OAAO,GAAkB,EAAE,CAAC;IAElC,KAAK,MAAM,KAAK,IAAI,SAAS,EAAE,CAAC;QAC9B,4CAA4C;QAC5C,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;YACpE,SAAS;QACX,CAAC;QAED,qBAAqB;QACrB,IAAI,KAAK,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,SAAS,EAAE,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC;YAC9F,MAAM,MAAM,GAAgB;gBAC1B,EAAE,EAAE,KAAK,CAAC,EAAE;gBACZ,QAAQ,EAAE,KAAK,CAAC,QAAQ;gBACxB,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,wCAAwC;gBACjD,SAAS,EAAE,aAAa,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE;aACjD,CAAC;YACF,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACrB,GAAG,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;YAC1C,SAAS;QACX,CAAC;QAED,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACpC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACrB,GAAG,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QAC5C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,MAAM,GAAgB;gBAC1B,EAAE,EAAE,KAAK,CAAC,EAAE;gBACZ,QAAQ,EAAE,KAAK,CAAC,QAAQ;gBACxB,MAAM,EAAE,OAAO;gBACf,OAAO,EAAE,gBAAgB,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE;aAC5E,CAAC;YACF,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACrB,GAAG,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED,MAAM,OAAO,GAAG;QACd,KAAK,EAAE,OAAO,CAAC,MAAM;QACrB,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,MAAM;QACvD,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,MAAM;QACvD,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,MAAM;QACvD,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,MAAM;QACvD,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,OAAO,CAAC,CAAC,MAAM;KAC1D,CAAC;IAEF,OAAO;QACL,GAAG,EAAE,OAAO;QACZ,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACnC,OAAO;QACP,OAAO;KACR,CAAC;AACJ,CAAC"}
@@ -0,0 +1,97 @@
1
+ export type CheckStatus = 'pass' | 'warn' | 'fail' | 'skip' | 'error';
2
+ export interface CheckResult {
3
+ id: string;
4
+ category: string;
5
+ status: CheckStatus;
6
+ message: string;
7
+ details?: Record<string, unknown>;
8
+ dependsOn?: string[];
9
+ }
10
+ export interface CheckContext {
11
+ /** The base URL being checked (as provided by the user). */
12
+ baseUrl: string;
13
+ /** The origin (scheme + host) derived from baseUrl. */
14
+ origin: string;
15
+ /** Results from previously-run checks, keyed by check ID. */
16
+ previousResults: Map<string, CheckResult>;
17
+ /** HTTP client with rate limiting. */
18
+ http: HttpClient;
19
+ /** Runtime options. */
20
+ options: CheckOptions;
21
+ }
22
+ export interface CheckOptions {
23
+ /** Maximum concurrent HTTP requests within a single check. */
24
+ maxConcurrency: number;
25
+ /** Delay in ms between HTTP requests. */
26
+ requestDelay: number;
27
+ /** Timeout in ms for individual HTTP requests. */
28
+ requestTimeout: number;
29
+ /** Maximum number of links to test in link-resolution checks. */
30
+ maxLinksToTest: number;
31
+ /** Size thresholds. */
32
+ thresholds: SizeThresholds;
33
+ }
34
+ export interface SizeThresholds {
35
+ /** Characters below which content passes (default 50,000). */
36
+ pass: number;
37
+ /** Characters above which content fails (default 100,000). */
38
+ fail: number;
39
+ }
40
+ export type CheckFunction = (ctx: CheckContext) => Promise<CheckResult>;
41
+ export interface CheckDefinition {
42
+ id: string;
43
+ category: string;
44
+ description: string;
45
+ /** Check IDs that must pass before this check runs. Array of arrays for OR-groups. */
46
+ dependsOn: string[][] | string[];
47
+ run: CheckFunction;
48
+ }
49
+ export interface HttpClient {
50
+ fetch(url: string, options?: HttpRequestOptions): Promise<HttpResponse>;
51
+ }
52
+ export interface HttpRequestOptions {
53
+ method?: string;
54
+ headers?: Record<string, string>;
55
+ redirect?: 'follow' | 'manual';
56
+ signal?: AbortSignal;
57
+ }
58
+ export interface HttpResponse {
59
+ ok: boolean;
60
+ status: number;
61
+ statusText: string;
62
+ headers: Headers;
63
+ url: string;
64
+ redirected: boolean;
65
+ text(): Promise<string>;
66
+ }
67
+ export interface DiscoveredFile {
68
+ url: string;
69
+ content: string;
70
+ status: number;
71
+ redirected: boolean;
72
+ redirectUrl?: string;
73
+ crossHostRedirect?: boolean;
74
+ }
75
+ export interface RunnerOptions extends CheckOptions {
76
+ /** Only run checks matching these IDs. If empty, run all. */
77
+ checkIds?: string[];
78
+ }
79
+ export interface ReportResult {
80
+ url: string;
81
+ timestamp: string;
82
+ results: CheckResult[];
83
+ summary: {
84
+ total: number;
85
+ pass: number;
86
+ warn: number;
87
+ fail: number;
88
+ skip: number;
89
+ error: number;
90
+ };
91
+ }
92
+ export interface AgentDocsConfig {
93
+ url: string;
94
+ checks?: string[];
95
+ options?: Partial<CheckOptions>;
96
+ }
97
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAEtE,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,WAAW,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,YAAY;IAC3B,4DAA4D;IAC5D,OAAO,EAAE,MAAM,CAAC;IAChB,uDAAuD;IACvD,MAAM,EAAE,MAAM,CAAC;IACf,6DAA6D;IAC7D,eAAe,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAC1C,sCAAsC;IACtC,IAAI,EAAE,UAAU,CAAC;IACjB,uBAAuB;IACvB,OAAO,EAAE,YAAY,CAAC;CACvB;AAED,MAAM,WAAW,YAAY;IAC3B,8DAA8D;IAC9D,cAAc,EAAE,MAAM,CAAC;IACvB,yCAAyC;IACzC,YAAY,EAAE,MAAM,CAAC;IACrB,kDAAkD;IAClD,cAAc,EAAE,MAAM,CAAC;IACvB,iEAAiE;IACjE,cAAc,EAAE,MAAM,CAAC;IACvB,uBAAuB;IACvB,UAAU,EAAE,cAAc,CAAC;CAC5B;AAED,MAAM,WAAW,cAAc;IAC7B,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAC;IACb,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,aAAa,GAAG,CAAC,GAAG,EAAE,YAAY,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;AAExE,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,sFAAsF;IACtF,SAAS,EAAE,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC;IACjC,GAAG,EAAE,aAAa,CAAC;CACpB;AAED,MAAM,WAAW,UAAU;IACzB,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CACzE;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,QAAQ,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAC/B,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,OAAO,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,OAAO,CAAC;IACpB,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,OAAO,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,WAAW,aAAc,SAAQ,YAAY;IACjD,6DAA6D;IAC7D,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,OAAO,EAAE;QACP,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;CACjC"}
package/dist/types.js ADDED
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}
package/package.json ADDED
@@ -0,0 +1,74 @@
1
+ {
2
+ "name": "afdocs",
3
+ "version": "0.1.0",
4
+ "description": "Test your documentation site against the Agent-Friendly Documentation Spec",
5
+ "type": "module",
6
+ "main": "dist/index.js",
7
+ "types": "dist/index.d.ts",
8
+ "bin": {
9
+ "afdocs": "bin/afdocs.mjs"
10
+ },
11
+ "exports": {
12
+ ".": {
13
+ "import": "./dist/index.js",
14
+ "types": "./dist/index.d.ts"
15
+ },
16
+ "./helpers": {
17
+ "import": "./dist/helpers/index.js",
18
+ "types": "./dist/helpers/index.d.ts"
19
+ }
20
+ },
21
+ "scripts": {
22
+ "build": "tsc",
23
+ "test": "vitest run",
24
+ "test:coverage": "vitest run --coverage",
25
+ "test:watch": "vitest",
26
+ "lint": "eslint . && tsc --noEmit",
27
+ "format": "prettier --write .",
28
+ "format:check": "prettier --check .",
29
+ "prepare": "husky",
30
+ "prepublishOnly": "npm run lint && npm test && npm run build"
31
+ },
32
+ "lint-staged": {
33
+ "*.{ts,js,mjs}": [
34
+ "prettier --write",
35
+ "eslint --fix"
36
+ ],
37
+ "*.{json,yml,yaml,md}": [
38
+ "prettier --write"
39
+ ]
40
+ },
41
+ "keywords": [
42
+ "agent",
43
+ "documentation",
44
+ "testing",
45
+ "llms-txt",
46
+ "agent-friendly"
47
+ ],
48
+ "files": [
49
+ "dist/",
50
+ "bin/"
51
+ ],
52
+ "license": "MIT",
53
+ "engines": {
54
+ "node": ">=20"
55
+ },
56
+ "dependencies": {
57
+ "chalk": "^5.4.1",
58
+ "commander": "^13.1.0",
59
+ "yaml": "^2.7.0"
60
+ },
61
+ "devDependencies": {
62
+ "@eslint/js": "^10.0.1",
63
+ "@types/node": "^22.13.4",
64
+ "@vitest/coverage-v8": "^4.0.18",
65
+ "eslint": "^10.0.1",
66
+ "husky": "^9.1.7",
67
+ "lint-staged": "^16.2.7",
68
+ "msw": "^2.7.3",
69
+ "prettier": "^3.8.1",
70
+ "typescript": "^5.7.3",
71
+ "typescript-eslint": "^8.56.0",
72
+ "vitest": "^4.0.18"
73
+ }
74
+ }