eslint-markdown 0.17.0 → 0.17.1

package/build/core/constants.d.ts

@@ -2,6 +2,22 @@
  * @fileoverview This file declares constants used throughout the `eslint-markdown` package.
  */
 export declare const URL_RULE_DOCS: (ruleName?: string) => string;
+/**
+ * ASCII punctuation characters.
+ */
+export declare const asciiPunctuation: readonly [".", ",", ";", ":", "!"];
+/**
+ * ASCII punctuation characters including the question mark.
+ */
+export declare const asciiPunctuationWithQuestionMark: readonly [".", ",", ";", ":", "!", "?"];
+/**
+ * Non-ASCII punctuation characters.
+ */
+export declare const nonAsciiPunctuation: readonly ["。", "，", "；", "：", "！"];
+/**
+ * Non-ASCII punctuation characters including the question mark.
+ */
+export declare const nonAsciiPunctuationWithQuestionMark: readonly ["。", "，", "；", "：", "！", "？"];
 /**
  * This pattern is based on the punctuation list used by `markdownlint` and `remark-lint`.
  * @see https://github.com/DavidAnson/markdownlint/blob/v0.41.1/helpers/helpers.cjs#L41
@@ -13,7 +29,11 @@ export declare const punctuation: readonly [".", ",", ";", ":", "!", "。", "，
  * @see https://github.com/DavidAnson/markdownlint/blob/v0.41.1/helpers/helpers.cjs#L41
  * @see https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-no-heading-punctuation#parameters
  */
-export declare const punctuationWithQuestionMark: readonly [".", ",", ";", ":", "!", "。", "，", "；", "：", "！", "?", "？"];
+export declare const punctuationWithQuestionMark: readonly [".", ",", ";", ":", "!", "?", "。", "，", "；", "：", "！", "？"];
+/**
+ * Regular expression for identifying an odd-length run of backslashes at the end of a string.
+ */
+export declare const escapedTrailingBackslashRegex: RegExp;
 /**
  * Regular expression for identifying a GitHub emoji code.
  * - NOTE: These patterns are based on the `markdownlint`.

package/build/core/constants.js

@@ -11,33 +11,48 @@ import pkg from '../../package.json' with { type: 'json' };
 export const URL_RULE_DOCS = (ruleName = '') => `${pkg.homepage}/docs/rules/${ruleName}`;
 // --------------------------------------------------------------------------------
 // #region array
+/**
+ * ASCII punctuation characters.
+ */
+export const asciiPunctuation = ['.', ',', ';', ':', '!'];
+/**
+ * ASCII punctuation characters including the question mark.
+ */
+export const asciiPunctuationWithQuestionMark = [...asciiPunctuation, '?'];
+/**
+ * Non-ASCII punctuation characters.
+ */
+export const nonAsciiPunctuation = ['。', '，', '；', '：', '！'];
+/**
+ * Non-ASCII punctuation characters including the question mark.
+ */
+export const nonAsciiPunctuationWithQuestionMark = [
+    ...nonAsciiPunctuation,
+    '？',
+];
 /**
  * This pattern is based on the punctuation list used by `markdownlint` and `remark-lint`.
  * @see https://github.com/DavidAnson/markdownlint/blob/v0.41.1/helpers/helpers.cjs#L41
  * @see https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-no-heading-punctuation#parameters
  */
-export const punctuation = [
-    '.',
-    ',',
-    ';',
-    ':',
-    '!',
-    '。',
-    '，',
-    '；',
-    '：',
-    '！',
-];
+export const punctuation = [...asciiPunctuation, ...nonAsciiPunctuation];
 /**
  * This pattern is based on the punctuation list used by `markdownlint` and `remark-lint`.
  * @see https://github.com/DavidAnson/markdownlint/blob/v0.41.1/helpers/helpers.cjs#L41
  * @see https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-no-heading-punctuation#parameters
  */
-export const punctuationWithQuestionMark = [...punctuation, '?', '？'];
+export const punctuationWithQuestionMark = [
+    ...asciiPunctuationWithQuestionMark,
+    ...nonAsciiPunctuationWithQuestionMark,
+];
 // #endregion array
 // --------------------------------------------------------------------------------
 // --------------------------------------------------------------------------------
 // #region regex
