Registry /
data / prettier-plugin-firestore-rules
Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslnode 18–226 runs
build_error
glibcnode 18–226 runs
build_error
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
prettier-plugin-firestore-rules
✓ No explicit import needed; use in .prettierrc or CLI as --plugin=prettier-plugin-firestore-rules
✗ import plugin from 'prettier-plugin-firestore-rules'; // Not needed and will not work
This is a prettier plugin, used via configuration or CLI, not directly imported in JavaScript/TypeScript.
firestore.rules
✓ Files with .rules extension are automatically detected and formatted when plugin is registered
✗ Relying on file detection without registering the plugin
Works out of the box for .rules files if the plugin is installed and listed in prettier config.
require('prettier-plugin-firestore-rules')
✓ Add to .prettierrc: { "plugins": ["prettier-plugin-firestore-rules"] }
✗ const rulesPlugin = require('prettier-plugin-firestore-rules'); // Not a standalone module
The plugin is not meant to be required directly; it is loaded by prettier.
Install the plugin, configure .prettierrc to include the plugin, then format .rules files using prettier CLI.
// 1. Install plugin and prettier
npm install --save-dev prettier prettier-plugin-firestore-rules
// 2. Create .prettierrc in project root
// .prettierrc
{
"plugins": ["prettier-plugin-firestore-rules"],
"singleQuote": true,
"tabWidth": 2
}
// 3. Format a .rules file (e.g., firestore.rules)
// Run: npx prettier --write firestore.rules
// Example firestore.rules before formatting:
// rules_version = '2';
// service cloud.firestore {
// match /databases/{database}/documents {
// match /{document=**} {
// allow read, write: if false;
// }
// }
// }
// After formatting:
// rules_version = '2';
// service cloud.firestore {
// match /databases/{database}/documents {
// match /{document=**} {
// allow read, write: if false;
// }
// }
// }
Errors
Common errors & fixes
Error: Cannot find module 'prettier-plugin-firestore-rules'
Plugin not installed or not in node_modules.
fixRun 'npm install --save-dev prettier-plugin-firestore-rules'.
TypeError: plugin is not a function
Incorrect usage: trying to require the plugin as a standalone module instead of via prettier configuration.
fixRemove direct require/import and add the plugin name to prettier's plugins config.
Error: No parser could be inferred for file: firestore.rules
Plugin not registered in prettier config; prettier does not know how to parse .rules files.
fixAdd the plugin to .prettierrc plugins array.
Audit
Dependencies
prettierrequiredpeer dependency; required as the formatting engine