You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Format various languages with formatters in ESLint. Supports Prettier and dprint. Side-effects-free and fully configurable.
Usages
Install
npm i -D eslint-plugin-format
Configure
This plugin does not do language detection or reading configure files, you need to specify the language for each file type you want to format along with other formatting options. We recommend using ESLint's Flat Config format.
// eslint.config.jsimportformatfrom'eslint-plugin-format'exportdefault[// ...other flat configs// use Prettier to format CSS{files: ['**/*.css'],languageOptions: {parser: format.parserPlain,},plugins: {
format,},rules: {'format/prettier': ['error',{parser: 'css',tabWidth: 2}],},},// use dprint to format TOML{files: ['**/*.toml'],languageOptions: {parser: format.parserPlain,},plugins: {
format,},rules: {'format/dprint': ['error',{language: 'toml',languageOptions: {indentWidth: 2}}],},},]
language (required) - the language to format, or can be a filepath or URL to the WASM binary. Supported languages
languageOptions - the options for the language
The rest options are passed as dprint's general options
Sponsors
FAQ
What's the difference between this and eslint-plugin-prettier?
While this plugin provides Prettier as one of the formatters, the main difference is that eslint-plugin-prettier is much more opinionated toward the Prettier CLI ecosystem. While this plugin only treats Prettier as the side-effects-free formatter and gives you full control in ESLint.
Credits
Thanks to the existing works for references and inspiration.