+/**
+ * Regular expression for identifying an odd-length run of backslashes at the end of a string.
+ */
+export const escapedTrailingBackslashRegex = /(?<=(?<!\\)(?:\\{2})*)\\$/u;
 /**
  * Regular expression for identifying a GitHub emoji code.
  * - NOTE: These patterns are based on the `markdownlint`.

package/build/rules/index.d.ts

@@ -932,7 +932,7 @@ declare const _default: {
                             readonly type: "string";
                             readonly minLength: 2;
                             readonly maxLength: 2;
-                            readonly pattern: "^[!,.:;?]{2}$";
+                            readonly pattern: `^[${string}]{2}$`;
                         };
                         readonly uniqueItems: true;
                     };

package/build/rules/no-double-punctuation.d.ts

@@ -37,7 +37,7 @@ declare const _default: {
                         readonly type: "string";
                         readonly minLength: 2;
                         readonly maxLength: 2;
-                        readonly pattern: "^[!,.:;?]{2}$";
+                        readonly pattern: `^[${string}]{2}$`;
                     };
                     readonly uniqueItems: true;
                 };

package/build/rules/no-double-punctuation.js

@@ -5,15 +5,17 @@
 // --------------------------------------------------------------------------------
 // Import
 // --------------------------------------------------------------------------------
-import { URL_RULE_DOCS } from '../core/constants.js';
+import { escapeStringRegexp } from '../core/utils/index.js';
+import { URL_RULE_DOCS, asciiPunctuationWithQuestionMark } from '../core/constants.js';
 // --------------------------------------------------------------------------------
 // Helper
 // --------------------------------------------------------------------------------
+const escapedAsciiPunctuationWithQuestionMark = escapeStringRegexp(asciiPunctuationWithQuestionMark.join(''));
 /**
  * This pattern is based on the punctuation list used by `remark-lint`.
  * @see https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-no-heading-punctuation#parameters
  */
-const doublePunctuationRegex = /(?:^|(?<=[^!,.:;?]))[!,.:;?]{2}(?:$|(?=[^!,.:;?]))/g;
+const doublePunctuationRegex = new RegExp(`(?:^|(?<=[^${escapedAsciiPunctuationWithQuestionMark}]))[${escapedAsciiPunctuationWithQuestionMark}]{2}(?:$|(?=[^${escapedAsciiPunctuationWithQuestionMark}]))`, 'g');
 // --------------------------------------------------------------------------------
 // Rule Definition
 // --------------------------------------------------------------------------------
@@ -38,7 +40,7 @@ export default {
                             type: 'string',
                             minLength: 2,
                             maxLength: 2,
-                            pattern: '^[!,.:;?]{2}$',
+                            pattern: `^[${escapedAsciiPunctuationWithQuestionMark}]{2}$`,
                         },
                         uniqueItems: true,
                     },

package/build/rules/no-shell-dollar.js

@@ -7,13 +7,12 @@
 // Import
 // --------------------------------------------------------------------------------
 import { getCodeStyle, isBlankLine } from '../core/utils/index.js';
-import { URL_RULE_DOCS } from '../core/constants.js';
+import { URL_RULE_DOCS, escapedTrailingBackslashRegex } from '../core/constants.js';
 // --------------------------------------------------------------------------------
 // Helper
 // --------------------------------------------------------------------------------
 const dollarCommandRegex = /^[ \t]*\$[ \t]+/u;
 const promptRegex = /\$[ \t]+/u;
-const trailingBackslashRegex = /\\+$/u;
 const lineEndingRegex = /\r\n|[\r\n]/u;
 // --------------------------------------------------------------------------------
 // Rule Definition
@@ -89,8 +88,7 @@ export default {
                         const endOffset = startOffset + match[0].length;
                         promptRanges.push([startOffset, endOffset]);
                     }
