eslint-plugin-markdown-preferences 0.2.0 → 0.3.0

package/README.md

@@ -92,6 +92,7 @@ The rules with the following star ⭐ are included in the configs.
 |:--------|:------------|:-------:|:-----------:|
 | [markdown-preferences/hard-linebreak-style](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/hard-linebreak-style.html) | enforce consistent hard linebreak style. | 🔧 | ⭐ |
 | [markdown-preferences/no-text-backslash-linebreak](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-text-backslash-linebreak.html) | disallow text backslash at the end of a line. |  | ⭐ |
+| [markdown-preferences/no-trailing-spaces](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-trailing-spaces.html) | trailing whitespace at the end of lines in Markdown files. | 🔧 |  |
 | [markdown-preferences/prefer-linked-words](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/prefer-linked-words.html) | enforce the specified word to be a link. | 🔧 |  |
 
 <!--RULES_TABLE_END-->

package/lib/index.d.ts

@@ -19,7 +19,7 @@ declare namespace meta_d_exports {
   export { name, version };
 }
 declare const name: "eslint-plugin-markdown-preferences";
-declare const version: "0.2.0";
+declare const version: "0.3.0";
 //#endregion
 //#region src/index.d.ts
 declare const configs: {

package/lib/index.js

@@ -124,6 +124,125 @@ var no_text_backslash_linebreak_default = createRule("no-text-backslash-linebrea
 	}
 });
 
+//#endregion
+//#region src/rules/no-trailing-spaces.ts
+const htmlComment = /<!--.*?-->/gsu;
+var no_trailing_spaces_default = createRule("no-trailing-spaces", {
+	meta: {
+		type: "layout",
+		docs: {
+			description: "trailing whitespace at the end of lines in Markdown files.",
+			categories: []
+		},
+		fixable: "whitespace",
+		hasSuggestions: false,
+		schema: [{
+			type: "object",
+			properties: {
+				skipBlankLines: {
+					type: "boolean",
+					default: false
+				},
+				ignoreComments: {
+					type: "boolean",
+					default: false
+				}
+			},
+			additionalProperties: false
+		}],
+		messages: { trailingSpace: "Trailing spaces not allowed." }
+	},
+	create(context) {
+		const sourceCode = context.sourceCode;
+		const options = context.options[0] || {};
+		const skipBlankLines = options.skipBlankLines || false;
+		const ignoreComments = options.ignoreComments || false;
+		const comments = [];
+		const ignoreNodes = [];
+		/**
+		* Report the error message
+		* @param node node to report
+		* @param location range information
+		* @param fixRange Range based on the whole program
+		* @returns {void}
+		*/
+		function report(location, fixRange) {
+			context.report({
+				loc: location,
+				messageId: "trailingSpace",
+				fix(fixer) {
+					return fixer.removeRange(fixRange);
+				}
+			});
+		}
+		/**
+		* Given a list of comment nodes, return the line numbers for those comments.
+		* @returns {Set<number>} A set of line numbers containing comments.
+		*/
+		function getCommentLineNumbers() {
+			const lines = /* @__PURE__ */ new Set();
+			comments.forEach((comment) => {
+				const loc = sourceCode.getLoc(comment);
+				const endLine = loc.end.line - 1;
+				for (let i = loc.start.line; i <= endLine; i++) lines.add(i);
+			});
+			return lines;
+		}
+		return {
+			html(node) {
+				if (htmlComment.test(node.value)) comments.push(node);
+			},
+			"break, code, inlineCode, text, yaml, toml, json"(node) {
+				ignoreNodes.push(node);
+			},
+			"root:exit"() {
+				const re = /[^\S\n\r]+$/u;
+				const skipMatch = /^[^\S\n\r]*$/u;
+				const lines = sourceCode.lines;
+				const linebreaks = sourceCode.text.match(/\r?\n/gu);
+				const commentLineNumbers = getCommentLineNumbers();
+				let totalLength = 0;
+				for (let i = 0, ii = lines.length; i < ii; i++) {
+					const lineNumber = i + 1;
+					const linebreakLength = linebreaks && linebreaks[i] ? linebreaks[i].length : 1;
+					const lineLength = lines[i].length + linebreakLength;
+					const matches = re.exec(lines[i]);
+					if (!matches) {
+						totalLength += lineLength;
+						continue;
+					}
+					const location = {
+						start: {
+							line: lineNumber,
+							column: matches.index + 1
+						},
+						end: {
+							line: lineNumber,
+							column: lineLength + 1 - linebreakLength
+						}
+					};
+					const rangeStart = totalLength + location.start.column - 1;
+					const rangeEnd = totalLength + location.end.column - 1;
+					if (ignoreNodes.some((node) => {
+						const range = sourceCode.getRange(node);
+						return range[0] <= rangeStart && rangeEnd <= range[1];
+					})) {
+						totalLength += lineLength;
+						continue;
+					}
+					if (skipBlankLines && skipMatch.test(lines[i])) {
+						totalLength += lineLength;
+						continue;
+					}
+					const fixRange = [rangeStart, rangeEnd];
+					if (!ignoreComments || !commentLineNumbers.has(lineNumber)) report(location, fixRange);
+					totalLength += lineLength;
+				}
+			}
+		};
+	}
+});
+
 //#endregion
 //#region src/rules/prefer-linked-words.ts
 const RE_PUNCTUATOR = /^[\s,:]*$/u;
@@ -227,6 +346,7 @@ var prefer_linked_words_default = createRule("prefer-linked-words", {
 const rules$1 = [
 	hard_linebreak_style_default,
 	no_text_backslash_linebreak_default,
+	no_trailing_spaces_default,
 	prefer_linked_words_default
 ];
 
@@ -262,7 +382,7 @@ __export(meta_exports, {
 	version: () => version
 });
 const name = "eslint-plugin-markdown-preferences";
-const version = "0.2.0";
+const version = "0.3.0";
 
 //#endregion
 //#region src/index.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-markdown-preferences",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "ESLint plugin that enforces our markdown preferences",
   "type": "module",
   "exports": {