Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ivangabriele/biome-config
My most commonly used Biome configuration.
https://github.com/ivangabriele/biome-config
Last synced: 17 days ago
JSON representation
My most commonly used Biome configuration.
- Host: GitHub
- URL: https://github.com/ivangabriele/biome-config
- Owner: ivangabriele
- License: mit
- Created: 2024-06-07T22:37:40.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-09-30T22:05:11.000Z (about 1 month ago)
- Last Synced: 2024-10-12T19:27:45.306Z (about 1 month ago)
- Size: 3.23 MB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# My Biome Configuration
[![License][img-license]][lnk-license] [![GitHub Check Workflow Status][img-github]][lnk-github]
[![NPM Version][img-npm]][lnk-npm]
My most commonly used [Biome](https://biomejs.dev) configuration.
---
- [Usage](#usage)
- [Lint-Staged](#lint-staged)
- [IDEs](#ides)
- [Visual Studio Code](#visual-studio-code)
- [Contribute](#contribute)
---
## Usage
Run:
```sh
yarn add -DE @biomejs/biome @ivangabriele/biome-config
```
Add this line to your `biome.jsonc`:
```jsonc
{
"$schema": "https://biomejs.dev/schemas/1.8.0/schema.json",
"extends": ["@ivangabriele/biome-config"],
}
```
Then add this line to your `package.json`:
```json
{
"scripts": {
"test:lint": "biome check --write --no-errors-on-unmatched ."
}
}
```
### Lint-Staged
Run:
```sh
yarn add -DE @ivangabriele/biome-config lint-staged
```
Then add this line to your `package.json`:
```json
{
"lint-staged": {
"*.{cjs,cts,d.cts,d.mts,d.ts,js,json,jsonc,jsx,mjs,mts,ts,tson,tsx}": ["yarn test:lint"]
}
}
```
### IDEs
#### Visual Studio Code
Install [Biome](https://marketplace.visualstudio.com/items?itemName=biomejs.biome) and
[Run On Save](https://marketplace.visualstudio.com/items?itemName=emeraldwalk.runonsave) extensions.
`.vscode/settings.json`:
```json
{
"editor.defaultFormatter": "biomejs.biome",
"[javascript]": {
"editor.defaultFormatter": "biomejs.biome"
},
"[javascriptreact]": {
"editor.defaultFormatter": "biomejs.biome"
},
"[json]": {
"editor.defaultFormatter": "biomejs.biome"
},
"[typescript]": {
"editor.defaultFormatter": "biomejs.biome"
},
"[typescriptreact]": {
"editor.defaultFormatter": "biomejs.biome"
},
"emeraldwalk.runonsave": {
"commands": [
{
"match": ".*",
"cmd": "yarn test:lint"
}
]
}
}
```
## Contribute
Please refer to the [contribution guidelines](./CONTRIBUTING.md) for information on how to contribute to this project.
---
[img-github]:
https://img.shields.io/github/actions/workflow/status/ivangabriele/biome-config/check.yml?branch=main&label=CI&style=for-the-badge
[img-license]: https://img.shields.io/github/license/ivangabriele/biome-config?style=for-the-badge
[img-npm]: https://img.shields.io/npm/v/@ivangabriele/biome-config?style=for-the-badge
[lnk-github]: https://github.com/ivangabriele/biome-config/actions?query=branch%3Amain++
[lnk-license]: https://github.com/ivangabriele/biome-config/blob/main/LICENSE
[lnk-npm]: https://www.npmjs.com/package/@ivangabriele/biome-config