Skip to content

ChFlick/prettier-plugin-firestore-rules

Repository files navigation

CI MIT-License Dependencies DevDependencies npmVersion

prettier-plugin-firestore-rules

A plugin for prettier to enable autoformatting for Cloud Firestore Security Rules.

A custom built parser for the rules is included.

How to install it

With npm

npm i --save-dev prettier prettier-plugin-firestore-rules 

With yarn

yarn add -D prettier prettier-plugin-firestore-rules 

How to install it in the CLI

Generally

prettier -w <path/to/file> 

Using yarn berry

yarn prettier -w <path/to/file> 

Example Usage

Configuration

Create a .prettierrc file and add your preferred configuration options.

Configurations are optional.

Available Options

  • emptyLinesBetweenBlocks
    • Default: 0
    • Adds empty lines between matcher blocks

.prettierrc example

{ "emptyLinesBetweenBlocks" : 1 } 

For more information see Prettier documentation.

To be done

  • Fix some indentation issues
    • Array not correctly indented as function parameter
    request.resource.data.keys().hasOnly( ['rank', 'name', 'description', 'imageUrl', 'timeSlot'] ) 
    • Function parameter in general
    get( /databases/$(database)/documents/configurations/someData ).data.values.hasAll(request.resource.data.someData) 
    • if-alignments, sometimes off
     if hasValue('writeSLots', request.auth.uid, carId) && zxcv && xcvb 
    • semicolon may be off
    && request.resource.data.timeSlot.to > request.resource.data.timeSlot.from ; 
  • Add formatter options:
    • && at start or end of the line

About

Format your firestore security rules using prettier.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published