eslint-markdown 0.15.0 → 0.17.0

package/README.md

@@ -1,8 +1,8 @@
 # eslint-markdown
 
-[![ci](https://img.shields.io/github/actions/workflow/status/lumirlumir/npm-eslint-markdown/ci.yml?label=ci&color=6358d4&labelColor=333333&logo=github)](https://github.com/lumirlumir/npm-eslint-markdown/actions/workflows/ci.yml)
-[![test](https://img.shields.io/github/actions/workflow/status/lumirlumir/npm-eslint-markdown/test.yml?label=test&color=6358d4&labelColor=333333&logo=github)](https://github.com/lumirlumir/npm-eslint-markdown/actions/workflows/test.yml)
-[![codecov](https://img.shields.io/codecov/c/gh/lumirlumir/npm-eslint-markdown?token=LJMUst9eR3&label=Codecov&color=6358d4&labelColor=333333&logo=codecov)](https://codecov.io/gh/lumirlumir/npm-eslint-markdown)
+[![ci](https://img.shields.io/github/actions/workflow/status/eslint-markdown/eslint-markdown/ci.yml?label=ci&color=6358d4&labelColor=333333&logo=github)](https://github.com/eslint-markdown/eslint-markdown/actions/workflows/ci.yml)
+[![test](https://img.shields.io/github/actions/workflow/status/eslint-markdown/eslint-markdown/test.yml?label=test&color=6358d4&labelColor=333333&logo=github)](https://github.com/eslint-markdown/eslint-markdown/actions/workflows/test.yml)
+[![codecov](https://img.shields.io/codecov/c/gh/eslint-markdown/eslint-markdown?token=LJMUst9eR3&label=Codecov&color=6358d4&labelColor=333333&logo=codecov)](https://codecov.io/gh/eslint-markdown/eslint-markdown)
 ![Node Current](https://img.shields.io/node/v/eslint-markdown?color=6358d4&labelColor=333333&logo=node.js)
 
 [![npm package eslint-markdown latest version](https://img.shields.io/npm/v/eslint-markdown?label=eslint-markdown@latest&color=6358d4&labelColor=333333&logo=npm)](https://www.npmjs.com/package/eslint-markdown)
@@ -11,7 +11,7 @@
 
 > [!IMPORTANT]
 >
-> If you like this package, please give it a star on [GitHub](https://github.com/lumirlumir/npm-eslint-markdown)!⭐<br/>
+> If you like this package, please give it a star on [GitHub](https://github.com/eslint-markdown/eslint-markdown)!⭐<br/>
 > Your support helps us improve and maintain the project.
 
 Lint your Markdown with ESLint. Additional rules for use with `@eslint/markdown`.🛠️
@@ -27,17 +27,17 @@ For full documentation, see the [official documentation of the `eslint-markdown`
 
 ## Compatibility
 
-This [`eslint-markdown`](https://github.com/lumirlumir/npm-eslint-markdown#readme) plugin does not include any rules that overlap with ESLint's built-in Markdown rules provided by [`@eslint/markdown`](https://github.com/eslint/markdown#readme).
+This [`eslint-markdown`](https://github.com/eslint-markdown/eslint-markdown#readme) plugin does not include any rules that overlap with ESLint's built-in Markdown rules provided by [`@eslint/markdown`](https://github.com/eslint/markdown#readme).
 
 So, we **highly recommend** using the `eslint-markdown` plugin alongside ESLint's built-in Markdown support, `@eslint/markdown`.
 
 ## Code of Conduct
 
-See [Code of Conduct](https://github.com/lumirlumir/.github/blob/main/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct).
+See [Code of Conduct](https://github.com/eslint-markdown/eslint-markdown/blob/main/CODE_OF_CONDUCT.md).
 
 ## Change Log
 
-See [Change Log](https://github.com/lumirlumir/npm-eslint-markdown/blob/main/CHANGELOG.md).
+See [Change Log](https://github.com/eslint-markdown/eslint-markdown/blob/main/CHANGELOG.md).
 
 ## Versioning
 
@@ -45,8 +45,8 @@ See [Versioning](https://eslint-markdown.lumir.page/docs/get-started/versioning)
 
 ## Security
 
-See [Security](https://github.com/lumirlumir/.github/blob/main/SECURITY.md#security).
+See [Security](https://github.com/eslint-markdown/eslint-markdown/blob/main/SECURITY.md).
 
 ## License
 
-[MIT](https://github.com/lumirlumir/npm-eslint-markdown/blob/main/LICENSE.md)
+[MIT](https://github.com/eslint-markdown/eslint-markdown/blob/main/LICENSE.md)

package/build/configs/all.d.ts

@@ -23,6 +23,7 @@ export default function all(plugin: ESLint.Plugin): {
         readonly 'md/consistent-code-style': "error";
         readonly 'md/consistent-delete-style': "error";
         readonly 'md/consistent-emphasis-style': "error";
+        readonly 'md/consistent-heading-style': "error";
         readonly 'md/consistent-inline-code-style': "error";
         readonly 'md/consistent-strong-style': "error";
         readonly 'md/consistent-thematic-break-style': "error";
@@ -36,6 +37,7 @@ export default function all(plugin: ESLint.Plugin): {
         readonly 'md/no-git-conflict-marker': "error";
         readonly 'md/no-irregular-dash': "error";
         readonly 'md/no-irregular-whitespace': "error";
+        readonly 'md/no-shell-dollar': "error";
         readonly 'md/no-tab': "error";
         readonly 'md/no-trailing-heading-punctuation': "error";
         readonly 'md/no-url-trailing-slash': "error";

package/build/configs/all.js

@@ -31,6 +31,7 @@ export default function all(plugin) {
             'md/consistent-code-style': 'error',
             'md/consistent-delete-style': 'error',
             'md/consistent-emphasis-style': 'error',
+            'md/consistent-heading-style': 'error',
             'md/consistent-inline-code-style': 'error',
             'md/consistent-strong-style': 'error',
             'md/consistent-thematic-break-style': 'error',
@@ -44,6 +45,7 @@ export default function all(plugin) {
             'md/no-git-conflict-marker': 'error',
             'md/no-irregular-dash': 'error',
             'md/no-irregular-whitespace': 'error',
+            'md/no-shell-dollar': 'error',
             'md/no-tab': 'error',
             'md/no-trailing-heading-punctuation': 'error',
             'md/no-url-trailing-slash': 'error',

package/build/configs/stylistic.d.ts

@@ -19,6 +19,7 @@ export default function stylistic(plugin: ESLint.Plugin): {
         readonly 'md/consistent-code-style': "error";
         readonly 'md/consistent-delete-style': "error";
         readonly 'md/consistent-emphasis-style': "error";
+        readonly 'md/consistent-heading-style': "error";
         readonly 'md/consistent-inline-code-style': "error";
         readonly 'md/consistent-strong-style': "error";
         readonly 'md/consistent-thematic-break-style': "error";

package/build/configs/stylistic.js

@@ -27,6 +27,7 @@ export default function stylistic(plugin) {
             'md/consistent-code-style': 'error',
             'md/consistent-delete-style': 'error',
             'md/consistent-emphasis-style': 'error',
+            'md/consistent-heading-style': 'error',
             'md/consistent-inline-code-style': 'error',
             'md/consistent-strong-style': 'error',
             'md/consistent-thematic-break-style': 'error',

package/build/core/types.d.ts

@@ -29,3 +29,7 @@ export interface RuleModule<RuleOptions extends MarkdownRuleDefinitionTypeOption
         MessageIds: MessageIds;
     }>): MarkdownRuleVisitor;
 }
+/**
+ * Represents a range of characters in the source.
+ */
+export type SourceRange = [number, number];

package/build/core/utils/escape-string-regexp.d.ts

@@ -11,7 +11,7 @@
  * @returns An escaped string.
  * @example
  * ```js
- * import escapeStringRegexp from 'path/to/escape-string-regexp.js';
+ * import { escapeStringRegexp } from 'path/to/escape-string-regexp.js';
  *
  * const escapedString = escapeStringRegexp('How much $ for a 🦄?');
  * //=> 'How much \\$ for a 🦄\\?'
@@ -19,4 +19,4 @@
  * new RegExp(escapedString);
  * ```
  */
-export default function escapeStringRegexp(string: string): string;
+export declare function escapeStringRegexp(string: string): string;

package/build/core/utils/escape-string-regexp.js

@@ -37,7 +37,7 @@
  * @returns An escaped string.
  * @example
  * ```js
- * import escapeStringRegexp from 'path/to/escape-string-regexp.js';
+ * import { escapeStringRegexp } from 'path/to/escape-string-regexp.js';
  *
  * const escapedString = escapeStringRegexp('How much $ for a 🦄?');
  * //=> 'How much \\$ for a 🦄\\?'
@@ -45,7 +45,7 @@
  * new RegExp(escapedString);
  * ```
  */
-export default function escapeStringRegexp(string) {
+export function escapeStringRegexp(string) {
     // Escape characters with special meaning either inside or outside character sets.
     // Use a simple backslash escape when it's always valid, and a `\xnn` escape
     // when the simpler form would be disallowed by Unicode patterns' stricter grammar.

package/build/core/utils/get-code-style.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @fileoverview Get the code style based on the given character.
+ * @see https://spec.commonmark.org/0.31.2/#fenced-code-blocks
+ * @see https://spec.commonmark.org/0.31.2/#indented-code-blocks
+ */
+export type CodeStyle = (typeof CODE_STYLE)[number];
+export declare const CODE_STYLE: readonly ["indent", "fence-backtick", "fence-tilde"];
+/**
+ * Get the code style based on the given character.
+ * @param char The character to determine the code style from. It must be a single character.
+ * @returns The code style.
+ */
+export declare function getCodeStyle(char: string): CodeStyle;

package/build/core/utils/get-code-style.js

@@ -0,0 +1,25 @@
+/**
+ * @fileoverview Get the code style based on the given character.
+ * @see https://spec.commonmark.org/0.31.2/#fenced-code-blocks
+ * @see https://spec.commonmark.org/0.31.2/#indented-code-blocks
+ */
+// --------------------------------------------------------------------------------
+// Export
+// --------------------------------------------------------------------------------
+export const CODE_STYLE = ['indent', 'fence-backtick', 'fence-tilde'];
+/**
+ * Get the code style based on the given character.
+ * @param char The character to determine the code style from. It must be a single character.
+ * @returns The code style.
+ */
+export function getCodeStyle(char) {
+    if (char === '`') {
+        return 'fence-backtick';
+    }
+    else if (char === '~') {
+        return 'fence-tilde';
+    }
+    else {
+        return 'indent';
+    }
+}

package/build/core/utils/html.d.ts

@@ -8,4 +8,4 @@ import type { DefaultTreeAdapterTypes } from 'parse5';
  * @param tagName The tag name to search for (case-insensitive).
  * @returns Matched elements.
  */
-export default function getElementsByTagName(html: string, tagName: string): (DefaultTreeAdapterTypes.Element | DefaultTreeAdapterTypes.Template)[];
+export declare function getElementsByTagName(html: string, tagName: string): (DefaultTreeAdapterTypes.Element | DefaultTreeAdapterTypes.Template)[];

package/build/core/utils/html.js

@@ -14,7 +14,7 @@ import { parseFragment } from 'parse5';
  * @param tagName The tag name to search for (case-insensitive).
  * @returns Matched elements.
  */
-export default function getElementsByTagName(html, tagName) {
+export function getElementsByTagName(html, tagName) {
     const ast = parseFragment(html, { sourceCodeLocationInfo: true });
     const normalizedTagName = tagName.toLowerCase();
     const nodes = [];

package/build/core/utils/index.d.ts

@@ -1,7 +1,7 @@
-import escapeStringRegexp from './escape-string-regexp.js';
-import getElementsByTagName from './html.js';
-import isBlankLine from './is-blank-line.js';
-import normalizeRegexPattern from './normalize-regex-pattern.js';
-import SkipRanges from './skip-ranges.js';
-import testRegexStateless from './test-regex-stateless.js';
-export { escapeStringRegexp, getElementsByTagName, isBlankLine, normalizeRegexPattern, SkipRanges, testRegexStateless, };
+export * from './escape-string-regexp.js';
+export * from './get-code-style.js';
+export * from './html.js';
+export * from './is-blank-line.js';
+export * from './normalize-regex-pattern.js';
+export * from './skip-ranges.js';
+export * from './test-regex-stateless.js';

package/build/core/utils/index.js

@@ -1,7 +1,7 @@
-import escapeStringRegexp from './escape-string-regexp.js';
-import getElementsByTagName from './html.js';
-import isBlankLine from './is-blank-line.js';
-import normalizeRegexPattern from './normalize-regex-pattern.js';
-import SkipRanges from './skip-ranges.js';
-import testRegexStateless from './test-regex-stateless.js';
-export { escapeStringRegexp, getElementsByTagName, isBlankLine, normalizeRegexPattern, SkipRanges, testRegexStateless, };
+export * from './escape-string-regexp.js';
+export * from './get-code-style.js';
+export * from './html.js';
+export * from './is-blank-line.js';
+export * from './normalize-regex-pattern.js';
+export * from './skip-ranges.js';
+export * from './test-regex-stateless.js';

package/build/core/utils/is-blank-line.d.ts

@@ -9,4 +9,4 @@
  * @param blockquoteDepth The depth of blockquotes. Default is `-1`.
  * @returns `true` if the line is blank. `false` otherwise.
  */
-export default function isBlankLine(str: string, blockquoteDepth?: number): boolean;
+export declare function isBlankLine(str: string, blockquoteDepth?: number): boolean;

package/build/core/utils/is-blank-line.js

@@ -17,7 +17,7 @@ const blockquoteChar = '>';
  * @param blockquoteDepth The depth of blockquotes. Default is `-1`.
  * @returns `true` if the line is blank. `false` otherwise.
  */
-export default function isBlankLine(str, blockquoteDepth = -1) {
+export function isBlankLine(str, blockquoteDepth = -1) {
     // `.length` is cached for performance.
     const strLength = str.length;
     let remainingBlockquotes = blockquoteDepth + 1;

package/build/core/utils/normalize-regex-pattern.d.ts

@@ -8,4 +8,4 @@
  * @param pattern `RegExp` or string pattern to normalize.
  * @returns The normalized `RegExp`.
  */
-export default function normalizeRegexPattern(pattern: RegExp | string): RegExp;
+export declare function normalizeRegexPattern(pattern: RegExp | string): RegExp;

package/build/core/utils/normalize-regex-pattern.js

@@ -11,6 +11,6 @@
  * @param pattern `RegExp` or string pattern to normalize.
  * @returns The normalized `RegExp`.
  */
-export default function normalizeRegexPattern(pattern) {
+export function normalizeRegexPattern(pattern) {
     return typeof pattern === 'string' ? new RegExp(pattern, 'u') : pattern;
 }

package/build/core/utils/skip-ranges.d.ts

@@ -1,12 +1,11 @@
 /**
  * @fileoverview Class to manage skip ranges.
  */
-import type { AST } from 'eslint';
-type SourceRange = AST.Range;
+import type { SourceRange } from '../types.js';
 /**
  * Class to manage skip ranges.
  */
-export default class SkipRanges {
+export declare class SkipRanges {
     #private;
     /**
      * Push a `range` to the set of skip ranges. (Method chaining supported.)
@@ -19,4 +18,3 @@ export default class SkipRanges {
      */
     includes(offset: number): boolean;
 }
-export {};

package/build/core/utils/skip-ranges.js

@@ -7,7 +7,7 @@
 /**
  * Class to manage skip ranges.
  */
-export default class SkipRanges {
+export class SkipRanges {
     // ------------------------------------------------------------------------------
     // Private Property
     // ------------------------------------------------------------------------------

package/build/core/utils/test-regex-stateless.d.ts

@@ -7,4 +7,4 @@
  * @param text Text to test.
  * @returns Whether the regex matches the text.
  */
-export default function testRegexStateless(regex: RegExp, text: string): boolean;
+export declare function testRegexStateless(regex: RegExp, text: string): boolean;

package/build/core/utils/test-regex-stateless.js

@@ -14,7 +14,7 @@ const statefulRegexFlagRegex = /[gy]/u;
  * @param text Text to test.
  * @returns Whether the regex matches the text.
  */
-export default function testRegexStateless(regex, text) {
+export function testRegexStateless(regex, text) {
     return statefulRegexFlagRegex.test(regex.flags)
         ? new RegExp(regex).test(text)
         : regex.test(text);

package/build/rules/consistent-code-style.d.ts

@@ -2,7 +2,7 @@
  * @fileoverview Rule to enforce consistent code style.
  * @author lumir(lumirlumir)
  */
-type CodeStyle = (typeof CODE_STYLE)[number];
+import { type CodeStyle } from '../core/utils/index.js';
 /**
  * Options for the `consistent-code-style` rule.
  */
@@ -26,7 +26,6 @@ type RuleOptions = [
     }
 ];
 type MessageIds = 'style' | 'blankLineAbove' | 'blankLineBelow';
-declare const CODE_STYLE: readonly ["indent", "fence-backtick", "fence-tilde"];
 declare const _default: {
     readonly meta: {
         readonly type: "layout";

package/build/rules/consistent-code-style.js

@@ -14,29 +14,9 @@
 // --------------------------------------------------------------------------------
 // Import
 // --------------------------------------------------------------------------------
-import { isBlankLine } from '../core/utils/index.js';
+import { CODE_STYLE, getCodeStyle, isBlankLine, } from '../core/utils/index.js';
 import { URL_RULE_DOCS } from '../core/constants.js';
 // --------------------------------------------------------------------------------
-// Helper
-// --------------------------------------------------------------------------------
-const CODE_STYLE = ['indent', 'fence-backtick', 'fence-tilde'];
-/**
- * Get the current code style based on the given text.
- * @param text The text to determine the code style from.
- * @returns The current code style.
- */
-function getCurrentCodeStyle(text) {
-    if (text === '`') {
-        return 'fence-backtick';
-    }
-    else if (text === '~') {
-        return 'fence-tilde';
-    }
-    else {
-        return 'indent';
-    }
-}
-// --------------------------------------------------------------------------------
 // Rule Definition
 // --------------------------------------------------------------------------------
 export default {
@@ -116,7 +96,7 @@ export default {
                 const { start, end } = sourceCode.getLoc(node);
                 const [nodeStartOffset] = sourceCode.getRange(node);
                 const currentCodeFenceChar = sourceCode.text[nodeStartOffset];
-                const currentCodeStyle = getCurrentCodeStyle(currentCodeFenceChar);
+                const currentCodeStyle = getCodeStyle(currentCodeFenceChar);
                 const nodeStartLineIndex = start.line - 1;
                 const nodeEndLineIndex = end.line - 1;
                 if (codeStyle === null) {

package/build/rules/consistent-heading-style.d.ts

@@ -0,0 +1,55 @@
+/**
+ * @fileoverview Rule to enforce consistent heading style.
+ * @author Ga eun Lee(tooth-is-silver)
+ * @author lumir(lumirlumir)
+ * @see https://github.com/DavidAnson/markdownlint/blob/v0.41.1/lib/md003.mjs
+ */
+import type { Heading } from 'mdast';
+type HeadingStyle = (typeof HEADING_STYLE)[number];
+type RuleOptions = [{
+    style: HeadingStyle;
+}];
+type MessageIds = 'style' | 'suggestAtxToSetext' | 'suggestAtxClosedToSetext';
+declare const HEADING_STYLE: readonly ["consistent", "atx", "atx-closed", "setext", "setext-with-atx", "setext-with-atx-closed"];
+declare const _default: {
+    readonly meta: {
+        readonly type: "layout";
+        readonly docs: {
+            readonly description: "Enforce consistent heading style";
+            readonly url: string;
+            readonly recommended: false;
+            readonly stylistic: true;
+        };
+        readonly fixable: "code";
+        readonly hasSuggestions: true;
+        readonly schema: [{
+            readonly type: "object";
+            readonly properties: {
+                readonly style: {
+                    readonly enum: readonly ["consistent", "atx", "atx-closed", "setext", "setext-with-atx", "setext-with-atx-closed"];
+                };
+            };
+            readonly additionalProperties: false;
+        }];
+        readonly defaultOptions: [{
+            readonly style: "consistent";
+        }];
+        readonly messages: {
+            readonly style: "Heading style should be `{{ style }}`.";
+            readonly suggestAtxToSetext: "Replace ATX heading with a Setext heading.";
+            readonly suggestAtxClosedToSetext: "Replace ATX closed heading with a Setext heading.";
+        };
+        readonly language: "markdown";
+        readonly dialects: ["commonmark", "gfm"];
+    };
+    readonly create: (context: import("../core/types.js").RuleContext<{
+        RuleOptions: RuleOptions;
+        MessageIds: MessageIds;
+    }>) => {
+        heading(node: Heading): void;
+        "heading[depth<=2]"(): void;
+        "heading[depth>2]"(): void;
+        'heading:exit'(node: Heading): void;
+    };
+};
+export default _default;