prettier-plugin-brace-style

A Prettier plugin that can apply ESLint's brace-style rules.

Installation¹

npm install -D prettier prettier-plugin-brace-style

Configuration

JSON example:

{
  "plugins": ["prettier-plugin-brace-style"]
}

JS example (CommonJS module):

module.exports = {
  plugins: ['prettier-plugin-brace-style'],
  braceStyle: 'stroustrup',
};

JS example (ES module):

export default {
  plugins: ['prettier-plugin-brace-style'],
  braceStyle: 'allman',
};

Markdown/MDX Override

This plugin does not support Markdown and MDX, but if this plugin supports a language inside code blocks (e.g. Vue), unintended formatting may occur inside the code blocks.

To prevent unintended formatting, you can use configuration overrides for Markdown and MDX.

JSON example:

{
  "plugins": ["prettier-plugin-brace-style"],
  "braceStyle": "stroustrup",
  "overrides": [
    {
      "files": ["*.md", "*.mdx"],
      "options": {
        "plugins": []
      }
    }
  ]
}

Options

Brace Style

Enforces consistent brace style for blocks. Same as ESLint, you can select one of 1tbs (default), stroustrup, allman.

• 1tbs example:

  if (condition) {
    statement1;
  } else {
    statement2;
  }
  

• stroustrup example:

  if (condition) {
    statement1;
  }
  else {
    statement2;
  }
  

• allman example:

  if (condition)
  {
    statement1;
  }
  else
  {
    statement2;
  }
  

Default	CLI Override	API Override
"1tbs"	--brace-style <1tbs|stroustrup|allman>	braceStyle: "<1tbs|stroustrup|allman>"

Version correlation with sibling plugins

Starting with 0.6.0, when there is a minor release on one side, I plan to reflect that change on the other side as well if possible.

Compatibility with other Prettier plugins

If more than one Prettier plugin can handle the text you want to format, Prettier will only use the last of those plugins.

In this case, you can configure it as follows by adding prettier-plugin-merge to apply those plugins sequentially.

JSON example:

{
  "plugins": [
    "@trivago/prettier-plugin-sort-imports",
    "prettier-plugin-brace-style",
    "prettier-plugin-merge"
  ],
  "braceStyle": "stroustrup"
}

Stargazers over time

Footnotes

1. If your version of prettier-plugin-brace-style is less than 0.5.0, you will also need to install @prettier/sync. ↩