eslint-markdown 0.14.0 → 0.15.0

package/build/core/constants.d.ts

@@ -1,6 +1,22 @@
 /**
  * @fileoverview This file declares constants used throughout the `eslint-markdown` package.
  */
-export declare const PKG_NAME: "eslint-markdown";
-export declare const PKG_VERSION: string;
 export declare const URL_RULE_DOCS: (ruleName?: string) => string;
+/**
+ * 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 declare const punctuation: 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
+ * @see https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-no-heading-punctuation#parameters
+ */
+export declare const punctuationWithQuestionMark: readonly [".", ",", ";", ":", "!", "。", "，", "；", "：", "！", "?", "？"];
+/**
+ * Regular expression for identifying a GitHub emoji code.
+ * - NOTE: These patterns are based on the `markdownlint`.
+ * @see https://github.com/DavidAnson/markdownlint/blob/v0.41.1/helpers/helpers.cjs#L36-L38
+ */
+export declare const gemojiRegex: RegExp;

package/build/core/constants.js

@@ -8,6 +8,41 @@ import pkg from '../../package.json' with { type: 'json' };
 // --------------------------------------------------------------------------------
 // Export
 // --------------------------------------------------------------------------------
-export const PKG_NAME = pkg.name;
-export const PKG_VERSION = pkg.version;
 export const URL_RULE_DOCS = (ruleName = '') => `${pkg.homepage}/docs/rules/${ruleName}`;
+// --------------------------------------------------------------------------------
+// #region array
+/**
+ * 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 = [
+    '.',
+    ',',
+    ';',
+    ':',
+    '!',
+    '。',
+    '，',
+    '；',
+    '：',
+    '！',
+];
+/**
+ * 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, '?', '？'];
+// #endregion array
+// --------------------------------------------------------------------------------
+// --------------------------------------------------------------------------------
+// #region regex
+/**
+ * Regular expression for identifying a GitHub emoji code.
+ * - NOTE: These patterns are based on the `markdownlint`.
+ * @see https://github.com/DavidAnson/markdownlint/blob/v0.41.1/helpers/helpers.cjs#L36-L38
+ */
+export const gemojiRegex = /:(?:[abmovx]|[-+]1|100|1234|(?:1st|2nd|3rd)_place_medal|8ball|clock\d{1,4}|e-mail|non-potable_water|o2|t-rex|u5272|u5408|u55b6|u6307|u6708|u6709|u6e80|u7121|u7533|u7981|u7a7a|[a-z]{2,15}2?|[a-z]{1,14}(?:_[a-z\d]{1,16})+):/;
+// #endregion regex
+// --------------------------------------------------------------------------------

package/build/core/types.d.ts

@@ -1,13 +1,20 @@
 /**
  * @fileoverview Define common types.
  */
-import type { MarkdownRuleDefinition, MarkdownRuleDefinitionTypeOptions } from '@eslint/markdown';
+import type { MarkdownRuleDefinition, MarkdownRuleDefinitionTypeOptions, MarkdownRuleVisitor } from '@eslint/markdown';
+/**
+ * Keeps inferred context types nameable without exposing Markdown's internal types.
+ *
+ * NOTE: This type supports compatibility with ESLint v9 and v10.
+ * Reevaluate whether it is still needed when ESLint v9 support is dropped.
+ */
+export type RuleContext<Options extends Partial<MarkdownRuleDefinitionTypeOptions>> = Omit<Parameters<MarkdownRuleDefinition<Options>['create']>[0], never>;
 /**
  * Represents a rule module with specific rule options and message IDs.
  * @template RuleOptions The rule options.
  * @template MessageIds The message IDs.
  */
-export type RuleModule<RuleOptions extends MarkdownRuleDefinitionTypeOptions['RuleOptions'], MessageIds extends MarkdownRuleDefinitionTypeOptions['MessageIds']> = MarkdownRuleDefinition<{
+export interface RuleModule<RuleOptions extends MarkdownRuleDefinitionTypeOptions['RuleOptions'], MessageIds extends MarkdownRuleDefinitionTypeOptions['MessageIds']> extends MarkdownRuleDefinition<{
     RuleOptions: RuleOptions;
     MessageIds: MessageIds;
     ExtRuleDocs: Partial<{
@@ -16,4 +23,9 @@ export type RuleModule<RuleOptions extends MarkdownRuleDefinitionTypeOptions['Ru
          */
         stylistic: boolean;
     }>;
-}>;
+}> {
+    create(context: RuleContext<{
+        RuleOptions: RuleOptions;
+        MessageIds: MessageIds;
+    }>): MarkdownRuleVisitor;
+}