-                    isPreviousLineContinues =
-                        (trailingBackslashRegex.exec(codeLine)?.[0].length ?? 0) % 2 === 1;
+                    isPreviousLineContinues = escapedTrailingBackslashRegex.test(codeLine);
                 }
                 for (const [startOffset, endOffset] of promptRanges) {
                     context.report({

package/build/rules/no-trailing-heading-punctuation.js

@@ -6,7 +6,7 @@
 // Import
 // --------------------------------------------------------------------------------
 import { escapeStringRegexp } from '../core/utils/index.js';
-import { URL_RULE_DOCS, punctuation as defaultPunctuation, gemojiRegex, } from '../core/constants.js';
+import { URL_RULE_DOCS, punctuation as defaultPunctuation, escapedTrailingBackslashRegex, gemojiRegex, } from '../core/constants.js';
 // --------------------------------------------------------------------------------
 // Helper
 // --------------------------------------------------------------------------------
@@ -65,7 +65,7 @@ export default {
     create(context) {
         const { sourceCode } = context;
         const [{ punctuation }] = context.options;
-        const trailingPunctuationRegex = new RegExp(`[ \\t\\r\\n]*[${escapeStringRegexp(punctuation.join(''))}]+$`);
+        const trailingPunctuationRegex = new RegExp(`(?<leadingSpaces>[ \\t\\r\\n]*)[${escapeStringRegexp(punctuation.join(''))}]+$`);
         return {
             heading(node) {
                 /*
@@ -128,9 +128,10 @@ export default {
                 }
                 const lastChildText = sourceCode.getText(lastChildNode);
                 const match = trailingPunctuationRegex.exec(lastChildText);
-                if (!match) {
+                if (!match || !match.groups) {
                     return;
                 }
+                const { leadingSpaces } = match.groups;
                 let trailingPunctuation = match[0];
                 /*
                  * Slice from the beginning of the trailing `text` node through the first
@@ -176,7 +177,14 @@ export default {
                     },
                     messageId: 'noTrailingHeadingPunctuation',
                     fix(fixer) {
-                        return fixer.removeRange([startOffset, endOffset]);
+                        return fixer.removeRange([
+                            startOffset -
+                                Number(
+                                // When `leadingSpaces` is `''` (empty string), check for an escaped trailing backslash.
+                                !leadingSpaces &&
+                                    escapedTrailingBackslashRegex.test(lastChildText.slice(0, -trailingPunctuation.length))),
+                            endOffset,
+                        ]);
                     },
                 });
             },

package/build/rules/require-image-title.js

@@ -64,14 +64,28 @@ export default {
                 const [nodeStartOffset] = sourceCode.getRange(node);
                 const html = sourceCode.getText(node);
                 for (const { attrs, sourceCodeLocation } of getElementsByTagName(html, 'img')) {
-                    let hasTitle = false;
+                    if (!sourceCodeLocation ||
+                        (!sourceCodeLocation.attrs?.src &&
+                            !sourceCodeLocation.attrs?.srcset &&
+                            !sourceCodeLocation.attrs?.alt)) {
+                        continue;
+                    }
+                    let needsTitle = true;
                     for (const { name, value } of attrs) {
                         if (name === 'title' && value) {
-                            hasTitle = true;
+                            needsTitle = false;
+                            break;
+                        }
+                        if (name === 'alt' && !value) {
+                            needsTitle = false;
+                            break;
+                        }
+                        if (name === 'aria-hidden' && value.toLowerCase() === 'true') {
+                            needsTitle = false;
                             break;
                         }
                     }
-                    if (!hasTitle && sourceCodeLocation) {
+                    if (needsTitle) {
                         report({
                             start: sourceCode.getLocFromIndex(nodeStartOffset + sourceCodeLocation.startOffset),
                             end: sourceCode.getLocFromIndex(nodeStartOffset + sourceCodeLocation.endOffset),

package/build/rules/require-link-title.js

@@ -67,14 +67,21 @@ export default {
                 const [nodeStartOffset] = sourceCode.getRange(node);
                 const html = sourceCode.getText(node);
                 for (const { attrs, sourceCodeLocation } of getElementsByTagName(html, 'a')) {
-                    let hasTitle = false;
+                    if (!sourceCodeLocation?.startTag || !sourceCodeLocation.attrs?.href) {
+                        continue;
+                    }
+                    let needsTitle = true;
                     for (const { name, value } of attrs) {
                         if (name === 'title' && value) {
-                            hasTitle = true;
+                            needsTitle = false;
+                            break;
+                        }
+                        if (name === 'aria-hidden' && value.toLowerCase() === 'true') {
+                            needsTitle = false;
                             break;
                         }
                     }
-                    if (!hasTitle && sourceCodeLocation?.startTag) {
+                    if (needsTitle) {
                         report({
                             start: sourceCode.getLocFromIndex(nodeStartOffset + sourceCodeLocation.startTag.startOffset),
                             end: sourceCode.getLocFromIndex(nodeStartOffset + sourceCodeLocation.startTag.endOffset),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-markdown",
-  "version": "0.17.0",
+  "version": "0.17.1",
   "type": "module",
   "sideEffects": false,
   "description": "Lint your Markdown with ESLint. Additional rules for use with `@eslint/markdown`.🛠️",