|
| 1 | +"use strict"; |
| 2 | + |
| 3 | +/** |
| 4 | + * Unit tests for document-length: disallow documents longer than a configured |
| 5 | + * maximum number of lines; reports one error on line 1 when over the limit. |
| 6 | + */ |
| 7 | + |
| 8 | +const { describe, it } = require("node:test"); |
| 9 | +const assert = require("node:assert"); |
| 10 | +const rule = require("../../markdownlint-rules/document-length.js"); |
| 11 | +const { runRule } = require("./run-rule.js"); |
| 12 | + |
| 13 | +function makeLines(n) { |
| 14 | + return Array.from({ length: n }, (_, i) => (i === 0 ? "# Title" : `line ${i + 1}`)); |
| 15 | +} |
| 16 | + |
| 17 | +describe("document-length", () => { |
| 18 | + it("reports no errors when lines.length <= maximum (default 1500)", () => { |
| 19 | + const lines = makeLines(1500); |
| 20 | + const errors = runRule(rule, lines); |
| 21 | + assert.strictEqual(errors.length, 0); |
| 22 | + }); |
| 23 | + |
| 24 | + it("reports one error when lines.length > maximum (1501 lines)", () => { |
| 25 | + const lines = makeLines(1501); |
| 26 | + const errors = runRule(rule, lines); |
| 27 | + assert.strictEqual(errors.length, 1); |
| 28 | + assert.strictEqual(errors[0].lineNumber, 1); |
| 29 | + assert.ok(errors[0].detail.includes("1501") && errors[0].detail.includes("1500")); |
| 30 | + assert.ok(errors[0].detail.includes("maximum") || errors[0].detail.includes("Consider splitting")); |
| 31 | + }); |
| 32 | + |
| 33 | + it("respects custom maximum: 11 lines with max 10 reports one error", () => { |
| 34 | + const lines = makeLines(11); |
| 35 | + const errors = runRule(rule, lines, { maximum: 10 }); |
| 36 | + assert.strictEqual(errors.length, 1); |
| 37 | + assert.strictEqual(errors[0].lineNumber, 1); |
| 38 | + assert.ok(errors[0].detail.includes("11") && errors[0].detail.includes("10")); |
| 39 | + }); |
| 40 | + |
| 41 | + it("respects custom maximum: 10 lines with max 10 reports no error", () => { |
| 42 | + const lines = makeLines(10); |
| 43 | + const errors = runRule(rule, lines, { maximum: 10 }); |
| 44 | + assert.strictEqual(errors.length, 0); |
| 45 | + }); |
| 46 | + |
| 47 | + it("reports no error for 0 lines", () => { |
| 48 | + const errors = runRule(rule, []); |
| 49 | + assert.strictEqual(errors.length, 0); |
| 50 | + }); |
| 51 | + |
| 52 | + it("reports no error for 1 line when max is 1", () => { |
| 53 | + const errors = runRule(rule, ["only line"], { maximum: 1 }); |
| 54 | + assert.strictEqual(errors.length, 0); |
| 55 | + }); |
| 56 | + |
| 57 | + it("reports one error for 2 lines when max is 1", () => { |
| 58 | + const errors = runRule(rule, ["first", "second"], { maximum: 1 }); |
| 59 | + assert.strictEqual(errors.length, 1); |
| 60 | + assert.strictEqual(errors[0].lineNumber, 1); |
| 61 | + }); |
| 62 | + |
| 63 | + it("uses default maximum when config.maximum is not a positive integer", () => { |
| 64 | + const lines = makeLines(1501); |
| 65 | + const errors = runRule(rule, lines, { maximum: "1500" }); |
| 66 | + assert.strictEqual(errors.length, 1); |
| 67 | + assert.ok(errors[0].detail.includes("1500")); |
| 68 | + }); |
| 69 | + |
| 70 | + it("reports error with empty context when first line is undefined (over limit)", () => { |
| 71 | + const lines = Array(2); |
| 72 | + lines[1] = "second"; |
| 73 | + const errors = runRule(rule, lines, { maximum: 1 }); |
| 74 | + assert.strictEqual(errors.length, 1); |
| 75 | + assert.strictEqual(errors[0].context, ""); |
| 76 | + }); |
| 77 | +}); |
0 commit comments