prettier-plugin-firebase-database/README.md

Formatter for Firebase Realtime Database Rules

# Prettier for Firebase rules

Formatter for Firebase Realtime Database Rules

## Usage

Install this package:

```bash
npm install --save-dev prettier prettier-plugin-firebase
```

Then add this line to your `prettier.config.js`:

```js
  plugins: ["prettier-plugin-firebase-database"],
```

Finally, run prettier:

```bash
prettier --write firebase-database.rules
```

By default, this plugin would try to parse all files with the extension `.rules`
as Firebase Realtime Database Rules. You can customize this behavior though
configuration overwrites in your `prettier.config.js` or equivalent:

```js
/**
 * @see https://prettier.io/docs/en/configuration.html
 * @type {import("prettier").Config}
 */
const config = {
  plugins: ['prettier-plugin-firebase-database'],
  overrides: [
    {
      files: '*.rules',
      options: {
        parser: 'prettier-plugin-firebase-database',
      },
    },
  ],
};

export default config;
```