@redocly/recheck 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 (182) hide show
  1. package/README.md +544 -0
  2. package/dist/assertions/bullet-style.d.ts +3 -0
  3. package/dist/assertions/bullet-style.d.ts.map +1 -0
  4. package/dist/assertions/bullet-style.js +60 -0
  5. package/dist/assertions/bullet-style.js.map +1 -0
  6. package/dist/assertions/index.d.ts +21 -0
  7. package/dist/assertions/index.d.ts.map +1 -0
  8. package/dist/assertions/index.js +30 -0
  9. package/dist/assertions/index.js.map +1 -0
  10. package/dist/assertions/max-image-size.d.ts +3 -0
  11. package/dist/assertions/max-image-size.d.ts.map +1 -0
  12. package/dist/assertions/max-image-size.js +73 -0
  13. package/dist/assertions/max-image-size.js.map +1 -0
  14. package/dist/assertions/max-line-length.d.ts +3 -0
  15. package/dist/assertions/max-line-length.d.ts.map +1 -0
  16. package/dist/assertions/max-line-length.js +68 -0
  17. package/dist/assertions/max-line-length.js.map +1 -0
  18. package/dist/assertions/no-broken-fragment-links.d.ts +3 -0
  19. package/dist/assertions/no-broken-fragment-links.d.ts.map +1 -0
  20. package/dist/assertions/no-broken-fragment-links.js +79 -0
  21. package/dist/assertions/no-broken-fragment-links.js.map +1 -0
  22. package/dist/assertions/no-duplicate-headings.d.ts +3 -0
  23. package/dist/assertions/no-duplicate-headings.d.ts.map +1 -0
  24. package/dist/assertions/no-duplicate-headings.js +66 -0
  25. package/dist/assertions/no-duplicate-headings.js.map +1 -0
  26. package/dist/assertions/no-hard-tabs.d.ts +3 -0
  27. package/dist/assertions/no-hard-tabs.d.ts.map +1 -0
  28. package/dist/assertions/no-hard-tabs.js +63 -0
  29. package/dist/assertions/no-hard-tabs.js.map +1 -0
  30. package/dist/assertions/no-trailing-spaces.d.ts +3 -0
  31. package/dist/assertions/no-trailing-spaces.d.ts.map +1 -0
  32. package/dist/assertions/no-trailing-spaces.js +72 -0
  33. package/dist/assertions/no-trailing-spaces.js.map +1 -0
  34. package/dist/assertions/pattern.d.ts +3 -0
  35. package/dist/assertions/pattern.d.ts.map +1 -0
  36. package/dist/assertions/pattern.js +39 -0
  37. package/dist/assertions/pattern.js.map +1 -0
  38. package/dist/assertions/semantic-line-breaks.d.ts +3 -0
  39. package/dist/assertions/semantic-line-breaks.d.ts.map +1 -0
  40. package/dist/assertions/semantic-line-breaks.js +152 -0
  41. package/dist/assertions/semantic-line-breaks.js.map +1 -0
  42. package/dist/assertions/swap.d.ts +3 -0
  43. package/dist/assertions/swap.d.ts.map +1 -0
  44. package/dist/assertions/swap.js +39 -0
  45. package/dist/assertions/swap.js.map +1 -0
  46. package/dist/assertions/utils.d.ts +8 -0
  47. package/dist/assertions/utils.d.ts.map +1 -0
  48. package/dist/assertions/utils.js +57 -0
  49. package/dist/assertions/utils.js.map +1 -0
  50. package/dist/cli.d.ts +3 -0
  51. package/dist/cli.d.ts.map +1 -0
  52. package/dist/cli.js +125 -0
  53. package/dist/cli.js.map +1 -0
  54. package/dist/commands/run.d.ts +20 -0
  55. package/dist/commands/run.d.ts.map +1 -0
  56. package/dist/commands/run.js +115 -0
  57. package/dist/commands/run.js.map +1 -0
  58. package/dist/commands/validate.d.ts +8 -0
  59. package/dist/commands/validate.d.ts.map +1 -0
  60. package/dist/commands/validate.js +43 -0
  61. package/dist/commands/validate.js.map +1 -0
  62. package/dist/config/load.d.ts +20 -0
  63. package/dist/config/load.d.ts.map +1 -0
  64. package/dist/config/load.js +85 -0
  65. package/dist/config/load.js.map +1 -0
  66. package/dist/config/schema.d.ts +109 -0
  67. package/dist/config/schema.d.ts.map +1 -0
  68. package/dist/config/schema.js +103 -0
  69. package/dist/config/schema.js.map +1 -0
  70. package/dist/config/validate.d.ts +10 -0
  71. package/dist/config/validate.d.ts.map +1 -0
  72. package/dist/config/validate.js +129 -0
  73. package/dist/config/validate.js.map +1 -0
  74. package/dist/core/auto-fix.d.ts +16 -0
  75. package/dist/core/auto-fix.d.ts.map +1 -0
  76. package/dist/core/auto-fix.js +82 -0
  77. package/dist/core/auto-fix.js.map +1 -0
  78. package/dist/core/files.d.ts +6 -0
  79. package/dist/core/files.d.ts.map +1 -0
  80. package/dist/core/files.js +75 -0
  81. package/dist/core/files.js.map +1 -0
  82. package/dist/core/rule-filters.d.ts +28 -0
  83. package/dist/core/rule-filters.d.ts.map +1 -0
  84. package/dist/core/rule-filters.js +54 -0
  85. package/dist/core/rule-filters.js.map +1 -0
  86. package/dist/core/runner.d.ts +4 -0
  87. package/dist/core/runner.d.ts.map +1 -0
  88. package/dist/core/runner.js +135 -0
  89. package/dist/core/runner.js.map +1 -0
  90. package/dist/core/scope-parser.d.ts +26 -0
  91. package/dist/core/scope-parser.d.ts.map +1 -0
  92. package/dist/core/scope-parser.js +110 -0
  93. package/dist/core/scope-parser.js.map +1 -0
  94. package/dist/core/timing.d.ts +24 -0
  95. package/dist/core/timing.d.ts.map +1 -0
  96. package/dist/core/timing.js +39 -0
  97. package/dist/core/timing.js.map +1 -0
  98. package/dist/files.d.ts +2 -0
  99. package/dist/files.d.ts.map +1 -0
  100. package/dist/files.js +39 -0
  101. package/dist/files.js.map +1 -0
  102. package/dist/load-config.d.ts +25 -0
  103. package/dist/load-config.d.ts.map +1 -0
  104. package/dist/load-config.js +104 -0
  105. package/dist/load-config.js.map +1 -0
  106. package/dist/load.d.ts +25 -0
  107. package/dist/load.d.ts.map +1 -0
  108. package/dist/load.js +112 -0
  109. package/dist/load.js.map +1 -0
  110. package/dist/reporter/fixes.d.ts +3 -0
  111. package/dist/reporter/fixes.d.ts.map +1 -0
  112. package/dist/reporter/fixes.js +20 -0
  113. package/dist/reporter/fixes.js.map +1 -0
  114. package/dist/reporter/formats/github-actions.d.ts +6 -0
  115. package/dist/reporter/formats/github-actions.d.ts.map +1 -0
  116. package/dist/reporter/formats/github-actions.js +20 -0
  117. package/dist/reporter/formats/github-actions.js.map +1 -0
  118. package/dist/reporter/formats/json.d.ts +6 -0
  119. package/dist/reporter/formats/json.d.ts.map +1 -0
  120. package/dist/reporter/formats/json.js +24 -0
  121. package/dist/reporter/formats/json.js.map +1 -0
  122. package/dist/reporter/formats/sarif.d.ts +10 -0
  123. package/dist/reporter/formats/sarif.d.ts.map +1 -0
  124. package/dist/reporter/formats/sarif.js +66 -0
  125. package/dist/reporter/formats/sarif.js.map +1 -0
  126. package/dist/reporter/formats/table.d.ts +6 -0
  127. package/dist/reporter/formats/table.d.ts.map +1 -0
  128. package/dist/reporter/formats/table.js +38 -0
  129. package/dist/reporter/formats/table.js.map +1 -0
  130. package/dist/reporter/index.d.ts +10 -0
  131. package/dist/reporter/index.d.ts.map +1 -0
  132. package/dist/reporter/index.js +42 -0
  133. package/dist/reporter/index.js.map +1 -0
  134. package/dist/reporter/prioritize-problems.d.ts +7 -0
  135. package/dist/reporter/prioritize-problems.d.ts.map +1 -0
  136. package/dist/reporter/prioritize-problems.js +29 -0
  137. package/dist/reporter/prioritize-problems.js.map +1 -0
  138. package/dist/reporter/statistics.d.ts +17 -0
  139. package/dist/reporter/statistics.d.ts.map +1 -0
  140. package/dist/reporter/statistics.js +52 -0
  141. package/dist/reporter/statistics.js.map +1 -0
  142. package/dist/reporter/summary.d.ts +10 -0
  143. package/dist/reporter/summary.d.ts.map +1 -0
  144. package/dist/reporter/summary.js +48 -0
  145. package/dist/reporter/summary.js.map +1 -0
  146. package/dist/scope.d.ts +26 -0
  147. package/dist/scope.d.ts.map +1 -0
  148. package/dist/scope.js +110 -0
  149. package/dist/scope.js.map +1 -0
  150. package/dist/types/assertions.d.ts +56 -0
  151. package/dist/types/assertions.d.ts.map +1 -0
  152. package/dist/types/assertions.js +2 -0
  153. package/dist/types/assertions.js.map +1 -0
  154. package/dist/types/index.d.ts +6 -0
  155. package/dist/types/index.d.ts.map +1 -0
  156. package/dist/types/index.js +6 -0
  157. package/dist/types/index.js.map +1 -0
  158. package/dist/types/problems.d.ts +21 -0
  159. package/dist/types/problems.d.ts.map +1 -0
  160. package/dist/types/problems.js +2 -0
  161. package/dist/types/problems.js.map +1 -0
  162. package/dist/types/reporting.d.ts +23 -0
  163. package/dist/types/reporting.d.ts.map +1 -0
  164. package/dist/types/reporting.js +2 -0
  165. package/dist/types/reporting.js.map +1 -0
  166. package/dist/types/rules.d.ts +43 -0
  167. package/dist/types/rules.d.ts.map +1 -0
  168. package/dist/types/rules.js +2 -0
  169. package/dist/types/rules.js.map +1 -0
  170. package/dist/types/validation.d.ts +6 -0
  171. package/dist/types/validation.d.ts.map +1 -0
  172. package/dist/types/validation.js +2 -0
  173. package/dist/types/validation.js.map +1 -0
  174. package/dist/types.d.ts +109 -0
  175. package/dist/types.d.ts.map +1 -0
  176. package/dist/types.js +2 -0
  177. package/dist/types.js.map +1 -0
  178. package/dist/validate.d.ts +31 -0
  179. package/dist/validate.d.ts.map +1 -0
  180. package/dist/validate.js +154 -0
  181. package/dist/validate.js.map +1 -0
  182. package/package.json +43 -0
