Registry / testing / eslint-plugin-format

eslint-plugin-format

library2.0.1jsnpmunverified

An ESLint plugin that integrates multiple formatters (Prettier, dprint, oxfmt) for formatting various languages directly through ESLint rules. Current stable version is 2.0.1, released with support for ESLint v8 through v10, TypeScript types included. Key differentiators: side-effects-free, flat config native, supports multiple formatters in one plugin, and does not require language detection or external config files. Each file type must be explicitly configured with a formatter and options, giving full control but requiring manual setup.

testing

npm install eslint-plugin-format

github ↗package ↗

INSTALL

IMPORT

SIG · ESLINT-PLUGIN-FORM

eslint-plugin-format

testingjavascriptv2.0.1

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

format (default)

✓ import format from 'eslint-plugin-format'

✗ import { format } from 'eslint-plugin-format'

The default export is an object with `parserPlain` and rule definitions. Named export `format` is not available; use default import.

parserPlain

✓ import format from 'eslint-plugin-format'; const { parserPlain } = format

✗ import { parserPlain } from 'eslint-plugin-format'

parserPlain is a property of the default export, not a named export. Access via the default import object.

CommonJS require

✓ const format = require('eslint-plugin-format')

✗ const { format } = require('eslint-plugin-format')

v2.0.0 dropped CJS support; only ESM is supported. For CJS projects, pin to v1.x or use dynamic import.

Configures ESLint flat config to format CSS files with Prettier and TOML files with dprint. Each formatter rule must be applied per file type with explicit parser and options.

// eslint.config.js import format from 'eslint-plugin-format' export default [ { files: ['**/*.css'], languageOptions: { parser: format.parserPlain, }, plugins: { format, }, rules: { 'format/prettier': ['error', { parser: 'css' }], }, }, { files: ['**/*.toml'], languageOptions: { parser: format.parserPlain, }, plugins: { format, }, rules: { 'format/dprint': ['error', { language: 'toml' }], }, }, ]

Debug

Known issues

breakingCJS support dropped in v2.0.0

fix

Use ESM imports. If CJS is required, pin to v1.x (e.g., 'eslint-plugin-format': '^1.5.0')

affects: >=2.0.0

gotchaNo default configs: formatters only apply to files explicitly configured with a rule

fix

Add a rule with matching `files` pattern for each file type you want to format. The plugin does not apply to all files automatically.

affects: >=1.0.0

deprecatedPrettier parser option may be deprecated in future versions; prefer explicit parser per file type

fix

Always specify a parser in format/prettier options. The rule will not infer from file extension.

affects: >=1.0.0

gotchadprint requires WASM plugins; local paths may fail if binary not found

fix

Ensure dprint plugin WASM files are installed or use a URL. Example: plugin: 'node_modules/dprint-plugin-malva/plugin.wasm'

affects: >=1.0.0

breakingoxfmt rule changed behavior for unsupported file types in v2.0.1

fix

Upgrade to >=2.0.1 to ignore unsupported file type errors gracefully.

affects: <2.0.1

Errors

Common errors & fixes

Cannot find module 'eslint-plugin-format'

Missing dependency or using incorrect import path in CJS context

fix

Run 'npm install eslint-plugin-format --save-dev'. For CJS, pin to v1.x or use dynamic import().

Error: The 'format/prettier' rule expects a `parser` option

Prettier parser not specified in rule options

fix

Add parser option: 'format/prettier': ['error', { parser: 'css' }]

Error: dprint plugin not found

Path to dprint WASM plugin is incorrect or plugin not installed

fix

Verify the path: plugin: 'node_modules/dprint-plugin-<name>/plugin.wasm' or use an absolute path.

TypeError: format is not a function

Using destructured import `{ format }` instead of default import

fix

Use `import format from 'eslint-plugin-format'`

Upgrade

Version history

2.0.1latest on npm

Audit

Dependencies

eslintrequiredPeer dependency required to function as an ESLint plugin

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/antfu/eslint-plugin-format ↗

packagehttps://www.npmjs.com/package/eslint-plugin-format ↗