eslint-plugin-markdown-preferences 0.26.1 → 0.28.0

package/README.md

@@ -58,17 +58,18 @@ Example **eslint.config.js**:
 import { defineConfig } from "eslint/config";
 // import markdown from "@eslint/markdown";
 import markdownPreferences from "eslint-plugin-markdown-preferences";
-export default [
+export default defineConfig([
   // add more generic rule sets here, such as:
   // markdown.configs.recommended,
   markdownPreferences.configs.recommended,
   {
+    files: ["**/*.md", "*.md"],
     rules: {
       // override/add rules settings here, such as:
       // 'markdown-preferences/prefer-linked-words': 'error'
     },
   },
-];
+]);
 ```
 
 This plugin provides configs:
@@ -78,6 +79,49 @@ This plugin provides configs:
 
 See [the rule list](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/) to get the `rules` that this plugin provides.
 
+##### Using Extended Syntax
+
+This plugin experimentally supports some extended Markdown syntax.\
+To use these extended syntaxes, set the `markdown-preferences/extended-syntax` language option.
+
+```js
+import { defineConfig } from "eslint/config";
+import markdownPreferences from "eslint-plugin-markdown-preferences";
+export default defineConfig([
+  {
+    extends: [markdownPreferences.configs.recommended],
+    language: "markdown-preferences/extended-syntax",
+  },
+]);
+```
+
+The following syntaxes are supported:
+
+- [Custom Containers](https://vitepress.dev/guide/markdown#custom-containers)\
+  Example:
+
+  ```md
+  ::: warning
+  This is a warning box.
+  :::
+  ```
+
+- [Mathematical Expressions](https://docs.github.com/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions)\
+  Example:
+
+  ```md
+  $$
+  E = mc^2
+  $$
+  ```
+
+- [VitePress-style Import Code Snippets](https://vitepress.dev/guide/markdown#import-code-snippets) syntax using triple left angle brackets\
+  Example:
+
+  ```md
+  <<< @/filepath
+  ```
+
 #### Legacy Config (`.eslintrc`)
 
 Is not supported.
@@ -131,6 +175,7 @@ The rules with the following 💄 are included in the `standard` config.
 | [markdown-preferences/level2-heading-style](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/level2-heading-style.html)                           | enforce consistent style for level 2 headings                                             |   🔧    |   💄   |
 | [markdown-preferences/link-destination-style](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/link-destination-style.html)                       | enforce a consistent style for link destinations                                          |   🔧    |   💄   |
 | [markdown-preferences/link-title-style](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/link-title-style.html)                                   | enforce a consistent style for link titles                                                |   🔧    |   💄   |
+| [markdown-preferences/no-implicit-block-closing](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-implicit-block-closing.html)                 | disallow implicit block closing for fenced code blocks, math blocks, and custom blocks    |   🔧    |  ⭐💄  |
 | [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/ordered-list-marker-style](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/ordered-list-marker-style.html)                 | enforce consistent ordered list marker style                                              |   🔧    |   💄   |
 | [markdown-preferences/prefer-autolinks](https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/prefer-autolinks.html)                                   | enforce the use of autolinks for URLs                                                     |   🔧    |  ⭐💄  |

package/lib/index.d.ts

@@ -1,7 +1,12 @@
 import markdown from "@eslint/markdown";
+import * as math from "mdast-util-math";
 import * as _eslint_core0 from "@eslint/core";
-import { RuleDefinition } from "@eslint/core";
+import { File, Language, OkParseResult, ParseResult, RuleDefinition, SourceLocation } from "@eslint/core";
 import { ESLint, Linter } from "eslint";
+import * as eslint from "@eslint/markdown/types";
+import { MarkdownLanguageContext, MarkdownLanguageOptions } from "@eslint/markdown/types";
+import * as mdast from "mdast";
+import { TextSourceCodeBase } from "@eslint/plugin-kit";
 
 //#region src/rule-types.d.ts
 declare module 'eslint' {
@@ -120,6 +125,11 @@ interface RuleOptions {
    * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/list-marker-alignment.html
    */
   'markdown-preferences/list-marker-alignment'?: Linter.RuleEntry<MarkdownPreferencesListMarkerAlignment>;
+  /**
+   * disallow implicit block closing for fenced code blocks, math blocks, and custom blocks
+   * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-implicit-block-closing.html
+   */
+  'markdown-preferences/no-implicit-block-closing'?: Linter.RuleEntry<[]>;
   /**
    * disallow laziness in blockquotes
    * @see https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/no-laziness-blockquotes.html
@@ -380,12 +390,12 @@ type MarkdownPreferencesOrderedListMarkerStyle = [] | [{
   }[];
 }];
 type MarkdownPreferencesPaddingLineBetweenBlocks = {
-  prev: (("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "*") | [("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "*"), ...(("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "*"))[]] | {
-    type: (("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "*") | [("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "*"), ...(("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "*"))[]]);
+  prev: (("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "custom-container" | "math" | "import-code-snippet" | "*") | [("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "custom-container" | "math" | "import-code-snippet" | "*"), ...(("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "custom-container" | "math" | "import-code-snippet" | "*"))[]] | {
+    type: (("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "custom-container" | "math" | "import-code-snippet" | "*") | [("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "custom-container" | "math" | "import-code-snippet" | "*"), ...(("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "custom-container" | "math" | "import-code-snippet" | "*"))[]]);
     in?: ("list" | "blockquote" | "footnote-definition");
   });
-  next: (("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "*") | [("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "*"), ...(("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "*"))[]] | {
-    type: (("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "*") | [("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "*"), ...(("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "*"))[]]);
+  next: (("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "custom-container" | "math" | "import-code-snippet" | "*") | [("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "custom-container" | "math" | "import-code-snippet" | "*"), ...(("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "custom-container" | "math" | "import-code-snippet" | "*"))[]] | {
+    type: (("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "custom-container" | "math" | "import-code-snippet" | "*") | [("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "custom-container" | "math" | "import-code-snippet" | "*"), ...(("blockquote" | "code" | "heading" | "html" | "list" | "paragraph" | "thematic-break" | "table" | "link-definition" | "footnote-definition" | "frontmatter" | "custom-container" | "math" | "import-code-snippet" | "*"))[]]);
     in?: ("list" | "blockquote" | "footnote-definition");
   });
   blankLine: ("any" | "never" | "always");
@@ -498,7 +508,161 @@ declare namespace meta_d_exports {
   export { name, version };
 }
 declare const name: "eslint-plugin-markdown-preferences";
-declare const version: "0.26.1";
+declare const version: "0.28.0";
+//#endregion
+//#region src/language/ast-types.d.ts
+type Node = mdast.Node;
+type Root = ExtendChildren<mdast.Root, RootContent>;
+type Blockquote = ExtendChildren<mdast.Blockquote, CustomContainer>;
+type Break = mdast.Break;
+type Code = mdast.Code;
+type Definition = mdast.Definition;
+type Delete = mdast.Delete;
+type Emphasis = mdast.Emphasis;
+type FootnoteDefinition = ExtendChildren<mdast.FootnoteDefinition, CustomContainer>;
+type FootnoteReference = mdast.FootnoteReference;
+type Heading = mdast.Heading;
+type Html = mdast.Html;
+type Image = mdast.Image;
+type ImageReference = mdast.ImageReference;
+type InlineCode = mdast.InlineCode;
+type Link = mdast.Link;
+type LinkReference = mdast.LinkReference;
+type List = mdast.List;
+type ListItem = ExtendChildren<mdast.ListItem, CustomContainer>;
+type Paragraph = mdast.Paragraph;
+type Strong = mdast.Strong;
+type Table = mdast.Table;
+type TableCell = mdast.TableCell;
+type TableRow = mdast.TableRow;
+type Text = mdast.Text;
+type ThematicBreak = mdast.ThematicBreak;
+type Yaml = mdast.Yaml;
+type Math = math.Math;
+type InlineMath = math.InlineMath;
+type Toml = eslint.Toml;
+type Json = eslint.Json;
+interface CustomContainer extends ExtendChildren<mdast.Parent, CustomContainer | ImportCodeSnippet> {
+  /**
+   * Node type of mdast custom container.
+   */
+  type: "customContainer";
+  /**
+   * Info string (e.g., "warning" in ::: warning ... :::).
+   */
+  info: string | null;
+  /**
+   * Children of custom container.
+   */
+  children: (CustomContainer | BlockContent | DefinitionContent)[];
+}
+interface ImportCodeSnippet extends mdast.Literal {
+  /**
+   * Node type of mdast import code snippet.
+   */
+  type: "importCodeSnippet";
+}
+type RootContent = RootContentMap[keyof RootContentMap];
+type BlockContent = RootContentMap[keyof mdast.BlockContentMap] | ImportCodeSnippet;
+type DefinitionContent = RootContentMap[keyof mdast.DefinitionContentMap];
+type ExtendChildren<N extends mdast.Node & {
+  children: mdast.Node[];
+}, C extends mdast.Node> = Omit<N, "children"> & {
+  children: (MapChild<N["children"][number]> | C)[];
+};
+type MapChild<N extends mdast.Node> = N["type"] extends RootContent["type"] ? RootContentMap[N["type"]] : N;
+interface RootContentMap {
+  blockquote: Blockquote;
+  break: Break;
+  code: Code;
+  definition: Definition;
+  delete: Delete;
+  emphasis: Emphasis;
+  footnoteDefinition: FootnoteDefinition;
+  footnoteReference: FootnoteReference;
+  heading: Heading;
+  html: Html;
+  image: Image;
+  imageReference: ImageReference;
+  inlineCode: InlineCode;
+  link: Link;
+  linkReference: LinkReference;
+  list: List;
+  listItem: ListItem;
+  paragraph: Paragraph;
+  strong: Strong;
+  table: Table;
+  tableCell: TableCell;
+  tableRow: TableRow;
+  text: Text;
+  thematicBreak: ThematicBreak;
+  yaml: Yaml;
+  toml: Toml;
+  json: Json;
+  customContainer: CustomContainer;
+  inlineMath: InlineMath;
+  math: Math;
+  importCodeSnippet: ImportCodeSnippet;
+}
+//#endregion
+//#region src/language/extended-markdown-language.d.ts
+type ExtendedMarkdownSourceCode = TextSourceCodeBase<{
+  LangOptions: MarkdownLanguageOptions;
+  RootNode: Root;
+  SyntaxElementWithLoc: Node;
+  ConfigNode: {
+    value: string;
+    position: SourceLocation;
+  };
+}>;
+declare class ExtendedMarkdownLanguage implements Language {
+  /**
+   * The type of file to read.
+   * @type {"text"}
+   */
+  readonly fileType: "text";
+  /**
+   * The line number at which the parser starts counting.
+   * @type {0|1}
+   */
+  readonly lineStart: 0 | 1;
+  /**
+   * The column number at which the parser starts counting.
+   * @type {0|1}
+   */
+  readonly columnStart: 0 | 1;
+  /**
+   * The name of the key that holds the type of the node.
+   * @type {string}
+   */
+  readonly nodeTypeKey: string;
+  /**
+   * Default language options. User-defined options are merged with this object.
+   * @type {MarkdownLanguageOptions}
+   */
+  readonly defaultLanguageOptions: MarkdownLanguageOptions;
+  /**
+   * Validates the language options.
+   * @param {MarkdownLanguageOptions} languageOptions The language options to validate.
+   * @returns {void}
+   * @throws {Error} When the language options are invalid.
+   */
+  validateLanguageOptions(languageOptions: MarkdownLanguageOptions): void;
+  /**
+   * Parses the given file into an AST.
+   * @param {File} file The virtual file to parse.
+   * @param {MarkdownLanguageContext} _context The options to use for parsing.
+   * @returns {ParseResult<Root>} The result of parsing.
+   */
+  parse(file: File, _context: MarkdownLanguageContext): ParseResult<Root>;
+  /**
+   * Creates a new `MarkdownSourceCode` object from the given information.
+   * @param {File} file The virtual file to create a `MarkdownSourceCode` object from.
+   * @param {OkParseResult<Root>} parseResult The result returned from `parse()`.
+   * @returns {MarkdownSourceCode} The new `MarkdownSourceCode` object.
+   */
+  createSourceCode(file: File, parseResult: OkParseResult<Root>): ExtendedMarkdownSourceCode;
+}
 //#endregion
 //#region src/index.d.ts
 declare const configs: {
@@ -510,8 +674,14 @@ declare const resources: {
   defaultPreserveWords: string[];
   defaultMinorWords: string[];
 };
+declare const languages: {
+  "extended-syntax": ExtendedMarkdownLanguage;
+};
 declare const _default: {
   meta: typeof meta_d_exports;
+  languages: {
+    "extended-syntax": ExtendedMarkdownLanguage;
+  };
   configs: {
     recommended: typeof recommended_d_exports;
     standard: typeof standard_d_exports;
@@ -523,4 +693,4 @@ declare const _default: {
   };
 };
 //#endregion
-export { RuleOptions, configs, _default as default, meta_d_exports as meta, resources, rules };
+export { RuleOptions, configs, _default as default, languages, meta_d_exports as meta, resources, rules };