firebase_rules
0.2.1, released 2 years ago by iodesignteam.com
A type-safe Firebase rules generator for Firestore, Storage, and Realtime Database
What it does
Generates Firebase security rules from type-safe Dart definitions. Provides custom lint rules to catch issues before deployment and mimics native syntax for easy migration.
AI-written summary of version 0.2.1, based on the package's README and metadata. Report an inaccuracy
Use it when
- You want type-safe access to your data model when writing Firebase security rules
- You want code completion and compile-time checks for your rules language
Skip it when
- You prefer writing native Firebase security rules directly in JavaScript-like syntax
- You are not using Dart for defining your security rules
Strengths
- Type-safe access to your data model
- Code completion for the rules language
- Custom lint rules to catch issues before deployment
Weaknesses
- Early in development and subject to breaking changes
- Realtime Database rules are not fully type-safe
Setup
- Kind
- Pure Dart
- Effort
- Medium
- Code generation
- Yes (build_runner)
- Direct dependencies
- 1
Requires build_runner and custom_lint plugins in dev_dependencies and an analysis_options.yaml configuration.
import 'package:firebase_rules/firebase.dart';
import 'shared.dart';
@FirebaseRules(service: Service.firestore)
final firestoreRules = [
Match<FirestoreResource>(
firestoreRoot,
matches: (database, request, resource) => [
Match<FirestoreResource<User>>(
'/users/{userId}',
rules: (userId, request, resource) => [
Allow([Operation.read], resource.data.userId.rules() == userId),
],
),
],
),
];Alternatives
Packages that do the same job and could replace firebase_rules.
- firebase_storage_web
Web implementation of Firebase Storage for Flutter.
77Compare - cloud_firestore
Flutter plugin for Cloud Firestore noSQL database with live synchronization.
98Compare - firebase_core_web
Web implementation of firebase_core for Flutter apps.
83Compare - cloud_firestore_web
The web implementation of cloud_firestore.
82Compare
Works with
Packages commonly used together with firebase_rules: ones it builds on, ones built on it, and its own family.