Enforces braces around arrow function bodies (arrow-body-style: always)
npm install biome-plugin-arrow-body-styleA Biome linter plugin that enforces braces around arrow function bodies, requiring the use of block statements instead of expression bodies for consistency and clarity.
Install the plugin as a dev dependency:
``bash`
npm install --save-dev biome-plugin-arrow-body-style
or with your preferred package manager:
`bash`
yarn add -D biome-plugin-arrow-body-style
pnpm add -D biome-plugin-arrow-body-style
bun add -D biome-plugin-arrow-body-style
Add the plugin to your Biome configuration file (biome.json or biome.jsonc):
`json`
{
"$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
"plugins": [
"node_modules/biome-plugin-arrow-body-style/arrow-body-style.grit"
]
}
`javascript`
// biome-ignore lint/plugin/arrow-body-style:
const getValue = () => 42;
The plugin will now check your code and report errors when it detects arrow functions without braces around their bodies.
The plugin enforces braces around arrow function bodies:
`javascript
// ❌ Error - expression body without braces
const getValue = () => 42;
const add = (a, b) => a + b;
// ✅ Correct - block statement with braces
const getValue = () => {
return 42;
};
const add = (a, b) => {
return a + b;
};
`
Requiring braces around arrow function bodies provides several benefits:
- Consistency: Maintains a uniform code style across your codebase
- Clarity: Makes function intent and return statements explicit
- Maintainability: Easier to add logic without accidentally changing return behavior
- Readability: Clearer distinction between simple expressions and actual function bodies
Contributions are welcome! Here's how to get started:
Clone the repository:
`bash`
git clone https://github.com/jeremytenjo/biome-plugin-arrow-body-style.git
cd biome-plugin-arrow-body-style
Install dependencies:
`bash`
npm install
The plugin is defined in arrow-body-style.grit using the Grit pattern language.
Run the test suite:
`bash`
npm test
Tests are located in the test directory and use Vitest. Test fixtures can be found in test/fixtures.
To publish a new version of the plugin:
1. Update the version in package.json.`
2. Publish to npm:
bash``
npm publish
3. Tag the release in GitHub creating a Release with the changes.
MIT © Jeremy Tenjo