Formats

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

Install @santi020k/eslint-config-formats alongside the lean basic package before enabling entries on this page. The full package already includes it.

Format	Enum	Use It When
Markdown	Format.Markdown	The project contains Markdown content that should be linted.
MDX	Format.Mdx	The project contains MDX files.
JSONC	Format.Jsonc	The project uses JSON with comments.
YAML	Format.Yaml	The project contains YAML configuration files.
TOML	Format.Toml	The project contains TOML configuration files.
Package.json	Format.PackageJson	The project’s package.json should be semantically validated for npm standards.
GraphQL	Format.Graphql	The project contains GraphQL documents.
CSS	Format.Css	The project contains plain CSS files (uses the official @eslint/css plugin).
HTML	Format.Html	The project contains plain HTML files (uses @html-eslint).

Example

import { defineConfig, Format } from '@santi020k/eslint-config-basic'

export default await defineConfig({
  formats: [Format.Markdown, Format.Mdx, Format.Yaml]
})

Notes

• 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.
• GitHub Actions workflows may use null event mappings such as workflow_dispatch:, pull_request:, and push:. These known event keys are accepted inside .github/workflows; unrelated empty mapping values still report a warning and should use {} or provide a mapping.

Repository Examples

• Format Playgrounds: packages/playground/formats
• Formats Package Source: packages/formats