Skip to content

Formats

The formats option enables linting for non-code or mixed-content file formats.

FormatEnumUse It When
MarkdownFormat.MarkdownThe project contains Markdown content that should be linted.
MDXFormat.MdxThe project contains MDX files.
JSONCFormat.JsoncThe project uses JSON with comments.
YAMLFormat.YamlThe project contains YAML configuration files.
TOMLFormat.TomlThe project contains TOML configuration files.
Package.jsonFormat.PackageJsonThe project’s package.json should be semantically validated for npm standards.
GraphQLFormat.GraphqlThe project contains GraphQL documents.
CSSFormat.CssThe project contains plain CSS files (uses the official @eslint/css plugin).
HTMLFormat.HtmlThe project contains plain HTML files (uses @html-eslint).
import { defineConfig, Format } from '@santi020k/eslint-config-basic'
export default await defineConfig({
formats: [Format.Markdown, Format.Mdx, Format.Yaml]
})
  • Format integrations are always explicit.
  • Markdown and MDX are especially useful when the repository includes docs, content, or developer guides that should follow the same standards as source code.

Did this page help?

One click helps us spot documentation that needs another pass. No personal data is sent.