@@ -0,0 +1,17 @@
1
+ import type { Problem } from '../types/index.js';
2
+ export interface BreakdownStats {
3
+ errors: number;
4
+ warnings: number;
5
+ info: number;
6
+ total: number;
7
+ }
8
+ export type RuleBreakdown = Record<string, BreakdownStats>;
9
+ /**
10
+ * Generate breakdown statistics by rule
11
+ */
12
+ export declare function getBreakdownStats(problems: Problem[]): RuleBreakdown;
13
+ /**
14
+ * Display detailed statistics to console
15
+ */
16
+ export declare function showDetailedStats(fileCount: number, problems: Problem[]): void;
17
+ //# sourceMappingURL=statistics.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"statistics.d.ts","sourceRoot":"","sources":["../../src/reporter/statistics.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAEjD,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;AAE3D;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,aAAa,CAwBpE;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI,CA0B9E"}
@@ -0,0 +1,52 @@
1
+ import { red, yellow, cyan } from 'colorette';
2
+ /**
3
+ * Generate breakdown statistics by rule
4
+ */
5
+ export function getBreakdownStats(problems) {
6
+ const breakdown = {};
7
+ for (const problem of problems) {
8
+ if (!breakdown[problem.ruleName]) {
9
+ breakdown[problem.ruleName] = { errors: 0, warnings: 0, info: 0, total: 0 };
10
+ }
11
+ breakdown[problem.ruleName].total++;
12
+ switch (problem.severity) {
13
+ case 'error':
14
+ breakdown[problem.ruleName].errors++;
15
+ break;
16
+ case 'warn':
17
+ breakdown[problem.ruleName].warnings++;
18
+ break;
19
+ case 'info':
20
+ breakdown[problem.ruleName].info++;
21
+ break;
22
+ }
23
+ }
24
+ return breakdown;
25
+ }
26
+ /**
27
+ * Display detailed statistics to console
28
+ */
29
+ export function showDetailedStats(fileCount, problems) {
30
+ console.log(cyan('\n📊 Summary Statistics:'));
31
+ console.log(` ${fileCount} markdown file(s) scanned`);
32
+ console.log(` ${problems.length} total issue(s) detected`);
33
+ const breakdown = getBreakdownStats(problems);
34
+ if (Object.keys(breakdown).length > 0) {
35
+ console.log('\n Breakdown by rule:');
36
+ // Sort rules by total count (descending)
37
+ const sortedRules = Object.entries(breakdown).sort(([, a], [, b]) => b.total - a.total);
38
+ for (const [ruleName, stats] of sortedRules) {
39
+ const parts = [];
40
+ if (stats.errors > 0)
41
+ parts.push(red(`${stats.errors} error${stats.errors !== 1 ? 's' : ''}`));
42
+ if (stats.warnings > 0)
43
+ parts.push(yellow(`${stats.warnings} warning${stats.warnings !== 1 ? 's' : ''}`));
44
+ if (stats.info > 0)
45
+ parts.push(cyan(`${stats.info} info`));
46
+ const statsText = parts.length > 0 ? ` (${parts.join(', ')})` : '';
47
+ const displayName = ruleName.replace('recheck/', '');
48
+ console.log(` ${displayName}: ${stats.total}${statsText}`);
49
+ }
50
+ }
51
+ }
52
+ //# sourceMappingURL=statistics.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"statistics.js","sourceRoot":"","sources":["../../src/reporter/statistics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAa9C;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,QAAmB;IACnD,MAAM,SAAS,GAAkB,EAAE,CAAC;IAEpC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YACjC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;QAC9E,CAAC;QAED,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC;QAEpC,QAAQ,OAAO,CAAC,QAAQ,EAAE,CAAC;YACzB,KAAK,OAAO;gBACV,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE,CAAC;gBACrC,MAAM;YACR,KAAK,MAAM;gBACT,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;gBACvC,MAAM;YACR,KAAK,MAAM;gBACT,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;gBACnC,MAAM;QACV,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,SAAiB,EAAE,QAAmB;IACtE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC,CAAC;IAC9C,OAAO,CAAC,GAAG,CAAC,MAAM,SAAS,2BAA2B,CAAC,CAAC;IACxD,OAAO,CAAC,GAAG,CAAC,MAAM,QAAQ,CAAC,MAAM,0BAA0B,CAAC,CAAC;IAE7D,MAAM,SAAS,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IAE9C,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtC,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;QAEvC,yCAAyC;QACzC,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;QAExF,KAAK,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,WAAW,EAAE,CAAC;YAC5C,MAAM,KAAK,GAAa,EAAE,CAAC;YAC3B,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;gBAClB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,SAAS,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;YAC3E,IAAI,KAAK,CAAC,QAAQ,GAAG,CAAC;gBACpB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,QAAQ,WAAW,KAAK,CAAC,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;YACpF,IAAI,KAAK,CAAC,IAAI,GAAG,CAAC;gBAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC;YAE3D,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YACnE,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;YACrD,OAAO,CAAC,GAAG,CAAC,MAAM,WAAW,KAAK,KAAK,CAAC,KAAK,GAAG,SAAS,EAAE,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;AACH,CAAC"}
@@ -0,0 +1,10 @@
1
+ import type { Problem, Summary } from '../types/index.js';
2
+ /**
3
+ * Build summary object from problems and file count
4
+ */
5
+ export declare function buildSummary(problems: Problem[], fileCount: number): Summary;
6
+ /**
7
+ * Emit summary in requested format to file or stdout
8
+ */
9
+ export declare function printSummary(summary: Summary, format: 'json' | 'text', path?: string): Promise<void>;
10
+ //# sourceMappingURL=summary.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"summary.d.ts","sourceRoot":"","sources":["../../src/reporter/summary.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAI1D;;GAEG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAc5E;AAED;;GAEG;AACH,wBAAsB,YAAY,CAChC,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,MAAM,GAAG,MAAM,EACvB,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,IAAI,CAAC,CA2Bf"}
@@ -0,0 +1,48 @@
1
+ import * as fs from 'fs/promises';
2
+ import { getBreakdownStats } from './statistics.js';
3
+ /**
4
+ * Build summary object from problems and file count
5
+ */
6
+ export function buildSummary(problems, fileCount) {
7
+ const breakdown = getBreakdownStats(problems);
8
+ const totalErrors = problems.filter((h) => h.severity === 'error').length;
9
+ const totalWarnings = problems.filter((h) => h.severity === 'warn').length;
10
+ const totalInfo = problems.filter((h) => h.severity === 'info').length;
11
+ return {
12
+ filesScanned: fileCount,
13
+ totalIssues: problems.length,
14
+ totalErrors,
15
+ totalWarnings,
16
+ totalInfo,
17
+ breakdown,
18
+ };
19
+ }
20
+ /**
21
+ * Emit summary in requested format to file or stdout
22
+ */
23
+ export async function printSummary(summary, format, path) {
24
+ let content = '';
25
+ if (format === 'json') {
26
+ content = JSON.stringify(summary, null, 2);
27
+ }
28
+ else {
29
+ const lines = [];
30
+ lines.push(`Files scanned: ${summary.filesScanned}`);
31
+ lines.push(`Total issues: ${summary.totalIssues}`);
32
+ lines.push(`Errors: ${summary.totalErrors}, Warnings: ${summary.totalWarnings}, Info: ${summary.totalInfo}`);
33
+ lines.push('');
34
+ lines.push('Breakdown by rule:');
35
+ for (const [rule, s] of Object.entries(summary.breakdown)) {
36
+ lines.push(`${rule}: ${s.total} (errors: ${s.errors}, warnings: ${s.warnings}, info: ${s.info})`);
37
+ }
38
+ content = lines.join('\n');
39
+ }
40
+ if (path && path.length > 0) {
41
+ await fs.writeFile(path, content, 'utf8');
42
+ console.log(`\n Wrote summary to ${path}`);
43
+ }
44
+ else {
45
+ console.log('\n' + content);
46
+ }
47
+ }
48
+ //# sourceMappingURL=summary.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"summary.js","sourceRoot":"","sources":["../../src/reporter/summary.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,aAAa,CAAC;AAIlC,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEpD;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,QAAmB,EAAE,SAAiB;IACjE,MAAM,SAAS,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IAC9C,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,MAAM,CAAC;IAC1E,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,MAAM,CAAC,CAAC,MAAM,CAAC;IAC3E,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,MAAM,CAAC,CAAC,MAAM,CAAC;IAEvE,OAAO;QACL,YAAY,EAAE,SAAS;QACvB,WAAW,EAAE,QAAQ,CAAC,MAAM;QAC5B,WAAW;QACX,aAAa;QACb,SAAS;QACT,SAAS;KACV,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,OAAgB,EAChB,MAAuB,EACvB,IAAa;IAEb,IAAI,OAAO,GAAG,EAAE,CAAC;IACjB,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;QACtB,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAC7C,CAAC;SAAM,CAAC;QACN,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,kBAAkB,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;QACrD,KAAK,CAAC,IAAI,CAAC,iBAAiB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;QACnD,KAAK,CAAC,IAAI,CACR,WAAW,OAAO,CAAC,WAAW,eAAe,OAAO,CAAC,aAAa,WAAW,OAAO,CAAC,SAAS,EAAE,CACjG,CAAC;QACF,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QACjC,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;YAC1D,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,KAAK,CAAC,CAAC,KAAK,aAAa,CAAC,CAAC,MAAM,eAAe,CAAC,CAAC,QAAQ,WAAW,CAAC,CAAC,IAAI,GAAG,CACtF,CAAC;QACJ,CAAC;QACD,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5B,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAC1C,OAAO,CAAC,GAAG,CAAC,yBAAyB,IAAI,EAAE,CAAC,CAAC;IAC/C,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,OAAO,CAAC,CAAC;IAC9B,CAAC;AACH,CAAC"}
@@ -0,0 +1,26 @@
1
+ /**
2
+ * Markdown scope types for semantic content linting
3
+ */
4
+ export type ScopeType = 'all' | 'heading' | 'paragraph' | 'sentence' | 'code' | 'default' | 'table' | 'frontmatter' | 'raw';
5
+ /**
6
+ * Represents a scoped segment of markdown content
7
+ */
8
+ export interface ScopedSegment {
9
+ /** The type of scope this segment represents */
10
+ scope: ScopeType;
11
+ /** The text content of this segment */
12
+ content: string;
13
+ /** Starting line number (1-based) */
14
+ startLine: number;
15
+ /** Ending line number (1-based) */
16
+ endLine: number;
17
+ /** Additional metadata specific to scope type */
18
+ metadata?: Record<string, any>;
19
+ }
20
+ /**
21
+ * Parses markdown content into scoped segments
22
+ */
23
+ export declare class MarkdownScopeParser {
24
+ parse(content: string): ScopedSegment[];
25
+ }
26
+ //# sourceMappingURL=scope.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"scope.d.ts","sourceRoot":"","sources":["../src/scope.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,SAAS,GACjB,KAAK,GACL,SAAS,GACT,WAAW,GACX,UAAU,GACV,MAAM,GACN,SAAS,GACT,OAAO,GACP,aAAa,GACb,KAAK,CAAC;AAEV;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,gDAAgD;IAChD,KAAK,EAAE,SAAS,CAAC;IAEjB,uCAAuC;IACvC,OAAO,EAAE,MAAM,CAAC;IAEhB,qCAAqC;IACrC,SAAS,EAAE,MAAM,CAAC;IAElB,mCAAmC;IACnC,OAAO,EAAE,MAAM,CAAC;IAEhB,iDAAiD;IACjD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAChC;AAED;;GAEG;AACH,qBAAa,mBAAmB;IAC9B,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,aAAa,EAAE;CAgHxC"}
package/dist/scope.js ADDED
@@ -0,0 +1,110 @@
1
+ /**
2
+ * Parses markdown content into scoped segments
3
+ */
4
+ export class MarkdownScopeParser {
5
+ parse(content) {
6
+ const segments = [];
7
+ const lines = content.split('\n');
8
+ let lineIndex = 0;
9
+ while (lineIndex < lines.length) {
10
+ const line = lines[lineIndex];
11
+ const lineNumber = lineIndex + 1;
12
+ // Frontmatter
13
+ if (lineNumber === 1 && line === '---') {
14
+ let endIndex = lineIndex + 1;
15
+ while (endIndex < lines.length && lines[endIndex] !== '---') {
16
+ endIndex++;
17
+ }
18
+ if (endIndex < lines.length) {
19
+ segments.push({
20
+ scope: 'frontmatter',
21
+ startLine: lineNumber,
22
+ endLine: endIndex + 1,
23
+ content: lines.slice(lineIndex, endIndex + 1).join('\n'),
24
+ });
25
+ lineIndex = endIndex + 1;
26
+ continue;
27
+ }
28
+ }
29
+ // Code blocks
30
+ if (line.startsWith('```') || line.startsWith('~~~')) {
31
+ const fenceType = line.substring(0, 3);
32
+ let endIndex = lineIndex + 1;
33
+ while (endIndex < lines.length && !lines[endIndex].startsWith(fenceType)) {
34
+ endIndex++;
35
+ }
36
+ segments.push({
37
+ scope: 'code',
38
+ startLine: lineNumber,
39
+ endLine: endIndex + 1,
40
+ content: lines.slice(lineIndex, endIndex + 1).join('\n'),
41
+ metadata: { language: line.substring(3) },
42
+ });
43
+ lineIndex = endIndex + 1;
44
+ continue;
45
+ }
46
+ // Tables
47
+ if (line.includes('|')) {
48
+ let endIndex = lineIndex;
49
+ while (endIndex < lines.length && lines[endIndex].includes('|')) {
50
+ endIndex++;
51
+ }
52
+ segments.push({
53
+ scope: 'table',
54
+ startLine: lineNumber,
55
+ endLine: endIndex,
56
+ content: lines.slice(lineIndex, endIndex).join('\n'),
57
+ });
58
+ lineIndex = endIndex;
59
+ continue;
60
+ }
61
+ // Headings
62
+ const headingMatch = line.match(/^(#{1,6})\s/);
63
+ if (headingMatch) {
64
+ segments.push({
65
+ scope: 'heading',
66
+ startLine: lineNumber,
67
+ endLine: lineNumber,
68
+ content: line,
69
+ metadata: { level: headingMatch[1].length },
70
+ });
71
+ lineIndex++;
72
+ continue;
73
+ }
74
+ // HTML comments
75
+ if (line.trim().startsWith('<!--')) {
76
+ let endIndex = lineIndex;
77
+ while (endIndex < lines.length && !lines[endIndex].trim().endsWith('-->')) {
78
+ endIndex++;
79
+ }
80
+ segments.push({
81
+ scope: 'code',
82
+ startLine: lineNumber,
83
+ endLine: endIndex + 1,
84
+ content: lines.slice(lineIndex, endIndex + 1).join('\n'),
85
+ metadata: { language: 'html-comment' },
86
+ });
87
+ lineIndex = endIndex + 1;
88
+ continue;
89
+ }
90
+ // Paragraphs (simple version)
91
+ if (line.trim() !== '') {
92
+ let endIndex = lineIndex;
93
+ while (endIndex + 1 < lines.length && lines[endIndex + 1].trim() !== '') {
94
+ endIndex++;
95
+ }
96
+ segments.push({
97
+ scope: 'paragraph',
98
+ startLine: lineNumber,
99
+ endLine: endIndex + 1,
100
+ content: lines.slice(lineIndex, endIndex + 1).join('\n'),
101
+ });
102
+ lineIndex = endIndex + 1;
103
+ continue;
104
+ }
105
+ lineIndex++;
106
+ }
107
+ return segments;
108
+ }
109
+ }
110
+ //# sourceMappingURL=scope.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"scope.js","sourceRoot":"","sources":["../src/scope.ts"],"names":[],"mappings":"AAkCA;;GAEG;AACH,MAAM,OAAO,mBAAmB;IAC9B,KAAK,CAAC,OAAe;QACnB,MAAM,QAAQ,GAAoB,EAAE,CAAC;QACrC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,SAAS,GAAG,CAAC,CAAC;QAElB,OAAO,SAAS,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;YAChC,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;YAC9B,MAAM,UAAU,GAAG,SAAS,GAAG,CAAC,CAAC;YAEjC,cAAc;YACd,IAAI,UAAU,KAAK,CAAC,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;gBACvC,IAAI,QAAQ,GAAG,SAAS,GAAG,CAAC,CAAC;gBAC7B,OAAO,QAAQ,GAAG,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,KAAK,EAAE,CAAC;oBAC5D,QAAQ,EAAE,CAAC;gBACb,CAAC;gBACD,IAAI,QAAQ,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;oBAC5B,QAAQ,CAAC,IAAI,CAAC;wBACZ,KAAK,EAAE,aAAa;wBACpB,SAAS,EAAE,UAAU;wBACrB,OAAO,EAAE,QAAQ,GAAG,CAAC;wBACrB,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;qBACzD,CAAC,CAAC;oBACH,SAAS,GAAG,QAAQ,GAAG,CAAC,CAAC;oBACzB,SAAS;gBACX,CAAC;YACH,CAAC;YAED,cAAc;YACd,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrD,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBACvC,IAAI,QAAQ,GAAG,SAAS,GAAG,CAAC,CAAC;gBAC7B,OAAO,QAAQ,GAAG,KAAK,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;oBACzE,QAAQ,EAAE,CAAC;gBACb,CAAC;gBACD,QAAQ,CAAC,IAAI,CAAC;oBACZ,KAAK,EAAE,MAAM;oBACb,SAAS,EAAE,UAAU;oBACrB,OAAO,EAAE,QAAQ,GAAG,CAAC;oBACrB,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;oBACxD,QAAQ,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE;iBAC1C,CAAC,CAAC;gBACH,SAAS,GAAG,QAAQ,GAAG,CAAC,CAAC;gBACzB,SAAS;YACX,CAAC;YAED,SAAS;YACT,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACvB,IAAI,QAAQ,GAAG,SAAS,CAAC;gBACzB,OAAO,QAAQ,GAAG,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;oBAChE,QAAQ,EAAE,CAAC;gBACb,CAAC;gBACD,QAAQ,CAAC,IAAI,CAAC;oBACZ,KAAK,EAAE,OAAO;oBACd,SAAS,EAAE,UAAU;oBACrB,OAAO,EAAE,QAAQ;oBACjB,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;iBACrD,CAAC,CAAC;gBACH,SAAS,GAAG,QAAQ,CAAC;gBACrB,SAAS;YACX,CAAC;YAED,WAAW;YACX,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YAC/C,IAAI,YAAY,EAAE,CAAC;gBACjB,QAAQ,CAAC,IAAI,CAAC;oBACZ,KAAK,EAAE,SAAS;oBAChB,SAAS,EAAE,UAAU;oBACrB,OAAO,EAAE,UAAU;oBACnB,OAAO,EAAE,IAAI;oBACb,QAAQ,EAAE,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE;iBAC5C,CAAC,CAAC;gBACH,SAAS,EAAE,CAAC;gBACZ,SAAS;YACX,CAAC;YAED,gBAAgB;YAChB,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;gBACnC,IAAI,QAAQ,GAAG,SAAS,CAAC;gBACzB,OAAO,QAAQ,GAAG,KAAK,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC1E,QAAQ,EAAE,CAAC;gBACb,CAAC;gBACD,QAAQ,CAAC,IAAI,CAAC;oBACZ,KAAK,EAAE,MAAM;oBACb,SAAS,EAAE,UAAU;oBACrB,OAAO,EAAE,QAAQ,GAAG,CAAC;oBACrB,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;oBACxD,QAAQ,EAAE,EAAE,QAAQ,EAAE,cAAc,EAAE;iBACvC,CAAC,CAAC;gBACH,SAAS,GAAG,QAAQ,GAAG,CAAC,CAAC;gBACzB,SAAS;YACX,CAAC;YAED,8BAA8B;YAC9B,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;gBACvB,IAAI,QAAQ,GAAG,SAAS,CAAC;gBACzB,OAAO,QAAQ,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;oBACxE,QAAQ,EAAE,CAAC;gBACb,CAAC;gBACD,QAAQ,CAAC,IAAI,CAAC;oBACZ,KAAK,EAAE,WAAW;oBAClB,SAAS,EAAE,UAAU;oBACrB,OAAO,EAAE,QAAQ,GAAG,CAAC;oBACrB,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;iBACzD,CAAC,CAAC;gBACH,SAAS,GAAG,QAAQ,GAAG,CAAC,CAAC;gBACzB,SAAS;YACX,CAAC;YAED,SAAS,EAAE,CAAC;QACd,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}
@@ -0,0 +1,56 @@
1
+ export interface SwapAssertion {
2
+ ignoreCase?: boolean;
3
+ wordBoundary?: boolean;
4
+ keysAreRegex?: boolean;
5
+ pairs: Record<string, string>;
6
+ }
7
+ export interface PatternAssertion {
8
+ tokens: string[];
9
+ ignoreCase?: boolean;
10
+ nonword?: boolean;
11
+ negate?: boolean;
12
+ }
13
+ export interface MaxLineLengthAssertion {
14
+ maxLength: number;
15
+ ignoreCodeBlocks?: boolean;
16
+ ignoreTables?: boolean;
17
+ ignoreFrontMatter?: boolean;
18
+ ignoreHtmlTags?: boolean;
19
+ ignoreMarkdownLinkUrls?: boolean;
20
+ }
21
+ export interface NoTrailingSpacesAssertion {
22
+ skipCodeBlocks?: boolean;
23
+ skipBlankLines?: boolean;
24
+ }
25
+ export interface BulletStyleAssertion {
26
+ style: '-' | '*';
27
+ normalizeNested?: boolean;
28
+ }
29
+ export interface SemanticLineBreaksAssertion {
30
+ mode: 'sentence' | 'phrase';
31
+ maxPhrase?: number;
32
+ ignoreCodeBlocks?: boolean;
33
+ ignoreTables?: boolean;
34
+ }
35
+ export interface NoHardTabsAssertion {
36
+ skipCodeBlocks?: boolean;
37
+ /** Number of spaces to replace a hard tab with. Default: 2 */
38
+ spacesPerTab?: number;
39
+ }
40
+ export interface NoDuplicateHeadingsAssertion {
41
+ caseSensitive?: boolean;
42
+ ignoreCommonHeadings?: boolean;
43
+ respectSections?: boolean;
44
+ }
45
+ export interface NoBrokenFragmentLinksAssertion {
46
+ /** Whether to check fragments in external files. Default: true */
47
+ checkExternalFiles?: boolean;
48
+ }
49
+ export interface MaxImageSizeAssertion {
50
+ /** Maximum image size in KB. Default: 100 */
51
+ maxSizeKB?: number;
52
+ /** File extensions to check. Default: ['jpg', 'jpeg', 'png', 'gif', 'webp', 'svg'] */
53
+ extensions?: string[];
54
+ }
55
+ export type AssertionConfig = SwapAssertion | PatternAssertion | MaxLineLengthAssertion | NoTrailingSpacesAssertion | BulletStyleAssertion | SemanticLineBreaksAssertion | NoHardTabsAssertion | NoDuplicateHeadingsAssertion | NoBrokenFragmentLinksAssertion | MaxImageSizeAssertion;
56
+ //# sourceMappingURL=assertions.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"assertions.d.ts","sourceRoot":"","sources":["../../src/types/assertions.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,aAAa;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC;AAED,MAAM,WAAW,yBAAyB;IACxC,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,GAAG,GAAG,GAAG,CAAC;IACjB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,UAAU,GAAG,QAAQ,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,mBAAmB;IAClC,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,8DAA8D;IAC9D,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,4BAA4B;IAC3C,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,8BAA8B;IAC7C,kEAAkE;IAClE,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED,MAAM,WAAW,qBAAqB;IACpC,6CAA6C;IAC7C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sFAAsF;IACtF,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB;AAGD,MAAM,MAAM,eAAe,GACvB,aAAa,GACb,gBAAgB,GAChB,sBAAsB,GACtB,yBAAyB,GACzB,oBAAoB,GACpB,2BAA2B,GAC3B,mBAAmB,GACnB,4BAA4B,GAC5B,8BAA8B,GAC9B,qBAAqB,CAAC"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=assertions.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"assertions.js","sourceRoot":"","sources":["../../src/types/assertions.ts"],"names":[],"mappings":""}
@@ -0,0 +1,6 @@
1
+ export * from './rules.js';
2
+ export * from './assertions.js';
3
+ export * from './problems.js';
4
+ export * from './validation.js';
5
+ export * from './reporting.js';
6
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC"}
@@ -0,0 +1,6 @@
1
+ export * from './rules.js';
2
+ export * from './assertions.js';
3
+ export * from './problems.js';
4
+ export * from './validation.js';
5
+ export * from './reporting.js';
6
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC"}
@@ -0,0 +1,21 @@
1
+ import type { RuleSeverity } from './rules.js';
2
+ export interface Problem {
3
+ file: string;
4
+ line: number;
5
+ column: number;
6
+ text: string;
7
+ match: string;
8
+ ruleName: string;
9
+ severity: RuleSeverity;
10
+ message: string;
11
+ }
12
+ export interface Fix {
13
+ file: string;
14
+ line: number;
15
+ column: number;
16
+ oldText: string;
17
+ newText: string;
18
+ ruleName: string;
19
+ description: string;
20
+ }
21
+ //# sourceMappingURL=problems.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"problems.d.ts","sourceRoot":"","sources":["../../src/types/problems.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,YAAY,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,GAAG;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;CACrB"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=problems.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"problems.js","sourceRoot":"","sources":["../../src/types/problems.ts"],"names":[],"mappings":""}
@@ -0,0 +1,23 @@
1
+ export interface BreakdownStats {
2
+ errors: number;
3
+ warnings: number;
4
+ info: number;
5
+ total: number;
6
+ }
7
+ export type RuleBreakdown = Record<string, BreakdownStats>;
8
+ export interface Summary {
9
+ filesScanned: number;
10
+ totalIssues: number;
11
+ totalErrors: number;
12
+ totalWarnings: number;
13
+ totalInfo: number;
14
+ breakdown: RuleBreakdown;
15
+ }
16
+ export type OutputFormat = 'table' | 'json' | 'sarif' | 'github-actions';
17
+ export interface ReportOptions {
18
+ format: OutputFormat;
19
+ showStats?: boolean;
20
+ annotationsLimit?: number;
21
+ outputPath?: string;
22
+ }
23
+ //# sourceMappingURL=reporting.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"reporting.d.ts","sourceRoot":"","sources":["../../src/types/reporting.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;AAE3D,MAAM,WAAW,OAAO;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,aAAa,CAAC;CAC1B;AAED,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,gBAAgB,CAAC;AAEzE,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,YAAY,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=reporting.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"reporting.js","sourceRoot":"","sources":["../../src/types/reporting.ts"],"names":[],"mappings":""}
@@ -0,0 +1,43 @@
1
+ import type { AssertionConfig } from './assertions';
2
+ export type RuleSeverity = 'off' | 'info' | 'warn' | 'error';
3
+ export type RuleScope = 'all' | 'heading' | 'sentence' | 'paragraph' | 'code' | 'default' | 'raw' | string | string[];
4
+ export interface BaseRule {
5
+ severity: RuleSeverity;
6
+ message: string;
7
+ enabled?: boolean;
8
+ tags?: string[];
9
+ description?: string;
10
+ link?: string;
11
+ scope?: RuleScope;
12
+ appliesTo?: string[];
13
+ excludes?: string[];
14
+ exceptions?: {
15
+ files?: string[];
16
+ lines?: string[];
17
+ };
18
+ autoFixable?: boolean;
19
+ assertions: Record<string, AssertionConfig>;
20
+ }
21
+ export interface NormalizedRule {
22
+ name: string;
23
+ shortName: string;
24
+ severity: RuleSeverity;
25
+ message: string;
26
+ enabled?: boolean;
27
+ tags?: string[];
28
+ description?: string;
29
+ link?: string;
30
+ scope?: RuleScope;
31
+ appliesTo?: string[];
32
+ excludes?: string[];
33
+ exceptions?: {
34
+ files?: string[];
35
+ lines?: string[];
36
+ };
37
+ autoFixable?: boolean;
38
+ assertions: Record<string, AssertionConfig>;
39
+ }
40
+ export interface RecheckConfig {
41
+ [key: string]: BaseRule;
42
+ }
43
+ //# sourceMappingURL=rules.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"rules.d.ts","sourceRoot":"","sources":["../../src/types/rules.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAEpD,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAE7D,MAAM,MAAM,SAAS,GACjB,KAAK,GACL,SAAS,GACT,UAAU,GACV,WAAW,GACX,MAAM,GACN,SAAS,GACT,KAAK,GACL,MAAM,GACN,MAAM,EAAE,CAAC;AAEb,MAAM,WAAW,QAAQ;IACvB,QAAQ,EAAE,YAAY,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,UAAU,CAAC,EAAE;QACX,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;KAClB,CAAC;IACF,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,YAAY,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,UAAU,CAAC,EAAE;QACX,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;KAClB,CAAC;IACF,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,aAAa;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAC;CACzB"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=rules.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"rules.js","sourceRoot":"","sources":["../../src/types/rules.ts"],"names":[],"mappings":""}
@@ -0,0 +1,6 @@
1
+ export interface ValidationError {
2
+ message: string;
3
+ path?: string;
4
+ value?: any;
5
+ }
6
+ //# sourceMappingURL=validation.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../src/types/validation.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,GAAG,CAAC;CACb"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=validation.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"validation.js","sourceRoot":"","sources":["../../src/types/validation.ts"],"names":[],"mappings":""}
@@ -0,0 +1,109 @@
1
+ export type RuleSeverity = 'off' | 'info' | 'warn' | 'error';
2
+ export type RuleScope = 'all' | 'heading' | 'sentence' | 'paragraph' | 'code' | 'default' | 'raw' | string | string[];
3
+ export interface BaseRule {
4
+ severity: RuleSeverity;
5
+ message: string;
6
+ enabled?: boolean;
7
+ tags?: string[];
8
+ description?: string;
9
+ link?: string;
10
+ scope?: RuleScope;
11
+ appliesTo?: string[];
12
+ excludes?: string[];
13
+ exceptions?: {
14
+ files?: string[];
15
+ lines?: string[];
16
+ };
17
+ autoFixable?: boolean;
18
+ assertions: Record<string, AssertionConfig>;
19
+ }
20
+ export interface SwapAssertion {
21
+ ignoreCase?: boolean;
22
+ wordBoundary?: boolean;
23
+ keysAreRegex?: boolean;
24
+ pairs: Record<string, string>;
25
+ }
26
+ export interface PatternAssertion {
27
+ tokens: string[];
28
+ ignoreCase?: boolean;
29
+ nonword?: boolean;
30
+ negate?: boolean;
31
+ }
32
+ export interface MaxLineLengthAssertion {
33
+ maxLength: number;
34
+ ignoreCodeBlocks?: boolean;
35
+ ignoreTables?: boolean;
36
+ ignoreFrontMatter?: boolean;
37
+ }
38
+ export interface NoTrailingSpacesAssertion {
39
+ skipCodeBlocks?: boolean;
40
+ skipBlankLines?: boolean;
41
+ }
42
+ export interface BulletStyleAssertion {
43
+ style: '-' | '*';
44
+ normalizeNested?: boolean;
45
+ }
46
+ export interface SemanticLineBreaksAssertion {
47
+ mode: 'sentence' | 'phrase';
48
+ maxPhrase?: number;
49
+ ignoreCodeBlocks?: boolean;
50
+ ignoreTables?: boolean;
51
+ }
52
+ export interface NoHardTabsAssertion {
53
+ skipCodeBlocks?: boolean;
54
+ /** Number of spaces to replace a hard tab with. Default: 2 */
55
+ spacesPerTab?: number;
56
+ }
57
+ export interface NoDuplicateHeadingsAssertion {
58
+ caseSensitive?: boolean;
59
+ ignoreCommonHeadings?: boolean;
60
+ respectSections?: boolean;
61
+ }
62
+ export type AssertionConfig = SwapAssertion | PatternAssertion | MaxLineLengthAssertion | NoTrailingSpacesAssertion | BulletStyleAssertion | SemanticLineBreaksAssertion | NoHardTabsAssertion | NoDuplicateHeadingsAssertion;
63
+ export interface NormalizedRule {
64
+ name: string;
65
+ shortName: string;
66
+ severity: RuleSeverity;
67
+ message: string;
68
+ enabled?: boolean;
69
+ tags?: string[];
70
+ description?: string;
71
+ link?: string;
72
+ scope?: RuleScope;
73
+ appliesTo?: string[];
74
+ excludes?: string[];
75
+ exceptions?: {
76
+ files?: string[];
77
+ lines?: string[];
78
+ };
79
+ autoFixable?: boolean;
80
+ assertions: Record<string, AssertionConfig>;
81
+ }
82
+ export interface RecheckConfig {
83
+ [key: string]: BaseRule;
84
+ }
85
+ export interface Problem {
86
+ file: string;
87
+ line: number;
88
+ column: number;
89
+ text: string;
90
+ match: string;
91
+ ruleName: string;
92
+ severity: RuleSeverity;
93
+ message: string;
94
+ }
95
+ export interface Fix {
96
+ file: string;
97
+ line: number;
98
+ column: number;
99
+ oldText: string;
100
+ newText: string;
101
+ ruleName: string;
102
+ description: string;
103
+ }
104
+ export interface ValidationError {
105
+ message: string;
106
+ path?: string;
107
+ value?: any;
108
+ }
109
+ //# sourceMappingURL=types.d.ts.map