Skip to content

CSpell ESLint Plugin support Markdown #3464

@jerone

Description

@jerone

It looks like the CSpell ESLint Plugin does not support Markdown files.

Via overrides it's possible to extend ESLint with different parsers. For example for Markdown files. It would be nice if CSpell ESLint Plugin would support that.

Example ESLint config file.
{
  "root": true,
  "overrides": [
    {
      "files": ["*.md"],
      "parser": "eslint-plugin-markdownlint/parser",
      "extends": [
        "plugin:markdownlint/recommended",
        "plugin:@cspell/recommended"
      ]
    }
  ]
}
An plugin that supports a different parser is Prettier.
{
  "root": true,
  "overrides": [
    {
      "files": ["*.md"],
      "parser": "eslint-plugin-markdownlint/parser",
      "extends": [
        "plugin:markdownlint/recommended",
        "plugin:prettier/recommended"
      ],
      "rules": {
        "prettier/prettier": ["error", { "parser": "markdown" }]
      }
    }
  ]
}

CSpell ESLint Plugin version: v6.8.0
ESLint version: v8.22.0

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions