https://github.com/advanced-astro/biome-config

https://github.com/advanced-astro/biome-config

astro biome biomejs

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/advanced-astro/biome-config
• Owner: advanced-astro
• License: isc
• Created: 2024-04-18T16:57:45.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-08-16T15:31:15.000Z (6 months ago)
• Last Synced: 2024-09-16T17:54:19.034Z (5 months ago)
• Topics: astro, biome, biomejs
• Homepage: https://npmjs.com/package/biome-config-astro
• Size: 21.5 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# biome-config-astro

[![Install Size][pkgphobia-badge]][pkgphobia-url]

[![NPM Package Version][npm-badge]][npm-url]

[![License: ISC][license-badge]][license-file]

[![GitHub Repo Stars][gh-stars]][gh-repo]

[pkgphobia-badge]: https://packagephobia.com/badge?p=biome-config-astro

[pkgphobia-url]: https://packagephobia.com/result?p=biome-config-astro

[npm-badge]: https://img.shields.io/npm/v/biome-config-astro?style=flat-square

[npm-url]: https://www.npmjs.com/package/biome-config-astro

[license-badge]: https://flat.badgen.net/github/license/amio/badgen

[license-file]: ./LICENSE.md

[gh-stars]: https://img.shields.io/github/stars/advanced-astro/biome-config?style=flat-square

[gh-repo]: https://github.com/advanced-astro/biome-config

Shared Biome config for Astro projects

## Usage

### Installation

```sh

(bun|npm|pnpm|yarn) add -D @biomejs/biome biome-config-astro

```

Add the `extends` array to your project's `biome.json` file:

```jsonc

// /biome.json

{

    // ...

    "extends": ["biome-config-astro"],

    // ...

}

```

Add scripts to your `package.json` if you haven't already:

```jsonc

// /package.json

{

    //...

    "scripts": {

        "format": "biome format . --write",

        "lint": "biome lint .",

        "lint:fix": "biome lint . --apply",

        "lint:fix:unsafe": "biome lint . --apply-unsafe"

    }

    // ...

}

```

## Links

- [Astro][astro-url]

- [Biome][biome-url]

  - [Blog: Announcing Biome](https://biomejs.dev/blog/annoucing-biome/)

## License

[ISC][license-file] License © 2024 [Marc Redwerkz](https://github.com/rdwz)

[astro-url]: https://astro.build

[biome-url]: https://biome.dev